[ aws . lookoutmetrics ]

list-anomaly-group-summaries

Description

Returns a list of anomaly groups.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-anomaly-group-summaries
--anomaly-detector-arn <value>
--sensitivity-threshold <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--anomaly-detector-arn (string)

The Amazon Resource Name (ARN) of the anomaly detector.

--sensitivity-threshold (integer)

The minimum severity score for inclusion in the output.

--max-results (integer)

The maximum number of results to return.

--next-token (string)

Specify the pagination token that’s returned by a previous request to retrieve the next page of results.

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

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

AnomalyGroupSummaryList -> (list)

A list of anomaly group summaries.

(structure)

Details about a group of anomalous metrics.

StartTime -> (string)

The start time for the group.

EndTime -> (string)

The end time for the group.

AnomalyGroupId -> (string)

The ID of the anomaly group.

AnomalyGroupScore -> (double)

The severity score of the group.

PrimaryMetricName -> (string)

The name of the primary affected measure for the group.

AnomalyGroupStatistics -> (structure)

Aggregated details about the anomaly groups.

EvaluationStartDate -> (string)

The start of the time range that was searched.

TotalCount -> (integer)

The number of groups found.

ItemizedMetricStatsList -> (list)

Statistics for individual metrics within the group.

(structure)

Aggregated statistics about a measure affected by an anomaly.

MetricName -> (string)

The name of the measure.

OccurrenceCount -> (integer)

The number of times that the measure appears.

NextToken -> (string)

The pagination token that’s included if more results are available.