GET

/clusters/{name}/updates/{updateId}

http://eks.{region}.amazonaws.com/clusters/{name}/updates/{updateId}

<p>Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.</p> <p>When the status of the update is <code>Succeeded</code>, the update is complete. If an update fails, the status is <code>Failed</code>, and an error detail explains the reason for the failure.</p>

Access Token Required: API Key

Path Parameters

namestringrequired

The name of the Amazon EKS cluster associated with the update.

updateIdstringrequired

The ID of the update to describe.

Query Params

nodegroupNamestring

The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.

addonNamestring

The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html"> <code>ListAddons</code> </a>. This parameter is required if the update is an add-on update.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://eks.{region}.amazonaws.com/clusters/{name}/updates/{updateId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET