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 ]



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


--anomaly-detector-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--anomaly-detector-arn (string)

The ARN of the detector 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.

See 'aws help' for descriptions of global parameters.


AnomalyDetectorArn -> (string)

The ARN of the detector.

AnomalyDetectorName -> (string)

The name of the detector.

AnomalyDetectorDescription -> (string)

A description of the detector.

AnomalyDetectorConfig -> (structure)

Contains information about the detector's configuration.

AnomalyDetectorFrequency -> (string)

The interval at which the detector analyzes its source data.

CreationTime -> (timestamp)

The time at which the detector was created.

LastModificationTime -> (timestamp)

The time at which the detector was last modified.

Status -> (string)

The status of the detector.

FailureReason -> (string)

The reason that the detector failed.

KmsKeyArn -> (string)

The ARN of the KMS key to use to encrypt your data.

FailureType -> (string)

The process that caused the detector to fail.