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

Description

Retrieves the summaries of all insights in the specified group matching the provided filter values.

See also: AWS API Documentation

Synopsis

  get-insight-summaries
[--states <value>]
[--group-arn <value>]
[--group-name <value>]
--start-time <value>
--end-time <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

--states (list)

The list of insight states.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  ACTIVE
  CLOSED

--group-arn (string)

The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.

--group-name (string)

The name of the group. Required if the GroupARN isn't provided.

--start-time (timestamp)

The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.

--end-time (timestamp)

The end of the time frame in which the insights ended. The end time can't be more than 30 days old.

--max-results (integer)

The maximum number of results to display.

--next-token (string)

Pagination token.

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

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

InsightSummaries -> (list)

The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.

(structure)

Information that describes an insight.

InsightId -> (string)

The insights unique identifier.

GroupARN -> (string)

The Amazon Resource Name (ARN) of the group that the insight belongs to.

GroupName -> (string)

The name of the group that the insight belongs to.

RootCauseServiceId -> (structure)

Name -> (string)

Names -> (list)

(string)

AccountId -> (string)

Type -> (string)

Categories -> (list)

Categories The categories that label and describe the type of insight.

(string)

State -> (string)

The current state of the insight.

StartTime -> (timestamp)

The time, in Unix seconds, at which the insight began.

EndTime -> (timestamp)

The time, in Unix seconds, at which the insight ended.

Summary -> (string)

A brief description of the insight.

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 within the insight 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)

LastUpdateTime -> (timestamp)

The time, in Unix seconds, that the insight was last updated.

NextToken -> (string)

Pagination token.