[ aws . devops-guru ]

search-insights

Description

Returns a list of insights in your AWS account. You can specify which insights are returned by their start time, one or more statuses (ONGOING , CLOSED , and CLOSED ), one or more severities (LOW , MEDIUM , and HIGH ), and type (REACTIVE or PROACTIVE ).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

search-insights is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ProactiveInsights, ReactiveInsights

Synopsis

  search-insights
--start-time-range <value>
[--filters <value>]
--type <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--start-time-range (structure)

The start of the time range passed in. Returned insights occurred after this time.

FromTime -> (timestamp)

The start time of the time range.

ToTime -> (timestamp)

The end time of the time range.

Shorthand Syntax:

FromTime=timestamp,ToTime=timestamp

JSON Syntax:

{
  "FromTime": timestamp,
  "ToTime": timestamp
}

--filters (structure)

A SearchInsightsFilters object that is used to set the severity and status filters on your insight search.

Severities -> (list)

An array of severity values used to search for insights.

(string)

Statuses -> (list)

An array of status values used to search for insights.

(string)

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)

JSON Syntax:

{
  "Severities": ["LOW"|"MEDIUM"|"HIGH", ...],
  "Statuses": ["ONGOING"|"CLOSED", ...],
  "ResourceCollection": {
    "CloudFormation": {
      "StackNames": ["string", ...]
    }
  }
}

--type (string)

The type of insights you are searching for (REACTIVE or PROACTIVE ).

Possible values:

• REACTIVE

• PROACTIVE

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

ProactiveInsights -> (list)

The returned proactive insights.

(structure)

Details about a proactive insight. This object is returned by DescribeInsight.

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)

ReactiveInsights -> (list)

The returned reactive insights.

(structure)

Information about a reactive insight. This object is returned by DescribeInsight.

Id -> (string)

The ID of a reactive summary.

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)

NextToken -> (string)

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.