Route53RecoveryReadiness / Paginator / ListRecoveryGroups

ListRecoveryGroups#

class Route53RecoveryReadiness.Paginator.ListRecoveryGroups#
paginator = client.get_paginator('list_recovery_groups')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.list_recovery_groups().

See also: AWS API Documentation

Request Syntax

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

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

{
    'RecoveryGroups': [
        {
            'Cells': [
                'string',
            ],
            'RecoveryGroupArn': 'string',
            'RecoveryGroupName': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    200 response - Success.

    • RecoveryGroups (list) –

      A list of recovery groups.

      • (dict) –

        A representation of the application, typically containing multiple cells.

        • Cells (list) –

          A list of a cell’s Amazon Resource Names (ARNs).

          • (string) –

        • RecoveryGroupArn (string) –

          The Amazon Resource Name (ARN) for the recovery group.

        • RecoveryGroupName (string) –

          The name of the recovery group.

        • Tags (dict) –

          The tags associated with the recovery group.

          • (string) –

            • (string) –