Amazon CloudWatch
API Reference (API Version 2010-08-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeAnomalyDetectors

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Dimensions.member.N

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.

Type: Array of Dimension objects

Array Members: Maximum number of 10 items.

Required: No

MaxResults

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

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

MetricName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

Namespace

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^:].*

Required: No

NextToken

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

Type: String

Required: No

Response Elements

The following elements are returned by the service.

AnomalyDetectors.member.N

The list of anomaly detection models returned by the operation.

Type: Array of AnomalyDetector objects

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

Request processing has failed due to some unknown error, exception, or failure.

HTTP Status Code: 500

InvalidNextToken

The next token specified is invalid.

HTTP Status Code: 400

InvalidParameterValue

The value of an input parameter is bad or out-of-range.

HTTP Status Code: 400

Example

The following example lists all the anomaly detectors for metrics with the name CPUUtilization.

Sample Request

{ "MetricName:": "CPUUtilization" }

Sample Response

{ "AnomalyDetectors": [ { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [ { "Name": "dimension1", "Value": "value1" }, { "Name": "dimension2", "Value": "value2" } ], "Stat": "Average", "Configuration": { "ExcludedTimeRanges": [ ] } }, { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [ { "Name": "dimension1", "Value": "value1" } ], "Stat": "SampleCount", "Configuration": { "ExcludedTimeRanges": [ ] } }, { "Namespace": "APITest1", "MetricName": "Metric1", "Dimensions": [ { "Name": "dimension1", "Value": "value1" } ], "Stat": "SampleCount", "Configuration": { "ExcludedTimeRanges": [ ] } }, { "Namespace": "CustomNamespace", "MetricName": "CPUUtilization", "Dimensions": [ { "Name": "dimension1", "Value": "value1" }, { "Name": "dimension2", "Value": "value2" } ], "Stat": "Maximum", "Configuration": { "ExcludedTimeRanges": [ ] } } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: