odb / Paginator / ListAutonomousDatabasePeers

ListAutonomousDatabasePeers

class odb.Paginator.ListAutonomousDatabasePeers

paginator = client.get_paginator('list_autonomous_database_peers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from odb.Client.list_autonomous_database_peers().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• autonomousDatabaseId (string) –

  [REQUIRED]

  The unique identifier of the Autonomous Database whose peer databases you want to list.

• 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

{
    'autonomousDatabasePeers': [
        {
            'autonomousDatabaseId': 'string',
            'autonomousDatabaseArn': 'string',
            'ocid': 'string',
            'region': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • autonomousDatabasePeers (list) –

    The list of peer databases for the Autonomous Database.

    • (dict) –

      A summary of a peer database of an Autonomous Database.

      • autonomousDatabaseId (string) –

        The unique identifier of the peer Autonomous Database.

      • autonomousDatabaseArn (string) –

        The Amazon Resource Name (ARN) of the peer Autonomous Database.

      • ocid (string) –

        The Oracle Cloud Identifier (OCID) of the peer Autonomous Database.

      • region (string) –

        The Amazon Web Services Region where the peer Autonomous Database is located.

  • NextToken (string) –

    A token to resume pagination.