Amazon Elastic Kubernetes Service
API Reference (API Version 2017-11-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeUpdate

Returns descriptive information about an update against your Amazon EKS cluster.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

Request Syntax

GET /clusters/name/updates/updateId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

name

The name of the Amazon EKS cluster to update.

updateId

The ID of the update to describe.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "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.

update

The full description of the specified update.

Type: Update object

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 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

ResourceNotFoundException

The specified resource could not be found. You can view your available clusters with ListClusters. Amazon EKS clusters are Region-specific.

HTTP Status Code: 404

ServerException

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

HTTP Status Code: 500

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 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) 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 describes an update with the ID 9f771284-9e30-4886-b5b1-3789b6bea4dc in the devel cluster.

Sample Request

GET /clusters/devel/updates/9f771284-9e30-4886-b5b1-3789b6bea4dc 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: 20181129T172927Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK Date: Thu, 29 Nov 2018 17:29:27 GMT Content-Type: application/json Content-Length: 228 x-amzn-RequestId: 52408bdb-f3fc-11e8-a2ad-4dd5bee7556d x-amz-apigw-id: RIo-oFsVvHcFXng= X-Amzn-Trace-Id: Root=1-5c0021f7-1bdc4007e77da96f686fecde;Sampled=1 Connection: keep-alive { "update": { "errors": [], "params": [{ "value": "1.11", "type": "Version" }, { "value": "eks.1", "type": "PlatformVersion" }], "status": "InProgress", "id": "9f771284-9e30-4886-b5b1-3789b6bea4dc", "createdAt": 1543512515.848, "type": "VersionUpdate" } }

See Also

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