Skip to content

ListRulesRequest

Source code in docs_src/capo_connect/types/list_rules_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class ListRulesRequest(TypedDict, closed=True):
    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>"""
    publish_status: NotRequired[
        "capo_connect.types.rule_publish_status.RulePublishStatus"
    ]
    """<p>The publish status of the rule.</p>"""
    event_source_name: NotRequired[
        "capo_connect.types.event_source_name.EventSourceName"
    ]
    """<p>The name of the event source.</p>"""
    max_results: NotRequired["capo_connect.types.max_result200.MaxResult200"]
    """<p>The maximum number of results to return per page.</p>"""
    next_token: NotRequired["capo_connect.types.next_token.NextToken"]
    """<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>"""

event_source_name instance-attribute 

event_source_name: NotRequired[EventSourceName]

The name of the event source.

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.

max_results instance-attribute 

max_results: NotRequired[MaxResult200]

The maximum number of results to return per page.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

publish_status instance-attribute 

publish_status: NotRequired[RulePublishStatus]

The publish status of the rule.