awswrangler.catalog.get_tables

awswrangler.catalog.get_tables(catalog_id: Optional[str] = None, database: Optional[str] = None, name_contains: Optional[str] = None, name_prefix: Optional[str] = None, name_suffix: Optional[str] = None, boto3_session: Optional[boto3.session.Session] = None) → Iterator[Dict[str, Any]]

Get an iterator of tables.

Parameters
  • 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.

  • database (str, optional) – Database name.

  • name_contains (str, optional) – Select by a specific string on table name

  • name_prefix (str, optional) – Select by a specific prefix on table name

  • name_suffix (str, optional) – Select by a specific suffix on table name

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

Returns

Iterator of tables.

Return type

Iterator[Dict[str, Any]]

Examples

>>> import awswrangler as wr
>>> tables = wr.catalog.get_tables()