Skip to content

iter_search_contacts async

iter_search_contacts(
    instance_id: InstanceId,
    time_range: SearchContactsTimeRange,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    search_criteria: Optional[SearchCriteria] = None,
    max_results: Optional[MaxResult100] = None,
    next_token: Optional[LargeNextToken] = None,
    sort: Optional[Sort] = None,
) -> AsyncIterator[ContactSearchSummary]
Source code in docs_src/capo_connect/_services/async_connect.py
async def iter_search_contacts(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    time_range: "capo_connect.types.search_contacts_time_range.SearchContactsTimeRange",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    search_criteria: Optional[
        "capo_connect.types.search_criteria.SearchCriteria"
    ] = None,
    max_results: Optional["capo_connect.types.max_result100.MaxResult100"] = None,
    next_token: Optional[
        "capo_connect.types.large_next_token.LargeNextToken"
    ] = None,
    sort: Optional["capo_connect.types.sort.Sort"] = None,
) -> (
    "AsyncIterator[capo_connect.types.contact_search_summary.ContactSearchSummary]"
):
    _token = next_token
    while True:
        _response = await self.search_contacts(
            instance_id,
            time_range,
            config_overrides=config_overrides,
            search_criteria=search_criteria,
            max_results=max_results,
            next_token=_token,
            sort=sort,
        )
        _page = _resolve_path(_response, ("contacts",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break