Skip to content

SearchQueuesRequest

Source code in docs_src/capo_connect/types/search_queues_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class SearchQueuesRequest(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>"""
    next_token: NotRequired["capo_connect.types.next_token2500.NextToken2500"]
    """<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>"""
    max_results: NotRequired["capo_connect.types.max_result500.MaxResult500"]
    """<p>The maximum number of results to return per page.</p>"""
    search_filter: NotRequired[
        "capo_connect.types.queue_search_filter.QueueSearchFilter"
    ]
    """<p>Filters to be applied to search results.</p>"""
    search_criteria: NotRequired[
        "capo_connect.types.queue_search_criteria.QueueSearchCriteria"
    ]
    """<p>The search criteria to be used to return queues.</p> <note> <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. </p> </note>"""

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[MaxResult500]

The maximum number of results to return per page.

next_token instance-attribute 

next_token: NotRequired[NextToken2500]

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.

search_criteria instance-attribute 

search_criteria: NotRequired[QueueSearchCriteria]

The search criteria to be used to return queues.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

search_filter instance-attribute 

search_filter: NotRequired[QueueSearchFilter]

Filters to be applied to search results.