BatchUpdateDetector - Amazon IoT Events
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

BatchUpdateDetector

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

Request Syntax

POST /detectors HTTP/1.1 Content-type: application/json { "detectors": [ { "detectorModelName": "string", "keyValue": "string", "messageId": "string", "state": { "stateName": "string", "timers": [ { "name": "string", "seconds": number } ], "variables": [ { "name": "string", "value": "string" } ] } } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

detectors

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

Type: Array of UpdateDetectorRequest objects

Array Members: Minimum number of 1 item.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "batchUpdateDetectorErrorEntries": [ { "errorCode": "string", "errorMessage": "string", "messageId": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

batchUpdateDetectorErrorEntries

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

Type: Array of BatchUpdateDetectorErrorEntry objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidRequestException

The request was invalid.

HTTP Status Code: 400

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: