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

Operations for composite alarms that aggregate multiple alarm states

AWS CloudWatch Composite 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 Composite 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 1 operation across 1 path, and defines 3 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.

1 operations 1 paths 3 schemas 1 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 Composite 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 1

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

Composite Alarms 1

Operations for composite alarms that aggregate multiple alarm states

POST
/#PutCompositeAlarm
Aws Cloudwatch Create or Update a Composite Alarm
PutCompositeAlarm 2 params body → 200400

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are PutCompositeAlarmInput (11 properties), ErrorResponse (2 properties), Tag (2 properties). Each schema is shown below with its type and property counts.

PutCompositeAlarmInput
object
11 properties 2 required
Tag
object
A key-value pair associated with a CloudWatch resource.
2 properties 2 required
ErrorResponse
object
Standard error response from CloudWatch API.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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