Skip to content

DetectorModelConfiguration

Source code in docs_src/capo_iot_events/types/detector_model_configuration.py
class DetectorModelConfiguration(TypedDict, closed=True):
    detector_model_name: NotRequired[
        "capo_iot_events.types.detector_model_name.DetectorModelName"
    ]
    """<p>The name of the detector model.</p>"""
    detector_model_version: NotRequired[
        "capo_iot_events.types.detector_model_version.DetectorModelVersion"
    ]
    """<p>The version of the detector model.</p>"""
    detector_model_description: NotRequired[
        "capo_iot_events.types.detector_model_description.DetectorModelDescription"
    ]
    """<p>A brief description of the detector model.</p>"""
    detector_model_arn: NotRequired[
        "capo_iot_events.types.detector_model_arn.DetectorModelArn"
    ]
    """<p>The ARN of the detector model.</p>"""
    role_arn: NotRequired[
        "capo_iot_events.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN of the role that grants permission to AWS IoT Events to perform its operations.</p>"""
    creation_time: NotRequired["capo_iot_events.types.timestamp.Timestamp"]
    """<p>The time the detector model was created.</p>"""
    last_update_time: NotRequired["capo_iot_events.types.timestamp.Timestamp"]
    """<p>The time the detector model was last updated.</p>"""
    status: NotRequired[
        "capo_iot_events.types.detector_model_version_status.DetectorModelVersionStatus"
    ]
    """<p>The status of the detector model.</p>"""
    key: NotRequired["capo_iot_events.types.attribute_json_path.AttributeJsonPath"]
    """<p>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. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information. </p> <p>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.</p>"""
    evaluation_method: NotRequired[
        "capo_iot_events.types.evaluation_method.EvaluationMethod"
    ]
    """<p>Information about the order in which events are evaluated and how actions are executed. </p>"""

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The time the detector model was created.

detector_model_arn instance-attribute

detector_model_arn: NotRequired[DetectorModelArn]

The ARN of the detector model.

detector_model_description instance-attribute

detector_model_description: NotRequired[DetectorModelDescription]

A brief description of the detector model.

detector_model_name instance-attribute

detector_model_name: NotRequired[DetectorModelName]

The name of the detector model.

detector_model_version instance-attribute

detector_model_version: NotRequired[DetectorModelVersion]

The version of the detector model.

evaluation_method instance-attribute

evaluation_method: NotRequired[EvaluationMethod]

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

key instance-attribute

key: NotRequired[AttributeJsonPath]

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

last_update_time instance-attribute

last_update_time: NotRequired[Timestamp]

The time the detector model was last updated.

role_arn instance-attribute

role_arn: NotRequired[AmazonResourceName]

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

status instance-attribute

status: NotRequired[DetectorModelVersionStatus]

The status of the detector model.