Creating an alarm model in Amazon IoT Events - Amazon IoT Events
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

End of support notice: On May 20, 2026, Amazon will end support for Amazon IoT Events. After May 20, 2026, you will no longer be able to access the Amazon IoT Events console or Amazon IoT Events resources. For more information, see Amazon IoT Events end of support.

Creating an alarm model in Amazon IoT Events

You can use Amazon IoT Events alarms to monitor your data and get notified when a threshold is breached. Alarms provide parameters that you use to create or configure an alarm model. You can use the Amazon IoT Events console or Amazon IoT Events API to create or configure the alarm model. When you configure the alarm model, changes take effect as new data arrives.

Requirements

The following requirements apply when you create an alarm model.

  • You can create an alarm model to monitor an input attribute in Amazon IoT Events or an asset property in Amazon IoT SiteWise.

  • You must have an IAM role that allows your alarm to perform actions and access Amazon resources. For more information, see Setting up permissions for Amazon IoT Events.

  • All the Amazon resources that this tutorial uses must be in the same Amazon Region.

Creating an alarm model (console)

The following shows you how to create an alarm model to monitor an Amazon IoT Events attribute in the Amazon IoT Events console.

  1. Sign in to the Amazon IoT Events console.

  2. In the navigation pane, choose Alarm models.

  3. On the Alarm models page, choose Create alarm model.

  4. In the Alarm model details section, do the following:

    1. Enter a unique name.

    2. (Optional) Enter a description.

  5. In the Alarm target section, do the following:

    Important

    If you choose Amazon IoT SiteWise asset property, you must have created an asset model in Amazon IoT SiteWise.

    1. Choose Amazon IoT Events input attribute.

    2. Choose the input.

    3. Choose the input attribute key. This input attribute is used as a key to create the alarm. Amazon IoT Events routes inputs associated with this key to the alarm.

      Important

      If the input message payload does not contain this input attribute key, or if the key is not in the same JSON path specified in the key, then the message will fail the ingestion in Amazon IoT Events.

  6. In the Threshold definitions section, you define the input attribute, threshold value, and comparison operator that Amazon IoT Events uses to change the state of the alarm.

    1. For Input attribute, choose the attribute that you want to monitor.

      Each time that this input attribute receives new data, it's evaluated to determine the state of the alarm.

    2. For Operator, choose the comparison operator. The operator compares your input attribute with the threshold value for your attribute.

      You can choose from these options:

      • > greater than

      • >= greater than or equal to

      • < less than

      • <= less than or equal to

      • = equal to

      • != not equal to

    3. For threshold Value, enter a number or choose an attribute in Amazon IoT Events inputs. Amazon IoT Events compares this value with the value of the input attribute you choose.

    4. (Optional) For Severity, Use a number that your team understands to reflect the severity of this alarm.

  7. (Optional) In the Notification settings section, configure notification settings for the alarm.

    Note

    The alarm notifications feature isn't available in the China (Beijing) Region.

    You can add up to 10 notifications. For Notification 1, do the following:

    1. For Protocol, choose from the following options:

      • Email & text - The alarm sends an SMS notification and an email notification.

      • Email - The alarm sends an email notification.

      • Text - The alarm sends an SMS notification.

    2. For Sender, specify the email address that can send notifications about this alarm.

      To add more email addresses to your sender list, choose Add sender.

    3. (Optional) For Recipient, choose the recipient.

      To add more users to your recipient list, choose Add new user. You must add new users to your IAM Identity Center store before you can add them to your alarm model. For more information, see Manage IAM Identity Center access of alarm recipients in Amazon IoT Events.

    4. (Optional) For Additional custom message, enter a message that describes what the alarm detects and what actions the recipients should take.

  8. In the Instance section, you can enable or disable all alarm instances that are created based on this alarm model.

  9. In the Advanced settings section, do the following:

    1. For Acknowledge flow, you can enable or disable notifications.

      • If you choose Enabled, you receive a notification when the alarm state changes. You must acknowledge the notification before the alarm state can return to normal.

      • If you choose Disabled, no action is required. The alarm automatically changes to the normal state when the measurement returns to the specified range.

      For more information, see Acknowledge flow.

    2. For Permissions, choose one of the following options:

      • You can Create a new role from Amazon policy templates and Amazon IoT Events automatically creates an IAM role for you.

      • You can Use an existing IAM role that allows this alarm model to perform actions and access other Amazon resources.

      For more information, see Identity and access management for Amazon IoT Events.

    3. For Additional notification settings, you can edit your Amazon Lambda function to manage alarm notifications. Choose one of the following options for your Amazon Lambda function:

      • Create a new Amazon Lambda function - Amazon IoT Events creates a new Amazon Lambda function for you.

      • Use an existing Amazon Lambda function - Use an existing Amazon Lambda function by choosing an Amazon Lambda function name.

      For more information about the possible actions, see Amazon IoT Events working with other Amazon services.

    4. (Optional) For Set state action, you can add one or more Amazon IoT Events actions to take when the alarm state changes.

  10. (Optional) You can add Tags to manage your alarms. For more information, see Tagging your Amazon IoT Events resources.

  11. Choose Create.