ListClusters
Retrieves information about a list of clusters.
Request Syntax
GET /cluster?max-results=maxResults&next-token=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
If your initial ListClusters operation returns a nextToken, you can include the returned nextToken in following ListClusters operations, which returns results in the next page.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"clusters": [
{
"arn": "string",
"identifier": "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
-
An array of the returned clusters.
Type: Array of ClusterSummary objects
- nextToken
-
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
Type: String
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.
- retryAfterSeconds
-
Retry after seconds.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
- resourceId
-
The resource ID could not be found.
- resourceType
-
The resource type could not be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
- message
-
The message that the request was denied due to request throttling.
- quotaCode
-
The request exceeds a request rate quota.
- retryAfterSeconds
-
The request exceeds a request rate quota. Retry after seconds.
- serviceCode
-
The request exceeds a service quota.
HTTP Status Code: 429
- ValidationException
-
The input failed to satisfy the constraints specified by an AWS service.
- fieldList
-
A list of fields that didn't validate.
- reason
-
The reason for the 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:
