Describes auto scaling settings across replicas of the global table at once.
Important
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
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.
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.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
