DescribeCluster, DeleteCluster - Amazon Route 53 Application Recovery Controller

DescribeCluster, DeleteCluster

URI

/cluster/ClusterArn

HTTP methods

GET

Operation ID: DescribeCluster

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

Path parameters
NameTypeRequiredDescription
ClusterArnStringTrue

The Amazon Resource Name (ARN) of the cluster.

Responses
Status codeResponse modelDescription
200DescribeClusterResponse

200 response - Success.

400ValidationException

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

403AccessDeniedException

403 response - AccessDeniedException. You do not have sufficient access to perform this action.

404ResourceNotFoundException

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

409ConflictException

409 response - ConflictException. You might be using a predefined variable.

429ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500InternalServerException

500 response - InternalServiceError. Temporary service error. Retry the request.

DELETE

Operation ID: DeleteCluster

Delete a cluster.

Path parameters
NameTypeRequiredDescription
ClusterArnStringTrue

The Amazon Resource Name (ARN) of the cluster that you're deleting.

Responses
Status codeResponse modelDescription
200DeleteClusterResponse

200 response - Success.

400ValidationException

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

403AccessDeniedException

403 response - AccessDeniedException. You do not have sufficient access to perform this action.

404ResourceNotFoundException

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

409ConflictException

409 response - ConflictException. You might be using a predefined variable.

429ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500InternalServerException

500 response - InternalServiceError. Temporary service error. Retry the request.

OPTIONS

Path parameters
NameTypeRequiredDescription
ClusterArnStringTrue

The Amazon Resource Name (ARN) of a cluster.

Responses
Status codeResponse modelDescription
200None

200 response - Success.

Schemas

Response bodies

{ "Cluster": { "ClusterArn": "string", "Status": enum, "ClusterEndpoints": [ { "Endpoint": "string", "Region": "string" } ], "Name": "string" } }
{ }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }

Properties

AccessDeniedException

403 response - You do not have sufficient access to perform this action.

PropertyTypeRequiredDescription
message

string

True

Cluster

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.

PropertyTypeRequiredDescription
ClusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

ClusterEndpoints

Array of type ClusterEndpoint

False

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.

Name

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

False

The name of the cluster.

Status

Status

False

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

ClusterEndpoint

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

PropertyTypeRequiredDescription
Endpoint

string

MinLength: 1

MaxLength: 128

False

A cluster endpoint. Specify an endpoint and AWS 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

MinLength: 1

MaxLength: 32

False

The AWS Region for a cluster endpoint.

ConflictException

409 response - ConflictException. You might be using a predefined variable.

PropertyTypeRequiredDescription
message

string

True

DeleteClusterResponse

A successful DeleteCluster request returns no response.

DescribeClusterResponse

The result of a successful DescribeCluster request.

PropertyTypeRequiredDescription
Cluster

Cluster

True

The cluster for the DescribeCluster request.

InternalServerException

500 response - InternalServiceError. Temporary service error. Retry the request.

PropertyTypeRequiredDescription
message

string

True

ResourceNotFoundException

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

PropertyTypeRequiredDescription
message

string

True

Status

The deployment status of a resource. Status can be one of the following:

PENDING: Amazon Route 53 Application Recovery Controller is creating the resource.

DEPLOYED: The resource is deployed and ready to use.

PENDING_DELETION: Amazon Route 53 Application Recovery Controller is deleting the resource.

  • PENDING

  • DEPLOYED

  • PENDING_DELETION

ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

PropertyTypeRequiredDescription
message

string

True

ValidationException

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

PropertyTypeRequiredDescription
message

string

True

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeCluster

DeleteCluster