Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTEventsData.Types.AlarmSummary

Description

Documentation

data AlarmSummary Source #

Contains a summary of an alarm.

See: newAlarmSummary smart constructor.

Constructors

AlarmSummary'

Fields

keyValue :: Maybe Text
The value of the key used as a filter to select only the alarms associated with the key.
creationTime :: Maybe POSIX
The time the alarm was created, in the Unix epoch format.
alarmModelName :: Maybe Text
The name of the alarm model.
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.
lastUpdateTime :: Maybe POSIX
The time the alarm was last updated, in the Unix epoch format.
alarmModelVersion :: Maybe Text
The version of the alarm model.

Instances

Instances details

Eq AlarmSummary Source #
Instance details Defined in Amazonka.IoTEventsData.Types.AlarmSummary Methods (==) :: AlarmSummary -> AlarmSummary -> Bool # (/=) :: AlarmSummary -> AlarmSummary -> Bool #
Read AlarmSummary Source #
Instance details Defined in Amazonka.IoTEventsData.Types.AlarmSummary Methods readsPrec :: Int -> ReadS AlarmSummary # readList :: ReadS [AlarmSummary] # readPrec :: ReadPrec AlarmSummary # readListPrec :: ReadPrec [AlarmSummary] #
Show AlarmSummary Source #
Instance details Defined in Amazonka.IoTEventsData.Types.AlarmSummary Methods showsPrec :: Int -> AlarmSummary -> ShowS # show :: AlarmSummary -> String # showList :: [AlarmSummary] -> ShowS #
Generic AlarmSummary Source #
Instance details Defined in Amazonka.IoTEventsData.Types.AlarmSummary Associated Types type Rep AlarmSummary :: Type -> Type # Methods from :: AlarmSummary -> Rep AlarmSummary x # to :: Rep AlarmSummary x -> AlarmSummary #
NFData AlarmSummary Source #
Instance details Defined in Amazonka.IoTEventsData.Types.AlarmSummary Methods rnf :: AlarmSummary -> () #
Hashable AlarmSummary Source #
Instance details Defined in Amazonka.IoTEventsData.Types.AlarmSummary Methods hashWithSalt :: Int -> AlarmSummary -> Int # hash :: AlarmSummary -> Int #
FromJSON AlarmSummary Source #
Instance details Defined in Amazonka.IoTEventsData.Types.AlarmSummary Methods parseJSON :: Value -> Parser AlarmSummary # parseJSONList :: Value -> Parser [AlarmSummary] #
type Rep AlarmSummary Source #
Instance details Defined in Amazonka.IoTEventsData.Types.AlarmSummary type Rep AlarmSummary = D1 ('MetaData "AlarmSummary" "Amazonka.IoTEventsData.Types.AlarmSummary" "libZSservicesZSamazonka-iotevents-dataZSamazonka-iotevents-data" 'False) (C1 ('MetaCons "AlarmSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "alarmModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "stateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmStateName)) :: (S1 ('MetaSel ('Just "lastUpdateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "alarmModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAlarmSummary :: AlarmSummary Source #

Create a value of AlarmSummary 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:keyValue:AlarmSummary', alarmSummary_keyValue - The value of the key used as a filter to select only the alarms associated with the key.

$sel:creationTime:AlarmSummary', alarmSummary_creationTime - The time the alarm was created, in the Unix epoch format.

$sel:alarmModelName:AlarmSummary', alarmSummary_alarmModelName - The name of the alarm model.

$sel:stateName:AlarmSummary', alarmSummary_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:lastUpdateTime:AlarmSummary', alarmSummary_lastUpdateTime - The time the alarm was last updated, in the Unix epoch format.

$sel:alarmModelVersion:AlarmSummary', alarmSummary_alarmModelVersion - The version of the alarm model.

alarmSummary_keyValue :: Lens' AlarmSummary (Maybe Text) Source #

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

alarmSummary_creationTime :: Lens' AlarmSummary (Maybe UTCTime) Source #

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

alarmSummary_alarmModelName :: Lens' AlarmSummary (Maybe Text) Source #

The name of the alarm model.

alarmSummary_stateName :: Lens' AlarmSummary (Maybe AlarmStateName) Source #

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.

alarmSummary_lastUpdateTime :: Lens' AlarmSummary (Maybe UTCTime) Source #

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

alarmSummary_alarmModelVersion :: Lens' AlarmSummary (Maybe Text) Source #

The version of the alarm model.