Iot Events Data

This page documents function available when using the Iot_Events_Data module, created with @service Iot_Events_Data.

Index

Documentation

Main.Iot_Events_Data.batch_put_messageMethod
batch_put_message(messages)
batch_put_message(messages, params::Dict{String,<:Any})

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.

Arguments

  • messages: The list of messages to send. Each message has the following format: '{ "messageId": "string", "inputName": "string", "payload": "string"}'
source
Main.Iot_Events_Data.batch_update_detectorMethod
batch_update_detector(detectors)
batch_update_detector(detectors, params::Dict{String,<:Any})

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

Arguments

  • detectors: The list of detectors (instances) to update, along with the values to update.
source
Main.Iot_Events_Data.describe_detectorMethod
describe_detector(detector_model_name)
describe_detector(detector_model_name, params::Dict{String,<:Any})

Returns information about the specified detector (instance).

Arguments

  • detector_model_name: The name of the detector model whose detectors (instances) you want information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "keyValue": A filter used to limit results to detectors (instances) created because of the given key ID.
source
Main.Iot_Events_Data.list_detectorsMethod
list_detectors(detector_model_name)
list_detectors(detector_model_name, params::Dict{String,<:Any})

Lists detectors (the instances of a detector model).

Arguments

  • detector_model_name: The name of the detector model whose detectors (instances) are listed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return at one time.
  • "nextToken": The token for the next set of results.
  • "stateName": A filter that limits results to those detectors (instances) in the given state.
source