Class: Aws::IoTEventsData::Types::AlarmState

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ioteventsdata/types.rb

Overview

Contains information about the current state of the alarm.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customer_action ⇒ Types::CustomerAction

Contains information about the action that you can take to respond to the alarm.

Returns:



148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 148

class AlarmState < Struct.new(
  :state_name,
  :rule_evaluation,
  :customer_action,
  :system_event)
  SENSITIVE = []
  include Aws::Structure
end

#rule_evaluation ⇒ Types::RuleEvaluation

Information needed to evaluate data.

Returns:



148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 148

class AlarmState < Struct.new(
  :state_name,
  :rule_evaluation,
  :customer_action,
  :system_event)
  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 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.

Returns:

  • (String) 


148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 148

class AlarmState < Struct.new(
  :state_name,
  :rule_evaluation,
  :customer_action,
  :system_event)
  SENSITIVE = []
  include Aws::Structure
end

#system_event ⇒ Types::SystemEvent

Contains information about alarm state changes.

Returns:



148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ioteventsdata/types.rb', line 148

class AlarmState < Struct.new(
  :state_name,
  :rule_evaluation,
  :customer_action,
  :system_event)
  SENSITIVE = []
  include Aws::Structure
end