Skip to content

IotAnalyticsAction

Source code in docs_src/capo_iot/types/iot_analytics_action.py 
13
14
15
16
17
18
19
20
21
class IotAnalyticsAction(TypedDict, closed=True):
    channel_arn: NotRequired["capo_iot.types.aws_arn.AwsArn"]
    """<p>(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.</p>"""
    channel_name: NotRequired["capo_iot.types.channel_name.ChannelName"]
    """<p>The name of the IoT Analytics channel to which message data will be sent.</p>"""
    batch_mode: NotRequired["capo_iot.types.batch_mode.BatchMode"]
    """<p>Whether to process the action as a batch. The default value is <code>false</code>.</p> <p>When <code>batchMode</code> is <code>true</code> and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by <a href="https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html"> <code>BatchPutMessage</code> </a> to the IoT Analytics channel. The resulting array can't have more than 100 messages.</p>"""
    role_arn: NotRequired["capo_iot.types.aws_arn.AwsArn"]
    """<p>The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).</p>"""

batch_mode instance-attribute 

batch_mode: NotRequired[BatchMode]

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

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the IoT Analytics channel. The resulting array can't have more than 100 messages.

channel_arn instance-attribute 

channel_arn: NotRequired[AwsArn]

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

channel_name instance-attribute 

channel_name: NotRequired[ChannelName]

The name of the IoT Analytics channel to which message data will be sent.

role_arn instance-attribute 

role_arn: NotRequired[AwsArn]

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).