awswrangler.catalog.get_table_description

awswrangler.catalog.get_table_description(database: str, table: str, catalog_id: str | None = None, boto3_session: Session | None = None) → str | None

Get table description.

Parameters:

  • database (str) – Database name.

  • table (str) – Table name.

  • catalog_id (str | None) – 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 (Session | None) – The default boto3 session will be used if boto3_session receive None.

Return type:

str | None

Returns:

Description if exists.

Examples

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