IntegrationsAwsActions
List CloudWatch alarms
List metric, composite, and log CloudWatch alarms. alarm_names and alarm_name_prefix are mutually exclusive. Requires cloudwatch:DescribeAlarms (composite enumeration needs Resource: *).
cloudwatch.alarms.list · AWS · v1
Details
Scopes
cloudwatch:DescribeAlarms
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
region | string | No | enum us-east-1 | us-east-2 | us-west-1 | us-west-2 | af-south-1 | ap-east-1 | ap-east-2 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-southeast-4 | ap-southeast-5 | ap-southeast-6 | ap-southeast-7 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ca-central-1 | ca-west-1 | eu-central-1 | eu-central-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-north-1 | eu-south-1 | eu-south-2 | il-central-1 | me-central-1 | me-south-1 | mx-central-1 | sa-east-1 |
alarm_names | array<string> | No | minItems 1; maxItems 100 |
alarm_names[] | string | Yes | minLength 1; maxLength 255 |
alarm_name_prefix | string | No | minLength 1; maxLength 255 |
state_value | string | No | enum OK | ALARM | INSUFFICIENT_DATA |
page_size | integer | No | minimum 1; maximum 100 |
cursor | string | No | minLength 1; maxLength 16384; pattern ^(?!.*://)[^\x00-\x1f\x7f]+$ |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
alarms | array<object> | Yes | maxItems 100 |
alarms[] | object | Yes | additionalProperties false; oneOf branch 1: required type, metric; type=metric / branch 2: required type, alarm_rule; type=composite / branch 3: required type, log; type=log |
alarms[].type | string | Yes | enum metric | composite | log |
alarms[].name | string | Yes | minLength 1; maxLength 255 |
alarms[].arn | string | Yes | minLength 20; maxLength 2048; pattern ^arn:aws:.+$ |
alarms[].description | string | No | maxLength 1024 |
alarms[].state | string | Yes | enum OK | ALARM | INSUFFICIENT_DATA |
alarms[].state_updated_at | string | Yes | minLength 1; maxLength 64 |
alarms[].actions_enabled | boolean | Yes | — |
alarms[].metric | object | No | additionalProperties false |
alarms[].metric.namespace | string | No | minLength 1; maxLength 255 |
alarms[].metric.metric_name | string | No | minLength 1; maxLength 255 |
alarms[].metric.statistic | string | No | minLength 1; maxLength 64 |
alarms[].metric.extended_statistic | string | No | minLength 1; maxLength 64 |
alarms[].metric.dimensions | array<object> | No | maxItems 30 |
alarms[].metric.dimensions[] | object | Yes | additionalProperties false |
alarms[].metric.dimensions[].name | string | Yes | minLength 1; maxLength 255 |
alarms[].metric.dimensions[].value | string | Yes | minLength 1; maxLength 1024 |
alarms[].metric.period_seconds | integer | No | minimum 1 |
alarms[].metric.unit | string | No | minLength 1; maxLength 64 |
alarms[].metric.threshold | number | No | — |
alarms[].metric.comparison_operator | string | No | minLength 1; maxLength 64 |
alarms[].metric.evaluation_periods | integer | No | minimum 1 |
alarms[].metric.datapoints_to_alarm | integer | No | minimum 1 |
alarms[].metric.treat_missing_data | string | No | minLength 1; maxLength 64 |
alarms[].alarm_rule | string | No | minLength 1; maxLength 10240 |
alarms[].log | object | No | additionalProperties false |
alarms[].log.query_string | string | No | minLength 1; maxLength 10000 |
alarms[].log.query_arn | string | No | minLength 20; maxLength 2048; pattern ^arn:aws:.+$ |
alarms[].log.aggregation_expression | string | No | minLength 1; maxLength 2048 |
alarms[].log.log_group_identifiers | array<string> | No | maxItems 50 |
alarms[].log.log_group_identifiers[] | string | Yes | minLength 1; maxLength 2048 |
alarms[].log.threshold | number | No | — |
alarms[].log.comparison_operator | string | No | minLength 1; maxLength 64 |
next_cursor | string | No | minLength 1; maxLength 16384; pattern ^(?!.*://)[^\x00-\x1f\x7f]+$ |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"region": {
"type": "string",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"af-south-1",
"ap-east-1",
"ap-east-2",
"ap-south-1",
"ap-south-2",
"ap-southeast-1",
"ap-southeast-2",
"ap-southeast-3",
"ap-southeast-4",
"ap-southeast-5",
"ap-southeast-6",
"ap-southeast-7",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ca-central-1",
"ca-west-1",
"eu-central-1",
"eu-central-2",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-north-1",
"eu-south-1",
"eu-south-2",
"il-central-1",
"me-central-1",
"me-south-1",
"mx-central-1",
"sa-east-1"
]
},
"alarm_names": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"minItems": 1,
"maxItems": 100
},
"alarm_name_prefix": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"state_value": {
"type": "string",
"enum": [
"OK",
"ALARM",
"INSUFFICIENT_DATA"
]
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 16384,
"pattern": "^(?!.*://)[^\\x00-\\x1f\\x7f]+$"
}
}
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"alarms": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"metric",
"composite",
"log"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"arn": {
"type": "string",
"minLength": 20,
"maxLength": 2048,
"pattern": "^arn:aws:.+$"
},
"description": {
"type": "string",
"maxLength": 1024
},
"state": {
"type": "string",
"enum": [
"OK",
"ALARM",
"INSUFFICIENT_DATA"
]
},
"state_updated_at": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"actions_enabled": {
"type": "boolean"
},
"metric": {
"type": "object",
"additionalProperties": false,
"properties": {
"namespace": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"metric_name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"statistic": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"extended_statistic": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"dimensions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"name",
"value"
]
},
"maxItems": 30
},
"period_seconds": {
"type": "integer",
"minimum": 1
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"threshold": {
"type": "number"
},
"comparison_operator": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"evaluation_periods": {
"type": "integer",
"minimum": 1
},
"datapoints_to_alarm": {
"type": "integer",
"minimum": 1
},
"treat_missing_data": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
}
},
"alarm_rule": {
"type": "string",
"minLength": 1,
"maxLength": 10240
},
"log": {
"type": "object",
"additionalProperties": false,
"properties": {
"query_string": {
"type": "string",
"minLength": 1,
"maxLength": 10000
},
"query_arn": {
"type": "string",
"minLength": 20,
"maxLength": 2048,
"pattern": "^arn:aws:.+$"
},
"aggregation_expression": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"log_group_identifiers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 50
},
"threshold": {
"type": "number"
},
"comparison_operator": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
}
}
},
"required": [
"type",
"name",
"arn",
"state",
"state_updated_at",
"actions_enabled"
],
"oneOf": [
{
"required": [
"type",
"metric"
],
"properties": {
"type": {
"enum": [
"metric"
]
}
}
},
{
"required": [
"type",
"alarm_rule"
],
"properties": {
"type": {
"enum": [
"composite"
]
}
}
},
{
"required": [
"type",
"log"
],
"properties": {
"type": {
"enum": [
"log"
]
}
}
}
]
},
"maxItems": 100
},
"next_cursor": {
"type": "string",
"minLength": 1,
"maxLength": 16384,
"pattern": "^(?!.*://)[^\\x00-\\x1f\\x7f]+$"
}
},
"required": [
"alarms"
]
}