Amazonka.IoTEventsData.Types.AlarmState

Documentation

data AlarmState

Contains information about the current state of the alarm.

See: newAlarmState smart constructor.

Constructors

AlarmState'

Fields

• customerAction :: Maybe CustomerAction

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

• ruleEvaluation :: Maybe RuleEvaluation

  Information needed to evaluate data.

• stateName :: Maybe AlarmStateName

  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.
• systemEvent :: Maybe SystemEvent

  Contains information about alarm state changes.

Instances

FromJSON AlarmState

Defined in Amazonka.IoTEventsData.Types.AlarmState

Methods

parseJSON :: Value -> Parser AlarmState

parseJSONList :: Value -> Parser [AlarmState]

Generic AlarmState

Defined in Amazonka.IoTEventsData.Types.AlarmState

Associated Types

type Rep AlarmState :: Type -> Type

Methods

from :: AlarmState -> Rep AlarmState x

to :: Rep AlarmState x -> AlarmState

Read AlarmState

Defined in Amazonka.IoTEventsData.Types.AlarmState

Methods

readsPrec :: Int -> ReadS AlarmState

readList :: ReadS [AlarmState]

readPrec :: ReadPrec AlarmState

readListPrec :: ReadPrec [AlarmState]

Show AlarmState

Defined in Amazonka.IoTEventsData.Types.AlarmState

Methods

showsPrec :: Int -> AlarmState -> ShowS

show :: AlarmState -> String

showList :: [AlarmState] -> ShowS

NFData AlarmState

Defined in Amazonka.IoTEventsData.Types.AlarmState

Methods

rnf :: AlarmState -> ()

Eq AlarmState

Defined in Amazonka.IoTEventsData.Types.AlarmState

Methods

(==) :: AlarmState -> AlarmState -> Bool

(/=) :: AlarmState -> AlarmState -> Bool

Hashable AlarmState

Defined in Amazonka.IoTEventsData.Types.AlarmState

Methods

hashWithSalt :: Int -> AlarmState -> Int

hash :: AlarmState -> Int

type Rep AlarmState

Defined in Amazonka.IoTEventsData.Types.AlarmState

type Rep AlarmState = D1 ('MetaData "AlarmState" "Amazonka.IoTEventsData.Types.AlarmState" "amazonka-iotevents-data-2.0-2nkzod7vvQTAS38g00IbEB" 'False) (C1 ('MetaCons "AlarmState'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customerAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomerAction)) :*: S1 ('MetaSel ('Just "ruleEvaluation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleEvaluation))) :*: (S1 ('MetaSel ('Just "stateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmStateName)) :*: S1 ('MetaSel ('Just "systemEvent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SystemEvent)))))

newAlarmState :: AlarmState

Create a value of AlarmState with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customerAction:AlarmState', alarmState_customerAction - Contains information about the action that you can take to respond to the alarm.

$sel:ruleEvaluation:AlarmState', alarmState_ruleEvaluation - Information needed to evaluate data.

$sel:stateName:AlarmState', alarmState_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.

$sel:systemEvent:AlarmState', alarmState_systemEvent - Contains information about alarm state changes.

alarmState_customerAction :: Lens' AlarmState (Maybe CustomerAction)

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

alarmState_ruleEvaluation :: Lens' AlarmState (Maybe RuleEvaluation)

Information needed to evaluate data.

alarmState_stateName :: Lens' AlarmState (Maybe AlarmStateName)

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.

alarmState_systemEvent :: Lens' AlarmState (Maybe SystemEvent)

Contains information about alarm state changes.