Class: AWS.IoTEventsData

var params = {
  detectors: [ /* required */
    {
      detectorModelName: 'STRING_VALUE', /* required */
      messageId: 'STRING_VALUE', /* required */
      keyValue: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ioteventsdata.batchDeleteDetector(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 one or more detectors to be deleted.

    • messageId — required — (String)

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

    • detectorModelName — required — (String)

      The name of the detector model that was used to create the detector instance.

    • keyValue — (String)

      The value of the key used to identify the detector.

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:

    • batchDeleteDetectorErrorEntries — (Array<map>)

      A list of errors associated with the request, or an empty array ([]) if there are no errors. Each error entry contains a messageId that helps you identify the entry that failed.

      • messageId — (String)

        The ID of the message that caused the error. (See the value of the "messageId" in the detectors object of the DeleteDetectorRequest.)

      • errorCode — (String)

        The error code.

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

        A message that describes the error.

Returns:

• (AWS.Request) —

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

var params = {
  disableActionRequests: [ /* required */
    {
      alarmModelName: 'STRING_VALUE', /* required */
      requestId: 'STRING_VALUE', /* required */
      keyValue: 'STRING_VALUE',
      note: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ioteventsdata.batchDisableAlarm(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: {}) —
  • disableActionRequests — (Array<map>)

    The list of disable action requests. You can specify up to 10 requests per operation.

    • requestId — required — (String)

      The request ID. Each ID must be unique within each batch.

    • alarmModelName — required — (String)

      The name of the alarm model.

    • keyValue — (String)

      The value of the key used as a filter to select only the alarms associated with the key.

    • note — (String)

      The note that you can leave when you disable the alarm.

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:

    • errorEntries — (Array<map>)

      A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.

      • requestId — (String)

        The request ID. Each ID must be unique within each batch.

      • errorCode — (String)

        The error code.

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

        A message that describes the error.

Returns:

• (AWS.Request) —

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

var params = {
  enableActionRequests: [ /* required */
    {
      alarmModelName: 'STRING_VALUE', /* required */
      requestId: 'STRING_VALUE', /* required */
      keyValue: 'STRING_VALUE',
      note: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ioteventsdata.batchEnableAlarm(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: {}) —
  • enableActionRequests — (Array<map>)

    The list of enable action requests. You can specify up to 10 requests per operation.

    • requestId — required — (String)

      The request ID. Each ID must be unique within each batch.

    • alarmModelName — required — (String)

      The name of the alarm model.

    • keyValue — (String)

      The value of the key used as a filter to select only the alarms associated with the key.

    • note — (String)

      The note that you can leave when you enable the alarm.

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:

    • errorEntries — (Array<map>)

      A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.

      • requestId — (String)

        The request ID. Each ID must be unique within each batch.

      • errorCode — (String)

        The error code.

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

        A message that describes the error.

Returns:

• (AWS.Request) —

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

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 */
      timestamp: {
        timeInMillis: 'NUMBER_VALUE'
      }
    },
    /* 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"}'

    • messageId — required — (String)

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

    • inputName — required — (String)

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

    • payload — required — (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).

    • timestamp — (map)

      The timestamp associated with the message.

      • timeInMillis — (Integer)

        The value of the timestamp, in the Unix epoch format.

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 error code.

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

        A message that describes the error.

Returns:

• (AWS.Request) —

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

var params = {
  resetActionRequests: [ /* required */
    {
      alarmModelName: 'STRING_VALUE', /* required */
      requestId: 'STRING_VALUE', /* required */
      keyValue: 'STRING_VALUE',
      note: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ioteventsdata.batchResetAlarm(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: {}) —
  • resetActionRequests — (Array<map>)

    The list of reset action requests. You can specify up to 10 requests per operation.

    • requestId — required — (String)

      The request ID. Each ID must be unique within each batch.

    • alarmModelName — required — (String)

      The name of the alarm model.

    • keyValue — (String)

      The value of the key used as a filter to select only the alarms associated with the key.

    • note — (String)

      The note that you can leave when you reset the alarm.

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:

    • errorEntries — (Array<map>)

      A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.

      • requestId — (String)

        The request ID. Each ID must be unique within each batch.

      • errorCode — (String)

        The error code.

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

        A message that describes the error.

Returns:

• (AWS.Request) —

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

var params = {
  snoozeActionRequests: [ /* required */
    {
      alarmModelName: 'STRING_VALUE', /* required */
      requestId: 'STRING_VALUE', /* required */
      snoozeDuration: 'NUMBER_VALUE', /* required */
      keyValue: 'STRING_VALUE',
      note: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ioteventsdata.batchSnoozeAlarm(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: {}) —
  • snoozeActionRequests — (Array<map>)

    The list of snooze action requests. You can specify up to 10 requests per operation.

    • requestId — required — (String)

      The request ID. Each ID must be unique within each batch.

    • alarmModelName — required — (String)

      The name of the alarm model.

    • keyValue — (String)

      The value of the key used as a filter to select only the alarms associated with the key.

    • note — (String)

      The note that you can leave when you snooze the alarm.

    • snoozeDuration — required — (Integer)

      The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.

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:

    • errorEntries — (Array<map>)

      A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.

      • requestId — (String)

        The request ID. Each ID must be unique within each batch.

      • errorCode — (String)

        The error code.

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

        A message that describes the error.

Returns:

• (AWS.Request) —

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

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.

    • messageId — required — (String)

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

    • detectorModelName — required — (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).

    • state — required — (map)

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

      • stateName — required — (String)

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

      • variables — required — (Array<map>)

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

        • name — required — (String)

          The name of the variable.

        • value — required — (String)

          The new value of the variable.

      • timers — required — (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.

        • name — required — (String)

          The name of the timer.

        • seconds — required — (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 error code.

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

        A message that describes the error.

Returns:

• (AWS.Request) —

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

var params = {
  alarmModelName: 'STRING_VALUE', /* required */
  keyValue: 'STRING_VALUE'
};
ioteventsdata.describeAlarm(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: {}) —
  • alarmModelName — (String)

    The name of the alarm model.

  • keyValue — (String)

    The value of the key used as a filter to select only the alarms associated with the key.

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:

    • alarm — (map)

      Contains information about an alarm.

      • alarmModelName — (String)

        The name of the alarm model.

      • alarmModelVersion — (String)

        The version of the alarm model.

      • keyValue — (String)

        The value of the key used as a filter to select only the alarms associated with the key.

      • alarmState — (map)

        Contains information about the current state of the alarm.

        • stateName — (String)

          The name of the alarm state. The state name can be one of the following values:

          • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

          • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

          • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

          • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

          • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

          • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

          Possible values include:
          • "DISABLED"
          • "NORMAL"
          • "ACTIVE"
          • "ACKNOWLEDGED"
          • "SNOOZE_DISABLED"
          • "LATCHED"
        • ruleEvaluation — (map)

          Information needed to evaluate data.

          • simpleRuleEvaluation — (map)

            Information needed to compare two values with a comparison operator.

            • inputPropertyValue — (String)

              The value of the input property, on the left side of the comparison operator.

            • operator — (String)

              The comparison operator.

              Possible values include:
              • "GREATER"
              • "GREATER_OR_EQUAL"
              • "LESS"
              • "LESS_OR_EQUAL"
              • "EQUAL"
              • "NOT_EQUAL"
            • thresholdValue — (String)

              The threshold value, on the right side of the comparison operator.

        • customerAction — (map)

          Contains information about the action that you can take to respond to the alarm.

          • actionName — (String)

            The name of the action. The action name can be one of the following values:

            • SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.

            • ENABLE - When you enable the alarm, the alarm state changes to NORMAL.

            • DISABLE - When you disable the alarm, the alarm state changes to DISABLED.

            • ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.

            • RESET - When you reset the alarm, the alarm state changes to NORMAL.

            For more information, see the AlarmState API.

            Possible values include:
            • "SNOOZE"
            • "ENABLE"
            • "DISABLE"
            • "ACKNOWLEDGE"
            • "RESET"
          • snoozeActionConfiguration — (map)

            Contains the configuration information of a snooze action.

            • snoozeDuration — (Integer)

              The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.

            • note — (String)

              The note that you can leave when you snooze the alarm.

          • enableActionConfiguration — (map)

            Contains the configuration information of an enable action.

            • note — (String)

              The note that you can leave when you enable the alarm.

          • disableActionConfiguration — (map)

            Contains the configuration information of a disable action.

            • note — (String)

              The note that you can leave when you disable the alarm.

          • acknowledgeActionConfiguration — (map)

            Contains the configuration information of an acknowledge action.

            • note — (String)

              The note that you can leave when you acknowledge the alarm.

          • resetActionConfiguration — (map)

            Contains the configuration information of a reset action.

            • note — (String)

              The note that you can leave when you reset the alarm.

        • systemEvent — (map)

          Contains information about alarm state changes.

          • eventType — (String)

            The event type. If the value is STATE_CHANGE, the event contains information about alarm state changes.

            Possible values include:
            • "STATE_CHANGE"
          • stateChangeConfiguration — (map)

            Contains the configuration information of alarm state changes.

            • triggerType — (String)

              The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration ends and the alarm automatically changes to the NORMAL state.

              Possible values include:
              • "SNOOZE_TIMEOUT"
      • severity — (Integer)

        A non-negative integer that reflects the severity level of the alarm.

      • creationTime — (Date)

        The time the alarm was created, in the Unix epoch format.

      • lastUpdateTime — (Date)

        The time the alarm was last updated, in the Unix epoch format.

Returns:

• (AWS.Request) —

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

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).

        • stateName — required — (String)

          The name of the state.

        • variables — required — (Array<map>)

          The current values of the detector's variables.

          • name — required — (String)

            The name of the variable.

          • value — required — (String)

            The current value of the variable.

        • timers — required — (Array<map>)

          The current state of the detector's timers.

          • name — required — (String)

            The name of the timer.

          • timestamp — required — (Date)

            The expiration time for 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.

var params = {
  alarmModelName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ioteventsdata.listAlarms(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: {}) —
  • alarmModelName — (String)

    The name of the alarm model.

  • nextToken — (String)

    The token that you can use to return the next set of results.

  • maxResults — (Integer)

    The maximum number of results to be returned per request.

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:

    • alarmSummaries — (Array<map>)

      A list that summarizes each alarm.

      • alarmModelName — (String)

        The name of the alarm model.

      • alarmModelVersion — (String)

        The version of the alarm model.

      • keyValue — (String)

        The value of the key used as a filter to select only the alarms associated with the key.

      • stateName — (String)

        The name of the alarm state. The state name can be one of the following values:

        • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

        • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

        • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

        • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

        • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

        • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

        Possible values include:
        • "DISABLED"
        • "NORMAL"
        • "ACTIVE"
        • "ACKNOWLEDGED"
        • "SNOOZE_DISABLED"
        • "LATCHED"
      • creationTime — (Date)

        The time the alarm was created, in the Unix epoch format.

      • lastUpdateTime — (Date)

        The time the alarm was last updated, in the Unix epoch format.

    • nextToken — (String)

      The token that you can use to return the next set of results, or null if there are no more results.

Returns:

• (AWS.Request) —

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

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 that you can use to return the next set of results.

  • maxResults — (Integer)

    The maximum number of results to be returned per request.

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)

      The token that you can use to return the next set of results, or null if there are no more results.

Returns:

• (AWS.Request) —

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