Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListClusterSnapshots

Returns information about snapshots for a specified elastic cluster.

Request Syntax


GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

clusterArn

The ARN identifier of the elastic cluster.

maxResults

The maximum number of elastic cluster snapshot results to receive in the response.

Valid Range: Minimum value of 20. Maximum value of 100.

nextToken

A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

If there is no more data in the responce, the nextToken will not be returned.

snapshotType

The type of cluster snapshots to be returned. You can specify one of the following values:

automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.
manual - Return all cluster snapshots that you have manually created for your AWS account.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "string",
         "status": "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.

nextToken

A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

If there is no more data in the responce, the nextToken will not be returned.

Type: String

snapshots

A list of snapshots for a specified elastic cluster.

Type: Array of ClusterSnapshotInList objects

Errors

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

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

There was an internal server error.

HTTP Status Code: 500

ThrottlingException

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

HTTP Status Code: 429

ValidationException

A structure defining a validation exception.

HTTP Status Code: 400