Returns information about provisioned Amazon DocumentDB elastic clusters.
Request Syntax
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of elastic cluster snapshot results to receive in the response.
Valid Range: Minimum value of 1. 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
nextTokenwill not be returned.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"clusters": [
{
"clusterArn": "string",
"clusterName": "string",
"status": "string"
}
],
"nextToken": "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.
- clusters
-
A list of Amazon DocumentDB elastic clusters.
Type: Array of ClusterInList objects
- 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
nextTokenwill not be returned.Type: String
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
