| 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
Contents
- Service Configuration
- Errors
- AlarmStateName
- ComparisonOperator
- CustomerActionName
- ErrorCode
- EventType
- TriggerType
- AcknowledgeActionConfiguration
- AcknowledgeAlarmActionRequest
- Alarm
- AlarmState
- AlarmSummary
- BatchAlarmActionErrorEntry
- BatchDeleteDetectorErrorEntry
- BatchPutMessageErrorEntry
- BatchUpdateDetectorErrorEntry
- CustomerAction
- DeleteDetectorRequest
- Detector
- DetectorState
- DetectorStateDefinition
- DetectorStateSummary
- DetectorSummary
- DisableActionConfiguration
- DisableAlarmActionRequest
- EnableActionConfiguration
- EnableAlarmActionRequest
- Message
- ResetActionConfiguration
- ResetAlarmActionRequest
- RuleEvaluation
- SimpleRuleEvaluation
- SnoozeActionConfiguration
- SnoozeAlarmActionRequest
- StateChangeConfiguration
- SystemEvent
- Timer
- TimerDefinition
- TimestampValue
- UpdateDetectorRequest
- Variable
- VariableDefinition
Description
Synopsis
- defaultService :: Service
- _InternalFailureException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- newtype AlarmStateName where
- AlarmStateName' { }
- pattern AlarmStateName_ACKNOWLEDGED :: AlarmStateName
- pattern AlarmStateName_ACTIVE :: AlarmStateName
- pattern AlarmStateName_DISABLED :: AlarmStateName
- pattern AlarmStateName_LATCHED :: AlarmStateName
- pattern AlarmStateName_NORMAL :: AlarmStateName
- pattern AlarmStateName_SNOOZE_DISABLED :: AlarmStateName
- newtype ComparisonOperator where
- ComparisonOperator' { }
- pattern ComparisonOperator_EQUAL :: ComparisonOperator
- pattern ComparisonOperator_GREATER :: ComparisonOperator
- pattern ComparisonOperator_GREATER_OR_EQUAL :: ComparisonOperator
- pattern ComparisonOperator_LESS :: ComparisonOperator
- pattern ComparisonOperator_LESS_OR_EQUAL :: ComparisonOperator
- pattern ComparisonOperator_NOT_EQUAL :: ComparisonOperator
- newtype CustomerActionName where
- CustomerActionName' { }
- pattern CustomerActionName_ACKNOWLEDGE :: CustomerActionName
- pattern CustomerActionName_DISABLE :: CustomerActionName
- pattern CustomerActionName_ENABLE :: CustomerActionName
- pattern CustomerActionName_RESET :: CustomerActionName
- pattern CustomerActionName_SNOOZE :: CustomerActionName
- newtype ErrorCode where
- ErrorCode' { }
- pattern ErrorCode_InternalFailureException :: ErrorCode
- pattern ErrorCode_InvalidRequestException :: ErrorCode
- pattern ErrorCode_ResourceNotFoundException :: ErrorCode
- pattern ErrorCode_ServiceUnavailableException :: ErrorCode
- pattern ErrorCode_ThrottlingException :: ErrorCode
- newtype EventType where
- EventType' { }
- pattern EventType_STATE_CHANGE :: EventType
- newtype TriggerType where
- TriggerType' { }
- pattern TriggerType_SNOOZE_TIMEOUT :: TriggerType
- data AcknowledgeActionConfiguration = AcknowledgeActionConfiguration' {}
- newAcknowledgeActionConfiguration :: AcknowledgeActionConfiguration
- acknowledgeActionConfiguration_note :: Lens' AcknowledgeActionConfiguration (Maybe Text)
- data AcknowledgeAlarmActionRequest = AcknowledgeAlarmActionRequest' {}
- newAcknowledgeAlarmActionRequest :: Text -> Text -> AcknowledgeAlarmActionRequest
- acknowledgeAlarmActionRequest_keyValue :: Lens' AcknowledgeAlarmActionRequest (Maybe Text)
- acknowledgeAlarmActionRequest_note :: Lens' AcknowledgeAlarmActionRequest (Maybe Text)
- acknowledgeAlarmActionRequest_requestId :: Lens' AcknowledgeAlarmActionRequest Text
- acknowledgeAlarmActionRequest_alarmModelName :: Lens' AcknowledgeAlarmActionRequest Text
- data Alarm = Alarm' {}
- newAlarm :: Alarm
- alarm_alarmModelName :: Lens' Alarm (Maybe Text)
- alarm_alarmModelVersion :: Lens' Alarm (Maybe Text)
- alarm_alarmState :: Lens' Alarm (Maybe AlarmState)
- alarm_creationTime :: Lens' Alarm (Maybe UTCTime)
- alarm_keyValue :: Lens' Alarm (Maybe Text)
- alarm_lastUpdateTime :: Lens' Alarm (Maybe UTCTime)
- alarm_severity :: Lens' Alarm (Maybe Natural)
- data AlarmState = AlarmState' {}
- newAlarmState :: AlarmState
- alarmState_customerAction :: Lens' AlarmState (Maybe CustomerAction)
- alarmState_ruleEvaluation :: Lens' AlarmState (Maybe RuleEvaluation)
- alarmState_stateName :: Lens' AlarmState (Maybe AlarmStateName)
- alarmState_systemEvent :: Lens' AlarmState (Maybe SystemEvent)
- data AlarmSummary = AlarmSummary' {}
- newAlarmSummary :: AlarmSummary
- alarmSummary_alarmModelName :: Lens' AlarmSummary (Maybe Text)
- alarmSummary_alarmModelVersion :: Lens' AlarmSummary (Maybe Text)
- alarmSummary_creationTime :: Lens' AlarmSummary (Maybe UTCTime)
- alarmSummary_keyValue :: Lens' AlarmSummary (Maybe Text)
- alarmSummary_lastUpdateTime :: Lens' AlarmSummary (Maybe UTCTime)
- alarmSummary_stateName :: Lens' AlarmSummary (Maybe AlarmStateName)
- data BatchAlarmActionErrorEntry = BatchAlarmActionErrorEntry' {}
- newBatchAlarmActionErrorEntry :: BatchAlarmActionErrorEntry
- batchAlarmActionErrorEntry_errorCode :: Lens' BatchAlarmActionErrorEntry (Maybe ErrorCode)
- batchAlarmActionErrorEntry_errorMessage :: Lens' BatchAlarmActionErrorEntry (Maybe Text)
- batchAlarmActionErrorEntry_requestId :: Lens' BatchAlarmActionErrorEntry (Maybe Text)
- data BatchDeleteDetectorErrorEntry = BatchDeleteDetectorErrorEntry' {}
- newBatchDeleteDetectorErrorEntry :: BatchDeleteDetectorErrorEntry
- batchDeleteDetectorErrorEntry_errorCode :: Lens' BatchDeleteDetectorErrorEntry (Maybe ErrorCode)
- batchDeleteDetectorErrorEntry_errorMessage :: Lens' BatchDeleteDetectorErrorEntry (Maybe Text)
- batchDeleteDetectorErrorEntry_messageId :: Lens' BatchDeleteDetectorErrorEntry (Maybe Text)
- data BatchPutMessageErrorEntry = BatchPutMessageErrorEntry' {}
- newBatchPutMessageErrorEntry :: BatchPutMessageErrorEntry
- batchPutMessageErrorEntry_errorCode :: Lens' BatchPutMessageErrorEntry (Maybe ErrorCode)
- batchPutMessageErrorEntry_errorMessage :: Lens' BatchPutMessageErrorEntry (Maybe Text)
- batchPutMessageErrorEntry_messageId :: Lens' BatchPutMessageErrorEntry (Maybe Text)
- data BatchUpdateDetectorErrorEntry = BatchUpdateDetectorErrorEntry' {}
- newBatchUpdateDetectorErrorEntry :: BatchUpdateDetectorErrorEntry
- batchUpdateDetectorErrorEntry_errorCode :: Lens' BatchUpdateDetectorErrorEntry (Maybe ErrorCode)
- batchUpdateDetectorErrorEntry_errorMessage :: Lens' BatchUpdateDetectorErrorEntry (Maybe Text)
- batchUpdateDetectorErrorEntry_messageId :: Lens' BatchUpdateDetectorErrorEntry (Maybe Text)
- data CustomerAction = CustomerAction' {
- acknowledgeActionConfiguration :: Maybe AcknowledgeActionConfiguration
- actionName :: Maybe CustomerActionName
- disableActionConfiguration :: Maybe DisableActionConfiguration
- enableActionConfiguration :: Maybe EnableActionConfiguration
- resetActionConfiguration :: Maybe ResetActionConfiguration
- snoozeActionConfiguration :: Maybe SnoozeActionConfiguration
- newCustomerAction :: CustomerAction
- customerAction_acknowledgeActionConfiguration :: Lens' CustomerAction (Maybe AcknowledgeActionConfiguration)
- customerAction_actionName :: Lens' CustomerAction (Maybe CustomerActionName)
- customerAction_disableActionConfiguration :: Lens' CustomerAction (Maybe DisableActionConfiguration)
- customerAction_enableActionConfiguration :: Lens' CustomerAction (Maybe EnableActionConfiguration)
- customerAction_resetActionConfiguration :: Lens' CustomerAction (Maybe ResetActionConfiguration)
- customerAction_snoozeActionConfiguration :: Lens' CustomerAction (Maybe SnoozeActionConfiguration)
- data DeleteDetectorRequest = DeleteDetectorRequest' {}
- newDeleteDetectorRequest :: Text -> Text -> DeleteDetectorRequest
- deleteDetectorRequest_keyValue :: Lens' DeleteDetectorRequest (Maybe Text)
- deleteDetectorRequest_messageId :: Lens' DeleteDetectorRequest Text
- deleteDetectorRequest_detectorModelName :: Lens' DeleteDetectorRequest Text
- data Detector = Detector' {}
- newDetector :: Detector
- detector_creationTime :: Lens' Detector (Maybe UTCTime)
- detector_detectorModelName :: Lens' Detector (Maybe Text)
- detector_detectorModelVersion :: Lens' Detector (Maybe Text)
- detector_keyValue :: Lens' Detector (Maybe Text)
- detector_lastUpdateTime :: Lens' Detector (Maybe UTCTime)
- detector_state :: Lens' Detector (Maybe DetectorState)
- data DetectorState = DetectorState' {}
- newDetectorState :: Text -> DetectorState
- detectorState_stateName :: Lens' DetectorState Text
- detectorState_variables :: Lens' DetectorState [Variable]
- detectorState_timers :: Lens' DetectorState [Timer]
- data DetectorStateDefinition = DetectorStateDefinition' {
- stateName :: Text
- variables :: [VariableDefinition]
- timers :: [TimerDefinition]
- newDetectorStateDefinition :: Text -> DetectorStateDefinition
- detectorStateDefinition_stateName :: Lens' DetectorStateDefinition Text
- detectorStateDefinition_variables :: Lens' DetectorStateDefinition [VariableDefinition]
- detectorStateDefinition_timers :: Lens' DetectorStateDefinition [TimerDefinition]
- data DetectorStateSummary = DetectorStateSummary' {}
- newDetectorStateSummary :: DetectorStateSummary
- detectorStateSummary_stateName :: Lens' DetectorStateSummary (Maybe Text)
- data DetectorSummary = DetectorSummary' {}
- newDetectorSummary :: DetectorSummary
- detectorSummary_creationTime :: Lens' DetectorSummary (Maybe UTCTime)
- detectorSummary_detectorModelName :: Lens' DetectorSummary (Maybe Text)
- detectorSummary_detectorModelVersion :: Lens' DetectorSummary (Maybe Text)
- detectorSummary_keyValue :: Lens' DetectorSummary (Maybe Text)
- detectorSummary_lastUpdateTime :: Lens' DetectorSummary (Maybe UTCTime)
- detectorSummary_state :: Lens' DetectorSummary (Maybe DetectorStateSummary)
- data DisableActionConfiguration = DisableActionConfiguration' {}
- newDisableActionConfiguration :: DisableActionConfiguration
- disableActionConfiguration_note :: Lens' DisableActionConfiguration (Maybe Text)
- data DisableAlarmActionRequest = DisableAlarmActionRequest' {}
- newDisableAlarmActionRequest :: Text -> Text -> DisableAlarmActionRequest
- disableAlarmActionRequest_keyValue :: Lens' DisableAlarmActionRequest (Maybe Text)
- disableAlarmActionRequest_note :: Lens' DisableAlarmActionRequest (Maybe Text)
- disableAlarmActionRequest_requestId :: Lens' DisableAlarmActionRequest Text
- disableAlarmActionRequest_alarmModelName :: Lens' DisableAlarmActionRequest Text
- data EnableActionConfiguration = EnableActionConfiguration' {}
- newEnableActionConfiguration :: EnableActionConfiguration
- enableActionConfiguration_note :: Lens' EnableActionConfiguration (Maybe Text)
- data EnableAlarmActionRequest = EnableAlarmActionRequest' {}
- newEnableAlarmActionRequest :: Text -> Text -> EnableAlarmActionRequest
- enableAlarmActionRequest_keyValue :: Lens' EnableAlarmActionRequest (Maybe Text)
- enableAlarmActionRequest_note :: Lens' EnableAlarmActionRequest (Maybe Text)
- enableAlarmActionRequest_requestId :: Lens' EnableAlarmActionRequest Text
- enableAlarmActionRequest_alarmModelName :: Lens' EnableAlarmActionRequest Text
- data Message = Message' {}
- newMessage :: Text -> Text -> ByteString -> Message
- message_timestamp :: Lens' Message (Maybe TimestampValue)
- message_messageId :: Lens' Message Text
- message_inputName :: Lens' Message Text
- message_payload :: Lens' Message ByteString
- data ResetActionConfiguration = ResetActionConfiguration' {}
- newResetActionConfiguration :: ResetActionConfiguration
- resetActionConfiguration_note :: Lens' ResetActionConfiguration (Maybe Text)
- data ResetAlarmActionRequest = ResetAlarmActionRequest' {}
- newResetAlarmActionRequest :: Text -> Text -> ResetAlarmActionRequest
- resetAlarmActionRequest_keyValue :: Lens' ResetAlarmActionRequest (Maybe Text)
- resetAlarmActionRequest_note :: Lens' ResetAlarmActionRequest (Maybe Text)
- resetAlarmActionRequest_requestId :: Lens' ResetAlarmActionRequest Text
- resetAlarmActionRequest_alarmModelName :: Lens' ResetAlarmActionRequest Text
- data RuleEvaluation = RuleEvaluation' {}
- newRuleEvaluation :: RuleEvaluation
- ruleEvaluation_simpleRuleEvaluation :: Lens' RuleEvaluation (Maybe SimpleRuleEvaluation)
- data SimpleRuleEvaluation = SimpleRuleEvaluation' {}
- newSimpleRuleEvaluation :: SimpleRuleEvaluation
- simpleRuleEvaluation_inputPropertyValue :: Lens' SimpleRuleEvaluation (Maybe Text)
- simpleRuleEvaluation_operator :: Lens' SimpleRuleEvaluation (Maybe ComparisonOperator)
- simpleRuleEvaluation_thresholdValue :: Lens' SimpleRuleEvaluation (Maybe Text)
- data SnoozeActionConfiguration = SnoozeActionConfiguration' {}
- newSnoozeActionConfiguration :: SnoozeActionConfiguration
- snoozeActionConfiguration_note :: Lens' SnoozeActionConfiguration (Maybe Text)
- snoozeActionConfiguration_snoozeDuration :: Lens' SnoozeActionConfiguration (Maybe Int)
- data SnoozeAlarmActionRequest = SnoozeAlarmActionRequest' {}
- newSnoozeAlarmActionRequest :: Text -> Text -> Int -> SnoozeAlarmActionRequest
- snoozeAlarmActionRequest_keyValue :: Lens' SnoozeAlarmActionRequest (Maybe Text)
- snoozeAlarmActionRequest_note :: Lens' SnoozeAlarmActionRequest (Maybe Text)
- snoozeAlarmActionRequest_requestId :: Lens' SnoozeAlarmActionRequest Text
- snoozeAlarmActionRequest_alarmModelName :: Lens' SnoozeAlarmActionRequest Text
- snoozeAlarmActionRequest_snoozeDuration :: Lens' SnoozeAlarmActionRequest Int
- data StateChangeConfiguration = StateChangeConfiguration' {}
- newStateChangeConfiguration :: StateChangeConfiguration
- stateChangeConfiguration_triggerType :: Lens' StateChangeConfiguration (Maybe TriggerType)
- data SystemEvent = SystemEvent' {}
- newSystemEvent :: SystemEvent
- systemEvent_eventType :: Lens' SystemEvent (Maybe EventType)
- systemEvent_stateChangeConfiguration :: Lens' SystemEvent (Maybe StateChangeConfiguration)
- data Timer = Timer' {}
- newTimer :: Text -> UTCTime -> Timer
- timer_name :: Lens' Timer Text
- timer_timestamp :: Lens' Timer UTCTime
- data TimerDefinition = TimerDefinition' {}
- newTimerDefinition :: Text -> Int -> TimerDefinition
- timerDefinition_name :: Lens' TimerDefinition Text
- timerDefinition_seconds :: Lens' TimerDefinition Int
- data TimestampValue = TimestampValue' {}
- newTimestampValue :: TimestampValue
- timestampValue_timeInMillis :: Lens' TimestampValue (Maybe Natural)
- data UpdateDetectorRequest = UpdateDetectorRequest' {}
- newUpdateDetectorRequest :: Text -> Text -> DetectorStateDefinition -> UpdateDetectorRequest
- updateDetectorRequest_keyValue :: Lens' UpdateDetectorRequest (Maybe Text)
- updateDetectorRequest_messageId :: Lens' UpdateDetectorRequest Text
- updateDetectorRequest_detectorModelName :: Lens' UpdateDetectorRequest Text
- updateDetectorRequest_state :: Lens' UpdateDetectorRequest DetectorStateDefinition
- data Variable = Variable' {}
- newVariable :: Text -> Text -> Variable
- variable_name :: Lens' Variable Text
- variable_value :: Lens' Variable Text
- data VariableDefinition = VariableDefinition' {}
- newVariableDefinition :: Text -> Text -> VariableDefinition
- variableDefinition_name :: Lens' VariableDefinition Text
- variableDefinition_value :: Lens' VariableDefinition Text
Service Configuration
defaultService :: Service Source #
API version 2018-10-23 of the Amazon IoT Events Data SDK configuration.
Errors
_InternalFailureException :: AsError a => Fold a ServiceError Source #
An internal failure occurred.
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The request was invalid.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource was not found.
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is currently unavailable.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request could not be completed due to throttling.
AlarmStateName
newtype AlarmStateName Source #
Constructors
| AlarmStateName' | |
Fields | |
Bundled Patterns
| pattern AlarmStateName_ACKNOWLEDGED :: AlarmStateName | |
| pattern AlarmStateName_ACTIVE :: AlarmStateName | |
| pattern AlarmStateName_DISABLED :: AlarmStateName | |
| pattern AlarmStateName_LATCHED :: AlarmStateName | |
| pattern AlarmStateName_NORMAL :: AlarmStateName | |
| pattern AlarmStateName_SNOOZE_DISABLED :: AlarmStateName |
Instances
ComparisonOperator
newtype ComparisonOperator Source #
Constructors
| ComparisonOperator' | |
Fields | |
Bundled Patterns
| pattern ComparisonOperator_EQUAL :: ComparisonOperator | |
| pattern ComparisonOperator_GREATER :: ComparisonOperator | |
| pattern ComparisonOperator_GREATER_OR_EQUAL :: ComparisonOperator | |
| pattern ComparisonOperator_LESS :: ComparisonOperator | |
| pattern ComparisonOperator_LESS_OR_EQUAL :: ComparisonOperator | |
| pattern ComparisonOperator_NOT_EQUAL :: ComparisonOperator |
Instances
CustomerActionName
newtype CustomerActionName Source #
Constructors
| CustomerActionName' | |
Fields | |
Bundled Patterns
| pattern CustomerActionName_ACKNOWLEDGE :: CustomerActionName | |
| pattern CustomerActionName_DISABLE :: CustomerActionName | |
| pattern CustomerActionName_ENABLE :: CustomerActionName | |
| pattern CustomerActionName_RESET :: CustomerActionName | |
| pattern CustomerActionName_SNOOZE :: CustomerActionName |
Instances
ErrorCode
Constructors
| ErrorCode' | |
Fields | |
Bundled Patterns
| pattern ErrorCode_InternalFailureException :: ErrorCode | |
| pattern ErrorCode_InvalidRequestException :: ErrorCode | |
| pattern ErrorCode_ResourceNotFoundException :: ErrorCode | |
| pattern ErrorCode_ServiceUnavailableException :: ErrorCode | |
| pattern ErrorCode_ThrottlingException :: ErrorCode |
Instances
EventType
Constructors
| EventType' | |
Fields | |
Bundled Patterns
| pattern EventType_STATE_CHANGE :: EventType |
Instances
TriggerType
newtype TriggerType Source #
Constructors
| TriggerType' | |
Fields | |
Bundled Patterns
| pattern TriggerType_SNOOZE_TIMEOUT :: TriggerType |
Instances
AcknowledgeActionConfiguration
data AcknowledgeActionConfiguration Source #
Contains the configuration information of an acknowledge action.
See: newAcknowledgeActionConfiguration smart constructor.
Constructors
| AcknowledgeActionConfiguration' | |
Instances
newAcknowledgeActionConfiguration :: AcknowledgeActionConfiguration Source #
Create a value of AcknowledgeActionConfiguration 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:note:AcknowledgeActionConfiguration', acknowledgeActionConfiguration_note - The note that you can leave when you acknowledge the alarm.
acknowledgeActionConfiguration_note :: Lens' AcknowledgeActionConfiguration (Maybe Text) Source #
The note that you can leave when you acknowledge the alarm.
AcknowledgeAlarmActionRequest
data AcknowledgeAlarmActionRequest Source #
Information needed to acknowledge the alarm.
See: newAcknowledgeAlarmActionRequest smart constructor.
Constructors
| AcknowledgeAlarmActionRequest' | |
Fields
| |
Instances
newAcknowledgeAlarmActionRequest Source #
Arguments
| :: Text | |
| -> Text | |
| -> AcknowledgeAlarmActionRequest |
Create a value of AcknowledgeAlarmActionRequest 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:AcknowledgeAlarmActionRequest', acknowledgeAlarmActionRequest_keyValue - The value of the key used as a filter to select only the alarms
associated with the
key.
$sel:note:AcknowledgeAlarmActionRequest', acknowledgeAlarmActionRequest_note - The note that you can leave when you acknowledge the alarm.
$sel:requestId:AcknowledgeAlarmActionRequest', acknowledgeAlarmActionRequest_requestId - The request ID. Each ID must be unique within each batch.
$sel:alarmModelName:AcknowledgeAlarmActionRequest', acknowledgeAlarmActionRequest_alarmModelName - The name of the alarm model.
acknowledgeAlarmActionRequest_keyValue :: Lens' AcknowledgeAlarmActionRequest (Maybe Text) Source #
The value of the key used as a filter to select only the alarms associated with the key.
acknowledgeAlarmActionRequest_note :: Lens' AcknowledgeAlarmActionRequest (Maybe Text) Source #
The note that you can leave when you acknowledge the alarm.
acknowledgeAlarmActionRequest_requestId :: Lens' AcknowledgeAlarmActionRequest Text Source #
The request ID. Each ID must be unique within each batch.
acknowledgeAlarmActionRequest_alarmModelName :: Lens' AcknowledgeAlarmActionRequest Text Source #
The name of the alarm model.
Alarm
Contains information about an alarm.
See: newAlarm smart constructor.
Constructors
| Alarm' | |
Fields
| |
Instances
Create a value of Alarm 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:alarmModelName:Alarm', alarm_alarmModelName - The name of the alarm model.
$sel:alarmModelVersion:Alarm', alarm_alarmModelVersion - The version of the alarm model.
$sel:alarmState:Alarm', alarm_alarmState - Contains information about the current state of the alarm.
$sel:creationTime:Alarm', alarm_creationTime - The time the alarm was created, in the Unix epoch format.
$sel:keyValue:Alarm', alarm_keyValue - The value of the key used as a filter to select only the alarms
associated with the
key.
$sel:lastUpdateTime:Alarm', alarm_lastUpdateTime - The time the alarm was last updated, in the Unix epoch format.
$sel:severity:Alarm', alarm_severity - A non-negative integer that reflects the severity level of the alarm.
alarm_alarmState :: Lens' Alarm (Maybe AlarmState) Source #
Contains information about the current state of the alarm.
alarm_creationTime :: Lens' Alarm (Maybe UTCTime) Source #
The time the alarm was created, in the Unix epoch format.
alarm_keyValue :: Lens' Alarm (Maybe Text) Source #
The value of the key used as a filter to select only the alarms associated with the key.
alarm_lastUpdateTime :: Lens' Alarm (Maybe UTCTime) Source #
The time the alarm was last updated, in the Unix epoch format.
alarm_severity :: Lens' Alarm (Maybe Natural) Source #
A non-negative integer that reflects the severity level of the alarm.
AlarmState
data AlarmState Source #
Contains information about the current state of the alarm.
See: newAlarmState smart constructor.
Constructors
| AlarmState' | |
Fields
| |
Instances
newAlarmState :: AlarmState Source #
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 theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate.NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data.ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked.ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm.SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate.LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, you must acknowledge the alarm.
$sel:systemEvent:AlarmState', alarmState_systemEvent - Contains information about alarm state changes.
alarmState_customerAction :: Lens' AlarmState (Maybe CustomerAction) Source #
Contains information about the action that you can take to respond to the alarm.
alarmState_ruleEvaluation :: Lens' AlarmState (Maybe RuleEvaluation) Source #
Information needed to evaluate data.
alarmState_stateName :: Lens' AlarmState (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 theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate.NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data.ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked.ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm.SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate.LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, you must acknowledge the alarm.
alarmState_systemEvent :: Lens' AlarmState (Maybe SystemEvent) Source #
Contains information about alarm state changes.
AlarmSummary
data AlarmSummary Source #
Contains a summary of an alarm.
See: newAlarmSummary smart constructor.
Constructors
| AlarmSummary' | |
Fields
| |
Instances
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:alarmModelName:AlarmSummary', alarmSummary_alarmModelName - The name of the alarm model.
$sel:alarmModelVersion:AlarmSummary', alarmSummary_alarmModelVersion - The version of the alarm model.
$sel:creationTime:AlarmSummary', alarmSummary_creationTime - The time the alarm was created, in the Unix epoch format.
$sel:keyValue:AlarmSummary', alarmSummary_keyValue - The value of the key used as a filter to select only the alarms
associated with the
key.
$sel:lastUpdateTime:AlarmSummary', alarmSummary_lastUpdateTime - The time the alarm was last updated, in the Unix epoch format.
$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 theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate.NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data.ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked.ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm.SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate.LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, you must acknowledge the alarm.
alarmSummary_alarmModelName :: Lens' AlarmSummary (Maybe Text) Source #
The name of the alarm model.
alarmSummary_alarmModelVersion :: Lens' AlarmSummary (Maybe Text) Source #
The version of the alarm model.
alarmSummary_creationTime :: Lens' AlarmSummary (Maybe UTCTime) Source #
The time the alarm was created, in the Unix epoch format.
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_lastUpdateTime :: Lens' AlarmSummary (Maybe UTCTime) Source #
The time the alarm was last updated, in the Unix epoch format.
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 theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate.NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data.ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked.ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm.SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate.LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, you must acknowledge the alarm.
BatchAlarmActionErrorEntry
data BatchAlarmActionErrorEntry Source #
Contains error messages associated with one of the following requests:
See: newBatchAlarmActionErrorEntry smart constructor.
Constructors
| BatchAlarmActionErrorEntry' | |
Instances
newBatchAlarmActionErrorEntry :: BatchAlarmActionErrorEntry Source #
Create a value of BatchAlarmActionErrorEntry 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:errorCode:BatchAlarmActionErrorEntry', batchAlarmActionErrorEntry_errorCode - The error code.
$sel:errorMessage:BatchAlarmActionErrorEntry', batchAlarmActionErrorEntry_errorMessage - A message that describes the error.
$sel:requestId:BatchAlarmActionErrorEntry', batchAlarmActionErrorEntry_requestId - The request ID. Each ID must be unique within each batch.
batchAlarmActionErrorEntry_errorCode :: Lens' BatchAlarmActionErrorEntry (Maybe ErrorCode) Source #
The error code.
batchAlarmActionErrorEntry_errorMessage :: Lens' BatchAlarmActionErrorEntry (Maybe Text) Source #
A message that describes the error.
batchAlarmActionErrorEntry_requestId :: Lens' BatchAlarmActionErrorEntry (Maybe Text) Source #
The request ID. Each ID must be unique within each batch.
BatchDeleteDetectorErrorEntry
data BatchDeleteDetectorErrorEntry Source #
Contains error messages associated with the deletion request.
See: newBatchDeleteDetectorErrorEntry smart constructor.
Constructors
| BatchDeleteDetectorErrorEntry' | |
Instances
newBatchDeleteDetectorErrorEntry :: BatchDeleteDetectorErrorEntry Source #
Create a value of BatchDeleteDetectorErrorEntry 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:errorCode:BatchDeleteDetectorErrorEntry', batchDeleteDetectorErrorEntry_errorCode - The error code.
$sel:errorMessage:BatchDeleteDetectorErrorEntry', batchDeleteDetectorErrorEntry_errorMessage - A message that describes the error.
$sel:messageId:BatchDeleteDetectorErrorEntry', batchDeleteDetectorErrorEntry_messageId - The ID of the message that caused the error. (See the value of the
"messageId" in the
detectors
object of the DeleteDetectorRequest.)
batchDeleteDetectorErrorEntry_errorCode :: Lens' BatchDeleteDetectorErrorEntry (Maybe ErrorCode) Source #
The error code.
batchDeleteDetectorErrorEntry_errorMessage :: Lens' BatchDeleteDetectorErrorEntry (Maybe Text) Source #
A message that describes the error.
batchDeleteDetectorErrorEntry_messageId :: Lens' BatchDeleteDetectorErrorEntry (Maybe Text) Source #
The ID of the message that caused the error. (See the value of the
"messageId" in the
detectors
object of the DeleteDetectorRequest.)
BatchPutMessageErrorEntry
data BatchPutMessageErrorEntry Source #
Contains information about the errors encountered.
See: newBatchPutMessageErrorEntry smart constructor.
Constructors
| BatchPutMessageErrorEntry' | |
Instances
newBatchPutMessageErrorEntry :: BatchPutMessageErrorEntry Source #
Create a value of BatchPutMessageErrorEntry 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:errorCode:BatchPutMessageErrorEntry', batchPutMessageErrorEntry_errorCode - The error code.
$sel:errorMessage:BatchPutMessageErrorEntry', batchPutMessageErrorEntry_errorMessage - A message that describes the error.
$sel:messageId:BatchPutMessageErrorEntry', batchPutMessageErrorEntry_messageId - The ID of the message that caused the error. (See the value
corresponding to the "messageId" key in the "message" object.)
batchPutMessageErrorEntry_errorCode :: Lens' BatchPutMessageErrorEntry (Maybe ErrorCode) Source #
The error code.
batchPutMessageErrorEntry_errorMessage :: Lens' BatchPutMessageErrorEntry (Maybe Text) Source #
A message that describes the error.
batchPutMessageErrorEntry_messageId :: Lens' BatchPutMessageErrorEntry (Maybe Text) Source #
The ID of the message that caused the error. (See the value
corresponding to the "messageId" key in the "message" object.)
BatchUpdateDetectorErrorEntry
data BatchUpdateDetectorErrorEntry Source #
Information about the error that occurred when attempting to update a detector.
See: newBatchUpdateDetectorErrorEntry smart constructor.
Constructors
| BatchUpdateDetectorErrorEntry' | |
Instances
newBatchUpdateDetectorErrorEntry :: BatchUpdateDetectorErrorEntry Source #
Create a value of BatchUpdateDetectorErrorEntry 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:errorCode:BatchUpdateDetectorErrorEntry', batchUpdateDetectorErrorEntry_errorCode - The error code.
$sel:errorMessage:BatchUpdateDetectorErrorEntry', batchUpdateDetectorErrorEntry_errorMessage - A message that describes the error.
$sel:messageId:BatchUpdateDetectorErrorEntry', batchUpdateDetectorErrorEntry_messageId - The "messageId" of the update request that caused the error. (The
value of the "messageId" in the update request "Detector"
object.)
batchUpdateDetectorErrorEntry_errorCode :: Lens' BatchUpdateDetectorErrorEntry (Maybe ErrorCode) Source #
The error code.
batchUpdateDetectorErrorEntry_errorMessage :: Lens' BatchUpdateDetectorErrorEntry (Maybe Text) Source #
A message that describes the error.
batchUpdateDetectorErrorEntry_messageId :: Lens' BatchUpdateDetectorErrorEntry (Maybe Text) Source #
The "messageId" of the update request that caused the error. (The
value of the "messageId" in the update request "Detector"
object.)
CustomerAction
data CustomerAction Source #
Contains information about the action that you can take to respond to the alarm.
See: newCustomerAction smart constructor.
Constructors
| CustomerAction' | |
Fields
| |
Instances
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 toSNOOZE_DISABLED.ENABLE- When you enable the alarm, the alarm state changes toNORMAL.DISABLE- When you disable the alarm, the alarm state changes toDISABLED.ACKNOWLEDGE- When you acknowledge the alarm, the alarm state changes toACKNOWLEDGED.RESET- When you reset the alarm, the alarm state changes toNORMAL.
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 toSNOOZE_DISABLED.ENABLE- When you enable the alarm, the alarm state changes toNORMAL.DISABLE- When you disable the alarm, the alarm state changes toDISABLED.ACKNOWLEDGE- When you acknowledge the alarm, the alarm state changes toACKNOWLEDGED.RESET- When you reset the alarm, the alarm state changes toNORMAL.
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.
DeleteDetectorRequest
data DeleteDetectorRequest Source #
Information used to delete the detector model.
See: newDeleteDetectorRequest smart constructor.
Constructors
| DeleteDetectorRequest' | |
Fields | |
Instances
newDeleteDetectorRequest Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteDetectorRequest |
Create a value of DeleteDetectorRequest 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:DeleteDetectorRequest', deleteDetectorRequest_keyValue - The value of the
key
used to identify the detector.
$sel:messageId:DeleteDetectorRequest', deleteDetectorRequest_messageId - The ID to assign to the DeleteDetectorRequest. Each "messageId"
must be unique within each batch sent.
$sel:detectorModelName:DeleteDetectorRequest', deleteDetectorRequest_detectorModelName - The name of the detector model that was used to create the detector
instance.
deleteDetectorRequest_keyValue :: Lens' DeleteDetectorRequest (Maybe Text) Source #
The value of the key used to identify the detector.
deleteDetectorRequest_messageId :: Lens' DeleteDetectorRequest Text Source #
The ID to assign to the DeleteDetectorRequest. Each "messageId"
must be unique within each batch sent.
deleteDetectorRequest_detectorModelName :: Lens' DeleteDetectorRequest Text Source #
The name of the detector model that was used to create the detector instance.
Detector
Information about the detector (instance).
See: newDetector smart constructor.
Constructors
| Detector' | |
Fields
| |
Instances
newDetector :: Detector Source #
Create a value of Detector 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:creationTime:Detector', detector_creationTime - The time the detector (instance) was created.
$sel:detectorModelName:Detector', detector_detectorModelName - The name of the detector model that created this detector (instance).
$sel:detectorModelVersion:Detector', detector_detectorModelVersion - The version of the detector model that created this detector (instance).
$sel:keyValue:Detector', detector_keyValue - The value of the key (identifying the device or system) that caused the
creation of this detector (instance).
$sel:lastUpdateTime:Detector', detector_lastUpdateTime - The time the detector (instance) was last updated.
$sel:state:Detector', detector_state - The current state of the detector (instance).
detector_creationTime :: Lens' Detector (Maybe UTCTime) Source #
The time the detector (instance) was created.
detector_detectorModelName :: Lens' Detector (Maybe Text) Source #
The name of the detector model that created this detector (instance).
detector_detectorModelVersion :: Lens' Detector (Maybe Text) Source #
The version of the detector model that created this detector (instance).
detector_keyValue :: Lens' Detector (Maybe Text) Source #
The value of the key (identifying the device or system) that caused the creation of this detector (instance).
detector_lastUpdateTime :: Lens' Detector (Maybe UTCTime) Source #
The time the detector (instance) was last updated.
detector_state :: Lens' Detector (Maybe DetectorState) Source #
The current state of the detector (instance).
DetectorState
data DetectorState Source #
Information about the current state of the detector instance.
See: newDetectorState smart constructor.
Constructors
| DetectorState' | |
Instances
Arguments
| :: Text | |
| -> DetectorState |
Create a value of DetectorState 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:stateName:DetectorState', detectorState_stateName - The name of the state.
$sel:variables:DetectorState', detectorState_variables - The current values of the detector's variables.
$sel:timers:DetectorState', detectorState_timers - The current state of the detector's timers.
detectorState_stateName :: Lens' DetectorState Text Source #
The name of the state.
detectorState_variables :: Lens' DetectorState [Variable] Source #
The current values of the detector's variables.
detectorState_timers :: Lens' DetectorState [Timer] Source #
The current state of the detector's timers.
DetectorStateDefinition
data DetectorStateDefinition Source #
The new state, variable values, and timer settings of the detector (instance).
See: newDetectorStateDefinition smart constructor.
Constructors
| DetectorStateDefinition' | |
Fields
| |
Instances
newDetectorStateDefinition Source #
Create a value of DetectorStateDefinition 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:stateName:DetectorStateDefinition', detectorStateDefinition_stateName - The name of the new state of the detector (instance).
$sel:variables:DetectorStateDefinition', detectorStateDefinition_variables - The new values of the detector's variables. Any variable whose value
isn't specified is cleared.
$sel:timers:DetectorStateDefinition', detectorStateDefinition_timers - The new values of the detector's timers. Any timer whose value isn't
specified is cleared, and its timeout event won't occur.
detectorStateDefinition_stateName :: Lens' DetectorStateDefinition Text Source #
The name of the new state of the detector (instance).
detectorStateDefinition_variables :: Lens' DetectorStateDefinition [VariableDefinition] Source #
The new values of the detector's variables. Any variable whose value isn't specified is cleared.
detectorStateDefinition_timers :: Lens' DetectorStateDefinition [TimerDefinition] Source #
The new values of the detector's timers. Any timer whose value isn't specified is cleared, and its timeout event won't occur.
DetectorStateSummary
data DetectorStateSummary Source #
Information about the detector state.
See: newDetectorStateSummary smart constructor.
Constructors
| DetectorStateSummary' | |
Instances
newDetectorStateSummary :: DetectorStateSummary Source #
Create a value of DetectorStateSummary 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:stateName:DetectorStateSummary', detectorStateSummary_stateName - The name of the state.
detectorStateSummary_stateName :: Lens' DetectorStateSummary (Maybe Text) Source #
The name of the state.
DetectorSummary
data DetectorSummary Source #
Information about the detector (instance).
See: newDetectorSummary smart constructor.
Constructors
| DetectorSummary' | |
Fields
| |
Instances
newDetectorSummary :: DetectorSummary Source #
Create a value of DetectorSummary 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:creationTime:DetectorSummary', detectorSummary_creationTime - The time the detector (instance) was created.
$sel:detectorModelName:DetectorSummary', detectorSummary_detectorModelName - The name of the detector model that created this detector (instance).
$sel:detectorModelVersion:DetectorSummary', detectorSummary_detectorModelVersion - The version of the detector model that created this detector (instance).
$sel:keyValue:DetectorSummary', detectorSummary_keyValue - The value of the key (identifying the device or system) that caused the
creation of this detector (instance).
$sel:lastUpdateTime:DetectorSummary', detectorSummary_lastUpdateTime - The time the detector (instance) was last updated.
$sel:state:DetectorSummary', detectorSummary_state - The current state of the detector (instance).
detectorSummary_creationTime :: Lens' DetectorSummary (Maybe UTCTime) Source #
The time the detector (instance) was created.
detectorSummary_detectorModelName :: Lens' DetectorSummary (Maybe Text) Source #
The name of the detector model that created this detector (instance).
detectorSummary_detectorModelVersion :: Lens' DetectorSummary (Maybe Text) Source #
The version of the detector model that created this detector (instance).
detectorSummary_keyValue :: Lens' DetectorSummary (Maybe Text) Source #
The value of the key (identifying the device or system) that caused the creation of this detector (instance).
detectorSummary_lastUpdateTime :: Lens' DetectorSummary (Maybe UTCTime) Source #
The time the detector (instance) was last updated.
detectorSummary_state :: Lens' DetectorSummary (Maybe DetectorStateSummary) Source #
The current state of the detector (instance).
DisableActionConfiguration
data DisableActionConfiguration Source #
Contains the configuration information of a disable action.
See: newDisableActionConfiguration smart constructor.
Constructors
| DisableActionConfiguration' | |
Instances
newDisableActionConfiguration :: DisableActionConfiguration Source #
Create a value of DisableActionConfiguration 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:note:DisableActionConfiguration', disableActionConfiguration_note - The note that you can leave when you disable the alarm.
disableActionConfiguration_note :: Lens' DisableActionConfiguration (Maybe Text) Source #
The note that you can leave when you disable the alarm.
DisableAlarmActionRequest
data DisableAlarmActionRequest Source #
Information used to disable the alarm.
See: newDisableAlarmActionRequest smart constructor.
Constructors
| DisableAlarmActionRequest' | |
Fields
| |
Instances
newDisableAlarmActionRequest Source #
Arguments
| :: Text | |
| -> Text | |
| -> DisableAlarmActionRequest |
Create a value of DisableAlarmActionRequest 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:DisableAlarmActionRequest', disableAlarmActionRequest_keyValue - The value of the key used as a filter to select only the alarms
associated with the
key.
$sel:note:DisableAlarmActionRequest', disableAlarmActionRequest_note - The note that you can leave when you disable the alarm.
$sel:requestId:DisableAlarmActionRequest', disableAlarmActionRequest_requestId - The request ID. Each ID must be unique within each batch.
$sel:alarmModelName:DisableAlarmActionRequest', disableAlarmActionRequest_alarmModelName - The name of the alarm model.
disableAlarmActionRequest_keyValue :: Lens' DisableAlarmActionRequest (Maybe Text) Source #
The value of the key used as a filter to select only the alarms associated with the key.
disableAlarmActionRequest_note :: Lens' DisableAlarmActionRequest (Maybe Text) Source #
The note that you can leave when you disable the alarm.
disableAlarmActionRequest_requestId :: Lens' DisableAlarmActionRequest Text Source #
The request ID. Each ID must be unique within each batch.
disableAlarmActionRequest_alarmModelName :: Lens' DisableAlarmActionRequest Text Source #
The name of the alarm model.
EnableActionConfiguration
data EnableActionConfiguration Source #
Contains the configuration information of an enable action.
See: newEnableActionConfiguration smart constructor.
Constructors
| EnableActionConfiguration' | |
Instances
newEnableActionConfiguration :: EnableActionConfiguration Source #
Create a value of EnableActionConfiguration 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:note:EnableActionConfiguration', enableActionConfiguration_note - The note that you can leave when you enable the alarm.
enableActionConfiguration_note :: Lens' EnableActionConfiguration (Maybe Text) Source #
The note that you can leave when you enable the alarm.
EnableAlarmActionRequest
data EnableAlarmActionRequest Source #
Information needed to enable the alarm.
See: newEnableAlarmActionRequest smart constructor.
Constructors
| EnableAlarmActionRequest' | |
Fields
| |
Instances
newEnableAlarmActionRequest Source #
Arguments
| :: Text | |
| -> Text | |
| -> EnableAlarmActionRequest |
Create a value of EnableAlarmActionRequest 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:EnableAlarmActionRequest', enableAlarmActionRequest_keyValue - The value of the key used as a filter to select only the alarms
associated with the
key.
$sel:note:EnableAlarmActionRequest', enableAlarmActionRequest_note - The note that you can leave when you enable the alarm.
$sel:requestId:EnableAlarmActionRequest', enableAlarmActionRequest_requestId - The request ID. Each ID must be unique within each batch.
$sel:alarmModelName:EnableAlarmActionRequest', enableAlarmActionRequest_alarmModelName - The name of the alarm model.
enableAlarmActionRequest_keyValue :: Lens' EnableAlarmActionRequest (Maybe Text) Source #
The value of the key used as a filter to select only the alarms associated with the key.
enableAlarmActionRequest_note :: Lens' EnableAlarmActionRequest (Maybe Text) Source #
The note that you can leave when you enable the alarm.
enableAlarmActionRequest_requestId :: Lens' EnableAlarmActionRequest Text Source #
The request ID. Each ID must be unique within each batch.
enableAlarmActionRequest_alarmModelName :: Lens' EnableAlarmActionRequest Text Source #
The name of the alarm model.
Message
Information about a message.
See: newMessage smart constructor.
Constructors
| Message' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ByteString | |
| -> Message |
Create a value of Message 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:timestamp:Message', message_timestamp - The timestamp associated with the message.
$sel:messageId:Message', message_messageId - The ID to assign to the message. Within each batch sent, each
"messageId" must be unique.
$sel:inputName:Message', message_inputName - The name of the input into which the message payload is transformed.
$sel:payload:Message', message_payload - The payload of the message. This can be a JSON string or a
Base-64-encoded string representing binary data (in which case you must
decode it).--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
message_timestamp :: Lens' Message (Maybe TimestampValue) Source #
The timestamp associated with the message.
message_messageId :: Lens' Message Text Source #
The ID to assign to the message. Within each batch sent, each
"messageId" must be unique.
message_inputName :: Lens' Message Text Source #
The name of the input into which the message payload is transformed.
message_payload :: Lens' Message ByteString Source #
The payload of the message. This can be a JSON string or a
Base-64-encoded string representing binary data (in which case you must
decode it).--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
ResetActionConfiguration
data ResetActionConfiguration Source #
Contains the configuration information of a reset action.
See: newResetActionConfiguration smart constructor.
Constructors
| ResetActionConfiguration' | |
Instances
newResetActionConfiguration :: ResetActionConfiguration Source #
Create a value of ResetActionConfiguration 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:note:ResetActionConfiguration', resetActionConfiguration_note - The note that you can leave when you reset the alarm.
resetActionConfiguration_note :: Lens' ResetActionConfiguration (Maybe Text) Source #
The note that you can leave when you reset the alarm.
ResetAlarmActionRequest
data ResetAlarmActionRequest Source #
Information needed to reset the alarm.
See: newResetAlarmActionRequest smart constructor.
Constructors
| ResetAlarmActionRequest' | |
Fields
| |
Instances
newResetAlarmActionRequest Source #
Arguments
| :: Text | |
| -> Text | |
| -> ResetAlarmActionRequest |
Create a value of ResetAlarmActionRequest 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:ResetAlarmActionRequest', resetAlarmActionRequest_keyValue - The value of the key used as a filter to select only the alarms
associated with the
key.
$sel:note:ResetAlarmActionRequest', resetAlarmActionRequest_note - The note that you can leave when you reset the alarm.
$sel:requestId:ResetAlarmActionRequest', resetAlarmActionRequest_requestId - The request ID. Each ID must be unique within each batch.
$sel:alarmModelName:ResetAlarmActionRequest', resetAlarmActionRequest_alarmModelName - The name of the alarm model.
resetAlarmActionRequest_keyValue :: Lens' ResetAlarmActionRequest (Maybe Text) Source #
The value of the key used as a filter to select only the alarms associated with the key.
resetAlarmActionRequest_note :: Lens' ResetAlarmActionRequest (Maybe Text) Source #
The note that you can leave when you reset the alarm.
resetAlarmActionRequest_requestId :: Lens' ResetAlarmActionRequest Text Source #
The request ID. Each ID must be unique within each batch.
resetAlarmActionRequest_alarmModelName :: Lens' ResetAlarmActionRequest Text Source #
The name of the alarm model.
RuleEvaluation
data RuleEvaluation Source #
Information needed to evaluate data.
See: newRuleEvaluation smart constructor.
Constructors
| RuleEvaluation' | |
Fields
| |
Instances
newRuleEvaluation :: RuleEvaluation Source #
Create a value of RuleEvaluation 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:simpleRuleEvaluation:RuleEvaluation', ruleEvaluation_simpleRuleEvaluation - Information needed to compare two values with a comparison operator.
ruleEvaluation_simpleRuleEvaluation :: Lens' RuleEvaluation (Maybe SimpleRuleEvaluation) Source #
Information needed to compare two values with a comparison operator.
SimpleRuleEvaluation
data SimpleRuleEvaluation Source #
Information needed to compare two values with a comparison operator.
See: newSimpleRuleEvaluation smart constructor.
Constructors
| SimpleRuleEvaluation' | |
Fields
| |
Instances
newSimpleRuleEvaluation :: SimpleRuleEvaluation Source #
Create a value of SimpleRuleEvaluation 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:inputPropertyValue:SimpleRuleEvaluation', simpleRuleEvaluation_inputPropertyValue - The value of the input property, on the left side of the comparison
operator.
$sel:operator:SimpleRuleEvaluation', simpleRuleEvaluation_operator - The comparison operator.
$sel:thresholdValue:SimpleRuleEvaluation', simpleRuleEvaluation_thresholdValue - The threshold value, on the right side of the comparison operator.
simpleRuleEvaluation_inputPropertyValue :: Lens' SimpleRuleEvaluation (Maybe Text) Source #
The value of the input property, on the left side of the comparison operator.
simpleRuleEvaluation_operator :: Lens' SimpleRuleEvaluation (Maybe ComparisonOperator) Source #
The comparison operator.
simpleRuleEvaluation_thresholdValue :: Lens' SimpleRuleEvaluation (Maybe Text) Source #
The threshold value, on the right side of the comparison operator.
SnoozeActionConfiguration
data SnoozeActionConfiguration Source #
Contains the configuration information of a snooze action.
See: newSnoozeActionConfiguration smart constructor.
Constructors
| SnoozeActionConfiguration' | |
Instances
newSnoozeActionConfiguration :: SnoozeActionConfiguration Source #
Create a value of SnoozeActionConfiguration 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:note:SnoozeActionConfiguration', snoozeActionConfiguration_note - The note that you can leave when you snooze the alarm.
$sel:snoozeDuration:SnoozeActionConfiguration', snoozeActionConfiguration_snoozeDuration - The snooze time in seconds. The alarm automatically changes to the
NORMAL state after this duration.
snoozeActionConfiguration_note :: Lens' SnoozeActionConfiguration (Maybe Text) Source #
The note that you can leave when you snooze the alarm.
snoozeActionConfiguration_snoozeDuration :: Lens' SnoozeActionConfiguration (Maybe Int) Source #
The snooze time in seconds. The alarm automatically changes to the
NORMAL state after this duration.
SnoozeAlarmActionRequest
data SnoozeAlarmActionRequest Source #
Information needed to snooze the alarm.
See: newSnoozeAlarmActionRequest smart constructor.
Constructors
| SnoozeAlarmActionRequest' | |
Fields
| |
Instances
newSnoozeAlarmActionRequest Source #
Arguments
| :: Text | |
| -> Text | |
| -> Int | |
| -> SnoozeAlarmActionRequest |
Create a value of SnoozeAlarmActionRequest 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:SnoozeAlarmActionRequest', snoozeAlarmActionRequest_keyValue - The value of the key used as a filter to select only the alarms
associated with the
key.
$sel:note:SnoozeAlarmActionRequest', snoozeAlarmActionRequest_note - The note that you can leave when you snooze the alarm.
$sel:requestId:SnoozeAlarmActionRequest', snoozeAlarmActionRequest_requestId - The request ID. Each ID must be unique within each batch.
$sel:alarmModelName:SnoozeAlarmActionRequest', snoozeAlarmActionRequest_alarmModelName - The name of the alarm model.
$sel:snoozeDuration:SnoozeAlarmActionRequest', snoozeAlarmActionRequest_snoozeDuration - The snooze time in seconds. The alarm automatically changes to the
NORMAL state after this duration.
snoozeAlarmActionRequest_keyValue :: Lens' SnoozeAlarmActionRequest (Maybe Text) Source #
The value of the key used as a filter to select only the alarms associated with the key.
snoozeAlarmActionRequest_note :: Lens' SnoozeAlarmActionRequest (Maybe Text) Source #
The note that you can leave when you snooze the alarm.
snoozeAlarmActionRequest_requestId :: Lens' SnoozeAlarmActionRequest Text Source #
The request ID. Each ID must be unique within each batch.
snoozeAlarmActionRequest_alarmModelName :: Lens' SnoozeAlarmActionRequest Text Source #
The name of the alarm model.
snoozeAlarmActionRequest_snoozeDuration :: Lens' SnoozeAlarmActionRequest Int Source #
The snooze time in seconds. The alarm automatically changes to the
NORMAL state after this duration.
StateChangeConfiguration
data StateChangeConfiguration Source #
Contains the configuration information of alarm state changes.
See: newStateChangeConfiguration smart constructor.
Constructors
| StateChangeConfiguration' | |
Fields
| |
Instances
newStateChangeConfiguration :: StateChangeConfiguration Source #
Create a value of StateChangeConfiguration 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:triggerType:StateChangeConfiguration', stateChangeConfiguration_triggerType - The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration
ends and the alarm automatically changes to the NORMAL state.
stateChangeConfiguration_triggerType :: Lens' StateChangeConfiguration (Maybe TriggerType) Source #
The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration
ends and the alarm automatically changes to the NORMAL state.
SystemEvent
data SystemEvent Source #
Contains information about alarm state changes.
See: newSystemEvent smart constructor.
Constructors
| SystemEvent' | |
Fields
| |
Instances
newSystemEvent :: SystemEvent Source #
Create a value of SystemEvent 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:eventType:SystemEvent', systemEvent_eventType - The event type. If the value is STATE_CHANGE, the event contains
information about alarm state changes.
$sel:stateChangeConfiguration:SystemEvent', systemEvent_stateChangeConfiguration - Contains the configuration information of alarm state changes.
systemEvent_eventType :: Lens' SystemEvent (Maybe EventType) Source #
The event type. If the value is STATE_CHANGE, the event contains
information about alarm state changes.
systemEvent_stateChangeConfiguration :: Lens' SystemEvent (Maybe StateChangeConfiguration) Source #
Contains the configuration information of alarm state changes.
Timer
The current state of a timer.
See: newTimer smart constructor.
Constructors
| Timer' | |
Instances
| FromJSON Timer Source # | |
| Generic Timer Source # | |
| Read Timer Source # | |
| Show Timer Source # | |
| NFData Timer Source # | |
Defined in Amazonka.IoTEventsData.Types.Timer | |
| Eq Timer Source # | |
| Hashable Timer Source # | |
Defined in Amazonka.IoTEventsData.Types.Timer | |
| type Rep Timer Source # | |
Defined in Amazonka.IoTEventsData.Types.Timer type Rep Timer = D1 ('MetaData "Timer" "Amazonka.IoTEventsData.Types.Timer" "amazonka-iotevents-data-2.0-2nkzod7vvQTAS38g00IbEB" 'False) (C1 ('MetaCons "Timer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) | |
Create a value of Timer 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:name:Timer', timer_name - The name of the timer.
$sel:timestamp:Timer', timer_timestamp - The expiration time for the timer.
TimerDefinition
data TimerDefinition Source #
The new setting of a timer.
See: newTimerDefinition smart constructor.
Constructors
| TimerDefinition' | |
Instances
Create a value of TimerDefinition 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:name:TimerDefinition', timerDefinition_name - The name of the timer.
$sel:seconds:TimerDefinition', timerDefinition_seconds - The new setting of the timer (the number of seconds before the timer
elapses).
timerDefinition_name :: Lens' TimerDefinition Text Source #
The name of the timer.
timerDefinition_seconds :: Lens' TimerDefinition Int Source #
The new setting of the timer (the number of seconds before the timer elapses).
TimestampValue
data TimestampValue Source #
Contains information about a timestamp.
See: newTimestampValue smart constructor.
Constructors
| TimestampValue' | |
Fields
| |
Instances
newTimestampValue :: TimestampValue Source #
Create a value of TimestampValue 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:timeInMillis:TimestampValue', timestampValue_timeInMillis - The value of the timestamp, in the Unix epoch format.
timestampValue_timeInMillis :: Lens' TimestampValue (Maybe Natural) Source #
The value of the timestamp, in the Unix epoch format.
UpdateDetectorRequest
data UpdateDetectorRequest Source #
Information used to update the detector (instance).
See: newUpdateDetectorRequest smart constructor.
Constructors
| UpdateDetectorRequest' | |
Fields
| |
Instances
newUpdateDetectorRequest Source #
Arguments
| :: Text | |
| -> Text | |
| -> DetectorStateDefinition | |
| -> UpdateDetectorRequest |
Create a value of UpdateDetectorRequest 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:UpdateDetectorRequest', updateDetectorRequest_keyValue - The value of the input key attribute (identifying the device or system)
that caused the creation of this detector (instance).
$sel:messageId:UpdateDetectorRequest', updateDetectorRequest_messageId - The ID to assign to the detector update "message". Each
"messageId" must be unique within each batch sent.
$sel:detectorModelName:UpdateDetectorRequest', updateDetectorRequest_detectorModelName - The name of the detector model that created the detectors (instances).
$sel:state:UpdateDetectorRequest', updateDetectorRequest_state - The new state, variable values, and timer settings of the detector
(instance).
updateDetectorRequest_keyValue :: Lens' UpdateDetectorRequest (Maybe Text) Source #
The value of the input key attribute (identifying the device or system) that caused the creation of this detector (instance).
updateDetectorRequest_messageId :: Lens' UpdateDetectorRequest Text Source #
The ID to assign to the detector update "message". Each
"messageId" must be unique within each batch sent.
updateDetectorRequest_detectorModelName :: Lens' UpdateDetectorRequest Text Source #
The name of the detector model that created the detectors (instances).
updateDetectorRequest_state :: Lens' UpdateDetectorRequest DetectorStateDefinition Source #
The new state, variable values, and timer settings of the detector (instance).
Variable
The current state of the variable.
See: newVariable smart constructor.
Constructors
| Variable' | |
Instances
| FromJSON Variable Source # | |
| Generic Variable Source # | |
| Read Variable Source # | |
| Show Variable Source # | |
| NFData Variable Source # | |
Defined in Amazonka.IoTEventsData.Types.Variable | |
| Eq Variable Source # | |
| Hashable Variable Source # | |
Defined in Amazonka.IoTEventsData.Types.Variable | |
| type Rep Variable Source # | |
Defined in Amazonka.IoTEventsData.Types.Variable type Rep Variable = D1 ('MetaData "Variable" "Amazonka.IoTEventsData.Types.Variable" "amazonka-iotevents-data-2.0-2nkzod7vvQTAS38g00IbEB" 'False) (C1 ('MetaCons "Variable'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Variable 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:name:Variable', variable_name - The name of the variable.
$sel:value:Variable', variable_value - The current value of the variable.
VariableDefinition
data VariableDefinition Source #
The new value of the variable.
See: newVariableDefinition smart constructor.
Constructors
| VariableDefinition' | |
Instances
newVariableDefinition Source #
Arguments
| :: Text | |
| -> Text | |
| -> VariableDefinition |
Create a value of VariableDefinition 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:name:VariableDefinition', variableDefinition_name - The name of the variable.
$sel:value:VariableDefinition', variableDefinition_value - The new value of the variable.
variableDefinition_name :: Lens' VariableDefinition Text Source #
The name of the variable.
variableDefinition_value :: Lens' VariableDefinition Text Source #
The new value of the variable.