AWS CLI Command Reference

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 ]

describe-alert

Description

Describes an alert.

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

Synopsis

  describe-alert
--alert-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--alert-arn (string)

The ARN of the alert to describe.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Alert -> (structure)

Contains information about an alert.

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.

AlertDescription -> (string)

A description of the alert.

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.

AlertFilters -> (structure)

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

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)