Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . eks ]

describe-update

Description

Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-update
--name <value>
--update-id <value>
[--nodegroup-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

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

--update-id (string)

The ID of the update to describe.

--nodegroup-name (string)

The name of the Amazon EKS node group associated with the update.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To describe an update for a cluster

This example command describes an update for a cluster named example in your default region.

Command:

aws eks describe-update --name example \
--update-id 10bddb13-a71b-425a-b0a6-71cd03e59161

Output:

{
    "update": {
        "id": "10bddb13-a71b-425a-b0a6-71cd03e59161",
        "status": "Successful",
        "type": "EndpointAccessUpdate",
        "params": [
            {
                "type": "EndpointPublicAccess",
                "value": "true"
            },
            {
                "type": "EndpointPrivateAccess",
                "value": "false"
            }
        ],
        "createdAt": 1565806691.149,
        "errors": []
    }
}

Output

update -> (structure)

The full description of the specified update.

id -> (string)

A UUID that is used to track the update.

status -> (string)

The current status of the update.

type -> (string)

The type of the update.

params -> (list)

A key-value map that contains the parameters associated with the update.

(structure)

An object representing the details of an update request.

type -> (string)

The keys associated with an update request.

value -> (string)

The value of the keys submitted as part of an update request.

createdAt -> (timestamp)

The Unix epoch timestamp in seconds for when the update was created.

errors -> (list)

Any errors associated with a Failed update.

(structure)

An object representing an error when an asynchronous operation fails.

errorCode -> (string)

A brief description of the error.

  • SubnetNotFound : We couldn't find one of the subnets associated with the cluster.
  • SecurityGroupNotFound : We couldn't find one of the security groups associated with the cluster.
  • EniLimitReached : You have reached the elastic network interface limit for your account.
  • IpNotAvailable : A subnet associated with the cluster doesn't have any free IP addresses.
  • AccessDenied : You don't have permissions to perform the specified operation.
  • OperationNotPermitted : The service role associated with the cluster doesn't have the required access permissions for Amazon EKS.
  • VpcIdNotFound : We couldn't find the VPC associated with the cluster.

errorMessage -> (string)

A more complete description of the error.

resourceIds -> (list)

An optional field that contains the resource IDs associated with the error.

(string)