Class: Aws::IoTEventsData::Types::AlarmSummary
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTEventsData::Types::AlarmSummary
- Defined in:
- gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb
Overview
Contains a summary of an alarm.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#alarm_model_name ⇒ String
The name of the alarm model.
-
#alarm_model_version ⇒ String
The version of the alarm model.
-
#creation_time ⇒ Time
The time the alarm was created, in the Unix epoch format.
-
#key_value ⇒ String
The value of the key used as a filter to select only the alarms associated with the [key][1].
-
#last_update_time ⇒ Time
The time the alarm was last updated, in the Unix epoch format.
-
#state_name ⇒ String
The name of the alarm state.
Instance Attribute Details
#alarm_model_name ⇒ String
The name of the alarm model.
212 213 214 215 216 217 218 219 220 221 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 212 class AlarmSummary < Struct.new( :alarm_model_name, :alarm_model_version, :key_value, :state_name, :creation_time, :last_update_time) SENSITIVE = [] include Aws::Structure end |
#alarm_model_version ⇒ String
The version of the alarm model.
212 213 214 215 216 217 218 219 220 221 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 212 class AlarmSummary < Struct.new( :alarm_model_name, :alarm_model_version, :key_value, :state_name, :creation_time, :last_update_time) SENSITIVE = [] include Aws::Structure end |
#creation_time ⇒ Time
The time the alarm was created, in the Unix epoch format.
212 213 214 215 216 217 218 219 220 221 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 212 class AlarmSummary < Struct.new( :alarm_model_name, :alarm_model_version, :key_value, :state_name, :creation_time, :last_update_time) SENSITIVE = [] include Aws::Structure end |
#key_value ⇒ String
The value of the key used as a filter to select only the alarms associated with the key.
212 213 214 215 216 217 218 219 220 221 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 212 class AlarmSummary < Struct.new( :alarm_model_name, :alarm_model_version, :key_value, :state_name, :creation_time, :last_update_time) SENSITIVE = [] include Aws::Structure end |
#last_update_time ⇒ Time
The time the alarm was last updated, in the Unix epoch format.
212 213 214 215 216 217 218 219 220 221 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 212 class AlarmSummary < Struct.new( :alarm_model_name, :alarm_model_version, :key_value, :state_name, :creation_time, :last_update_time) SENSITIVE = [] include Aws::Structure end |
#state_name ⇒ String
The name of the alarm state. The state name can be one of the following values:
DISABLED
- When the alarm is in theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state.NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data.ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked.ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm.SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state.LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
212 213 214 215 216 217 218 219 220 221 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/types.rb', line 212 class AlarmSummary < Struct.new( :alarm_model_name, :alarm_model_version, :key_value, :state_name, :creation_time, :last_update_time) SENSITIVE = [] include Aws::Structure end |