[ aws . cloudwatch ]

describe-anomaly-detectors

Description

Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-anomaly-detectors
[--next-token <value>]
[--max-results <value>]
[--namespace <value>]
[--metric-name <value>]
[--dimensions <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

Use the token returned by the previous operation to request the next page of results.

--max-results (integer)

The maximum number of results to return in one operation. The maximum value that you can specify is 100.

To retrieve the remaining results, make another call with the returned NextToken value.

--namespace (string)

Limits the results to only the anomaly detection models that are associated with the specified namespace.

--metric-name (string)

Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they’re all returned.

--dimensions (list)

Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they’re all returned.

(structure)

A dimension is a name/value pair that is part of the identity of a metric. You can assign up to 10 dimensions to a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric.

Name -> (string)

The name of the dimension. Dimension names cannot contain blank spaces or non-ASCII characters.

Value -> (string)

The value of the dimension. Dimension values cannot contain blank spaces or non-ASCII characters.

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Value": "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

AnomalyDetectors -> (list)

The list of anomaly detection models returned by the operation.

(structure)

An anomaly detection model associated with a particular CloudWatch metric and statistic. You can use the model to display a band of expected normal values when the metric is graphed.

Namespace -> (string)

The namespace of the metric associated with the anomaly detection model.

MetricName -> (string)

The name of the metric associated with the anomaly detection model.

Dimensions -> (list)

The metric dimensions associated with the anomaly detection model.

(structure)

A dimension is a name/value pair that is part of the identity of a metric. You can assign up to 10 dimensions to a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric.

Name -> (string)

The name of the dimension. Dimension names cannot contain blank spaces or non-ASCII characters.

Value -> (string)

The value of the dimension. Dimension values cannot contain blank spaces or non-ASCII characters.

Stat -> (string)

The statistic associated with the anomaly detection model.

Configuration -> (structure)

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.

ExcludedTimeRanges -> (list)

An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren’t used when CloudWatch creates the model.

(structure)

Specifies one range of days or times to exclude from use for training an anomaly detection model.

StartTime -> (timestamp)

The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 .

EndTime -> (timestamp)

The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 .

MetricTimezone -> (string)

The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database .

StateValue -> (string)

The current status of the anomaly detector’s training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA

NextToken -> (string)

A token that you can use in a subsequent operation to retrieve the next set of results.