Skip to content

DynamoDB  >  Operations  >  list_tables

list_tables

Operation

list_tables async

list_tables(input: ListTablesInput, plugins: list[Plugin] | None = None) -> ListTablesOutput

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

Parameters:

Name Type Description Default
input ListTablesInput

An instance of ListTablesInput.

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
ListTablesOutput

An instance of ListTablesOutput.

Input

ListTablesInput dataclass

Represents the input of a ListTables operation.

Attributes

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

The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

limit class-attribute instance-attribute
limit: int | None = None

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

Output

ListTablesOutput dataclass

Represents the output of a ListTables operation.

Attributes

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

The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

table_names class-attribute instance-attribute
table_names: list[str] | None = None

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.