Skip to content

ListDatabasesInput

Source code in docs_src/capo_athena/types/list_databases_input.py
class ListDatabasesInput(TypedDict, closed=True):
    catalog_name: "capo_athena.types.catalog_name_string.CatalogNameString"
    """<p>The name of the data catalog that contains the databases to return.</p>"""
    next_token: NotRequired["capo_athena.types.token.Token"]
    """<p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p>"""
    max_results: NotRequired["capo_athena.types.max_databases_count.MaxDatabasesCount"]
    """<p>Specifies the maximum number of results to return.</p>"""
    work_group: NotRequired["capo_athena.types.work_group_name.WorkGroupName"]
    """<p>The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.</p>"""

catalog_name instance-attribute

catalog_name: CatalogNameString

The name of the data catalog that contains the databases to return.

max_results instance-attribute

max_results: NotRequired[MaxDatabasesCount]

Specifies the maximum number of results to return.

next_token instance-attribute

next_token: NotRequired[Token]

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

work_group instance-attribute

work_group: NotRequired[WorkGroupName]

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.