# ListClusters Lists the Amazon EKS clusters in your Amazon account in the specified Amazon Web Services Region. ## Request Syntax ``` GET /clusters?include=include&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [include](#API_ListClusters_RequestSyntax) ** Indicates whether external clusters are included in the returned list. Use '`all`' to return [https://docs.amazonaws.cn/eks/latest/userguide/eks-connector.html](https://docs.amazonaws.cn/eks/latest/userguide/eks-connector.html)connected clusters, or blank to return only Amazon EKS clusters. '`all`' must be in lowercase otherwise an error occurs. ** [maxResults](#API_ListClusters_RequestSyntax) ** The maximum number of results, returned in paginated output. You receive `maxResults` in a single page, along with a `nextToken` response element. You can see the remaining results of the initial request by sending another request with the returned `nextToken` value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a `nextToken` value, if applicable, are returned. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListClusters_RequestSyntax) ** The `nextToken` value returned from a previous paginated 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. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is used only 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](#API_ListClusters_ResponseSyntax) ** A list of all of the clusters for your account in the specified Amazon Web Services Region . Type: Array of strings ** [nextToken](#API_ListClusters_ResponseSyntax) ** The `nextToken` value returned from a previous paginated 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. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an Amazon Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.amazonaws.cn/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [Amazon Command Line Interface (Amazon CLI)](http://www.amazonaws.cn/cli/) or one of the [Amazon SDKs](http://www.amazonaws.cn/tools/) to make requests to Amazon, 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 Amazon Web Services 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: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: HxkiCF8EPHcF4nw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "clusters": [ "my-cluster", "prod" ], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific Amazon SDKs, see the following: + [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/eks-2017-11-01/ListClusters) + [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/eks-2017-11-01/ListClusters) + [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/eks-2017-11-01/ListClusters) + [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/eks-2017-11-01/ListClusters) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/eks-2017-11-01/ListClusters) + [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/eks-2017-11-01/ListClusters) + [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/eks-2017-11-01/ListClusters) + [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/eks-2017-11-01/ListClusters) + [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/eks-2017-11-01/ListClusters) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/eks-2017-11-01/ListClusters)