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 . devops-guru ]

describe-insight

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-insight
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string)

The ID of the insight.

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

Output

ProactiveInsight -> (structure)

An ProactiveInsight object that represents the requested insight.

Id -> (string)

The ID of the proactive insight.

Name -> (string)

The name of the proactive insight.

Severity -> (string)

The severity of the proactive insight.

Status -> (string)

The status of the proactive insight.

InsightTimeRange -> (structure)

A time ranged that specifies when the observed behavior in an insight started and ended.

StartTime -> (timestamp)

The time when the behavior described in an insight started.

EndTime -> (timestamp)

The time when the behavior described in an insight ended.

PredictionTimeRange -> (structure)

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

StartTime -> (timestamp)

The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.

EndTime -> (timestamp)

The time when the behavior in a proactive insight is expected to end.

ResourceCollection -> (structure)

A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

CloudFormation -> (structure)

An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes.

StackNames -> (list)

An array of CloudFormation stack names.

(string)

SsmOpsItemId -> (string)

The ID of the AWS System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.

ReactiveInsight -> (structure)

An ReactiveInsight object that represents the requested insight.

Id -> (string)

The ID of a reactive insight.

Name -> (string)

The name of a reactive insight.

Severity -> (string)

The severity of a reactive insight.

Status -> (string)

The status of a reactive insight.

InsightTimeRange -> (structure)

A time ranged that specifies when the observed behavior in an insight started and ended.

StartTime -> (timestamp)

The time when the behavior described in an insight started.

EndTime -> (timestamp)

The time when the behavior described in an insight ended.

ResourceCollection -> (structure)

A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

CloudFormation -> (structure)

An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes.

StackNames -> (list)

An array of CloudFormation stack names.

(string)

SsmOpsItemId -> (string)

The ID of the AWS System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.