# 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** | Name | Type | Required | Description | | --- |--- |--- |--- | | ClusterArn | String | True | The Amazon Resource Name (ARN) of the cluster. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | DescribeClusterResponse | 200 response - Success. | | 400 | ValidationException | 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. | | 403 | AccessDeniedException | 403 response - AccessDeniedException. You do not have sufficient access to perform this action. | | 404 | ResourceNotFoundException | 404 response - MalformedQueryString. The query string contains a syntax error or resource not found. | | 409 | ConflictException | 409 response - ConflictException. You might be using a predefined variable. | | 429 | ThrottlingException | 429 response - LimitExceededException or TooManyRequestsException. | | 500 | InternalServerException | 500 response - InternalServiceError. Temporary service error. Retry the request. | ### DELETE **Operation ID:** `DeleteCluster` Delete a cluster. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | ClusterArn | String | True | The Amazon Resource Name (ARN) of the cluster that you're deleting. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | DeleteClusterResponse | 200 response - Success. | | 400 | ValidationException | 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. | | 403 | AccessDeniedException | 403 response - AccessDeniedException. You do not have sufficient access to perform this action. | | 404 | ResourceNotFoundException | 404 response - MalformedQueryString. The query string contains a syntax error or resource not found. | | 409 | ConflictException | 409 response - ConflictException. You might be using a predefined variable. | | 429 | ThrottlingException | 429 response - LimitExceededException or TooManyRequestsException. | | 500 | InternalServerException | 500 response - InternalServiceError. Temporary service error. Retry the request. | ### OPTIONS **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | ClusterArn | String | True | The Amazon Resource Name (ARN) of a cluster. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | 200 response - Success. | ## Schemas ### Response bodies #### DescribeClusterResponse schema DescribeClusterResponse ``` { "Cluster": { "ClusterArn": "string", "Status": enum, "Owner": "string", "NetworkType": enum, "ClusterEndpoints": [ { "Endpoint": "string", "Region": "string" } ], "Name": "string" } } ``` #### DeleteClusterResponse schema DeleteClusterResponse ``` { } ``` #### ValidationException schema ValidationException ``` { "message": "string" } ``` #### AccessDeniedException schema AccessDeniedException ``` { "message": "string" } ``` #### ResourceNotFoundException schema ResourceNotFoundException ``` { "message": "string" } ``` #### ConflictException schema ConflictException ``` { "message": "string" } ``` #### ThrottlingException schema ThrottlingException ``` { "message": "string" } ``` #### InternalServerException schema InternalServerException ``` { "message": "string" } ``` ## Properties ### AccessDeniedException 403 response - You do not have sufficient access to perform this action. | Property | Type | Required | Description | | --- |--- |--- |--- | | 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. | Property | Type | Required | Description | | --- |--- |--- |--- | | ClusterArn | stringPattern: `^[A-Za-z0-9:\/_-]*$`MinLength: 1MaxLength: 256 | False | The Amazon Resource Name (ARN) of the cluster. | | ClusterEndpoints | Array of type [ClusterEndpoint](#cluster-clusterarn-model-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 learn more, see [ Best practices](https://docs.aws.amazon.com/r53recovery/latest/dg/route53-arc-best-practices.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.To learn more about getting or updating a routing control state, see [Routing control](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) in the Amazon Route 53 Application Recovery Controller Developer Guide. | | Name | stringPattern: `^((?![;'\s<>&"])[\u0021-\u007E])+$`MinLength: 1MaxLength: 64 | False | The name of the cluster. Note that only ASCII characters are supported for cluster names. | | NetworkType | [NetworkType](#cluster-clusterarn-model-networktype) | False | The network-type can either be IPV4 or DUALSTACK. | | Owner | stringPattern: `^\d{12}$`MinLength: 12MaxLength: 12 | False | The AWS account ID of the cluster owner. | | Status | [Status](#cluster-clusterarn-model-status) | False | Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING\$1DELETION. | ### ClusterEndpoint A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster. | Property | Type | Required | Description | | --- |--- |--- |--- | | Endpoint | stringPattern: `^[A-Za-z0-9:.\/_-]*$`MinLength: 1MaxLength: 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 | stringPattern: `^\S+$`MinLength: 1MaxLength: 32 | False | The AWS Region for a cluster endpoint. | ### ConflictException 409 response - ConflictException. You might be using a predefined variable. | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | True | | ### DeleteClusterResponse A successful `DeleteCluster` request returns no response. ### DescribeClusterResponse The result of a successful `DescribeCluster` request. | Property | Type | Required | Description | | --- |--- |--- |--- | | Cluster | [Cluster](#cluster-clusterarn-model-cluster) | True | The cluster for the `DescribeCluster` request. | ### InternalServerException 500 response - InternalServiceError. Temporary service error. Retry the request. | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | True | | ### NetworkType The network-type of a cluster can either be IPV4 or DUALSTACK. + `IPV4` + `DUALSTACK` ### ResourceNotFoundException 404 response - MalformedQueryString. The query string contains a syntax error or resource not found. | Property | Type | Required | Description | | --- |--- |--- |--- | | 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\$1DELETION: Amazon Route 53 Application Recovery Controller is deleting the resource. + `PENDING` + `DEPLOYED` + `PENDING_DELETION` ### ThrottlingException 429 response - LimitExceededException or TooManyRequestsException. | Property | Type | Required | Description | | --- |--- |--- |--- | | 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. | Property | Type | Required | Description | | --- |--- |--- |--- | | 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 + [AWS Command Line Interface V2](/goto/cli2/route53-recovery-control-config-2020-11-02/DescribeCluster) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/route53-recovery-control-config-2020-11-02/DescribeCluster) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/route53-recovery-control-config-2020-11-02/DescribeCluster) + [AWS SDK for Go v2](/goto/SdkForGoV2/route53-recovery-control-config-2020-11-02/DescribeCluster) + [AWS SDK for Java V2](/goto/SdkForJavaV2/route53-recovery-control-config-2020-11-02/DescribeCluster) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/route53-recovery-control-config-2020-11-02/DescribeCluster) + [AWS SDK for Kotlin](/goto/SdkForKotlin/route53-recovery-control-config-2020-11-02/DescribeCluster) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/route53-recovery-control-config-2020-11-02/DescribeCluster) + [AWS SDK for Python](/goto/boto3/route53-recovery-control-config-2020-11-02/DescribeCluster) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/route53-recovery-control-config-2020-11-02/DescribeCluster) ### DeleteCluster + [AWS Command Line Interface V2](/goto/cli2/route53-recovery-control-config-2020-11-02/DeleteCluster) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/route53-recovery-control-config-2020-11-02/DeleteCluster) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/route53-recovery-control-config-2020-11-02/DeleteCluster) + [AWS SDK for Go v2](/goto/SdkForGoV2/route53-recovery-control-config-2020-11-02/DeleteCluster) + [AWS SDK for Java V2](/goto/SdkForJavaV2/route53-recovery-control-config-2020-11-02/DeleteCluster) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/route53-recovery-control-config-2020-11-02/DeleteCluster) + [AWS SDK for Kotlin](/goto/SdkForKotlin/route53-recovery-control-config-2020-11-02/DeleteCluster) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/route53-recovery-control-config-2020-11-02/DeleteCluster) + [AWS SDK for Python](/goto/boto3/route53-recovery-control-config-2020-11-02/DeleteCluster) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/route53-recovery-control-config-2020-11-02/DeleteCluster)