Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeTableReplicaAutoScaling

Describes auto scaling settings across replicas of the global table at once.

Request Syntax


{ "TableName": "string" }

Request Parameters

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

TableName

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

Response Syntax


{ "TableAutoScalingDescription": { "Replicas": [ { "GlobalSecondaryIndexes": [ { "IndexName": "string", "IndexStatus": "string", "ProvisionedReadCapacityAutoScalingSettings": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicies": [ { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } ] }, "ProvisionedWriteCapacityAutoScalingSettings": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicies": [ { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } ] } } ], "RegionName": "string", "ReplicaProvisionedReadCapacityAutoScalingSettings": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicies": [ { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } ] }, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicies": [ { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } ] }, "ReplicaStatus": "string" } ], "TableName": "string", "TableStatus": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TableAutoScalingDescription

Represents the auto scaling properties of the table.

Type: TableAutoScalingDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

message: The server encountered an internal error trying to fulfill the request.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

message: The resource which is being requested does not exist.

HTTP Status Code: 400