Skip to content

describe_global_table

Operation

describe_global_table

describe_global_table(request: DescribeGlobalTableInput | DescribeGlobalTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeGlobalTableInputDict]) -> 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
request DescribeGlobalTableInput | DescribeGlobalTableInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeGlobalTableInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeGlobalTableOutput

An instance of DescribeGlobalTableOutput.

describe_global_table async

describe_global_table(request: DescribeGlobalTableInput | DescribeGlobalTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeGlobalTableInputDict]) -> 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
request DescribeGlobalTableInput | DescribeGlobalTableInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeGlobalTableInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeGlobalTableOutput

An instance of DescribeGlobalTableOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeGlobalTableInputDict

Bases: TypedDict

Dictionary form of DescribeGlobalTableInput.

Attributes

global_table_name instance-attribute
global_table_name: Required[str]

The name of the global table.

DescribeGlobalTableInput dataclass

Bases: _SerdeShape

Dataclass for DescribeGlobalTableInput structure.

Attributes

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

The name of the global table.

Output

DescribeGlobalTableOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeGlobalTableOutput structure.

Attributes

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

Contains the details of the global table.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.