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

Operations for creating, managing, and querying CloudWatch alarms

AWS CloudWatch Alarms 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 Alarms. 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 8 operations across 8 paths, and defines 24 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.

8 operations 8 paths 24 schemas 8 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 Alarms 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 8

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

Alarms 8

Operations for creating, managing, and querying CloudWatch alarms

POST
/#PutMetricAlarm
Aws Cloudwatch Create or Update a Cloudwatch Alarm
PutMetricAlarm 2 params body → 200400
POST
/#DescribeAlarms
Aws Cloudwatch Retrieve Information About Specified Alarms
DescribeAlarms 2 params body → 200400
POST
/#DescribeAlarmsForMetric
Aws Cloudwatch Retrieve Alarms for a Specified Metric
DescribeAlarmsForMetric 2 params body → 200
POST
/#DescribeAlarmHistory
Aws Cloudwatch Retrieve the History for a Specified Alarm
DescribeAlarmHistory 2 params body → 200400
POST
/#DeleteAlarms
Aws Cloudwatch Delete Specified Alarms
DeleteAlarms 2 params body → 200400
POST
/#SetAlarmState
Aws Cloudwatch Temporarily Set the State of an Alarm
SetAlarmState 2 params body → 200400
POST
/#EnableAlarmActions
Aws Cloudwatch Enable Actions for Specified Alarms
EnableAlarmActions 2 params body → 200
POST
/#DisableAlarmActions
Aws Cloudwatch Disable Actions for Specified Alarms
DisableAlarmActions 2 params body → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are MetricAlarm (28 properties), PutMetricAlarmInput (22 properties), CompositeAlarm (19 properties), DescribeAlarmsInput (9 properties). Each schema is shown below with its type and property counts.

Statistic
string
The statistic for the metric.
SetAlarmStateInput
object
4 properties 3 required
Tag
object
A key-value pair associated with a CloudWatch resource.
2 properties 2 required
ComparisonOperator
string
The arithmetic operation to use when comparing the specified statistic and threshold.
AlarmHistoryItem
object
Represents the history of a specific alarm.
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
DisableAlarmActionsInput
object
1 property 1 required
StateValue
string
The state value for the alarm.
CompositeAlarm
object
The details about a composite alarm.
19 properties
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
DescribeAlarmsForMetricInput
object
7 properties 2 required
DescribeAlarmHistoryInput
object
8 properties
ErrorResponse
object
Standard error response from CloudWatch API.
2 properties
DescribeAlarmHistoryOutput
object
2 properties
DeleteAlarmsInput
object
1 property 1 required
Metric
object
Represents a specific metric.
3 properties
MetricAlarm
object
The details about a metric alarm.
28 properties
PutMetricAlarmInput
object
22 properties 3 required
Dimension
object
A dimension is a name/value pair that is part of the identity of a metric.
2 properties 2 required
EnableAlarmActionsInput
object
1 property 1 required
DescribeAlarmsOutput
object
3 properties
DescribeAlarmsInput
object
9 properties
DescribeAlarmsForMetricOutput
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudwatch-alarms-api-openapi.yml Raw ↑

Other APIs AWS CloudWatch publishes across the network.

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