ListGlobalTablesCommand

Suggest an Edit

Lists all global tables that have a replica in the specified Region.

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, ListGlobalTablesCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, ListGlobalTablesCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // ListGlobalTablesInput
  ExclusiveStartGlobalTableName: "STRING_VALUE",
  Limit: Number("int"),
  RegionName: "STRING_VALUE",
};
const command = new ListGlobalTablesCommand(input);
const response = await client.send(command);
// { // ListGlobalTablesOutput
//   GlobalTables: [ // GlobalTableList
//     { // GlobalTable
//       GlobalTableName: "STRING_VALUE",
//       ReplicationGroup: [ // ReplicaList
//         { // Replica
//           RegionName: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   LastEvaluatedGlobalTableName: "STRING_VALUE",
// };

ListGlobalTablesCommand Input

See ListGlobalTablesCommandInput for more details

Parameter
Type
Description
ExclusiveStartGlobalTableName
string | undefined

The first global table name that this operation will evaluate.

Limit
number | undefined

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 the ExclusiveStartGlobalTableName parameter.

RegionName
string | undefined

Lists the global tables in a specific Region.

ListGlobalTablesCommand Output

See ListGlobalTablesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
GlobalTables
GlobalTable[] | undefined

List of global table names.

LastEvaluatedGlobalTableName
string | undefined

Last evaluated global table name.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

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