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 Metrics API

Operations for working with CloudWatch metrics and metric data

AWS CloudWatch Metrics 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 Metrics. 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 7 operations across 7 paths, and defines 25 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.

7 operations 7 paths 25 schemas 7 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 Metrics 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 7

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

Metrics 7

Operations for working with CloudWatch metrics and metric data

POST
/
Aws Cloudwatch Publish Metric Data Points to Cloudwatch
PutMetricData 3 params body → 200400500
POST
/#GetMetricData
Aws Cloudwatch Retrieve Metric Data From Cloudwatch
GetMetricData 2 params body → 200400
POST
/#GetMetricStatistics
Aws Cloudwatch Retrieve Statistics for a Specified Metric
GetMetricStatistics 2 params body → 200400
POST
/#ListMetrics
Aws Cloudwatch List the Specified Metrics
ListMetrics 2 params body → 200400
POST
/#TagResource
Aws Cloudwatch Assign Tags to a Cloudwatch Resource
TagResource 2 params body → 200
POST
/#UntagResource
Aws Cloudwatch Remove Tags From a Cloudwatch Resource
UntagResource 2 params body → 200
POST
/#ListTagsForResource
Aws Cloudwatch List Tags for a Cloudwatch Resource
ListTagsForResource 2 params body → 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are MetricDatum (9 properties), GetMetricStatisticsInput (9 properties), Datapoint (8 properties), ListMetricsInput (7 properties). Each schema is shown below with its type and property counts.

Statistic
string
The statistic for the metric.
UntagResourceInput
object
2 properties 2 required
Tag
object
A key-value pair associated with a CloudWatch resource.
2 properties 2 required
ListMetricsInput
object
7 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
StatisticSet
object
Represents a set of statistics that describes a specific metric.
4 properties 4 required
ListTagsForResourceOutput
object
1 property
ListMetricsOutput
object
3 properties
StandardUnit
string
The unit of the metric.
MessageData
object
A message returned by the GetMetricData API.
2 properties
PutMetricDataInput
object
2 properties 2 required
MetricStat
object
This structure defines the metric to be returned, along with the statistics, period, and units.
4 properties 3 required
Datapoint
object
Encapsulates the statistical data that CloudWatch computes from metric data.
8 properties
ErrorResponse
object
Standard error response from CloudWatch API.
2 properties
GetMetricStatisticsInput
object
9 properties 5 required
GetMetricStatisticsOutput
object
2 properties
ListTagsForResourceInput
object
1 property 1 required
DimensionFilter
object
Represents filters for a dimension.
2 properties 1 required
GetMetricDataInput
object
7 properties 3 required
Metric
object
Represents a specific metric.
3 properties
GetMetricDataOutput
object
3 properties
MetricDatum
object
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
9 properties 1 required
Dimension
object
A dimension is a name/value pair that is part of the identity of a metric.
2 properties 2 required
MetricDataResult
object
A GetMetricData call returns an array of MetricDataResult structures.
6 properties
TagResourceInput
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudwatch-metrics-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 Anomaly Detection API
AWS CloudWatch Composite Alarms API
AWS CloudWatch Dashboards API
AWS CloudWatch Metric Streams API