ListNodegroups
Lists the managed node groups associated with the specified cluster in your AWS account in the specified AWS Region. Self-managed node groups aren't listed.
Request Syntax
GET /clusters/name
/node-groups?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of your cluster.
Required: Yes
- maxResults
-
The maximum number of results, returned in paginated output. You receive
maxResults
in a single page, along with anextToken
response element. You can see the remaining results of the initial request by sending another request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter, 100 results and anextToken
value, if applicable, are returned.Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The
nextToken
value returned from a previous paginated request, wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value is null when there are no more results to return.Note
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
{
"nextToken": "string",
"nodegroups": [ "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
-
The
nextToken
value returned from a previous paginated request, wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value is null when there are no more results to return.Note
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
- nodegroups
-
A list of all of the node groups associated with the specified cluster.
Type: Array of strings
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. Actions can include using an action or resource on behalf of an IAM principal 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
- ResourceNotFoundException
-
The specified resource could not be found. You can view your available clusters with
ListClusters
. You can view your available managed node groups withListNodegroups
. Amazon EKS clusters and node groups are AWS Region specific.HTTP Status Code: 404
- 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
Examples
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 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 AWS Command Line
Interface (AWS CLI)
Example
This example lists all of the managed node groups that are associated with the
my-cluster
cluster.
Sample Request
GET /clusters/my-cluster/node-groups HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.275 Python/3.7.4 Darwin/18.7.0 botocore/1.13.11
X-Amz-Date: 20191111T183756Z
Authorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OK
Date: Mon, 11 Nov 2019 18:37:56 GMT
Content-Type: application/json
Content-Length: 50
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: DAeUrHtPPHcFU_A=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive
{
"nodegroups": [
"gpu",
"standard"
],
"nextToken": null
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: