AWS.IoTEventsData (aws-elixir v0.9.2) View Source
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur.
You can use AWS IoT Events Data API commands to send inputs to detectors, list detectors, and view or update a detector's status.
For more information, see What is AWS IoT Events? in the AWS IoT Events Developer Guide.
Link to this section Summary
Functions
Acknowledges one or more alarms.
Disables one or more alarms.
Enables one or more alarms.
Sends a set of messages to the AWS IoT Events system.
Resets one or more alarms.
Changes one or more alarms to the snooze mode.
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
Retrieves information about an alarm.
Returns information about the specified detector (instance).
Lists one or more alarms.
Lists detectors (the instances of a detector model).
Link to this section Functions
Acknowledges one or more alarms.
The alarms change to the ACKNOWLEDGED state after you acknowledge them.
Disables one or more alarms.
The alarms change to the DISABLED state after you disable them.
Enables one or more alarms.
The alarms change to the NORMAL state after you enable them.
Sends a set of messages to the AWS IoT Events system.
Each message payload is transformed into the input you specify ("inputName")
and ingested into any detectors that monitor that input. If multiple messages
are sent, the order in which the messages are processed isn't guaranteed. To
guarantee ordering, you must send messages one at a time and wait for a
successful response.
Resets one or more alarms.
The alarms return to the NORMAL state after you reset them.
Changes one or more alarms to the snooze mode.
The alarms change to the SNOOZE_DISABLED state after you set them to the
snooze mode.
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
describe_alarm(client, alarm_model_name, key_value \\ nil, options \\ [])
View SourceRetrieves information about an alarm.
describe_detector(client, detector_model_name, key_value \\ nil, options \\ [])
View SourceReturns information about the specified detector (instance).
list_alarms(client, alarm_model_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists one or more alarms.
The operation returns only the metadata associated with each alarm.
list_detectors(client, detector_model_name, max_results \\ nil, next_token \\ nil, state_name \\ nil, options \\ [])
View SourceLists detectors (the instances of a detector model).