Skip to content

Rule

Source code in docs_src/capo_connect/types/rule.py
class Rule(TypedDict, closed=True):
    name: "capo_connect.types.rule_name.RuleName"
    """<p>The name of the rule.</p>"""
    rule_id: "capo_connect.types.rule_id.RuleId"
    """<p>A unique identifier for the rule.</p>"""
    rule_arn: "capo_connect.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) of the rule.</p>"""
    trigger_event_source: (
        "capo_connect.types.rule_trigger_event_source.RuleTriggerEventSource"
    )
    """<p>The event source to trigger the rule.</p>"""
    rule_capability_tiers: NotRequired[
        "capo_connect.types.rule_capability_tiers.RuleCapabilityTiers"
    ]
    """<p>The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example, <code>GenerativeAI</code>).</p>"""
    function: "capo_connect.types.rule_function.RuleFunction"
    """<p>The conditions of the rule.</p>"""
    actions: "capo_connect.types.rule_actions.RuleActions"
    """<p>A list of actions to be run when the rule is triggered.</p>"""
    publish_status: "capo_connect.types.rule_publish_status.RulePublishStatus"
    """<p>The publish status of the rule.</p>"""
    pre_evaluation_filters: NotRequired[
        "capo_connect.types.pre_evaluation_filters.PreEvaluationFilters"
    ]
    """<p>The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based on the resource's attributes, such as tags assigned to a contact. The pre-evaluation filters are applied even before rule conditions are evaluated and are used to enforce tag-based-access-control while applying rules.</p>"""
    created_time: "capo_connect.types.timestamp.Timestamp"
    """<p>The timestamp for when the rule was created.</p>"""
    last_updated_time: "capo_connect.types.timestamp.Timestamp"
    """<p>The timestamp for the when the rule was last updated.</p>"""
    last_updated_by: "capo_connect.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) of the user who last updated the rule.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>"""

actions instance-attribute

actions: RuleActions

A list of actions to be run when the rule is triggered.

created_time instance-attribute

created_time: Timestamp

The timestamp for when the rule was created.

function instance-attribute

function: RuleFunction

The conditions of the rule.

last_updated_by instance-attribute

last_updated_by: ARN

The Amazon Resource Name (ARN) of the user who last updated the rule.

last_updated_time instance-attribute

last_updated_time: Timestamp

The timestamp for the when the rule was last updated.

name instance-attribute

name: RuleName

The name of the rule.

pre_evaluation_filters instance-attribute

pre_evaluation_filters: NotRequired[PreEvaluationFilters]

The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based on the resource's attributes, such as tags assigned to a contact. The pre-evaluation filters are applied even before rule conditions are evaluated and are used to enforce tag-based-access-control while applying rules.

publish_status instance-attribute

publish_status: RulePublishStatus

The publish status of the rule.

rule_arn instance-attribute

rule_arn: ARN

The Amazon Resource Name (ARN) of the rule.

rule_capability_tiers instance-attribute

rule_capability_tiers: NotRequired[RuleCapabilityTiers]

The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example, GenerativeAI).

rule_id instance-attribute

rule_id: RuleId

A unique identifier for the rule.

tags instance-attribute

tags: NotRequired[TagMap]

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

trigger_event_source instance-attribute

trigger_event_source: RuleTriggerEventSource

The event source to trigger the rule.