[ aws . lookoutmetrics ]

create-alert

Description

Creates an alert for an anomaly detector.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

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

SnsFormat -> (string)

The format of the SNS topic.

• JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.

• LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.

• SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.

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:

SNSConfiguration={RoleArn=string,SnsTopicArn=string,SnsFormat=string},LambdaConfiguration={RoleArn=string,LambdaArn=string}

JSON Syntax:

{
  "SNSConfiguration": {
    "RoleArn": "string",
    "SnsTopicArn": "string",
    "SnsFormat": "LONG_TEXT"|"SHORT_TEXT"|"JSON"
  },
  "LambdaConfiguration": {
    "RoleArn": "string",
    "LambdaArn": "string"
  }
}

--tags (map)

A list of tags to apply to the alert.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--alert-filters (structure)

The configuration of the alert filters, containing MetricList and DimensionFilterList.

MetricList -> (list)

The list of measures that you want to get alerts for.

(string)

DimensionFilterList -> (list)

The list of DimensionFilter objects that are used for dimension-based filtering.

(structure)

The dimension filter, containing DimensionName and DimensionValueList.

DimensionName -> (string)

The name of the dimension to filter on.

DimensionValueList -> (list)

The list of values for the dimension specified in DimensionName that you want to filter on.

(string)

JSON Syntax:

{
  "MetricList": ["string", ...],
  "DimensionFilterList": [
    {
      "DimensionName": "string",
      "DimensionValueList": ["string", ...]
    }
    ...
  ]
}

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

See ‘aws help’ for descriptions of global parameters.

Output

AlertArn -> (string)

The ARN of the alert.