Skip to content

UpdateRuleRequest

Source code in docs_src/capo_connect/types/update_rule_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class UpdateRuleRequest(TypedDict, closed=True):
    rule_id: "capo_connect.types.rule_id.RuleId"
    """<p>A unique identifier for the rule.</p>"""
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    name: "capo_connect.types.rule_name.RuleName"
    """<p>The name of the rule. You can change the name only if <code>TriggerEventSource</code> is one of the following values: <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</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>"""

actions instance-attribute 

actions: RuleActions

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

function instance-attribute 

function: RuleFunction

The conditions of the rule.

instance_id instance-attribute 

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

name instance-attribute 

name: RuleName

The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

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_id instance-attribute 

rule_id: RuleId

A unique identifier for the rule.