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 |
- Operations
- Types
- 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
Synopsis
- batchAcknowledgeAlarm_acknowledgeActionRequests :: Lens' BatchAcknowledgeAlarm (NonEmpty AcknowledgeAlarmActionRequest)
- batchAcknowledgeAlarmResponse_errorEntries :: Lens' BatchAcknowledgeAlarmResponse (Maybe [BatchAlarmActionErrorEntry])
- batchAcknowledgeAlarmResponse_httpStatus :: Lens' BatchAcknowledgeAlarmResponse Int
- batchDeleteDetector_detectors :: Lens' BatchDeleteDetector (NonEmpty DeleteDetectorRequest)
- batchDeleteDetectorResponse_batchDeleteDetectorErrorEntries :: Lens' BatchDeleteDetectorResponse (Maybe [BatchDeleteDetectorErrorEntry])
- batchDeleteDetectorResponse_httpStatus :: Lens' BatchDeleteDetectorResponse Int
- batchDisableAlarm_disableActionRequests :: Lens' BatchDisableAlarm (NonEmpty DisableAlarmActionRequest)
- batchDisableAlarmResponse_errorEntries :: Lens' BatchDisableAlarmResponse (Maybe [BatchAlarmActionErrorEntry])
- batchDisableAlarmResponse_httpStatus :: Lens' BatchDisableAlarmResponse Int
- batchEnableAlarm_enableActionRequests :: Lens' BatchEnableAlarm (NonEmpty EnableAlarmActionRequest)
- batchEnableAlarmResponse_errorEntries :: Lens' BatchEnableAlarmResponse (Maybe [BatchAlarmActionErrorEntry])
- batchEnableAlarmResponse_httpStatus :: Lens' BatchEnableAlarmResponse Int
- batchPutMessage_messages :: Lens' BatchPutMessage (NonEmpty Message)
- batchPutMessageResponse_batchPutMessageErrorEntries :: Lens' BatchPutMessageResponse (Maybe [BatchPutMessageErrorEntry])
- batchPutMessageResponse_httpStatus :: Lens' BatchPutMessageResponse Int
- batchResetAlarm_resetActionRequests :: Lens' BatchResetAlarm (NonEmpty ResetAlarmActionRequest)
- batchResetAlarmResponse_errorEntries :: Lens' BatchResetAlarmResponse (Maybe [BatchAlarmActionErrorEntry])
- batchResetAlarmResponse_httpStatus :: Lens' BatchResetAlarmResponse Int
- batchSnoozeAlarm_snoozeActionRequests :: Lens' BatchSnoozeAlarm (NonEmpty SnoozeAlarmActionRequest)
- batchSnoozeAlarmResponse_errorEntries :: Lens' BatchSnoozeAlarmResponse (Maybe [BatchAlarmActionErrorEntry])
- batchSnoozeAlarmResponse_httpStatus :: Lens' BatchSnoozeAlarmResponse Int
- batchUpdateDetector_detectors :: Lens' BatchUpdateDetector (NonEmpty UpdateDetectorRequest)
- batchUpdateDetectorResponse_batchUpdateDetectorErrorEntries :: Lens' BatchUpdateDetectorResponse (Maybe [BatchUpdateDetectorErrorEntry])
- batchUpdateDetectorResponse_httpStatus :: Lens' BatchUpdateDetectorResponse Int
- describeAlarm_keyValue :: Lens' DescribeAlarm (Maybe Text)
- describeAlarm_alarmModelName :: Lens' DescribeAlarm Text
- describeAlarmResponse_alarm :: Lens' DescribeAlarmResponse (Maybe Alarm)
- describeAlarmResponse_httpStatus :: Lens' DescribeAlarmResponse Int
- describeDetector_keyValue :: Lens' DescribeDetector (Maybe Text)
- describeDetector_detectorModelName :: Lens' DescribeDetector Text
- describeDetectorResponse_detector :: Lens' DescribeDetectorResponse (Maybe Detector)
- describeDetectorResponse_httpStatus :: Lens' DescribeDetectorResponse Int
- listAlarms_maxResults :: Lens' ListAlarms (Maybe Natural)
- listAlarms_nextToken :: Lens' ListAlarms (Maybe Text)
- listAlarms_alarmModelName :: Lens' ListAlarms Text
- listAlarmsResponse_alarmSummaries :: Lens' ListAlarmsResponse (Maybe [AlarmSummary])
- listAlarmsResponse_nextToken :: Lens' ListAlarmsResponse (Maybe Text)
- listAlarmsResponse_httpStatus :: Lens' ListAlarmsResponse Int
- listDetectors_maxResults :: Lens' ListDetectors (Maybe Natural)
- listDetectors_nextToken :: Lens' ListDetectors (Maybe Text)
- listDetectors_stateName :: Lens' ListDetectors (Maybe Text)
- listDetectors_detectorModelName :: Lens' ListDetectors Text
- listDetectorsResponse_detectorSummaries :: Lens' ListDetectorsResponse (Maybe [DetectorSummary])
- listDetectorsResponse_nextToken :: Lens' ListDetectorsResponse (Maybe Text)
- listDetectorsResponse_httpStatus :: Lens' ListDetectorsResponse Int
- acknowledgeActionConfiguration_note :: Lens' AcknowledgeActionConfiguration (Maybe Text)
- acknowledgeAlarmActionRequest_keyValue :: Lens' AcknowledgeAlarmActionRequest (Maybe Text)
- acknowledgeAlarmActionRequest_note :: Lens' AcknowledgeAlarmActionRequest (Maybe Text)
- acknowledgeAlarmActionRequest_requestId :: Lens' AcknowledgeAlarmActionRequest Text
- acknowledgeAlarmActionRequest_alarmModelName :: Lens' AcknowledgeAlarmActionRequest Text
- 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)
- alarmState_customerAction :: Lens' AlarmState (Maybe CustomerAction)
- alarmState_ruleEvaluation :: Lens' AlarmState (Maybe RuleEvaluation)
- alarmState_stateName :: Lens' AlarmState (Maybe AlarmStateName)
- alarmState_systemEvent :: Lens' AlarmState (Maybe SystemEvent)
- 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)
- batchAlarmActionErrorEntry_errorCode :: Lens' BatchAlarmActionErrorEntry (Maybe ErrorCode)
- batchAlarmActionErrorEntry_errorMessage :: Lens' BatchAlarmActionErrorEntry (Maybe Text)
- batchAlarmActionErrorEntry_requestId :: Lens' BatchAlarmActionErrorEntry (Maybe Text)
- batchDeleteDetectorErrorEntry_errorCode :: Lens' BatchDeleteDetectorErrorEntry (Maybe ErrorCode)
- batchDeleteDetectorErrorEntry_errorMessage :: Lens' BatchDeleteDetectorErrorEntry (Maybe Text)
- batchDeleteDetectorErrorEntry_messageId :: Lens' BatchDeleteDetectorErrorEntry (Maybe Text)
- batchPutMessageErrorEntry_errorCode :: Lens' BatchPutMessageErrorEntry (Maybe ErrorCode)
- batchPutMessageErrorEntry_errorMessage :: Lens' BatchPutMessageErrorEntry (Maybe Text)
- batchPutMessageErrorEntry_messageId :: Lens' BatchPutMessageErrorEntry (Maybe Text)
- batchUpdateDetectorErrorEntry_errorCode :: Lens' BatchUpdateDetectorErrorEntry (Maybe ErrorCode)
- batchUpdateDetectorErrorEntry_errorMessage :: Lens' BatchUpdateDetectorErrorEntry (Maybe Text)
- batchUpdateDetectorErrorEntry_messageId :: Lens' BatchUpdateDetectorErrorEntry (Maybe Text)
- 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)
- deleteDetectorRequest_keyValue :: Lens' DeleteDetectorRequest (Maybe Text)
- deleteDetectorRequest_messageId :: Lens' DeleteDetectorRequest Text
- deleteDetectorRequest_detectorModelName :: Lens' DeleteDetectorRequest Text
- 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)
- detectorState_stateName :: Lens' DetectorState Text
- detectorState_variables :: Lens' DetectorState [Variable]
- detectorState_timers :: Lens' DetectorState [Timer]
- detectorStateDefinition_stateName :: Lens' DetectorStateDefinition Text
- detectorStateDefinition_variables :: Lens' DetectorStateDefinition [VariableDefinition]
- detectorStateDefinition_timers :: Lens' DetectorStateDefinition [TimerDefinition]
- detectorStateSummary_stateName :: Lens' DetectorStateSummary (Maybe Text)
- 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)
- disableActionConfiguration_note :: Lens' DisableActionConfiguration (Maybe Text)
- disableAlarmActionRequest_keyValue :: Lens' DisableAlarmActionRequest (Maybe Text)
- disableAlarmActionRequest_note :: Lens' DisableAlarmActionRequest (Maybe Text)
- disableAlarmActionRequest_requestId :: Lens' DisableAlarmActionRequest Text
- disableAlarmActionRequest_alarmModelName :: Lens' DisableAlarmActionRequest Text
- enableActionConfiguration_note :: Lens' EnableActionConfiguration (Maybe Text)
- enableAlarmActionRequest_keyValue :: Lens' EnableAlarmActionRequest (Maybe Text)
- enableAlarmActionRequest_note :: Lens' EnableAlarmActionRequest (Maybe Text)
- enableAlarmActionRequest_requestId :: Lens' EnableAlarmActionRequest Text
- enableAlarmActionRequest_alarmModelName :: Lens' EnableAlarmActionRequest Text
- message_timestamp :: Lens' Message (Maybe TimestampValue)
- message_messageId :: Lens' Message Text
- message_inputName :: Lens' Message Text
- message_payload :: Lens' Message ByteString
- resetActionConfiguration_note :: Lens' ResetActionConfiguration (Maybe Text)
- resetAlarmActionRequest_keyValue :: Lens' ResetAlarmActionRequest (Maybe Text)
- resetAlarmActionRequest_note :: Lens' ResetAlarmActionRequest (Maybe Text)
- resetAlarmActionRequest_requestId :: Lens' ResetAlarmActionRequest Text
- resetAlarmActionRequest_alarmModelName :: Lens' ResetAlarmActionRequest Text
- ruleEvaluation_simpleRuleEvaluation :: Lens' RuleEvaluation (Maybe SimpleRuleEvaluation)
- simpleRuleEvaluation_inputPropertyValue :: Lens' SimpleRuleEvaluation (Maybe Text)
- simpleRuleEvaluation_operator :: Lens' SimpleRuleEvaluation (Maybe ComparisonOperator)
- simpleRuleEvaluation_thresholdValue :: Lens' SimpleRuleEvaluation (Maybe Text)
- snoozeActionConfiguration_note :: Lens' SnoozeActionConfiguration (Maybe Text)
- snoozeActionConfiguration_snoozeDuration :: Lens' SnoozeActionConfiguration (Maybe Int)
- 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
- stateChangeConfiguration_triggerType :: Lens' StateChangeConfiguration (Maybe TriggerType)
- systemEvent_eventType :: Lens' SystemEvent (Maybe EventType)
- systemEvent_stateChangeConfiguration :: Lens' SystemEvent (Maybe StateChangeConfiguration)
- timer_name :: Lens' Timer Text
- timer_timestamp :: Lens' Timer UTCTime
- timerDefinition_name :: Lens' TimerDefinition Text
- timerDefinition_seconds :: Lens' TimerDefinition Int
- timestampValue_timeInMillis :: Lens' TimestampValue (Maybe Natural)
- updateDetectorRequest_keyValue :: Lens' UpdateDetectorRequest (Maybe Text)
- updateDetectorRequest_messageId :: Lens' UpdateDetectorRequest Text
- updateDetectorRequest_detectorModelName :: Lens' UpdateDetectorRequest Text
- updateDetectorRequest_state :: Lens' UpdateDetectorRequest DetectorStateDefinition
- variable_name :: Lens' Variable Text
- variable_value :: Lens' Variable Text
- variableDefinition_name :: Lens' VariableDefinition Text
- variableDefinition_value :: Lens' VariableDefinition Text
Operations
BatchAcknowledgeAlarm
batchAcknowledgeAlarm_acknowledgeActionRequests :: Lens' BatchAcknowledgeAlarm (NonEmpty AcknowledgeAlarmActionRequest) Source #
The list of acknowledge action requests. You can specify up to 10 requests per operation.
batchAcknowledgeAlarmResponse_errorEntries :: Lens' BatchAcknowledgeAlarmResponse (Maybe [BatchAlarmActionErrorEntry]) Source #
A list of errors associated with the request, or null
if there are no
errors. Each error entry contains an entry ID that helps you identify
the entry that failed.
batchAcknowledgeAlarmResponse_httpStatus :: Lens' BatchAcknowledgeAlarmResponse Int Source #
The response's http status code.
BatchDeleteDetector
batchDeleteDetector_detectors :: Lens' BatchDeleteDetector (NonEmpty DeleteDetectorRequest) Source #
The list of one or more detectors to be deleted.
batchDeleteDetectorResponse_batchDeleteDetectorErrorEntries :: Lens' BatchDeleteDetectorResponse (Maybe [BatchDeleteDetectorErrorEntry]) Source #
A list of errors associated with the request, or an empty array ([]
)
if there are no errors. Each error entry contains a messageId
that
helps you identify the entry that failed.
batchDeleteDetectorResponse_httpStatus :: Lens' BatchDeleteDetectorResponse Int Source #
The response's http status code.
BatchDisableAlarm
batchDisableAlarm_disableActionRequests :: Lens' BatchDisableAlarm (NonEmpty DisableAlarmActionRequest) Source #
The list of disable action requests. You can specify up to 10 requests per operation.
batchDisableAlarmResponse_errorEntries :: Lens' BatchDisableAlarmResponse (Maybe [BatchAlarmActionErrorEntry]) Source #
A list of errors associated with the request, or null
if there are no
errors. Each error entry contains an entry ID that helps you identify
the entry that failed.
batchDisableAlarmResponse_httpStatus :: Lens' BatchDisableAlarmResponse Int Source #
The response's http status code.
BatchEnableAlarm
batchEnableAlarm_enableActionRequests :: Lens' BatchEnableAlarm (NonEmpty EnableAlarmActionRequest) Source #
The list of enable action requests. You can specify up to 10 requests per operation.
batchEnableAlarmResponse_errorEntries :: Lens' BatchEnableAlarmResponse (Maybe [BatchAlarmActionErrorEntry]) Source #
A list of errors associated with the request, or null
if there are no
errors. Each error entry contains an entry ID that helps you identify
the entry that failed.
batchEnableAlarmResponse_httpStatus :: Lens' BatchEnableAlarmResponse Int Source #
The response's http status code.
BatchPutMessage
batchPutMessage_messages :: Lens' BatchPutMessage (NonEmpty Message) Source #
The list of messages to send. Each message has the following format:
'{ "messageId": "string", "inputName": "string", "payload": "string"}'
batchPutMessageResponse_batchPutMessageErrorEntries :: Lens' BatchPutMessageResponse (Maybe [BatchPutMessageErrorEntry]) Source #
A list of any errors encountered when sending the messages.
batchPutMessageResponse_httpStatus :: Lens' BatchPutMessageResponse Int Source #
The response's http status code.
BatchResetAlarm
batchResetAlarm_resetActionRequests :: Lens' BatchResetAlarm (NonEmpty ResetAlarmActionRequest) Source #
The list of reset action requests. You can specify up to 10 requests per operation.
batchResetAlarmResponse_errorEntries :: Lens' BatchResetAlarmResponse (Maybe [BatchAlarmActionErrorEntry]) Source #
A list of errors associated with the request, or null
if there are no
errors. Each error entry contains an entry ID that helps you identify
the entry that failed.
batchResetAlarmResponse_httpStatus :: Lens' BatchResetAlarmResponse Int Source #
The response's http status code.
BatchSnoozeAlarm
batchSnoozeAlarm_snoozeActionRequests :: Lens' BatchSnoozeAlarm (NonEmpty SnoozeAlarmActionRequest) Source #
The list of snooze action requests. You can specify up to 10 requests per operation.
batchSnoozeAlarmResponse_errorEntries :: Lens' BatchSnoozeAlarmResponse (Maybe [BatchAlarmActionErrorEntry]) Source #
A list of errors associated with the request, or null
if there are no
errors. Each error entry contains an entry ID that helps you identify
the entry that failed.
batchSnoozeAlarmResponse_httpStatus :: Lens' BatchSnoozeAlarmResponse Int Source #
The response's http status code.
BatchUpdateDetector
batchUpdateDetector_detectors :: Lens' BatchUpdateDetector (NonEmpty UpdateDetectorRequest) Source #
The list of detectors (instances) to update, along with the values to update.
batchUpdateDetectorResponse_batchUpdateDetectorErrorEntries :: Lens' BatchUpdateDetectorResponse (Maybe [BatchUpdateDetectorErrorEntry]) Source #
A list of those detector updates that resulted in errors. (If an error is listed here, the specific update did not occur.)
batchUpdateDetectorResponse_httpStatus :: Lens' BatchUpdateDetectorResponse Int Source #
The response's http status code.
DescribeAlarm
describeAlarm_keyValue :: Lens' DescribeAlarm (Maybe Text) Source #
The value of the key used as a filter to select only the alarms associated with the key.
describeAlarm_alarmModelName :: Lens' DescribeAlarm Text Source #
The name of the alarm model.
describeAlarmResponse_alarm :: Lens' DescribeAlarmResponse (Maybe Alarm) Source #
Contains information about an alarm.
describeAlarmResponse_httpStatus :: Lens' DescribeAlarmResponse Int Source #
The response's http status code.
DescribeDetector
describeDetector_keyValue :: Lens' DescribeDetector (Maybe Text) Source #
A filter used to limit results to detectors (instances) created because of the given key ID.
describeDetector_detectorModelName :: Lens' DescribeDetector Text Source #
The name of the detector model whose detectors (instances) you want information about.
describeDetectorResponse_detector :: Lens' DescribeDetectorResponse (Maybe Detector) Source #
Information about the detector (instance).
describeDetectorResponse_httpStatus :: Lens' DescribeDetectorResponse Int Source #
The response's http status code.
ListAlarms
listAlarms_maxResults :: Lens' ListAlarms (Maybe Natural) Source #
The maximum number of results to be returned per request.
listAlarms_nextToken :: Lens' ListAlarms (Maybe Text) Source #
The token that you can use to return the next set of results.
listAlarms_alarmModelName :: Lens' ListAlarms Text Source #
The name of the alarm model.
listAlarmsResponse_alarmSummaries :: Lens' ListAlarmsResponse (Maybe [AlarmSummary]) Source #
A list that summarizes each alarm.
listAlarmsResponse_nextToken :: Lens' ListAlarmsResponse (Maybe Text) Source #
The token that you can use to return the next set of results, or null
if there are no more results.
listAlarmsResponse_httpStatus :: Lens' ListAlarmsResponse Int Source #
The response's http status code.
ListDetectors
listDetectors_maxResults :: Lens' ListDetectors (Maybe Natural) Source #
The maximum number of results to be returned per request.
listDetectors_nextToken :: Lens' ListDetectors (Maybe Text) Source #
The token that you can use to return the next set of results.
listDetectors_stateName :: Lens' ListDetectors (Maybe Text) Source #
A filter that limits results to those detectors (instances) in the given state.
listDetectors_detectorModelName :: Lens' ListDetectors Text Source #
The name of the detector model whose detectors (instances) are listed.
listDetectorsResponse_detectorSummaries :: Lens' ListDetectorsResponse (Maybe [DetectorSummary]) Source #
A list of summary information about the detectors (instances).
listDetectorsResponse_nextToken :: Lens' ListDetectorsResponse (Maybe Text) Source #
The token that you can use to return the next set of results, or null
if there are no more results.
listDetectorsResponse_httpStatus :: Lens' ListDetectorsResponse Int Source #
The response's http status code.
Types
AcknowledgeActionConfiguration
acknowledgeActionConfiguration_note :: Lens' AcknowledgeActionConfiguration (Maybe Text) Source #
The note that you can leave when you acknowledge the alarm.
AcknowledgeAlarmActionRequest
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
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
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 theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state.NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data.ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked.ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm.SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state.LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
alarmState_systemEvent :: Lens' AlarmState (Maybe SystemEvent) Source #
Contains information about alarm state changes.
AlarmSummary
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 theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state.NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data.ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked.ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm.SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state.LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
BatchAlarmActionErrorEntry
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
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
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
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
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
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
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
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
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
detectorStateSummary_stateName :: Lens' DetectorStateSummary (Maybe Text) Source #
The name of the state.
DetectorSummary
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
disableActionConfiguration_note :: Lens' DisableActionConfiguration (Maybe Text) Source #
The note that you can leave when you disable the alarm.
DisableAlarmActionRequest
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
enableActionConfiguration_note :: Lens' EnableActionConfiguration (Maybe Text) Source #
The note that you can leave when you enable the alarm.
EnableAlarmActionRequest
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
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
resetActionConfiguration_note :: Lens' ResetActionConfiguration (Maybe Text) Source #
The note that you can leave when you reset the alarm.
ResetAlarmActionRequest
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
ruleEvaluation_simpleRuleEvaluation :: Lens' RuleEvaluation (Maybe SimpleRuleEvaluation) Source #
Information needed to compare two values with a comparison operator.
SimpleRuleEvaluation
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
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
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
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
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
TimerDefinition
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
timestampValue_timeInMillis :: Lens' TimestampValue (Maybe Natural) Source #
The value of the timestamp, in the Unix epoch format.
UpdateDetectorRequest
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
VariableDefinition
variableDefinition_name :: Lens' VariableDefinition Text Source #
The name of the variable.
variableDefinition_value :: Lens' VariableDefinition Text Source #
The new value of the variable.