Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).
The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.
Class: AWS.IoTEventsData
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.IoTEventsData
- Identifier:
- ioteventsdata
- API Version:
- 2018-10-23
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. AWS IoT Events Data API commands enable you to send inputs to detectors, list detectors, and view or update a detector's status.
Sending a Request Using IoTEventsData
var ioteventsdata = new AWS.IoTEventsData();
ioteventsdata.batchPutMessage(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the IoTEventsData object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var ioteventsdata = new AWS.IoTEventsData({apiVersion: '2018-10-23'});
You can also set the API version globally in AWS.config.apiVersions
using
the ioteventsdata service identifier:
AWS.config.apiVersions = {
ioteventsdata: '2018-10-23',
// other service API versions
};
var ioteventsdata = new AWS.IoTEventsData();
Constructor Summary collapse
-
new AWS.IoTEventsData(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
batchPutMessage(params = {}, callback) ⇒ AWS.Request
Sends a set of messages to the AWS IoT Events system.
-
batchUpdateDetector(params = {}, callback) ⇒ AWS.Request
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
-
describeDetector(params = {}, callback) ⇒ AWS.Request
Returns information about the specified detector (instance).
-
listDetectors(params = {}, callback) ⇒ AWS.Request
Lists detectors (the instances of a detector model).
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.IoTEventsData(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
batchPutMessage(params = {}, callback) ⇒ AWS.Request
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.
batchUpdateDetector(params = {}, callback) ⇒ AWS.Request
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.