Route53RecoveryControlConfig / Client / describe_cluster

describe_cluster#

Route53RecoveryControlConfig.Client.describe_cluster(**kwargs)#

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

Request Syntax

response = client.describe_cluster(
    ClusterArn='string'
)

Parameters:

ClusterArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

200 response - Success.
- Cluster (dict) –
  
  The cluster for the DescribeCluster request.
  - 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.

Exceptions

Route53RecoveryControlConfig.Client.exceptions.ValidationException
Route53RecoveryControlConfig.Client.exceptions.InternalServerException
Route53RecoveryControlConfig.Client.exceptions.AccessDeniedException
Route53RecoveryControlConfig.Client.exceptions.ResourceNotFoundException
Route53RecoveryControlConfig.Client.exceptions.ThrottlingException
Route53RecoveryControlConfig.Client.exceptions.ConflictException