AWS CLI Command Reference

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

Description

Returns details about an insight that you specify using its ID.

See also: AWS API Documentation

Synopsis

  describe-insight
--cluster-name <value>
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--cluster-name (string)

The name of the cluster to describe the insight for.

--id (string)

The identity of the insight to describe.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

insight -> (structure)

The full description of the insight.

id -> (string)

The ID of the insight.

name -> (string)

The name of the insight.

category -> (string)

The category of the insight.

kubernetesVersion -> (string)

The Kubernetes minor version associated with an insight if applicable.

lastRefreshTime -> (timestamp)

The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.

lastTransitionTime -> (timestamp)

The time the status of the insight last changed.

description -> (string)

The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).

insightStatus -> (structure)

An object containing more detail on the status of the insight resource.

status -> (string)

The status of the resource.

reason -> (string)

Explanation on the reasoning for the status of the resource.

recommendation -> (string)

A summary of how to remediate the finding of this insight if applicable.

additionalInfo -> (map)

Links to sources that provide additional context on the insight.

key -> (string)

value -> (string)

resources -> (list)

The details about each resource listed in the insight check result.

(structure)

Returns information about the resource being evaluated.

insightStatus -> (structure)

An object containing more detail on the status of the insight resource.

status -> (string)

The status of the resource.

reason -> (string)

Explanation on the reasoning for the status of the resource.

kubernetesResourceUri -> (string)

The Kubernetes resource URI if applicable.

arn -> (string)

The Amazon Resource Name (ARN) if applicable.

categorySpecificSummary -> (structure)

Summary information that relates to the category of the insight. Currently only returned with certain insights having category UPGRADE_READINESS .

deprecationDetails -> (list)

The summary information about deprecated resource usage for an insight check in the UPGRADE_READINESS category.

(structure)

The summary information about deprecated resource usage for an insight check in the UPGRADE_READINESS category.

usage -> (string)

The deprecated version of the resource.

replacedWith -> (string)

The newer version of the resource to migrate to if applicable.

stopServingVersion -> (string)

The version of the software where the deprecated resource version will stop being served.

startServingReplacementVersion -> (string)

The version of the software where the newer resource version became available to migrate to if applicable.

clientStats -> (list)

Details about Kubernetes clients using the deprecated resources.

(structure)

Details about clients using the deprecated resources.

userAgent -> (string)

The user agent of the Kubernetes client using the deprecated resource.

numberOfRequestsLast30Days -> (integer)

The number of requests from the Kubernetes client seen over the last 30 days.

lastRequestTime -> (timestamp)

The timestamp of the last request seen from the Kubernetes client.