POST

/detector-models

http://iotevents.{region}.amazonaws.com/detector-models

Creates a detector model.

Access Token Required: API Key

Body Params

keystring

The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.

tagsarray

Metadata that can be used to manage the detector model.

roleArnstringrequired

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

evaluationMethodstring

Information about the order in which events are evaluated and how actions are executed.

detectorModelNamestringrequired

The name of the detector model.

detectorModelDefinitionobjectrequired

Information that defines how a detector operates.

detectorModelDescriptionstring

A brief description of the detector model.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://iotevents.{region}.amazonaws.com/detector-models' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}