Athena / Paginator / ListDataCatalogs


class Athena.Paginator.ListDataCatalogs#
paginator = client.get_paginator('list_data_catalogs')

Creates an iterator that will paginate through responses from Athena.Client.list_data_catalogs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • WorkGroup (string) – The name of the workgroup. Required if making an IAM Identity Center request.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'DataCatalogsSummary': [
            'CatalogName': 'string',
            'Type': 'LAMBDA'|'GLUE'|'HIVE'


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.