AWS IoT Events
API Reference

DescribeDetectorModel

Describes a detector model. If the "version" parameter is not specified, information about the latest version is returned.

Request Syntax

GET /detector-models/detectorModelName?version=detectorModelVersion HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

detectorModelName

The name of the detector model.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_-]+$

detectorModelVersion

The version of the detector model.

Length Constraints: Minimum length of 1. Maximum length of 128.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "detectorModel": { "detectorModelConfiguration": { "creationTime": number, "detectorModelArn": "string", "detectorModelDescription": "string", "detectorModelName": "string", "detectorModelVersion": "string", "evaluationMethod": "string", "key": "string", "lastUpdateTime": number, "roleArn": "string", "status": "string" }, "detectorModelDefinition": { "initialStateName": "string", "states": [ { "onEnter": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "firehose": { "deliveryStreamName": "string", "separator": "string" }, "iotEvents": { "inputName": "string" }, "iotTopicPublish": { "mqttTopic": "string" }, "lambda": { "functionArn": "string" }, "resetTimer": { "timerName": "string" }, "setTimer": { "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "targetArn": "string" }, "sqs": { "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onExit": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "firehose": { "deliveryStreamName": "string", "separator": "string" }, "iotEvents": { "inputName": "string" }, "iotTopicPublish": { "mqttTopic": "string" }, "lambda": { "functionArn": "string" }, "resetTimer": { "timerName": "string" }, "setTimer": { "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "targetArn": "string" }, "sqs": { "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onInput": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "firehose": { "deliveryStreamName": "string", "separator": "string" }, "iotEvents": { "inputName": "string" }, "iotTopicPublish": { "mqttTopic": "string" }, "lambda": { "functionArn": "string" }, "resetTimer": { "timerName": "string" }, "setTimer": { "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "targetArn": "string" }, "sqs": { "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ], "transitionEvents": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "firehose": { "deliveryStreamName": "string", "separator": "string" }, "iotEvents": { "inputName": "string" }, "iotTopicPublish": { "mqttTopic": "string" }, "lambda": { "functionArn": "string" }, "resetTimer": { "timerName": "string" }, "setTimer": { "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "targetArn": "string" }, "sqs": { "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string", "nextState": "string" } ] }, "stateName": "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.

detectorModel

Information about the detector model.

Type: DetectorModel object

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

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

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: