AWS.IoTEventsData (aws-elixir v0.8.0) 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

Sends a set of messages to the AWS IoT Events system.

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.

Returns information about the specified detector (instance).

Link to this section Functions

Link to this function

batch_acknowledge_alarm(client, input, options \\ [])

View Source

Acknowledges one or more alarms.

The alarms change to the ACKNOWLEDGED state after you acknowledge them.

Link to this function

batch_disable_alarm(client, input, options \\ [])

View Source

Disables one or more alarms.

The alarms change to the DISABLED state after you disable them.

Link to this function

batch_enable_alarm(client, input, options \\ [])

View Source

Enables one or more alarms.

The alarms change to the NORMAL state after you enable them.

Link to this function

batch_put_message(client, input, options \\ [])

View Source

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.

Link to this function

batch_reset_alarm(client, input, options \\ [])

View Source

Resets one or more alarms.

The alarms return to the NORMAL state after you reset them.

Link to this function

batch_snooze_alarm(client, input, options \\ [])

View Source

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.

Link to this function

batch_update_detector(client, input, options \\ [])

View Source

Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.

Link to this function

describe_alarm(client, alarm_model_name, key_value \\ nil, options \\ [])

View Source

Retrieves information about an alarm.

Link to this function

describe_detector(client, detector_model_name, key_value \\ nil, options \\ [])

View Source

Returns information about the specified detector (instance).

Link to this function

list_alarms(client, alarm_model_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists one or more alarms.

The operation returns only the metadata associated with each alarm.

Link to this function

list_detectors(client, detector_model_name, max_results \\ nil, next_token \\ nil, state_name \\ nil, options \\ [])

View Source

Lists detectors (the instances of a detector model).