Struct aws_sdk_chime::client::fluent_builders::SearchAvailablePhoneNumbers

pub struct SearchAvailablePhoneNumbers { /* private fields */ }

Fluent builder constructing a request to SearchAvailablePhoneNumbers.

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

Implementations

impl SearchAvailablePhoneNumbers

pub async fn customize(
    self
) -> Result<CustomizableOperation<SearchAvailablePhoneNumbers, AwsResponseRetryClassifier>, SdkError<SearchAvailablePhoneNumbersError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<SearchAvailablePhoneNumbersOutput, SdkError<SearchAvailablePhoneNumbersError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> SearchAvailablePhoneNumbersPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn area_code(self, input: impl Into<String>) -> Self

The area code used to filter results. Only applies to the US.

pub fn set_area_code(self, input: Option<String>) -> Self

The area code used to filter results. Only applies to the US.

pub fn city(self, input: impl Into<String>) -> Self

The city used to filter results. Only applies to the US.

pub fn set_city(self, input: Option<String>) -> Self

The city used to filter results. Only applies to the US.

pub fn country(self, input: impl Into<String>) -> Self

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

pub fn set_country(self, input: Option<String>) -> Self

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

pub fn state(self, input: impl Into<String>) -> Self

The state used to filter results. Required only if you provide City. Only applies to the US.

pub fn set_state(self, input: Option<String>) -> Self

The state used to filter results. Required only if you provide City. Only applies to the US.

pub fn toll_free_prefix(self, input: impl Into<String>) -> Self

The toll-free prefix that you use to filter results. Only applies to the US.

pub fn set_toll_free_prefix(self, input: Option<String>) -> Self

The toll-free prefix that you use to filter results. Only applies to the US.

pub fn phone_number_type(self, input: PhoneNumberType) -> Self

The phone number type used to filter results. Required for non-US numbers.

pub fn set_phone_number_type(self, input: Option<PhoneNumberType>) -> Self

The phone number type used to filter results. Required for non-US numbers.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return in a single call.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return in a single call.

pub fn next_token(self, input: impl Into<String>) -> Self

The token used to retrieve the next page of results.

pub fn set_next_token(self, input: Option<String>) -> Self

The token used to retrieve the next page of results.

Trait Implementations

impl Clone for SearchAvailablePhoneNumbers

fn clone(&self) -> SearchAvailablePhoneNumbers

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchAvailablePhoneNumbers

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.