Skip to main content

detector_model_tags

Expands all tag keys and values for detector_models in a region

Overview

Namedetector_model_tags
TypeResource
DescriptionThe AWS::IoTEvents::DetectorModel resource creates a detector model. You create a detector model (a model of your equipment or process) using states. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the Developer Guide.
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) all detector instances created by the model are reset to their initial states. (The detector's state, and the values of any variables and timers are reset.)
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.)
If you attempt to update a detector model using CFN and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset.
Also, be aware that if you attempt to update several detector models at once using CFN, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.
Idaws.iotevents.detector_model_tags

Fields

NameDatatypeDescription
detector_model_definitionobjectInformation that defines how a detector operates.
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. ITE 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.
role_arnstringThe ARN of the role that grants permission to ITE to perform its operations.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all detector_models in a region.

SELECT
region,
detector_model_definition,
detector_model_description,
detector_model_name,
evaluation_method,
key,
role_arn,
tag_key,
tag_value
FROM aws.iotevents.detector_model_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the detector_model_tags resource, see detector_models