Skip to content

IotEventsAction

Source code in docs_src/capo_iot/types/iot_events_action.py 
16
17
18
19
20
21
22
23
24
class IotEventsAction(TypedDict, closed=True):
    input_name: "capo_iot.types.input_name.InputName"
    """<p>The name of the IoT Events input.</p>"""
    message_id: NotRequired["capo_iot.types.message_id.MessageId"]
    """<p>The ID of the message. The default <code>messageId</code> is a new UUID value.</p> <p>When <code>batchMode</code> is <code>true</code>, you can't specify a <code>messageId</code>--a new UUID value will be assigned.</p> <p>Assign a value to this property to ensure that only one input (message) with a given <code>messageId</code> will be processed by an IoT Events detector.</p>"""
    batch_mode: NotRequired["capo_iot.types.batch_mode.BatchMode"]
    """<p>Whether to process the event actions as a batch. The default value is <code>false</code>.</p> <p>When <code>batchMode</code> is <code>true</code>, you can't specify a <code>messageId</code>. </p> <p>When <code>batchMode</code> is <code>true</code> and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html"> <code>BatchPutMessage</code> </a>. The resulting array can't have more than 10 messages.</p>"""
    role_arn: "capo_iot.types.aws_arn.AwsArn"
    """<p>The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").</p>"""

batch_mode instance-attribute 

batch_mode: NotRequired[BatchMode]

Whether to process the event actions as a batch. The default value is false.

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

input_name instance-attribute 

input_name: InputName

The name of the IoT Events input.

message_id instance-attribute 

message_id: NotRequired[MessageId]

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId--a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.

role_arn instance-attribute 

role_arn: AwsArn

The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").