list_tables¶
Operation¶
list_tables
¶
list_tables(request: ListTablesInput | ListTablesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListTablesInputDict]) -> 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 |
|---|---|---|---|
request
|
ListTablesInput | ListTablesInputDict | 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[ListTablesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListTablesOutput
|
An instance of |
list_tables
async
¶
list_tables(request: ListTablesInput | ListTablesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListTablesInputDict]) -> 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 |
|---|---|---|---|
request
|
ListTablesInput | ListTablesInputDict | 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[ListTablesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListTablesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListTablesInputDict
¶
Bases: TypedDict
Dictionary form of ListTablesInput.
ListTablesInput
dataclass
¶
Bases: _SerdeShape
Represents the input of a ListTables operation.
Attributes¶
Output¶
ListTablesOutput
dataclass
¶
Bases: _SerdeShape
Represents the output of a ListTables operation.
Attributes¶
last_evaluated_table_name
class-attribute
instance-attribute
¶
last_evaluated_table_name: str | 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.
response_metadata
class-attribute
instance-attribute
¶
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_names
class-attribute
instance-attribute
¶
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.