aws-sdk-pinpointsmsvoicev2 1.124.0

AWS SDK for Amazon Pinpoint SMS Voice V2
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListAvailablePhoneNumbers`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`iso_country_code(impl Into<String>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::iso_country_code) / [`set_iso_country_code(Option<String>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::set_iso_country_code):<br>required: **true**<br><p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region in which to search for available phone numbers. This operation currently supports only <code>US</code>.</p><br>
    ///   - [`number_capabilities(NumberCapability)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::number_capabilities) / [`set_number_capabilities(Option<Vec::<NumberCapability>>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::set_number_capabilities):<br>required: **true**<br><p>The capabilities to filter by, such as SMS. Only phone numbers that support all of the specified capabilities are returned.</p><br>
    ///   - [`number_type(SearchableNumberType)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::number_type) / [`set_number_type(Option<SearchableNumberType>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::set_number_type):<br>required: **true**<br><p>The type of phone number to search for.</p><br>
    ///   - [`registration_id(impl Into<String>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::registration_id) / [`set_registration_id(Option<String>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::set_registration_id):<br>required: **false**<br><p>The registration associated with the request. A registration is required for regulated number types. You can specify either:</p> <ul>  <li>   <p>The unique identifier of the registration.</p></li>  <li>   <p>The Amazon Resource Name (ARN) of the registration.</p></li> </ul><br>
    ///   - [`number_preference(NumberPreferenceItem)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::number_preference) / [`set_number_preference(Option<Vec::<NumberPreferenceItem>>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::set_number_preference):<br>required: **false**<br>Optional. If omitted, returns unfiltered available numbers. Max 1 element for List API.<br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned from a previous request to retrieve the next page of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page. If you don't specify a value, the default is 10.</p><br>
    /// - On success, responds with [`ListAvailablePhoneNumbersOutput`](crate::operation::list_available_phone_numbers::ListAvailablePhoneNumbersOutput) with field(s):
    ///   - [`available_phone_numbers(Vec::<String>)`](crate::operation::list_available_phone_numbers::ListAvailablePhoneNumbersOutput::available_phone_numbers): <p>An array of phone numbers, in E.164 format, that are available to request based on the specified filters.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_available_phone_numbers::ListAvailablePhoneNumbersOutput::next_token): <p>The token to include in the next request to retrieve the next page of results. This value is null when there are no more results.</p>
    /// - On failure, responds with [`SdkError<ListAvailablePhoneNumbersError>`](crate::operation::list_available_phone_numbers::ListAvailablePhoneNumbersError)
    pub fn list_available_phone_numbers(&self) -> crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder {
        crate::operation::list_available_phone_numbers::builders::ListAvailablePhoneNumbersFluentBuilder::new(self.handle.clone())
    }
}