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

list-alerts

Description

Lists the alerts attached to a detector.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-alerts
[--anomaly-detector-arn <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--anomaly-detector-arn (string)

The ARN of the alert's detector.

--next-token (string)

If the result of the previous request is truncated, the response includes a NextToken . To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

--max-results (integer)

The maximum number of results that will be displayed by the request.

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

AlertSummaryList -> (list)

Contains information about an alert.

(structure)

Provides a summary of an alert's configuration.

AlertArn -> (string)

The ARN of the alert.

AnomalyDetectorArn -> (string)

The ARN of the detector to which the alert is attached.

AlertName -> (string)

The name of the alert.

AlertSensitivityThreshold -> (integer)

The minimum severity for an anomaly to trigger the alert.

AlertType -> (string)

The type of the alert.

AlertStatus -> (string)

The status of the alert.

LastModificationTime -> (timestamp)

The time at which the alert was last modified.

CreationTime -> (timestamp)

The time at which the alert was created.

Tags -> (map)

The alert's tags .

key -> (string)

value -> (string)

NextToken -> (string)

If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.