Amazon CloudWatch · Schema

Alarm

Represents a CloudWatch metric alarm

CloudWatchMonitoringObservabilityMetricsLogs

Properties

Name Type Description
alarmName string The name of the alarm
alarmArn string The ARN of the alarm
alarmDescription string The description of the alarm
stateValue string The state value for the alarm
stateReason string An explanation for the alarm state
stateUpdatedTimestamp string The time stamp of the last update to the state
metricName string The name of the metric associated with the alarm
namespace string The namespace of the metric associated with the alarm
statistic string The statistic for the metric associated with the alarm
dimensions array The dimensions for the metric associated with the alarm
period integer The period in seconds over which the statistic is applied
evaluationPeriods integer The number of periods over which data is compared to the threshold
threshold number The value to compare with the specified statistic
comparisonOperator string The arithmetic operation to use when comparing the statistic and threshold
treatMissingData string How missing data points are treated
actionsEnabled boolean Whether actions are executed during alarm state changes
alarmActions array The actions to execute when the alarm transitions to ALARM state
okActions array The actions to execute when the alarm transitions to OK state
insufficientDataActions array The actions to execute when the alarm transitions to INSUFFICIENT_DATA state
View JSON Schema on GitHub

JSON Schema

cloudwatch-alarm-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cloudwatch/refs/heads/main/json-schema/cloudwatch-alarm-schema.json",
  "title": "Alarm",
  "description": "Represents a CloudWatch metric alarm",
  "type": "object",
  "properties": {
    "alarmName": {
      "type": "string",
      "description": "The name of the alarm"
    },
    "alarmArn": {
      "type": "string",
      "description": "The ARN of the alarm"
    },
    "alarmDescription": {
      "type": "string",
      "description": "The description of the alarm"
    },
    "stateValue": {
      "type": "string",
      "description": "The state value for the alarm",
      "enum": [
        "OK",
        "ALARM",
        "INSUFFICIENT_DATA"
      ]
    },
    "stateReason": {
      "type": "string",
      "description": "An explanation for the alarm state"
    },
    "stateUpdatedTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The time stamp of the last update to the state"
    },
    "metricName": {
      "type": "string",
      "description": "The name of the metric associated with the alarm"
    },
    "namespace": {
      "type": "string",
      "description": "The namespace of the metric associated with the alarm"
    },
    "statistic": {
      "type": "string",
      "description": "The statistic for the metric associated with the alarm"
    },
    "dimensions": {
      "type": "array",
      "description": "The dimensions for the metric associated with the alarm",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    },
    "period": {
      "type": "integer",
      "description": "The period in seconds over which the statistic is applied"
    },
    "evaluationPeriods": {
      "type": "integer",
      "description": "The number of periods over which data is compared to the threshold"
    },
    "threshold": {
      "type": "number",
      "description": "The value to compare with the specified statistic"
    },
    "comparisonOperator": {
      "type": "string",
      "description": "The arithmetic operation to use when comparing the statistic and threshold"
    },
    "treatMissingData": {
      "type": "string",
      "description": "How missing data points are treated"
    },
    "actionsEnabled": {
      "type": "boolean",
      "description": "Whether actions are executed during alarm state changes"
    },
    "alarmActions": {
      "type": "array",
      "description": "The actions to execute when the alarm transitions to ALARM state",
      "items": {
        "type": "string"
      }
    },
    "okActions": {
      "type": "array",
      "description": "The actions to execute when the alarm transitions to OK state",
      "items": {
        "type": "string"
      }
    },
    "insufficientDataActions": {
      "type": "array",
      "description": "The actions to execute when the alarm transitions to INSUFFICIENT_DATA state",
      "items": {
        "type": "string"
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cloudwatch-alarm"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.