Menu
Amazon Elastic Container Service for Kubernetes
Welcome (API Version 2017-11-01)

ListClusters

Lists the Amazon EKS clusters in your AWS account in the specified Region.

Request Syntax

GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

maxResults

The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.

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

nextToken

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Note

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "clusters": [ "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 all of the clusters for your account in the specified Region.

Type: Array of strings

nextToken

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Errors

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

ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

HTTP Status Code: 400

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server-side issue.

HTTP Status Code: 500

ServiceUnavailableException

The service is unavailable. Back off and retry the operation.

HTTP Status Code: 503

Example

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

The following example lists all of the Amazon EKS clusters in the specified Region.

Sample Request

GET /clusters HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.15.0 Python/3.6.5 Darwin/16.7.0 botocore/1.10.0 X-Amz-Date: 20180531T231200Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK Date: Thu, 31 May 2018 23:12:00 GMT Content-Type: application/json Content-Length: 46 x-amzn-RequestId: 05a756a1-6528-11e8-8b76-b9c1c7f233af x-amz-apigw-id: HxkiCF8EPHcF4nw= X-Amzn-Trace-Id: Root=1-5b108140-02517e16072fcc6261058b70 Connection: keep-alive { "clusters": [ "devel", "prod" ], "nextToken": null }

See Also

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