Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iotevents-data ]

batch-update-detector

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  batch-update-detector
--detectors <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--detectors (list)

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

JSON Syntax:

[
  {
    "messageId": "string",
    "detectorModelName": "string",
    "keyValue": "string",
    "state": {
      "stateName": "string",
      "variables": [
        {
          "name": "string",
          "value": "string"
        }
        ...
      ],
      "timers": [
        {
          "name": "string",
          "seconds": integer
        }
        ...
      ]
    }
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To update a detector (instance)

The following batch-update-detector example updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.

aws iotevents-data batch-update-detector \
    --cli-input-json file://budFulton-A32.json

Contents of budFulton-A32.json:

{
    "detectors": [
        {
            "messageId": "00001",
            "detectorModelName": "motorDetectorModel",
            "keyValue": "Fulton-A32",
            "state": {
                "stateName": "Normal",
                "variables": [
                    {
                        "name": "pressureThresholdBreached",
                        "value": "0"
                    }
                ],
                "timers": [
                ]
            }
        }
    ]
}

Output:

{
    "batchUpdateDetectorErrorEntries": []
}

For more information, see BatchUpdateDetector in the AWS IoT Events Developer Guide*.

Output

batchUpdateDetectorErrorEntries -> (list)

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

(structure)

Information about the error that occured when attempting to update a detector.

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.

errorMessage -> (string)

A message describing the error.