UpdateTableReplicaAutoScalingCommand

Suggest an Edit

Updates auto scaling settings on your global tables 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, UpdateTableReplicaAutoScalingCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, UpdateTableReplicaAutoScalingCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // UpdateTableReplicaAutoScalingInput
  GlobalSecondaryIndexUpdates: [ // GlobalSecondaryIndexAutoScalingUpdateList
    { // GlobalSecondaryIndexAutoScalingUpdate
      IndexName: "STRING_VALUE",
      ProvisionedWriteCapacityAutoScalingUpdate: { // AutoScalingSettingsUpdate
        MinimumUnits: Number("long"),
        MaximumUnits: Number("long"),
        AutoScalingDisabled: true || false,
        AutoScalingRoleArn: "STRING_VALUE",
        ScalingPolicyUpdate: { // AutoScalingPolicyUpdate
          PolicyName: "STRING_VALUE",
          TargetTrackingScalingPolicyConfiguration: { // AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
            DisableScaleIn: true || false,
            ScaleInCooldown: Number("int"),
            ScaleOutCooldown: Number("int"),
            TargetValue: Number("double"), // required
          },
        },
      },
    },
  ],
  TableName: "STRING_VALUE", // required
  ProvisionedWriteCapacityAutoScalingUpdate: {
    MinimumUnits: Number("long"),
    MaximumUnits: Number("long"),
    AutoScalingDisabled: true || false,
    AutoScalingRoleArn: "STRING_VALUE",
    ScalingPolicyUpdate: {
      PolicyName: "STRING_VALUE",
      TargetTrackingScalingPolicyConfiguration: {
        DisableScaleIn: true || false,
        ScaleInCooldown: Number("int"),
        ScaleOutCooldown: Number("int"),
        TargetValue: Number("double"), // required
      },
    },
  },
  ReplicaUpdates: [ // ReplicaAutoScalingUpdateList
    { // ReplicaAutoScalingUpdate
      RegionName: "STRING_VALUE", // required
      ReplicaGlobalSecondaryIndexUpdates: [ // ReplicaGlobalSecondaryIndexAutoScalingUpdateList
        { // ReplicaGlobalSecondaryIndexAutoScalingUpdate
          IndexName: "STRING_VALUE",
          ProvisionedReadCapacityAutoScalingUpdate: "<AutoScalingSettingsUpdate>",
        },
      ],
      ReplicaProvisionedReadCapacityAutoScalingUpdate: "<AutoScalingSettingsUpdate>",
    },
  ],
};
const command = new UpdateTableReplicaAutoScalingCommand(input);
const response = await client.send(command);
// { // UpdateTableReplicaAutoScalingOutput
//   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",
//       },
//     ],
//   },
// };

UpdateTableReplicaAutoScalingCommand Input

See UpdateTableReplicaAutoScalingCommandInput for more details

Parameter
Type
Description
TableName
Required
string | undefined

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

GlobalSecondaryIndexUpdates
GlobalSecondaryIndexAutoScalingUpdate[] | undefined

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

ProvisionedWriteCapacityAutoScalingUpdate
AutoScalingSettingsUpdate | undefined

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

ReplicaUpdates
ReplicaAutoScalingUpdate[] | undefined

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

UpdateTableReplicaAutoScalingCommand Output

See UpdateTableReplicaAutoScalingCommandOutput for details

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

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

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

LimitExceededException
client

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

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

ResourceInUseException
client

The operation conflicts with the resource's availability. For example:

  • You attempted to recreate an existing table.

  • You tried to delete a table currently in the CREATING state.

  • You tried to update a resource that was already being updated.

When appropriate, wait for the ongoing update to complete and attempt the request again.

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.