AWS IoT Events
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DetectorModelConfiguration

Information about how the detector model is configured.

Contents

creationTime

The time the detector model was created.

Type: Timestamp

Required: No

detectorModelArn

The ARN of the detector model.

Type: String

Required: No

detectorModelDescription

A brief description of the detector model.

Type: String

Length Constraints: Maximum length of 128.

Required: No

detectorModelName

The name of the detector model.

Type: String

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

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

Required: No

detectorModelVersion

The version of the detector model.

Type: String

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

Required: No

key

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 to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input.

Type: String

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

Pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$

Required: No

lastUpdateTime

The time the detector model was last updated.

Type: Timestamp

Required: No

roleArn

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

Type: String

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

Required: No

status

The status of the detector model.

Type: String

Valid Values: ACTIVE | ACTIVATING | INACTIVE | DEPRECATED | DRAFT | PAUSED | FAILED

Required: No

See Also

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

On this page: