Route53RecoveryControlConfig / Paginator / ListClusters

ListClusters

class Route53RecoveryControlConfig.Paginator.ListClusters

paginator = client.get_paginator('list_clusters')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53RecoveryControlConfig.Client.list_clusters().

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

{
    'Clusters': [
        {
            'ClusterArn': 'string',
            'ClusterEndpoints': [
                {
                    'Endpoint': 'string',
                    'Region': 'string'
                },
            ],
            'Name': 'string',
            'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
        },
    ],

}

Response Structure

• (dict) –

  200 response - Success.

  • Clusters (list) –

    An array of the clusters in an account.

    • (dict) –

      A set of five redundant Regional endpoints against which you can execute API calls to update or get the state of routing controls. You can host multiple control panels and routing controls on one cluster.

      • ClusterArn (string) –

        The Amazon Resource Name (ARN) of the cluster.

      • ClusterEndpoints (list) –

        Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

        To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

        • (dict) –

          A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.

          • Endpoint (string) –

            A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

            To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

          • Region (string) –

            The Amazon Web Services Region for a cluster endpoint.

      • Name (string) –

        The name of the cluster.

      • Status (string) –

        Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.