list_data_catalogs

list_data_catalogs(**kwargs)

Lists the data catalogs in the current Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_data_catalogs(
    NextToken='string',
    MaxResults=123
)

Parameters

• NextToken (string) -- 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.
• MaxResults (integer) -- Specifies the maximum number of data catalogs to return.

Return type

dict

Returns

Response Syntax

{
    'DataCatalogsSummary': [
        {
            'CatalogName': 'string',
            'Type': 'LAMBDA'|'GLUE'|'HIVE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • DataCatalogsSummary (list) --

    A summary list of data catalogs.

    • (dict) --

      The summary information for the data catalog, which includes its name and type.

      • CatalogName (string) --

        The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

      • Type (string) --

        The data catalog type.

  • NextToken (string) --

    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.

Exceptions

• Athena.Client.exceptions.InternalServerException
• Athena.Client.exceptions.InvalidRequestException