Athena / Paginator / ListDatabases

ListDatabases

class Athena.Paginator.ListDatabases

paginator = client.get_paginator('list_databases')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CatalogName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CatalogName (string) –

  [REQUIRED]

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

• 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:

dict

Returns:

Response Syntax

{
    'DatabaseList': [
        {
            'Name': 'string',
            'Description': 'string',
            'Parameters': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • DatabaseList (list) –

    A list of databases from a data catalog.

    • (dict) –

      Contains metadata information for a database in a data catalog.

      • Name (string) –

        The name of the database.

      • Description (string) –

        An optional description of the database.

      • Parameters (dict) –

        A set of custom key/value pairs.

        • (string) –

          • (string) –