GetClusterSnapshot - Amazon DocumentDB


Returns information about a specific elastic cluster snapshot

Request Syntax

GET /cluster-snapshot/snapshotArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ARN identifier of the elastic cluster snapshot.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "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.


Returns information about a specific elastic cluster snapshot.

Type: ClusterSnapshot object


For information about the errors that are common to all actions, see Common Errors.


An exception that occurs when there are not sufficient permissions to perform an action.

HTTP Status Code: 403


There was an internal server error.

HTTP Status Code: 500


The specified resource could not be located.

HTTP Status Code: 404


ThrottlingException will be thrown when request was denied due to request throttling.

HTTP Status Code: 429


A structure defining a validation exception.

HTTP Status Code: 400

See Also

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