# AlarmSummary


Contains a summary of an alarm.

## Contents


 ** alarmModelName **   <a name="iotevents-Type-iotevents-data_AlarmSummary-alarmModelName"></a>
The name of the alarm model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: No

 ** alarmModelVersion **   <a name="iotevents-Type-iotevents-data_AlarmSummary-alarmModelVersion"></a>
The version of the alarm model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** creationTime **   <a name="iotevents-Type-iotevents-data_AlarmSummary-creationTime"></a>
The time the alarm was created, in the Unix epoch format.  
Type: Timestamp  
Required: No

 ** keyValue **   <a name="iotevents-Type-iotevents-data_AlarmSummary-keyValue"></a>
The value of the key used as a filter to select only the alarms associated with the [key](https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9\-_:]+$`   
Required: No

 ** lastUpdateTime **   <a name="iotevents-Type-iotevents-data_AlarmSummary-lastUpdateTime"></a>
The time the alarm was last updated, in the Unix epoch format.  
Type: Timestamp  
Required: No

 ** stateName **   <a name="iotevents-Type-iotevents-data_AlarmSummary-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

## See Also


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/AlarmSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/AlarmSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/AlarmSummary)