POST

/alarm-models

http://iotevents.{region}.amazonaws.com/alarm-models

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html">Create an alarm model</a> in the AWS IoT Events Developer Guide.

Access Token Required: API Key

Body Params

keystring

An input attribute used as a key to create an alarm. AWS IoT Events routes <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html">inputs</a> associated with this key to the alarm.

tagsarray

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html">Tagging your AWS IoT Events resources</a> in the AWS IoT Events Developer Guide. You can create up to 50 tags for one alarm model.

roleArnstringrequired

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the AWS General Reference.

severityinteger

A non-negative integer that reflects the severity level of the alarm.

alarmRuleobjectrequired

Defines when your alarm is invoked.

alarmModelNamestringrequired

A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.

alarmCapabilitiesobject

Contains the configuration information of alarm state changes.

alarmEventActionsobject

Contains information about one or more alarm actions.

alarmNotificationobject

Contains information about one or more notification actions.

alarmModelDescriptionstring

A description that tells you what the alarm model detects.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://iotevents.{region}.amazonaws.com/alarm-models' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}