Skip to content

List Global Tables

dynamodb_list_global_tables R Documentation

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

Description

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.

Usage

dynamodb_list_global_tables(ExclusiveStartGlobalTableName, Limit,
  RegionName)

Arguments

ExclusiveStartGlobalTableName

The first global table name that this operation will evaluate.

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

RegionName

Lists the global tables in a specific Region.

Value

A list with the following syntax:

list(
  GlobalTables = list(
    list(
      GlobalTableName = "string",
      ReplicationGroup = list(
        list(
          RegionName = "string"
        )
      )
    )
  ),
  LastEvaluatedGlobalTableName = "string"
)

Request syntax

svc$list_global_tables(
  ExclusiveStartGlobalTableName = "string",
  Limit = 123,
  RegionName = "string"
)