Skip to main content

detector_model

Gets an individual detector_model resource

Overview

Namedetector_model
TypeResource
Descriptiondetector_model
Idawscc.iotevents.detector_model

Fields

NameDatatypeDescription
detector_model_definitionobject
detector_model_descriptionstringA brief description of the detector model.
detector_model_namestringThe name of the detector model.
evaluation_methodstringInformation about the order in which events are evaluated and how actions are executed.
keystringThe 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.<br/><br/>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.
role_arnstringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
tagsarrayAn array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
detector_model_definition,
detector_model_description,
detector_model_name,
evaluation_method,
key,
role_arn,
tags
FROM awscc.iotevents.detector_model
WHERE data__Identifier = '<DetectorModelName>';

Permissions

To operate on the detector_model resource, the following permissions are required:

Read

iotevents:DescribeDetectorModel,
iotevents:ListTagsForResource

Update

iotevents:UpdateDetectorModel,
iotevents:UpdateInputRouting,
iotevents:DescribeDetectorModel,
iotevents:ListTagsForResource,
iotevents:UntagResource,
iotevents:TagResource,
iam:PassRole

Delete

iotevents:DeleteDetectorModel,
iotevents:DescribeDetectorModel