Skip to content

describe_table

Operation

describe_table

describe_table(request: DescribeTableInput | DescribeTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTableInputDict]) -> DescribeTableOutput

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

Note

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

Parameters:

Name Type Description Default
request DescribeTableInput | DescribeTableInputDict | 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[DescribeTableInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTableOutput

An instance of DescribeTableOutput.

describe_table async

describe_table(request: DescribeTableInput | DescribeTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTableInputDict]) -> DescribeTableOutput

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

Note

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

Parameters:

Name Type Description Default
request DescribeTableInput | DescribeTableInputDict | 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[DescribeTableInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTableOutput

An instance of DescribeTableOutput.

Input

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

DescribeTableInputDict

Bases: TypedDict

Dictionary form of DescribeTableInput.

Attributes

table_name instance-attribute
table_name: Required[str]

The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

DescribeTableInput dataclass

Bases: _SerdeShape

Represents the input of a DescribeTable operation.

Attributes

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

The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Output

DescribeTableOutput dataclass

Bases: _SerdeShape

Represents the output of a DescribeTable operation.

Attributes

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.

table class-attribute instance-attribute
table: TableDescription | None = ...

The properties of the table.