Skip to content

SearchContactsRequest

Source code in docs_src/capo_connect/types/search_contacts_request.py
class SearchContactsRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>"""
    time_range: "capo_connect.types.search_contacts_time_range.SearchContactsTimeRange"
    """<p>Time range that you want to search results.</p>"""
    search_criteria: NotRequired["capo_connect.types.search_criteria.SearchCriteria"]
    """<p>The search criteria to be used to return contacts.</p>"""
    max_results: NotRequired["capo_connect.types.max_result100.MaxResult100"]
    """<p>The maximum number of results to return per page.</p>"""
    next_token: NotRequired["capo_connect.types.large_next_token.LargeNextToken"]
    """<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>"""
    sort: NotRequired["capo_connect.types.sort.Sort"]
    """<p>Specifies a field to sort by and a sort order.</p>"""

instance_id instance-attribute

instance_id: InstanceId

The identifier of 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[MaxResult100]

The maximum number of results to return per page.

next_token instance-attribute

next_token: NotRequired[LargeNextToken]

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

The search criteria to be used to return contacts.

sort instance-attribute

sort: NotRequired[Sort]

Specifies a field to sort by and a sort order.

time_range instance-attribute

Time range that you want to search results.