- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeGlobalTableSettingsCommand
Describes Region-specific settings for a global table.
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 .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DynamoDBClient, DescribeGlobalTableSettingsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, DescribeGlobalTableSettingsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // DescribeGlobalTableSettingsInput
GlobalTableName: "STRING_VALUE", // required
};
const command = new DescribeGlobalTableSettingsCommand(input);
const response = await client.send(command);
// { // DescribeGlobalTableSettingsOutput
// GlobalTableName: "STRING_VALUE",
// ReplicaSettings: [ // ReplicaSettingsDescriptionList
// { // ReplicaSettingsDescription
// RegionName: "STRING_VALUE", // required
// ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
// ReplicaBillingModeSummary: { // BillingModeSummary
// BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
// LastUpdateToPayPerRequestDateTime: new Date("TIMESTAMP"),
// },
// ReplicaProvisionedReadCapacityUnits: Number("long"),
// ReplicaProvisionedReadCapacityAutoScalingSettings: { // AutoScalingSettingsDescription
// MinimumUnits: Number("long"),
// MaximumUnits: Number("long"),
// AutoScalingDisabled: true || false,
// AutoScalingRoleArn: "STRING_VALUE",
// ScalingPolicies: [ // AutoScalingPolicyDescriptionList
// { // AutoScalingPolicyDescription
// PolicyName: "STRING_VALUE",
// TargetTrackingScalingPolicyConfiguration: { // AutoScalingTargetTrackingScalingPolicyConfigurationDescription
// DisableScaleIn: true || false,
// ScaleInCooldown: Number("int"),
// ScaleOutCooldown: Number("int"),
// TargetValue: Number("double"), // required
// },
// },
// ],
// },
// ReplicaProvisionedWriteCapacityUnits: Number("long"),
// ReplicaProvisionedWriteCapacityAutoScalingSettings: {
// MinimumUnits: Number("long"),
// MaximumUnits: Number("long"),
// AutoScalingDisabled: true || false,
// AutoScalingRoleArn: "STRING_VALUE",
// ScalingPolicies: [
// {
// PolicyName: "STRING_VALUE",
// TargetTrackingScalingPolicyConfiguration: {
// DisableScaleIn: true || false,
// ScaleInCooldown: Number("int"),
// ScaleOutCooldown: Number("int"),
// TargetValue: Number("double"), // required
// },
// },
// ],
// },
// ReplicaGlobalSecondaryIndexSettings: [ // ReplicaGlobalSecondaryIndexSettingsDescriptionList
// { // ReplicaGlobalSecondaryIndexSettingsDescription
// IndexName: "STRING_VALUE", // required
// IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
// ProvisionedReadCapacityUnits: Number("long"),
// ProvisionedReadCapacityAutoScalingSettings: {
// MinimumUnits: Number("long"),
// MaximumUnits: Number("long"),
// AutoScalingDisabled: true || false,
// AutoScalingRoleArn: "STRING_VALUE",
// ScalingPolicies: [
// {
// PolicyName: "STRING_VALUE",
// TargetTrackingScalingPolicyConfiguration: {
// DisableScaleIn: true || false,
// ScaleInCooldown: Number("int"),
// ScaleOutCooldown: Number("int"),
// TargetValue: Number("double"), // required
// },
// },
// ],
// },
// ProvisionedWriteCapacityUnits: Number("long"),
// ProvisionedWriteCapacityAutoScalingSettings: {
// MinimumUnits: Number("long"),
// MaximumUnits: Number("long"),
// AutoScalingDisabled: true || false,
// AutoScalingRoleArn: "STRING_VALUE",
// ScalingPolicies: [
// {
// PolicyName: "STRING_VALUE",
// TargetTrackingScalingPolicyConfiguration: {
// DisableScaleIn: true || false,
// ScaleInCooldown: Number("int"),
// ScaleOutCooldown: Number("int"),
// TargetValue: Number("double"), // required
// },
// },
// ],
// },
// },
// ],
// ReplicaTableClassSummary: { // TableClassSummary
// TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
// LastUpdateDateTime: new Date("TIMESTAMP"),
// },
// },
// ],
// };
DescribeGlobalTableSettingsCommand Input
See DescribeGlobalTableSettingsCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
GlobalTableNameRequired | string | undefined | The name of the global table to describe. |
DescribeGlobalTableSettingsCommand Output
See DescribeGlobalTableSettingsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
GlobalTableName | string | undefined | The name of the global table. |
ReplicaSettings | ReplicaSettingsDescription[] | undefined | The Region-specific settings for the global table. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| GlobalTableNotFoundException | client | The specified global table does not exist. |
| InternalServerError | server | An error occurred on the server side. |
| InvalidEndpointException | client | |
| DynamoDBServiceException | Base exception class for all service exceptions from DynamoDB service. |