GetCluster
Retrieves information about a cluster.
Request Syntax
GET /cluster/identifier
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- identifier
-
The ID of the cluster to retrieve.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationTime": number,
"deletionProtectionEnabled": boolean,
"identifier": "string",
"linkedClusterArns": [ "string" ],
"status": "string",
"witnessRegion": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- arn
-
The ARN of the retrieved cluster.
Type: String
- creationTime
-
The time of when the cluster was created.
Type: Timestamp
- deletionProtectionEnabled
-
Whether deletion protection is enabled in this cluster.
Type: Boolean
- identifier
-
The ID of the retrieved cluster.
Type: String
- linkedClusterArns
-
The ARNs of the clusters linked to the retrieved cluster.
Type: Array of strings
- status
-
The status of the retrieved cluster.
Type: String
Valid Values:
CREATING | ACTIVE | UPDATING | DELETING | DELETED | FAILED
- witnessRegion
-
The witness Region of the cluster. Applicable only for multi-Region clusters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 20.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input failed to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: