SsmSap / Paginator / ListDatabases

ListDatabases

class SsmSap.Paginator.ListDatabases

paginator = client.get_paginator('list_databases')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ApplicationId (string) – The ID of the application.

• ComponentId (string) – The ID of the component.

• 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

{
    'Databases': [
        {
            'ApplicationId': 'string',
            'ComponentId': 'string',
            'DatabaseId': 'string',
            'DatabaseType': 'SYSTEM'|'TENANT',
            'Arn': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • Databases (list) –

    The SAP HANA databases of an application.

    • (dict) –

      The summary of the database.

      • ApplicationId (string) –

        The ID of the application.

      • ComponentId (string) –

        The ID of the component.

      • DatabaseId (string) –

        The ID of the database.

      • DatabaseType (string) –

        The type of the database.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the database.

      • Tags (dict) –

        The tags of the database.

        • (string) –

          • (string) –