DescribeGlobalTableSettings - Amazon DynamoDB

DescribeGlobalTableSettings

Describes Region-specific settings for a global table.

Important

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

Request Syntax

{ "GlobalTableName": "string" }

Request Parameters

The request accepts the following data in JSON format.

Note

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

GlobalTableName

The name of the global table to describe.

Type: String

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

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

Required: Yes

Response Syntax

{ "GlobalTableName": "string", "ReplicaSettings": [ { "RegionName": "string", "ReplicaBillingModeSummary": { "BillingMode": "string", "LastUpdateToPayPerRequestDateTime": number }, "ReplicaGlobalSecondaryIndexSettings": [ { "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 } } ] }, "ProvisionedReadCapacityUnits": number, "ProvisionedWriteCapacityAutoScalingSettings": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicies": [ { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } ] }, "ProvisionedWriteCapacityUnits": number } ], "ReplicaProvisionedReadCapacityAutoScalingSettings": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicies": [ { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } ] }, "ReplicaProvisionedReadCapacityUnits": number, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "AutoScalingDisabled": boolean, "AutoScalingRoleArn": "string", "MaximumUnits": number, "MinimumUnits": number, "ScalingPolicies": [ { "PolicyName": "string", "TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": boolean, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } } ] }, "ReplicaProvisionedWriteCapacityUnits": number, "ReplicaStatus": "string", "ReplicaTableClassSummary": { "LastUpdateDateTime": number, "TableClass": "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.

GlobalTableName

The name of the global table.

Type: String

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

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

ReplicaSettings

The Region-specific settings for the global table.

Type: Array of ReplicaSettingsDescription objects

Errors

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

GlobalTableNotFoundException

The specified global table does not exist.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: