Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTEventsData.Types.CustomerAction

Description

Synopsis

Documentation

data CustomerAction Source #

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

See: newCustomerAction smart constructor.

Constructors

CustomerAction'

Fields

acknowledgeActionConfiguration :: Maybe AcknowledgeActionConfiguration
Contains the configuration information of an acknowledge action.
actionName :: Maybe CustomerActionName
The name of the action. The action name can be one of the following values:
- SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.
- ENABLE - When you enable the alarm, the alarm state changes to NORMAL.
- DISABLE - When you disable the alarm, the alarm state changes to DISABLED.
- ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.
- RESET - When you reset the alarm, the alarm state changes to NORMAL.
For more information, see the AlarmState API.
disableActionConfiguration :: Maybe DisableActionConfiguration
Contains the configuration information of a disable action.
enableActionConfiguration :: Maybe EnableActionConfiguration
Contains the configuration information of an enable action.
resetActionConfiguration :: Maybe ResetActionConfiguration
Contains the configuration information of a reset action.
snoozeActionConfiguration :: Maybe SnoozeActionConfiguration
Contains the configuration information of a snooze action.

Instances

Instances details

FromJSON CustomerAction Source #
Instance details Defined in Amazonka.IoTEventsData.Types.CustomerAction Methods parseJSON :: Value -> Parser CustomerAction # parseJSONList :: Value -> Parser [CustomerAction] #
Generic CustomerAction Source #
Instance details Defined in Amazonka.IoTEventsData.Types.CustomerAction Associated Types type Rep CustomerAction :: Type -> Type # Methods from :: CustomerAction -> Rep CustomerAction x # to :: Rep CustomerAction x -> CustomerAction #
Read CustomerAction Source #
Instance details Defined in Amazonka.IoTEventsData.Types.CustomerAction Methods readsPrec :: Int -> ReadS CustomerAction # readList :: ReadS [CustomerAction] # readPrec :: ReadPrec CustomerAction # readListPrec :: ReadPrec [CustomerAction] #
Show CustomerAction Source #
Instance details Defined in Amazonka.IoTEventsData.Types.CustomerAction Methods showsPrec :: Int -> CustomerAction -> ShowS # show :: CustomerAction -> String # showList :: [CustomerAction] -> ShowS #
NFData CustomerAction Source #
Instance details Defined in Amazonka.IoTEventsData.Types.CustomerAction Methods rnf :: CustomerAction -> () #
Eq CustomerAction Source #
Instance details Defined in Amazonka.IoTEventsData.Types.CustomerAction Methods (==) :: CustomerAction -> CustomerAction -> Bool # (/=) :: CustomerAction -> CustomerAction -> Bool #
Hashable CustomerAction Source #
Instance details Defined in Amazonka.IoTEventsData.Types.CustomerAction Methods hashWithSalt :: Int -> CustomerAction -> Int # hash :: CustomerAction -> Int #
type Rep CustomerAction Source #
Instance details Defined in Amazonka.IoTEventsData.Types.CustomerAction type Rep CustomerAction = D1 ('MetaData "CustomerAction" "Amazonka.IoTEventsData.Types.CustomerAction" "amazonka-iotevents-data-2.0-2nkzod7vvQTAS38g00IbEB" 'False) (C1 ('MetaCons "CustomerAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acknowledgeActionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AcknowledgeActionConfiguration)) :: (S1 ('MetaSel ('Just "actionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomerActionName)) :: S1 ('MetaSel ('Just "disableActionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DisableActionConfiguration)))) :: (S1 ('MetaSel ('Just "enableActionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnableActionConfiguration)) :: (S1 ('MetaSel ('Just "resetActionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResetActionConfiguration)) :*: S1 ('MetaSel ('Just "snoozeActionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnoozeActionConfiguration))))))

newCustomerAction :: CustomerAction Source #

Create a value of CustomerAction 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:acknowledgeActionConfiguration:CustomerAction', customerAction_acknowledgeActionConfiguration - Contains the configuration information of an acknowledge action.

$sel:actionName:CustomerAction', customerAction_actionName - The name of the action. The action name can be one of the following values:

SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.
ENABLE - When you enable the alarm, the alarm state changes to NORMAL.
DISABLE - When you disable the alarm, the alarm state changes to DISABLED.
ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.
RESET - When you reset the alarm, the alarm state changes to NORMAL.

For more information, see the AlarmState API.

$sel:disableActionConfiguration:CustomerAction', customerAction_disableActionConfiguration - Contains the configuration information of a disable action.

$sel:enableActionConfiguration:CustomerAction', customerAction_enableActionConfiguration - Contains the configuration information of an enable action.

$sel:resetActionConfiguration:CustomerAction', customerAction_resetActionConfiguration - Contains the configuration information of a reset action.

$sel:snoozeActionConfiguration:CustomerAction', customerAction_snoozeActionConfiguration - Contains the configuration information of a snooze action.

customerAction_acknowledgeActionConfiguration :: Lens' CustomerAction (Maybe AcknowledgeActionConfiguration) Source #

Contains the configuration information of an acknowledge action.

customerAction_actionName :: Lens' CustomerAction (Maybe CustomerActionName) Source #

The name of the action. The action name can be one of the following values:

SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.
ENABLE - When you enable the alarm, the alarm state changes to NORMAL.
DISABLE - When you disable the alarm, the alarm state changes to DISABLED.
ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.
RESET - When you reset the alarm, the alarm state changes to NORMAL.

For more information, see the AlarmState API.

customerAction_disableActionConfiguration :: Lens' CustomerAction (Maybe DisableActionConfiguration) Source #

Contains the configuration information of a disable action.

customerAction_enableActionConfiguration :: Lens' CustomerAction (Maybe EnableActionConfiguration) Source #

Contains the configuration information of an enable action.

customerAction_resetActionConfiguration :: Lens' CustomerAction (Maybe ResetActionConfiguration) Source #

Contains the configuration information of a reset action.

customerAction_snoozeActionConfiguration :: Lens' CustomerAction (Maybe SnoozeActionConfiguration) Source #

Contains the configuration information of a snooze action.