ListGlobalTables
Lists all global tables that have a replica in the specified Region.
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
{
"ExclusiveStartGlobalTableName": "string
",
"Limit": number
,
"RegionName": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- ExclusiveStartGlobalTableName
-
The first global table name that this operation will evaluate.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
Required: No
- Limit
-
The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.
If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point, with a table name in the
LastEvaluatedGlobalTableName
to apply in a subsequent operation to theExclusiveStartGlobalTableName
parameter.Type: Integer
Valid Range: Minimum value of 1.
Required: No
- RegionName
-
Lists the global tables in a specific Region.
Type: String
Required: No
Response Syntax
{
"GlobalTables": [
{
"GlobalTableName": "string",
"ReplicationGroup": [
{
"RegionName": "string"
}
]
}
],
"LastEvaluatedGlobalTableName": "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.
- GlobalTables
-
List of global table names.
Type: Array of GlobalTable objects
- LastEvaluatedGlobalTableName
-
Last evaluated global table name.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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 Amazon SDKs, see the following: