AWS.IoTEventsData — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use 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 IoT Events? in the IoT Events Developer Guide.

Sending a Request Using IoTEventsData

var ioteventsdata = new AWS.IoTEventsData();
ioteventsdata.batchAcknowledgeAlarm(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 Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

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

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

batchAcknowledgeAlarm(params = {}, callback) ⇒ AWS.Request

Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.

batchDeleteDetector(params = {}, callback) ⇒ AWS.Request

Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call.

batchDisableAlarm(params = {}, callback) ⇒ AWS.Request

Disables one or more alarms. The alarms change to the DISABLED state after you disable them.

batchEnableAlarm(params = {}, callback) ⇒ AWS.Request

Enables one or more alarms. The alarms change to the NORMAL state after you enable them.

batchPutMessage(params = {}, callback) ⇒ AWS.Request

Sends a set of messages to the 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.

batchResetAlarm(params = {}, callback) ⇒ AWS.Request

Resets one or more alarms. The alarms return to the NORMAL state after you reset them.

batchSnoozeAlarm(params = {}, callback) ⇒ AWS.Request

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.

batchUpdateDetector(params = {}, callback) ⇒ AWS.Request

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

describeAlarm(params = {}, callback) ⇒ AWS.Request

Retrieves information about an alarm.

describeDetector(params = {}, callback) ⇒ AWS.Request

Returns information about the specified detector (instance).

listAlarms(params = {}, callback) ⇒ AWS.Request

Lists one or more alarms. The operation returns only the metadata associated with each alarm.

listDetectors(params = {}, callback) ⇒ AWS.Request

Lists detectors (the instances of a detector model).