Skip to content

TopicRulePayload

Used by
Source code in docs_src/capo_iot/types/topic_rule_payload.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class TopicRulePayload(TypedDict, closed=True):
    sql: "capo_iot.types.sql.SQL"
    """<p>The SQL statement used to query the topic. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html">IoT SQL Reference</a> in the <i>IoT Developer Guide</i>.</p>"""
    description: NotRequired["capo_iot.types.description.Description"]
    """<p>The description of the rule.</p>"""
    actions: "capo_iot.types.action_list.ActionList"
    """<p>The actions associated with the rule.</p>"""
    rule_disabled: NotRequired["capo_iot.types.is_disabled.IsDisabled"]
    """<p>Specifies whether the rule is disabled.</p>"""
    aws_iot_sql_version: NotRequired[
        "capo_iot.types.aws_iot_sql_version.AwsIotSqlVersion"
    ]
    """<p>The version of the SQL rules engine to use when evaluating the rule.</p>"""
    error_action: NotRequired["capo_iot.types.action.Action"]
    """<p>The action to take when an error occurs.</p>"""

actions instance-attribute 

actions: ActionList

The actions associated with the rule.

aws_iot_sql_version instance-attribute 

aws_iot_sql_version: NotRequired[AwsIotSqlVersion]

The version of the SQL rules engine to use when evaluating the rule.

description instance-attribute 

description: NotRequired[Description]

The description of the rule.

error_action instance-attribute 

error_action: NotRequired[Action]

The action to take when an error occurs.

rule_disabled instance-attribute 

rule_disabled: NotRequired[IsDisabled]

Specifies whether the rule is disabled.

sql instance-attribute 

sql: SQL

The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.