TopicRule ¶

class TopicRule(TypedDict, closed=True):
    rule_name: NotRequired["capo_iot.types.rule_name.RuleName"]
    """<p>The name of the rule.</p>"""
    sql: NotRequired["capo_iot.types.sql.SQL"]
    """<p>The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.</p>"""
    description: NotRequired["capo_iot.types.description.Description"]
    """<p>The description of the rule.</p>"""
    created_at: NotRequired["capo_iot.types.created_at_date.CreatedAtDate"]
    """<p>The date and time the rule was created.</p>"""
    actions: NotRequired["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 perform when an error occurs.</p>"""