iter_search_available_phone_numbers ¶

iter_search_available_phone_numbers(
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
    area_code: Optional[String] = None,
    city: Optional[String] = None,
    country: Optional[Alpha2CountryCode] = None,
    state: Optional[String] = None,
    toll_free_prefix: Optional[TollFreePrefix] = None,
    phone_number_type: Optional[PhoneNumberType] = None,
    max_results: Optional[PhoneNumberMaxResults] = None,
    next_token: Optional[String] = None,
) -> Iterator[SearchAvailablePhoneNumbersResponse]

Source code in docs_src/capo_chime/_services/chime.py

def iter_search_available_phone_numbers(
    self,
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
    area_code: Optional["capo_chime.types.string.String"] = None,
    city: Optional["capo_chime.types.string.String"] = None,
    country: Optional[
        "capo_chime.types.alpha2_country_code.Alpha2CountryCode"
    ] = None,
    state: Optional["capo_chime.types.string.String"] = None,
    toll_free_prefix: Optional[
        "capo_chime.types.toll_free_prefix.TollFreePrefix"
    ] = None,
    phone_number_type: Optional[
        "capo_chime.types.phone_number_type.PhoneNumberType"
    ] = None,
    max_results: Optional[
        "capo_chime.types.phone_number_max_results.PhoneNumberMaxResults"
    ] = None,
    next_token: Optional["capo_chime.types.string.String"] = None,
) -> "Iterator[capo_chime.types.search_available_phone_numbers_response.SearchAvailablePhoneNumbersResponse]":
    _token = next_token
    while True:
        _response = self.search_available_phone_numbers(
            config_overrides=config_overrides,
            area_code=area_code,
            city=city,
            country=country,
            state=state,
            toll_free_prefix=toll_free_prefix,
            phone_number_type=phone_number_type,
            max_results=max_results,
            next_token=_token,
        )
        yield _response
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break