Defining an Amazon IoT Events alarm (console) - Amazon IoT SiteWise
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.

Defining an Amazon IoT Events alarm (console)

You can use the Amazon IoT SiteWise console to define an Amazon IoT Events alarm on an existing asset model. To define an Amazon IoT Events alarm on a new asset model, create the asset model, and then complete these steps. For more information, see Creating asset models.

Important

Each alarm requires an attribute that specifies the threshold value to compare against for the alarm. You must define the threshold value attribute on the asset model before you can define an alarm.

Consider an example where you want to define an alarm that detects when a wind turbine exceeds its maximum wind speed rating of 50 mph. Before you define the alarm, you must define an attribute (Maximum wind speed) with a default value of 50.

To define an Amazon IoT Events alarm on an asset model

  1. Navigate to the Amazon IoT SiteWise console.

  2. In the navigation pane, choose Models.

  3. Choose the asset model for which to define an alarm.

  4. Choose the Alarm definitions tab.

  5. Choose Add alarm.

  6. In Alarm type options, choose Amazon IoT Events alarm.

  7. Enter a name for your alarm.

  8. (Optional) Enter a description for your alarm.

  9. In the Threshold definitions pane, you define when the alarm detects and the severity of the alarm. Do the following:

    1. Select the Property on which the alarm detects. Each time this property receives a new value, Amazon IoT SiteWise sends the value to Amazon IoT Events to evaluate the state of the alarm.

    2. Select the Operator to use to compare the property with the threshold value. Choose from the following options:

      • < less than

      • <= less than or equal

      • == equal

      • != not equal

      • >= greater than or equal

      • > greater than

    3. Select the attribute property to use as the threshold Value. Amazon IoT Events compares the value of the property with the value of this attribute.

    4. Enter the Severity of the alarm. Use a number that your team understands to reflect the severity of this alarm.

  10. Specify the Default asset state for this alarm. You can enable or disable this alarm for all assets that you create from this asset model in a later step.

  11. In the Advanced settings pane, you can configure the permissions, the additional notification settings, the alarm state actions, the alarm model in SiteWise Monitor, and the acknowledge flow.

    Note

    Amazon IoT Events alarms require the following service roles:

    • A role that Amazon IoT Events assumes to send alarm state values to Amazon IoT SiteWise.

    In the Permissions pane, do the following:

    1. For Amazon IoT Events role, use an existing role or create a role with the required permissions. This role requires the iotsitewise:BatchPutAssetPropertyValue permission and a trust relationship that allows iotevents.amazonaws.com to assume the role.

  12. (Optional) In the Set state action pane, do the following:

    1. Choose Edit action.

    2. On the Add alarm state actions page, add actions. You can add up to 10 actions.

    Amazon IoT Events can perform actions when the alarm is active. You can define built-in actions to use a timer or set a variable, or send data to other Amazon resources. For more information, see Supported actions in the Amazon IoT Events Developer Guide.

  13. (Optional) In the Manage alarm model in SiteWise Monitor pane, choose Enabled or Disabled.

    Use this option so that you can update the alarm model in SiteWise Monitorss. This option is enabled by default.

  14. In Acknowledge flow, you can specify if the acknowledge flow is enabled. For more information about the acknowledge flow, see Alarm states.

  15. Choose Add alarm.

    Note

    The Amazon IoT SiteWise console makes multiple API requests to add the alarm to the asset model. When you choose Add alarm, the console opens a dialog box that shows the progress of these API requests. Stay on this page until each API requests succeeds or until an API request fails. If a request fails, close the dialog box, fix the issue, and choose Add alarm to try again.