Skip to content

DynamoDB  >  Operations  >  describe_global_table

describe_global_table

Operation

describe_global_table async 

describe_global_table(input: DescribeGlobalTableInput, plugins: list[Plugin] | None = None) -> DescribeGlobalTableOutput

Returns information about the specified global table.

Warning

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.

Parameters:

Name Type Description Default
input DescribeGlobalTableInput

An instance of DescribeGlobalTableInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeGlobalTableOutput

An instance of DescribeGlobalTableOutput.

Input

DescribeGlobalTableInput dataclass

Dataclass for DescribeGlobalTableInput structure.

Attributes

global_table_name class-attribute instance-attribute 
global_table_name: str | None = None

The name of the global table.

Output

DescribeGlobalTableOutput dataclass

Dataclass for DescribeGlobalTableOutput structure.

Attributes

global_table_description class-attribute instance-attribute 
global_table_description: GlobalTableDescription | None = None

Contains the details of the global table.