awswrangler.catalog.get_columns_comments

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

Get all columns comments.

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

Columns comments. e.g. {“col1”: “foo boo bar”}.

Return type

Dict[str, str]

Examples

>>> import awswrangler as wr
>>> pars = wr.catalog.get_table_parameters(database="...", table="...")