AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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

Synopsis

  batch-update-detector
--detectors <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--detectors (list)

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

(structure)

Information used to update the detector (instance).

messageId -> (string)

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

detectorModelName -> (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 -> (structure)

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

stateName -> (string)

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

variables -> (list)

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

(structure)

The new value of the variable.

name -> (string)

The name of the variable.

value -> (string)

The new value of the variable.

timers -> (list)

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

(structure)

The new setting of a timer.

name -> (string)

The name of the timer.

seconds -> (integer)

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

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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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

errorMessage -> (string)

A message that describes the error.