Skip to content

CreateDetectorModelRequest

Source code in docs_src/capo_iot_events/types/create_detector_model_request.py
class CreateDetectorModelRequest(TypedDict, closed=True):
    detector_model_name: "capo_iot_events.types.detector_model_name.DetectorModelName"
    """<p>The name of the detector model.</p>"""
    detector_model_definition: (
        "capo_iot_events.types.detector_model_definition.DetectorModelDefinition"
    )
    """<p>Information that defines how the detectors operate.</p>"""
    detector_model_description: NotRequired[
        "capo_iot_events.types.detector_model_description.DetectorModelDescription"
    ]
    """<p>A brief description of the detector model.</p>"""
    key: NotRequired["capo_iot_events.types.attribute_json_path.AttributeJsonPath"]
    """<p>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.</p>"""
    role_arn: "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>"""
    tags: NotRequired["capo_iot_events.types.tags.Tags"]
    """<p>Metadata that can be used to manage the detector model.</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>"""

detector_model_definition instance-attribute

detector_model_definition: DetectorModelDefinition

Information that defines how the detectors operate.

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: DetectorModelName

The name 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 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.

role_arn instance-attribute

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

tags instance-attribute

tags: NotRequired[Tags]

Metadata that can be used to manage the detector model.