Skip to content

GetDatabasesRequest

Source code in docs_src/capo_glue/types/get_databases_request.py
class GetDatabasesRequest(TypedDict, closed=True):
    catalog_id: NotRequired["capo_glue.types.catalog_id_string.CatalogIdString"]
    """<p>The ID of the Data Catalog from which to retrieve <code>Databases</code>. If none is provided, the Amazon Web Services account ID is used by default.</p>"""
    next_token: NotRequired["capo_glue.types.token.Token"]
    """<p>A continuation token, if this is a continuation call.</p>"""
    max_results: NotRequired[
        "capo_glue.types.catalog_getter_page_size.CatalogGetterPageSize"
    ]
    """<p>The maximum number of databases to return in one response.</p>"""
    resource_share_type: NotRequired[
        "capo_glue.types.resource_share_type.ResourceShareType"
    ]
    """<p>Allows you to specify that you want to list the databases shared with your account. The allowable values are <code>FEDERATED</code>, <code>FOREIGN</code> or <code>ALL</code>. </p> <ul> <li> <p>If set to <code>FEDERATED</code>, will list the federated databases (referencing an external entity) shared with your account.</p> </li> <li> <p>If set to <code>FOREIGN</code>, will list the databases shared with your account. </p> </li> <li> <p>If set to <code>ALL</code>, will list the databases shared with your account, as well as the databases in yor local account. </p> </li> </ul>"""
    attributes_to_get: NotRequired[
        "capo_glue.types.database_attributes_list.DatabaseAttributesList"
    ]
    """<p>Specifies the database fields returned by the <code>GetDatabases</code> call. This parameter doesn’t accept an empty list. The request must include the <code>NAME</code>.</p>"""

attributes_to_get instance-attribute

attributes_to_get: NotRequired[DatabaseAttributesList]

Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.

catalog_id instance-attribute

catalog_id: NotRequired[CatalogIdString]

The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.

max_results instance-attribute

max_results: NotRequired[CatalogGetterPageSize]

The maximum number of databases to return in one response.

next_token instance-attribute

next_token: NotRequired[Token]

A continuation token, if this is a continuation call.

resource_share_type instance-attribute

resource_share_type: NotRequired[ResourceShareType]

Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

  • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

  • If set to FOREIGN, will list the databases shared with your account.

  • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.