Skip to content

DynamoDB  >  Operations  >  describe_table

describe_table

Operation

describe_table async 

describe_table(input: DescribeTableInput, plugins: list[Plugin] | None = None) -> 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
input DescribeTableInput

An instance of DescribeTableInput.

 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
DescribeTableOutput

An instance of DescribeTableOutput.

Input

DescribeTableInput dataclass

Represents the input of a DescribeTable operation.

Attributes

table_name class-attribute instance-attribute 
table_name: str | None = 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

Represents the output of a DescribeTable operation.

Attributes

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

The properties of the table.