Route53RecoveryControlConfig / Client / list_clusters

list_clusters#

Route53RecoveryControlConfig.Client.list_clusters(**kwargs)#

Returns an array of all the clusters in an account.

See also: AWS API Documentation

Request Syntax

response = client.list_clusters(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The number of objects that you want to return with this call.

  • NextToken (string) – The token that identifies which batch of results you want to see.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      The token that identifies which batch of results you want to see.

Exceptions

  • Route53RecoveryControlConfig.Client.exceptions.ResourceNotFoundException

  • Route53RecoveryControlConfig.Client.exceptions.ThrottlingException

  • Route53RecoveryControlConfig.Client.exceptions.ValidationException

  • Route53RecoveryControlConfig.Client.exceptions.InternalServerException

  • Route53RecoveryControlConfig.Client.exceptions.AccessDeniedException