CancelUpdate

Cancels an in-progress update to an Amazon EKS cluster on a best-effort basis. Cancellation is only performed if the update can be cancelled. Currently, this is supported for VersionRollback update types on EKS Auto Mode clusters when nodes are rolling back.

A successful cancellation stops the node rollback. After cancellation, nodes converge to the current cluster version honoring configured disruption controls. If the control plane rollback has already begun, the cancellation request fails.

Request Syntax

POST /clusters/name/updates/updateId/cancel-update HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

Request Body

The request accepts the following data in JSON format.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "update": { 
      "cancellation": { 
         "reason": "string",
         "status": "string"
      },
      "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.

Errors

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

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

Sample Request

POST /clusters/my-cluster/updates/9f771284-9e30-4886-b5b1-3789b6bea4dc/cancel-update HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.cancel-update
X-Amz-Date: 20250601T120000Z
Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK
Date: Sun, 01 Jun 2025 12:00:01 GMT
Content-Type: application/json
Content-Length: 300
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive

{
	"update": {
		"id": "9f771284-9e30-4886-b5b1-3789b6bea4dc",
		"status": "InProgress",
		"type": "VersionRollback",
		"params": [{
			"type": "Version",
			"value": "1.30"
		}],
		"createdAt": 1748764800.0,
		"errors": [],
		"cancellation": {
			"status": "InProgress"
		}
	}
}

See Also

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