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.
pub use crate::operation::describe_opted_out_numbers::_describe_opted_out_numbers_input::DescribeOptedOutNumbersInputBuilder;

pub use crate::operation::describe_opted_out_numbers::_describe_opted_out_numbers_output::DescribeOptedOutNumbersOutputBuilder;

impl crate::operation::describe_opted_out_numbers::builders::DescribeOptedOutNumbersInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.describe_opted_out_numbers();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `DescribeOptedOutNumbers`.
///
/// <p>Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.</p>
/// <p>If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.</p>
/// <p>If you specify an opted out number that isn't valid, an exception is returned.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DescribeOptedOutNumbersFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::describe_opted_out_numbers::builders::DescribeOptedOutNumbersInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersOutput,
        crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersError,
    > for DescribeOptedOutNumbersFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersOutput,
            crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl DescribeOptedOutNumbersFluentBuilder {
    /// Creates a new `DescribeOptedOutNumbersFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the DescribeOptedOutNumbers as a reference.
    pub fn as_input(&self) -> &crate::operation::describe_opted_out_numbers::builders::DescribeOptedOutNumbersInputBuilder {
        &self.inner
    }
    /// 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](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbers::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbers::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersOutput,
        crate::operation::describe_opted_out_numbers::DescribeOptedOutNumbersError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// Create a paginator for this request
    ///
    /// Paginators are used by calling [`send().await`](crate::operation::describe_opted_out_numbers::paginator::DescribeOptedOutNumbersPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::describe_opted_out_numbers::paginator::DescribeOptedOutNumbersPaginator {
        crate::operation::describe_opted_out_numbers::paginator::DescribeOptedOutNumbersPaginator::new(self.handle, self.inner)
    }
    /// <p>The OptOutListName or OptOutListArn of the OptOutList. You can use <code>DescribeOptOutLists</code> to find the values for OptOutListName and OptOutListArn.</p><important>
    /// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
    /// </important>
    pub fn opt_out_list_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.opt_out_list_name(input.into());
        self
    }
    /// <p>The OptOutListName or OptOutListArn of the OptOutList. You can use <code>DescribeOptOutLists</code> to find the values for OptOutListName and OptOutListArn.</p><important>
    /// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
    /// </important>
    pub fn set_opt_out_list_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_opt_out_list_name(input);
        self
    }
    /// <p>The OptOutListName or OptOutListArn of the OptOutList. You can use <code>DescribeOptOutLists</code> to find the values for OptOutListName and OptOutListArn.</p><important>
    /// <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
    /// </important>
    pub fn get_opt_out_list_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_opt_out_list_name()
    }
    ///
    /// Appends an item to `OptedOutNumbers`.
    ///
    /// To override the contents of this collection use [`set_opted_out_numbers`](Self::set_opted_out_numbers).
    ///
    /// <p>An array of phone numbers to search for in the OptOutList.</p>
    /// <p>If you specify an opted out number that isn't valid, an exception is returned.</p>
    pub fn opted_out_numbers(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.opted_out_numbers(input.into());
        self
    }
    /// <p>An array of phone numbers to search for in the OptOutList.</p>
    /// <p>If you specify an opted out number that isn't valid, an exception is returned.</p>
    pub fn set_opted_out_numbers(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_opted_out_numbers(input);
        self
    }
    /// <p>An array of phone numbers to search for in the OptOutList.</p>
    /// <p>If you specify an opted out number that isn't valid, an exception is returned.</p>
    pub fn get_opted_out_numbers(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_opted_out_numbers()
    }
    ///
    /// Appends an item to `Filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>An array of OptedOutFilter objects to filter the results on.</p>
    pub fn filters(mut self, input: crate::types::OptedOutFilter) -> Self {
        self.inner = self.inner.filters(input);
        self
    }
    /// <p>An array of OptedOutFilter objects to filter the results on.</p>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OptedOutFilter>>) -> Self {
        self.inner = self.inner.set_filters(input);
        self
    }
    /// <p>An array of OptedOutFilter objects to filter the results on.</p>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OptedOutFilter>> {
        self.inner.get_filters()
    }
    /// <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.next_token(input.into());
        self
    }
    /// <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_next_token(input);
        self
    }
    /// <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
    /// <p>The maximum number of results to return per each request.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.inner = self.inner.max_results(input);
        self
    }
    /// <p>The maximum number of results to return per each request.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
    /// <p>The maximum number of results to return per each request.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
}