BatchDeleteDetector - AWS IoT Events Data

BatchDeleteDetector

Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call.

Request Syntax

POST /detectors/delete HTTP/1.1 Content-type: application/json { "detectors": [ { "detectorModelName": "string", "keyValue": "string", "messageId": "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 one or more detectors to be deleted.

Type: Array of DeleteDetectorRequest objects

Array Members: Minimum number of 1 item.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "batchDeleteDetectorErrorEntries": [ { "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.

batchDeleteDetectorErrorEntries

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.

Type: Array of BatchDeleteDetectorErrorEntry 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 AWS SDKs, see the following: