AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.IoTEventsData

Inherits:
AWS.Service show all
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();

Version:

  • 2018-10-23

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a IoTEventsData object

var ioteventsdata = new AWS.IoTEventsData({apiVersion: '2018-10-23'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.IoTEventsData.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.IoTEventsData.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.IoTEventsData.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

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.

Service Reference:

Examples:

Calling the batchPutMessage operation

var params = {
  messages: [ /* required */
    {
      inputName: 'STRING_VALUE', /* required */
      messageId: 'STRING_VALUE', /* required */
      payload: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */
    },
    /* more items */
  ]
};
ioteventsdata.batchPutMessage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • messages — (Array<map>)

      The list of messages to send. Each message has the following format: '{ "messageId": "string", "inputName": "string", "payload": "string"}'

      • messageIdrequired — (String)

        The ID to assign to the message. Within each batch sent, each "messageId" must be unique.

      • inputNamerequired — (String)

        The name of the input into which the message payload is transformed.

      • payloadrequired — (Buffer, Typed Array, Blob, String)

        The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BatchPutMessageErrorEntries — (Array<map>)

        A list of any errors encountered when sending the messages.

        • messageId — (String)

          The ID of the message that caused the error. (See the value corresponding to the "messageId" key in the "message" object.)

        • errorCode — (String)

          The code associated with the error.

          Possible values include:
          • "ResourceNotFoundException"
          • "InvalidRequestException"
          • "InternalFailureException"
          • "ServiceUnavailableException"
          • "ThrottlingException"
        • errorMessage — (String)

          More information about the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the batchUpdateDetector operation

var params = {
  detectors: [ /* required */
    {
      detectorModelName: 'STRING_VALUE', /* required */
      messageId: 'STRING_VALUE', /* required */
      state: { /* required */
        stateName: 'STRING_VALUE', /* required */
        timers: [ /* required */
          {
            name: 'STRING_VALUE', /* required */
            seconds: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ],
        variables: [ /* required */
          {
            name: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      keyValue: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ioteventsdata.batchUpdateDetector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • detectors — (Array<map>)

      The list of detectors (instances) to update, along with the values to update.

      • messageIdrequired — (String)

        The ID to assign to the detector update "message". Each "messageId" must be unique within each batch sent.

      • detectorModelNamerequired — (String)

        The name of the detector model that created the detectors (instances).

      • keyValue — (String)

        The value of the input key attribute (identifying the device or system) that caused the creation of this detector (instance).

      • staterequired — (map)

        The new state, variable values, and timer settings of the detector (instance).

        • stateNamerequired — (String)

          The name of the new state of the detector (instance).

        • variablesrequired — (Array<map>)

          The new values of the detector's variables. Any variable whose value isn't specified is cleared.

          • namerequired — (String)

            The name of the variable.

          • valuerequired — (String)

            The new value of the variable.

        • timersrequired — (Array<map>)

          The new values of the detector's timers. Any timer whose value isn't specified is cleared, and its timeout event won't occur.

          • namerequired — (String)

            The name of the timer.

          • secondsrequired — (Integer)

            The new setting of the timer (the number of seconds before the timer elapses).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • batchUpdateDetectorErrorEntries — (Array<map>)

        A list of those detector updates that resulted in errors. (If an error is listed here, the specific update did not occur.)

        • messageId — (String)

          The "messageId" of the update request that caused the error. (The value of the "messageId" in the update request "Detector" object.)

        • errorCode — (String)

          The code of the error.

          Possible values include:
          • "ResourceNotFoundException"
          • "InvalidRequestException"
          • "InternalFailureException"
          • "ServiceUnavailableException"
          • "ThrottlingException"
        • errorMessage — (String)

          A message describing the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns information about the specified detector (instance).

Service Reference:

Examples:

Calling the describeDetector operation

var params = {
  detectorModelName: 'STRING_VALUE', /* required */
  keyValue: 'STRING_VALUE'
};
ioteventsdata.describeDetector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • detectorModelName — (String)

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

    • keyValue — (String)

      A filter used to limit results to detectors (instances) created because of the given key ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • detector — (map)

        Information about the detector (instance).

        • detectorModelName — (String)

          The name of the detector model that created this detector (instance).

        • keyValue — (String)

          The value of the key (identifying the device or system) that caused the creation of this detector (instance).

        • detectorModelVersion — (String)

          The version of the detector model that created this detector (instance).

        • state — (map)

          The current state of the detector (instance).

          • stateNamerequired — (String)

            The name of the state.

          • variablesrequired — (Array<map>)

            The current values of the detector's variables.

            • namerequired — (String)

              The name of the variable.

            • valuerequired — (String)

              The current value of the variable.

          • timersrequired — (Array<map>)

            The current state of the detector's timers.

            • namerequired — (String)

              The name of the timer.

            • timestamprequired — (Date)

              The number of seconds which have elapsed on the timer.

        • creationTime — (Date)

          The time the detector (instance) was created.

        • lastUpdateTime — (Date)

          The time the detector (instance) was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists detectors (the instances of a detector model).

Service Reference:

Examples:

Calling the listDetectors operation

var params = {
  detectorModelName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  stateName: 'STRING_VALUE'
};
ioteventsdata.listDetectors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • detectorModelName — (String)

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

    • stateName — (String)

      A filter that limits results to those detectors (instances) in the given state.

    • nextToken — (String)

      The token for the next set of results.

    • maxResults — (Integer)

      The maximum number of results to return at one time.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • detectorSummaries — (Array<map>)

        A list of summary information about the detectors (instances).

        • detectorModelName — (String)

          The name of the detector model that created this detector (instance).

        • keyValue — (String)

          The value of the key (identifying the device or system) that caused the creation of this detector (instance).

        • detectorModelVersion — (String)

          The version of the detector model that created this detector (instance).

        • state — (map)

          The current state of the detector (instance).

          • stateName — (String)

            The name of the state.

        • creationTime — (Date)

          The time the detector (instance) was created.

        • lastUpdateTime — (Date)

          The time the detector (instance) was last updated.

      • nextToken — (String)

        A token to retrieve the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.