AlarmSummary - 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.

AlarmSummary

Contains a summary of an alarm.

Contents

alarmModelName

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

The version of the alarm model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

creationTime

The time the alarm was created, in the Unix epoch format.

Type: Timestamp

Required: No

keyValue

The value of the key used as a filter to select only the alarms associated with the key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9\-_:]+$

Required: No

lastUpdateTime

The time the alarm was last updated, in the Unix epoch format.

Type: Timestamp

Required: No

stateName

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 Amazon SDKs, see the following: