Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS CloudWatch Anomaly Detection API

Operations for CloudWatch anomaly detection models

AWS CloudWatch Anomaly Detection API is one of 8 APIs that AWS CloudWatch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Anomaly Detection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, pricing, a getting-started guide, an API reference, and 2 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 2010-08-01.

Requests are made against a single base URL, https://monitoring.{region}.amazonaws.com.

3 operations 3 paths 16 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2010-08-01
Base URL
https://monitoring.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

AWS CloudWatch Anomaly Detection API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (aws_sigv4). By default, every request must be authenticated.

  • aws_sigv4 — AWS Signature Version 4 authentication

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Anomaly Detection 3

Operations for CloudWatch anomaly detection models

POST
/#PutAnomalyDetector
Aws Cloudwatch Create an Anomaly Detection Model for a Metric
PutAnomalyDetector 2 params body → 200400
POST
/#DescribeAnomalyDetectors
Aws Cloudwatch List Anomaly Detection Models
DescribeAnomalyDetectors 2 params body → 200
POST
/#DeleteAnomalyDetector
Aws Cloudwatch Delete an Anomaly Detection Model
DeleteAnomalyDetector 2 params body → 200400

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are AnomalyDetector (9 properties), PutAnomalyDetectorInput (8 properties), MetricDataQuery (7 properties), DescribeAnomalyDetectorsInput (6 properties). Each schema is shown below with its type and property counts.

MetricCharacteristics
object
This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.
1 property
DeleteAnomalyDetectorInput
object
6 properties
MetricDataQuery
object
This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.
7 properties 1 required
StandardUnit
string
The unit of the metric.
MetricStat
object
This structure defines the metric to be returned, along with the statistics, period, and units.
4 properties 3 required
Range
object
Specifies one range of days or times to exclude from use for training an anomaly detection model.
2 properties 2 required
ErrorResponse
object
Standard error response from CloudWatch API.
2 properties
DescribeAnomalyDetectorsOutput
object
2 properties
MetricMathAnomalyDetector
object
Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input.
1 property
Metric
object
Represents a specific metric.
3 properties
DescribeAnomalyDetectorsInput
object
6 properties
PutAnomalyDetectorInput
object
8 properties
Dimension
object
A dimension is a name/value pair that is part of the identity of a metric.
2 properties 2 required
AnomalyDetector
object
An anomaly detection model associated with a particular CloudWatch metric.
9 properties
AnomalyDetectorConfiguration
object
The configuration specifies details about how the anomaly detection model is to be trained.
2 properties
SingleMetricAnomalyDetector
object
Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudwatch-anomaly-detection-api-openapi.yml Raw ↑

Other APIs AWS CloudWatch publishes across the network.

Amazon CloudWatch Application Signals API
Amazon CloudWatch Network Monitor API
AWS CloudWatch Alarms API
AWS CloudWatch Composite Alarms API
AWS CloudWatch Dashboards API
AWS CloudWatch Metric Streams API
AWS CloudWatch Metrics API