# AlarmState
<a name="API_iotevents-data_AlarmState"></a>

Contains information about the current state of the alarm.

## Contents
<a name="API_iotevents-data_AlarmState_Contents"></a>

 ** customerAction **   <a name="iotevents-Type-iotevents-data_AlarmState-customerAction"></a>
Contains information about the action that you can take to respond to the alarm.  
Type: [CustomerAction](API_iotevents-data_CustomerAction.md) object  
Required: No

 ** ruleEvaluation **   <a name="iotevents-Type-iotevents-data_AlarmState-ruleEvaluation"></a>
Information needed to evaluate data.  
Type: [RuleEvaluation](API_iotevents-data_RuleEvaluation.md) object  
Required: No

 ** stateName **   <a name="iotevents-Type-iotevents-data_AlarmState-stateName"></a>
The name of the alarm state. The state name can be one of the following values:  
+  `DISABLED` - When the alarm is in the `DISABLED` state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the `NORMAL` state.
+  `NORMAL` - When the alarm is in the `NORMAL` state, it's ready to evaluate data.
+  `ACTIVE` - If the alarm is in the `ACTIVE` state, the alarm is invoked.
+  `ACKNOWLEDGED` - When the alarm is in the `ACKNOWLEDGED` state, the alarm was invoked and you acknowledged the alarm.
+  `SNOOZE_DISABLED` - When the alarm is in the `SNOOZE_DISABLED` state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the `NORMAL` state. 
+  `LATCHED` - When the alarm is in the `LATCHED` state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the `NORMAL` state, you must acknowledge the alarm.
Type: String  
Valid Values: `DISABLED | NORMAL | ACTIVE | ACKNOWLEDGED | SNOOZE_DISABLED | LATCHED`   
Required: No

 ** systemEvent **   <a name="iotevents-Type-iotevents-data_AlarmState-systemEvent"></a>
Contains information about alarm state changes.  
Type: [SystemEvent](API_iotevents-data_SystemEvent.md) object  
Required: No

## See Also
<a name="API_iotevents-data_AlarmState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/AlarmState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/AlarmState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/AlarmState)