DetectorModelConfiguration - 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.

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

evaluationMethod

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

Type: String

Valid Values: BATCH | SERIAL

Required: No

key

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. Amazon IoT Events can continue to route input to its corresponding detector instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.

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 Amazon 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 Amazon SDKs, see the following: