Table Of Contents


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 ]



Creates an alert for an anomaly detector.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--alert-name <value>
--alert-sensitivity-threshold <value>
[--alert-description <value>]
--anomaly-detector-arn <value>
--action <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--alert-name (string)

The name of the alert.

--alert-sensitivity-threshold (integer)

An integer from 0 to 100 specifying the alert sensitivity threshold.

--alert-description (string)

A description of the alert.

--anomaly-detector-arn (string)

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

--action (structure)

Action that will be triggered when there is an alert.

SNSConfiguration -> (structure)

A configuration for an Amazon SNS channel.

RoleArn -> (string)

The ARN of the IAM role that has access to the target SNS topic.

SnsTopicArn -> (string)

The ARN of the target SNS topic.

LambdaConfiguration -> (structure)

A configuration for an AWS Lambda channel.

RoleArn -> (string)

The ARN of an IAM role that has permission to invoke the Lambda function.

LambdaArn -> (string)

The ARN of the Lambda function.

Shorthand Syntax:


JSON Syntax:

  "SNSConfiguration": {
    "RoleArn": "string",
    "SnsTopicArn": "string"
  "LambdaConfiguration": {
    "RoleArn": "string",
    "LambdaArn": "string"

--tags (map)

A list of tags to apply to the alert.

key -> (string)

value -> (string)

Shorthand Syntax:


JSON Syntax:

{"string": "string"

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


AlertArn -> (string)

The ARN of the alert.