UpdateTableReplicaAutoScaling - Amazon DynamoDB

UpdateTableReplicaAutoScaling

Updates auto scaling settings on your global tables at once.

Note

This operation only applies to Version 2019.11.21 of global tables.

Request Syntax

{ "GlobalSecondaryIndexUpdates": [ { "IndexName": "string", "ProvisionedWriteCapacityAutoScalingUpdate": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicyUpdate": { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } } } ], "ProvisionedWriteCapacityAutoScalingUpdate": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicyUpdate": { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } }, "ReplicaUpdates": [ { "RegionName": "string", "ReplicaGlobalSecondaryIndexUpdates": [ { "IndexName": "string", "ProvisionedReadCapacityAutoScalingUpdate": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicyUpdate": { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } } } ], "ReplicaProvisionedReadCapacityAutoScalingUpdate": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicyUpdate": { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } } } ], "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 global table to be updated.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

GlobalSecondaryIndexUpdates

Represents the auto scaling settings of the global secondary indexes of the replica to be updated.

Type: Array of GlobalSecondaryIndexAutoScalingUpdate objects

Array Members: Minimum number of 1 item.

Required: No

ProvisionedWriteCapacityAutoScalingUpdate

Represents the auto scaling settings to be modified for a global table or global secondary index.

Type: AutoScalingSettingsUpdate object

Required: No

ReplicaUpdates

Represents the auto scaling settings of replicas of the table that will be modified.

Type: Array of ReplicaAutoScalingUpdate objects

Array Members: Minimum number of 1 item.

Required: No

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

Returns information about the auto scaling settings of a table with replicas.

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

LimitExceededException

There is no limit to the number of daily on-demand backups that can be taken.

Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

There is a soft account quota of 256 tables.

HTTP Status Code: 400

ResourceInUseException

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

HTTP Status Code: 400

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: