awswrangler.catalog.get_table_description

awswrangler.catalog.get_table_description(database: str, table: str, transaction_id: Optional[str] = None, query_as_of_time: Optional[str] = None, catalog_id: Optional[str] = None, boto3_session: Optional[Session] = None) → Optional[str]

Get table description.

Note

If reading from a governed table, pass only one of transaction_id or query_as_of_time.

Parameters

  • database (str) – Database name.

  • table (str) – Table name.

  • transaction_id (str, optional) – The ID of the transaction (i.e. used with GOVERNED tables).

  • query_as_of_time (str, optional) – The time as of when to read the table contents. Must be a valid Unix epoch timestamp. Cannot be specified alongside transaction_id.

  • catalog_id (str, optional) – The ID of the Data Catalog from which to retrieve Databases. If none is provided, the AWS account ID is used by default.

  • boto3_session (boto3.Session(), optional) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.

Returns

Description if exists.

Return type

Optional[str]

Examples

>>> import awswrangler as wr
>>> desc = wr.catalog.get_table_description(database="...", table="...")