String note
The note that you can leave when you acknowledge the alarm.
String requestId
The request ID. Each ID must be unique within each batch.
String alarmModelName
The name of the alarm model.
String keyValue
The value of the key used as a filter to select only the alarms associated with the key.
String note
The note that you can leave when you acknowledge the alarm.
String alarmModelName
The name of the alarm model.
String alarmModelVersion
The version of the alarm model.
String keyValue
The value of the key used as a filter to select only the alarms associated with the key.
AlarmState alarmState
Contains information about the current state of the alarm.
Integer severity
A non-negative integer that reflects the severity level of the alarm.
Date creationTime
The time the alarm was created, in the Unix epoch format.
Date lastUpdateTime
The time the alarm was last updated, in the Unix epoch format.
String stateName
The name of the alarm state. The state name can be one of the following values:
DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To
enable the alarm, you must change the alarm to the NORMAL state.
NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and
you acknowledged the alarm.
SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled
for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL
state.
LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the
data that the alarm is currently evaluating is within the specified range. To change the alarm to the
NORMAL state, you must acknowledge the alarm.
RuleEvaluation ruleEvaluation
Information needed to evaluate data.
CustomerAction customerAction
Contains information about the action that you can take to respond to the alarm.
SystemEvent systemEvent
Contains information about alarm state changes.
String alarmModelName
The name of the alarm model.
String alarmModelVersion
The version of the alarm model.
String keyValue
The value of the key used as a filter to select only the alarms associated with the key.
String stateName
The name of the alarm state. The state name can be one of the following values:
DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To
enable the alarm, you must change the alarm to the NORMAL state.
NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and
you acknowledged the alarm.
SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled
for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL
state.
LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the
data that the alarm is currently evaluating is within the specified range. To change the alarm to the
NORMAL state, you must acknowledge the alarm.
Date creationTime
The time the alarm was created, in the Unix epoch format.
Date lastUpdateTime
The time the alarm was last updated, in the Unix epoch format.
String actionName
The name of the action. The action name can be one of the following values:
SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.
ENABLE - When you enable the alarm, the alarm state changes to NORMAL.
DISABLE - When you disable the alarm, the alarm state changes to DISABLED.
ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.
RESET - When you reset the alarm, the alarm state changes to NORMAL.
For more information, see the AlarmState API.
SnoozeActionConfiguration snoozeActionConfiguration
Contains the configuration information of a snooze action.
EnableActionConfiguration enableActionConfiguration
Contains the configuration information of an enable action.
DisableActionConfiguration disableActionConfiguration
Contains the configuration information of a disable action.
AcknowledgeActionConfiguration acknowledgeActionConfiguration
Contains the configuration information of an acknowledge action.
ResetActionConfiguration resetActionConfiguration
Contains the configuration information of a reset action.
Alarm alarm
Contains information about an alarm.
Detector detector
Information about the detector (instance).
String detectorModelName
The name of the detector model that created this detector (instance).
String keyValue
The value of the key (identifying the device or system) that caused the creation of this detector (instance).
String detectorModelVersion
The version of the detector model that created this detector (instance).
DetectorState state
The current state of the detector (instance).
Date creationTime
The time the detector (instance) was created.
Date lastUpdateTime
The time the detector (instance) was last updated.
String stateName
The name of the new state of the detector (instance).
List<E> variables
The new values of the detector's variables. Any variable whose value isn't specified is cleared.
List<E> 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.
String stateName
The name of the state.
String detectorModelName
The name of the detector model that created this detector (instance).
String keyValue
The value of the key (identifying the device or system) that caused the creation of this detector (instance).
String detectorModelVersion
The version of the detector model that created this detector (instance).
DetectorStateSummary state
The current state of the detector (instance).
Date creationTime
The time the detector (instance) was created.
Date lastUpdateTime
The time the detector (instance) was last updated.
String note
The note that you can leave when you disable the alarm.
String requestId
The request ID. Each ID must be unique within each batch.
String alarmModelName
The name of the alarm model.
String keyValue
The value of the key used as a filter to select only the alarms associated with the key.
String note
The note that you can leave when you disable the alarm.
String note
The note that you can leave when you enable the alarm.
String requestId
The request ID. Each ID must be unique within each batch.
String alarmModelName
The name of the alarm model.
String keyValue
The value of the key used as a filter to select only the alarms associated with the key.
String note
The note that you can leave when you enable the alarm.
String detectorModelName
The name of the detector model whose detectors (instances) are listed.
String stateName
A filter that limits results to those detectors (instances) in the given state.
String nextToken
The token that you can use to return the next set of results.
Integer maxResults
The maximum number of results to be returned per request.
String messageId
The ID to assign to the message. Within each batch sent, each "messageId" must be unique.
String inputName
The name of the input into which the message payload is transformed.
ByteBuffer 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).
TimestampValue timestamp
The timestamp associated with the message.
String note
The note that you can leave when you reset the alarm.
String requestId
The request ID. Each ID must be unique within each batch.
String alarmModelName
The name of the alarm model.
String keyValue
The value of the key used as a filter to select only the alarms associated with the key.
String note
The note that you can leave when you reset the alarm.
SimpleRuleEvaluation simpleRuleEvaluation
Information needed to compare two values with a comparison operator.
String requestId
The request ID. Each ID must be unique within each batch.
String alarmModelName
The name of the alarm model.
String keyValue
The value of the key used as a filter to select only the alarms associated with the key.
String note
The note that you can leave when you snooze the alarm.
Integer snoozeDuration
The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.
String triggerType
The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration ends and the alarm
automatically changes to the NORMAL state.
String eventType
The event type. If the value is STATE_CHANGE, the event contains information about alarm state
changes.
StateChangeConfiguration stateChangeConfiguration
Contains the configuration information of alarm state changes.
Long timeInMillis
The value of the timestamp, in the Unix epoch format.
String messageId
The ID to assign to the detector update "message". Each "messageId" must be unique
within each batch sent.
String detectorModelName
The name of the detector model that created the detectors (instances).
String keyValue
The value of the input key attribute (identifying the device or system) that caused the creation of this detector (instance).
DetectorStateDefinition state
The new state, variable values, and timer settings of the detector (instance).
Copyright © 2022. All rights reserved.