awswrangler.catalog.get_table_description

awswrangler.catalog.get_table_description(database: str, table: str, catalog_id: Optional[str] = None, boto3_session: Optional[boto3.session.Session] = None)Optional[str]

Get table description.

Parameters
  • database (str) – Database name.

  • table (str) – Table name.

  • 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="...")