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

get-insight-events

Description

X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.

See also: AWS API Documentation

Synopsis

  get-insight-events
--insight-id <value>
[--max-results <value>]
[--next-token <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

--insight-id (string)

The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

--max-results (integer)

Used to retrieve at most the specified value of events.

--next-token (string)

Specify the pagination token returned by a previous request to retrieve the next page of events.

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

InsightEvents -> (list)

A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.

(structure)

X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.

Summary -> (string)

A brief description of the event.

EventTime -> (timestamp)

The time, in Unix seconds, at which the event was recorded.

ClientRequestImpactStatistics -> (structure)

The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.

FaultCount -> (long)

The number of requests that have resulted in a fault,

OkCount -> (long)

The number of successful requests.

TotalCount -> (long)

The total number of requests to the service.

RootCauseServiceRequestImpactStatistics -> (structure)

The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.

FaultCount -> (long)

The number of requests that have resulted in a fault,

OkCount -> (long)

The number of successful requests.

TotalCount -> (long)

The total number of requests to the service.

TopAnomalousServices -> (list)

The service during the event that is most impacted by the incident.

(structure)

The service within the service graph that has anomalously high fault rates.

ServiceId -> (structure)

Name -> (string)

Names -> (list)

(string)

AccountId -> (string)

Type -> (string)

NextToken -> (string)

Use this token to retrieve the next page of insight events.