

The SiteWise Monitor feature is not available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html)

# Monitor with alarms in AWS IoT SiteWise Monitor
Monitor with alarms

**Note**  
The SiteWise Monitor feature is no longer available to new customers. Existing customers can continue to use the service as normal. For more information, see [SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html).

Alarms alert you and your team when equipment or processes perform sub-optimally. Optimal performance of a machine or process means that the values for certain metrics should be within a range of high and low limits. When these metrics are outside their operating range, equipment operators must be notified so that they can fix the issue. Alarms help you quickly identify issues and notify operators to maximize performance of your equipment and processes.

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

AWS IoT SiteWise Monitor supports two types of alarms:
+ Alarms that detect in the AWS Cloud – You can view and customize the thresholds and notification settings for these alarms. You can also acknowledge and snooze these alarms.
**Important**  
After you enable the alarms feature for your portals, members of your organization can create only AWS IoT Events alarms in your portals.
+ External alarms – These alarms detect on external equipment and then send the alarm state to the AWS Cloud. You can't customize, acknowledge, or snooze these alarms. These alarms don't have any information other than their state.

Alarms have the following states:
+ **Normal** – The alarm is enabled but inactive. The equipment or process operates as expected.
+ **Active** – The alarm is active. The equipment or process is outside its operating range and needs attention.
+ **Acknowledged** – An operator acknowledged the state of the alarm.
+ **Latched** – The alarm returned to normal but was active and no operator acknowledged it. The equipment or process requires attention to reset the alarm to normal.
+ **Snoozed** – The alarm is inactive because an operator snoozed the alarm. The operator defines the duration for which the alarm snoozes. After that duration, the alarm returns to normal state.
+ **Disabled** – The alarm is inactive and won't detect any changes.

You can perform the following alarm-related tasks.


| Task | Required role | Description | 
| --- | --- | --- | 
|  [Create alarm definitions](create-alarms.md)  |  Portal administrator  |  Create alarm definitions on models to monitor properties associated with the models.  | 
|  [View alarm details in AWS IoT SiteWise Monitor](view-alarm-details.md)  |  Portal administrator, project owner, and project viewer  |  View details about the alarms that you can access.  | 
|  [Respond to alarms in AWS IoT SiteWise](respond-to-alarms.md)  |  Portal administrator, project owner, project viewer  |  Acknowledge or snooze the alarms that you can access.  | 
|  [Configure alarms for AWS IoT SiteWise](configure-alarms.md)  |  Portal administrator, project owner  |  Customize the threshold and notification settings for the alarms that you can access.  | 
|  [Visualize alarms in dashboards](visualize-alarms.md)  |  Portal administrator, project owner  |  Add alarms to dashboards to visualize alarm state or alarms as thresholds in your dashboards.  | 

**Topics**
+ [

# Create alarm definitions
](create-alarms.md)
+ [

# View alarm details in AWS IoT SiteWise Monitor
](view-alarm-details.md)
+ [

# Respond to alarms in AWS IoT SiteWise
](respond-to-alarms.md)
+ [

# Configure alarms for AWS IoT SiteWise
](configure-alarms.md)
+ [

# Visualize alarms in dashboards
](visualize-alarms.md)

# Create alarm definitions
Create alarm definitions

On the **Models** page, you can create AWS IoT Events alarms on models to monitor properties associated with the models. The alarms can also send notifications to you and members of your organization.

**Note**  
Your IT administrator must enable the alarms feature for your portal before you can create alarms.
If you want to send alarm notifications, your IT administrator must use IAM Identity Center for the portal authentication service.
For more information, see [Enabling alarms for your SiteWise Monitor portals](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-additional-features.html) in the *AWS IoT SiteWise User Guide*.

**To create an alarm definition**

1. In the navigation bar, choose the **Models** icon.

1. Choose a model in the **Models** hierarchy.

1. Choose the **Alarms** tab for the model.

1. Choose **Create an alarm definition**.

1. On the **Define threshold** page, you define when the alarm is invoked and the severity of the alarm. Do the following: 

   1. Choose the property on which the alarm monitors. Each time this property receives a new value, AWS IoT SiteWise sends the value to AWS IoT Events to evaluate the state of the alarm.

   1. 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**
      + **\$1= not equal**
      + **>= greater than or equal**
      + **> greater than**

   1. Choose the property or custom value to use as the threshold. AWS IoT Events compares the value of the property with the value of this attribute.
**Note**  
If you choose **Custom value**, enter a number.

   1. Enter the **Severity** of the alarm. Use an integer that your team understands to reflect the severity of this alarm.

   1. Choose an asset to preview this threshold.

   1. Choose **Next**.  
![\["Define threshold" page with model dropdown menus and "Preview" dropdown menu highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/alarms-create-define-threshold.png)

1. On the **Configuration settings** page, you enter a name and choose the default state for this alarm definition. Do the following:

   1. Enter a unique alarm name.

   1. Specify the **Default state** for this alarm definition. You can enable or disable all alarms created based on this alarm definition. You can enable or disable individual alarms associated with model in a later step.

   1. Choose **Next**.  
![\["Configure settings" screen with "Name" field highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/alarms-create-configure-settings.png)

1. On the **Configure notification** page, you configure the notification recipient, the message protocol, and the custom message to send when this alarm is invoked. Do the following:

   1. For **Recipient**, choose the recipient.
**Note**  
Your IT administrator must add IAM Identity Center users in the current AWS Region before you can add recipients for this alarm.

   1. For **Protocol**, choose from the following options:
      + **Email and text** – The alarm notifies IAM Identity Center users with an SMS message and an email.
      + **Email** – The alarm notifies IAM Identity Center users with an email.
      + **Text** – The alarm notifies IAM Identity Center users with an SMS message.

   1. For **Additional custom message**, you specify the custom message to send in addition to the default state change message. For example, you can specify a message that helps your team understand how to address this alarm.

   1. Choose **Create alarm definition**.  
![\[Create an alarm in the SiteWise Monitor portal.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/alarms-create-configure-notification.png)

# View alarm details in AWS IoT SiteWise Monitor
View alarm details

On the **Assets** page, you can view and respond to the alarms on any asset that is associated with your projects. Portal administrators have access to all assets in the portal and can use the **Assets** page to view and configure all assets' alarms.

**To view details about an alarm**

1. In the navigation bar, choose the **Assets** icon.  
![\[The "Assets" icon in the navigation bar.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/portal-navigation-asset-library-console.png)

1. <a name="asset-library-choose-project"></a>(Optional) Choose a project in the projects drop-down list to show only assets from a specific project.  
![\[The "Assets" page, with the projects drop-down list called out.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/asset-library-choose-project-console.png)

1. Choose an asset in the **Assets** hierarchy.
**Tip**  
Expand the arrow next to an asset to view all children of that asset.

1. Choose the **Alarms** tab for the asset.

1. Choose the alarm to view.

   The alarm details page opens. You can view the alarm's configuration, status history, and notification settings.

# Respond to alarms in AWS IoT SiteWise
Respond to alarms

On the **Assets** page, you can respond to an alarm so that your team knows that you see the alarm. When you respond to an alarm, you can leave a note with details about the alarm or the actions that you took. If you don't acknowledge an active alarm before it becomes inactive, the alarm becomes latched. The latched state indicates that the alarm became active and wasn't acknowledged. You might need to check on the equipment or process and acknowledge the latched alarm.

You can do the following to respond to an alarm:
+ Acknowledge an alarm to indicate that you are handling the issue.
+ Snooze an alarm to disable it temporarily.

**Topics**
+ [

## Acknowledge alarms
](#acknowledge-alarms)
+ [

## Snooze alarms
](#snooze-alarms)

## Acknowledge alarms


When an alarm is active or latched, you can acknowledge it to indicate to your team that you are handling the issue. You can leave a note about the alarm when you acknowledge it.

You can acknowledge alarms that have the following states:
+ **Active**
+ **Latched**

**Note**  
Your team can configure alarms that don't support the acknowledge option. You can't acknowledge these alarms, and these alarms can't have the **Acknowledged** or **Latched** states.

**To acknowledge an alarm**

1. In the navigation bar, choose the **Assets** icon.  
![\[The "Assets" icon in the navigation bar.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/portal-navigation-asset-library-console.png)

1. <a name="asset-library-choose-project"></a>(Optional) Choose a project in the projects drop-down list to show only assets from a specific project.  
![\[The "Assets" page, with the projects drop-down list called out.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/asset-library-choose-project-console.png)

1. Choose an asset in the **Assets** hierarchy.
**Tip**  
Choose the arrow next to an asset to view all children of that asset.

1. Choose the **Alarms** tab for the asset.

1. Select the alarm to acknowledge.

1. Choose **Acknowledge**.

   A modal opens where you can enter a comment.

1. (Optional) Enter a **Comment** about the alarm or the action you will take to acknowledge it.

1. Choose **Acknowledge**.

   The alarm's state changes to **Acknowledged**.

## Snooze alarms


You can snooze an alarm to temporarily disable it. While the alarm is snoozed, it won't detect any changes. You might want to do this if you're aware that an equipment or process is broken or malfunctioning, so you don't need an alarm to go off. You can leave a note about the alarm when you snooze it.

You can snooze alarms that have the following states:
+ **Normal**
+ **Active**
+ **Acknowledged**
+ **Latched**
+ **Snoozed**

**To snooze an alarm**

1. In the navigation bar, choose the **Assets** icon.  
![\[The "Assets" icon in the navigation bar.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/portal-navigation-asset-library-console.png)

1. <a name="asset-library-choose-project"></a>(Optional) Choose a project in the projects drop-down list to show only assets from a specific project.  
![\[The "Assets" page, with the projects drop-down list called out.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/asset-library-choose-project-console.png)

1. Choose an asset in the **Assets** hierarchy.
**Tip**  
Choose the arrow next to an asset to view all children of that asset.

1. Choose the **Alarms** tab for the asset.

1. Select the alarm to snooze.

1. Choose **Snooze**.

   A modal opens where you can specify the snooze duration and enter a comment.

1. Enter the **Snooze duration** to snooze the alarm.

1. (Optional) Enter a **Comment** about the alarm.

1. Choose **Snooze**.

   The alarm's state changes to **Snoozed**. The alarm stays **Snoozed** for the duration that you specify.

# Configure alarms for AWS IoT SiteWise
Configure alarms

On the **Assets** page, project owners can configure each alarm to set it up for their equipment and processes. You can update the alarm's threshold value and notification settings.

**Notes**  
You can only configure alarms that your team sets up to detect in the AWS Cloud. You can't configure external alarms.
You can only configure alarm properties that your team sets up for you to customize. For example, your AWS administrator might define a threshold or notification recipient as a static value that you can't change.

**To configure an alarm**

1. In the navigation bar, choose the **Assets** icon.  
![\[The "Assets" icon in the navigation bar.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/portal-navigation-asset-library-console.png)

1. <a name="asset-library-choose-project"></a>(Optional) Choose a project in the projects drop-down list to show only assets from a specific project.  
![\[The "Assets" page, with the projects drop-down list called out.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/asset-library-choose-project-console.png)

1. Choose an asset in the **Assets** hierarchy.
**Tip**  
Choose the arrow next to an asset to view all children of that asset.

1. Choose the **Alarms** tab for the asset.

1. Select the alarm to configure.

1. Choose **Configure**.

1. On the **Configure alarm** page, do any of the following:

   1. Edit the threshold value for the alarm. You can preview the threshold on the recent data for the property that the alarm monitors.  
![\[The "Configure alarm" page with the alarm threshold highlighted.\]](http://docs.aws.amazon.com/iot-sitewise/latest/appguide/images/alarms-configure-threshold-console.png)

   1. Choose a new **Notification recipient** for the alarm notification. You can choose an AWS IAM Identity Center (IAM Identity Center) user in your organization.

   1. Change the message **Protocol** for the alarm notification.

   1. Change the **Custom message** to include in the notification. The notification message includes this message and information about the alarm state change.

1. Choose **Save**.

# Visualize alarms in dashboards
Visualize alarms in dashboards

Project owners can add alarms to dashboards to visualize alarm state as data and alarms as thresholds on other properties.
+ Add a property with an alarm to a visualization to display the alarm as a threshold on that property's data.
+ Add alarms to [status](choose-visualization-types.md#status-widgets) and [table](choose-visualization-types.md#table-widgets) widgets to display alarm state in a dashboard.

**Note**  
When you add a property that has an alarm to a visualization, the visualization automatically includes the alarm as a threshold.

For more information, see the following topics:
+ [Create dashboards in an AWS IoT SiteWise Monitor project](create-dashboards.md)
+ [Add visualizations in AWS IoT SiteWise Monitor](add-visualizations.md)
+ [Customize visualizations](customize-visualizations.md)