aws_sdk_chime/client/
search_available_phone_numbers.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`SearchAvailablePhoneNumbers`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`area_code(impl Into<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::area_code) / [`set_area_code(Option<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::set_area_code):<br>required: **false**<br><p>The area code used to filter results. Only applies to the US.</p><br>
8    ///   - [`city(impl Into<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::city) / [`set_city(Option<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::set_city):<br>required: **false**<br><p>The city used to filter results. Only applies to the US.</p><br>
9    ///   - [`country(impl Into<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::country) / [`set_country(Option<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::set_country):<br>required: **false**<br><p>The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.</p><br>
10    ///   - [`state(impl Into<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::state) / [`set_state(Option<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::set_state):<br>required: **false**<br><p>The state used to filter results. Required only if you provide <code>City</code>. Only applies to the US.</p><br>
11    ///   - [`toll_free_prefix(impl Into<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::toll_free_prefix) / [`set_toll_free_prefix(Option<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::set_toll_free_prefix):<br>required: **false**<br><p>The toll-free prefix that you use to filter results. Only applies to the US.</p><br>
12    ///   - [`phone_number_type(PhoneNumberType)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::phone_number_type) / [`set_phone_number_type(Option<PhoneNumberType>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::set_phone_number_type):<br>required: **false**<br><p>The phone number type used to filter results. Required for non-US numbers.</p><br>
13    ///   - [`max_results(i32)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
14    ///   - [`next_token(impl Into<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::set_next_token):<br>required: **false**<br><p>The token used to retrieve the next page of results.</p><br>
15    /// - On success, responds with [`SearchAvailablePhoneNumbersOutput`](crate::operation::search_available_phone_numbers::SearchAvailablePhoneNumbersOutput) with field(s):
16    ///   - [`e164_phone_numbers(Option<Vec::<String>>)`](crate::operation::search_available_phone_numbers::SearchAvailablePhoneNumbersOutput::e164_phone_numbers): <p>List of phone numbers, in E.164 format.</p>
17    ///   - [`next_token(Option<String>)`](crate::operation::search_available_phone_numbers::SearchAvailablePhoneNumbersOutput::next_token): <p>The token used to retrieve the next page of search results.</p>
18    /// - On failure, responds with [`SdkError<SearchAvailablePhoneNumbersError>`](crate::operation::search_available_phone_numbers::SearchAvailablePhoneNumbersError)
19    pub fn search_available_phone_numbers(
20        &self,
21    ) -> crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder {
22        crate::operation::search_available_phone_numbers::builders::SearchAvailablePhoneNumbersFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_chime/client/search_available_phone_numbers.rs

aws_sdk_chime/client/
search_available_phone_numbers.rs
