DescribeTableReplicaAutoScalingCommand

Suggest an Edit

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

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DynamoDBClient, DescribeTableReplicaAutoScalingCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, DescribeTableReplicaAutoScalingCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // DescribeTableReplicaAutoScalingInput
  TableName: "STRING_VALUE", // required
};
const command = new DescribeTableReplicaAutoScalingCommand(input);
const response = await client.send(command);
// { // DescribeTableReplicaAutoScalingOutput
//   TableAutoScalingDescription: { // TableAutoScalingDescription
//     TableName: "STRING_VALUE",
//     TableStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
//     Replicas: [ // ReplicaAutoScalingDescriptionList
//       { // ReplicaAutoScalingDescription
//         RegionName: "STRING_VALUE",
//         GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexAutoScalingDescriptionList
//           { // ReplicaGlobalSecondaryIndexAutoScalingDescription
//             IndexName: "STRING_VALUE",
//             IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
//             ProvisionedReadCapacityAutoScalingSettings: { // 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
//                   },
//                 },
//               ],
//             },
//             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
//                   },
//                 },
//               ],
//             },
//           },
//         ],
//         ReplicaProvisionedReadCapacityAutoScalingSettings: {
//           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
//               },
//             },
//           ],
//         },
//         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
//               },
//             },
//           ],
//         },
//         ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
//       },
//     ],
//   },
// };

DescribeTableReplicaAutoScalingCommand Input

See DescribeTableReplicaAutoScalingCommandInput for more details

Parameter
Type
Description
TableName
Required
string | undefined

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

DescribeTableReplicaAutoScalingCommand Output

See DescribeTableReplicaAutoScalingCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
TableAutoScalingDescription
TableAutoScalingDescription | undefined

Represents the auto scaling properties of the table.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

ResourceNotFoundException
client

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

DynamoDBServiceException
Base exception class for all service exceptions from DynamoDB service.