Sign In to the Console
Amazon DynamoDB
API Reference

AWS Documentation » Amazon DynamoDB » API Reference » Actions » Amazon DynamoDB » UpdateGlobalTableSettings

UpdateGlobalTableSettings

Updates settings for a global table.

Request Syntax

{
   "GlobalTableGlobalSecondaryIndexSettingsUpdate": [ 
      { 
         "IndexName": "string",
         "ProvisionedWriteCapacityAutoScalingSettingsUpdate": { 
            "AutoScalingDisabled": boolean,
            "AutoScalingRoleArn": "string",
            "MaximumUnits": number,
            "MinimumUnits": number,
            "ScalingPolicyUpdate": { 
               "PolicyName": "string",
               "TargetTrackingScalingPolicyConfiguration": { 
                  "DisableScaleIn": boolean,
                  "ScaleInCooldown": number,
                  "ScaleOutCooldown": number,
                  "TargetValue": number
               }
            }
         },
         "ProvisionedWriteCapacityUnits": number
      }
   ],
   "GlobalTableName": "string",
   "GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate": { 
      "AutoScalingDisabled": boolean,
      "AutoScalingRoleArn": "string",
      "MaximumUnits": number,
      "MinimumUnits": number,
      "ScalingPolicyUpdate": { 
         "PolicyName": "string",
         "TargetTrackingScalingPolicyConfiguration": { 
            "DisableScaleIn": boolean,
            "ScaleInCooldown": number,
            "ScaleOutCooldown": number,
            "TargetValue": number
         }
      }
   },
   "GlobalTableProvisionedWriteCapacityUnits": number,
   "ReplicaSettingsUpdate": [ 
      { 
         "RegionName": "string",
         "ReplicaGlobalSecondaryIndexSettingsUpdate": [ 
            { 
               "IndexName": "string",
               "ProvisionedReadCapacityAutoScalingSettingsUpdate": { 
                  "AutoScalingDisabled": boolean,
                  "AutoScalingRoleArn": "string",
                  "MaximumUnits": number,
                  "MinimumUnits": number,
                  "ScalingPolicyUpdate": { 
                     "PolicyName": "string",
                     "TargetTrackingScalingPolicyConfiguration": { 
                        "DisableScaleIn": boolean,
                        "ScaleInCooldown": number,
                        "ScaleOutCooldown": number,
                        "TargetValue": number
                     }
                  }
               },
               "ProvisionedReadCapacityUnits": number
            }
         ],
         "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate": { 
            "AutoScalingDisabled": boolean,
            "AutoScalingRoleArn": "string",
            "MaximumUnits": number,
            "MinimumUnits": number,
            "ScalingPolicyUpdate": { 
               "PolicyName": "string",
               "TargetTrackingScalingPolicyConfiguration": { 
                  "DisableScaleIn": boolean,
                  "ScaleInCooldown": number,
                  "ScaleOutCooldown": number,
                  "TargetValue": number
               }
            }
         },
         "ReplicaProvisionedReadCapacityUnits": number
      }
   ]
}

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

Type: String

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

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

Required: Yes

GlobalTableGlobalSecondaryIndexSettingsUpdate

Represents the settings of a global secondary index for a global table that will be modified.

Type: Array of GlobalTableGlobalSecondaryIndexSettingsUpdate objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: No

GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate

AutoScaling settings for managing provisioned write capacity for the global table.

Type: AutoScalingSettingsUpdate object

Required: No

GlobalTableProvisionedWriteCapacityUnits

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Type: Long

Valid Range: Minimum value of 1.

Required: No

ReplicaSettingsUpdate

Represents the settings for a global table in a region that will be modified.

Type: Array of ReplicaSettingsUpdate objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax

{
   "GlobalTableName": "string",
   "ReplicaSettings": [ 
      { 
         "RegionName": "string",
         "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"
      }
   ]
}

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

IndexNotFoundException

The operation tried to access a nonexistent index.

HTTP Status Code: 400

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 10 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

For tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.

The total limit of tables in the ACTIVE state is 250.

HTTP Status Code: 400

ReplicaNotFoundException

The specified replica is no longer part of the global table.

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

See Also

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