ListUpdates
Lists the updates associated with an Amazon EKS resource in your AWS account, in the specified AWS Region.
Request Syntax
GET /clusters/name/updates?addonName=addonName&maxResults=maxResults&nextToken=nextToken&nodegroupName=nodegroupName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- addonName
-
The names of the installed add-ons that have available updates.
- maxResults
-
The maximum number of results, returned in paginated output. You receive
maxResultsin a single page, along with anextTokenresponse element. You can see the remaining results of the initial request by sending another request with the returnednextTokenvalue. This value can be between 1 and 100. If you don't use this parameter, 100 results and anextTokenvalue, if applicable, are returned.Valid Range: Minimum value of 1. Maximum value of 100.
- name
-
The name of the Amazon EKS cluster to list updates for.
Required: Yes
- nextToken
-
The
nextTokenvalue returned from a previous paginated request, wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. 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.
- nodegroupName
-
The name of the Amazon EKS managed node group to list updates for.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"updateIds": [ "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
nextTokenvalue returned from a previous paginated request, wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. 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
- updateIds
-
A list of all the updates for the specified cluster and Region.
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
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
The following example lists all updates that are associated with the
my-cluster cluster.
Sample Request
GET /clusters/my-cluster/updates HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46
X-Amz-Date: 20181129T172901Z
Authorization: AUTHPARAMSSample Response
HTTP/1.1 200 OK
Date: Thu, 29 Nov 2018 17:29:01 GMT
Content-Type: application/json
Content-Length: 71
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: RIo6pF2NPHcF5PQ=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive
{
"updateIds": ["9f771284-9e30-4886-b5b1-3789b6bea4dc"],
"nextToken": null
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
