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::update_rcs_agent::_update_rcs_agent_input::UpdateRcsAgentInputBuilder;

pub use crate::operation::update_rcs_agent::_update_rcs_agent_output::UpdateRcsAgentOutputBuilder;

impl crate::operation::update_rcs_agent::builders::UpdateRcsAgentInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::update_rcs_agent::UpdateRcsAgentOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::update_rcs_agent::UpdateRcsAgentError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.update_rcs_agent();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `UpdateRcsAgent`.
///
/// <p>Updates the configuration of an existing RCS agent. You can update the opt-out list, deletion protection, two-way messaging settings, and self-managed opt-outs configuration.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdateRcsAgentFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::update_rcs_agent::builders::UpdateRcsAgentInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::update_rcs_agent::UpdateRcsAgentOutput,
        crate::operation::update_rcs_agent::UpdateRcsAgentError,
    > for UpdateRcsAgentFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::update_rcs_agent::UpdateRcsAgentOutput,
            crate::operation::update_rcs_agent::UpdateRcsAgentError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl UpdateRcsAgentFluentBuilder {
    /// Creates a new `UpdateRcsAgentFluentBuilder`.
    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 UpdateRcsAgent as a reference.
    pub fn as_input(&self) -> &crate::operation::update_rcs_agent::builders::UpdateRcsAgentInputBuilder {
        &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::update_rcs_agent::UpdateRcsAgentOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::update_rcs_agent::UpdateRcsAgentError,
            ::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::update_rcs_agent::UpdateRcsAgent::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::update_rcs_agent::UpdateRcsAgent::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::update_rcs_agent::UpdateRcsAgentOutput,
        crate::operation::update_rcs_agent::UpdateRcsAgentError,
        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
    }
    /// <p>The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.</p>
    pub fn rcs_agent_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.rcs_agent_id(input.into());
        self
    }
    /// <p>The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.</p>
    pub fn set_rcs_agent_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_rcs_agent_id(input);
        self
    }
    /// <p>The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.</p>
    pub fn get_rcs_agent_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_rcs_agent_id()
    }
    /// <p>By default this is set to false. When set to true the RCS agent can't be deleted.</p>
    pub fn deletion_protection_enabled(mut self, input: bool) -> Self {
        self.inner = self.inner.deletion_protection_enabled(input);
        self
    }
    /// <p>By default this is set to false. When set to true the RCS agent can't be deleted.</p>
    pub fn set_deletion_protection_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_deletion_protection_enabled(input);
        self
    }
    /// <p>By default this is set to false. When set to true the RCS agent can't be deleted.</p>
    pub fn get_deletion_protection_enabled(&self) -> &::std::option::Option<bool> {
        self.inner.get_deletion_protection_enabled()
    }
    /// <p>The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.</p>
    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 OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.</p>
    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 OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.</p>
    pub fn get_opt_out_list_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_opt_out_list_name()
    }
    /// <p>By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.</p>
    pub fn self_managed_opt_outs_enabled(mut self, input: bool) -> Self {
        self.inner = self.inner.self_managed_opt_outs_enabled(input);
        self
    }
    /// <p>By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.</p>
    pub fn set_self_managed_opt_outs_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_self_managed_opt_outs_enabled(input);
        self
    }
    /// <p>By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.</p>
    pub fn get_self_managed_opt_outs_enabled(&self) -> &::std::option::Option<bool> {
        self.inner.get_self_managed_opt_outs_enabled()
    }
    /// <p>The Amazon Resource Name (ARN) of the two way channel.</p>
    pub fn two_way_channel_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.two_way_channel_arn(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the two way channel.</p>
    pub fn set_two_way_channel_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_two_way_channel_arn(input);
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the two way channel.</p>
    pub fn get_two_way_channel_arn(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_two_way_channel_arn()
    }
    /// <p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p>
    pub fn two_way_channel_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.two_way_channel_role(input.into());
        self
    }
    /// <p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p>
    pub fn set_two_way_channel_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_two_way_channel_role(input);
        self
    }
    /// <p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p>
    pub fn get_two_way_channel_role(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_two_way_channel_role()
    }
    /// <p>By default this is set to false. When set to true you can receive incoming text messages from your end recipients.</p>
    pub fn two_way_enabled(mut self, input: bool) -> Self {
        self.inner = self.inner.two_way_enabled(input);
        self
    }
    /// <p>By default this is set to false. When set to true you can receive incoming text messages from your end recipients.</p>
    pub fn set_two_way_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_two_way_enabled(input);
        self
    }
    /// <p>By default this is set to false. When set to true you can receive incoming text messages from your end recipients.</p>
    pub fn get_two_way_enabled(&self) -> &::std::option::Option<bool> {
        self.inner.get_two_way_enabled()
    }
    /// <p>The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3Role.</p>
    pub fn two_way_media_s3_bucket_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.two_way_media_s3_bucket_name(input.into());
        self
    }
    /// <p>The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3Role.</p>
    pub fn set_two_way_media_s3_bucket_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_two_way_media_s3_bucket_name(input);
        self
    }
    /// <p>The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3Role.</p>
    pub fn get_two_way_media_s3_bucket_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_two_way_media_s3_bucket_name()
    }
    /// <p>The key prefix used for inbound RCS media objects in the S3 bucket.</p>
    pub fn two_way_media_s3_key_prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.two_way_media_s3_key_prefix(input.into());
        self
    }
    /// <p>The key prefix used for inbound RCS media objects in the S3 bucket.</p>
    pub fn set_two_way_media_s3_key_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_two_way_media_s3_key_prefix(input);
        self
    }
    /// <p>The key prefix used for inbound RCS media objects in the S3 bucket.</p>
    pub fn get_two_way_media_s3_key_prefix(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_two_way_media_s3_key_prefix()
    }
    /// <p>The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have <code>s3:PutObject</code> permission on the bucket and a trust policy allowing <code>sms-voice.amazonaws.com</code> to assume it. To remove the media configuration, pass the sentinel value <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3BucketName.</p>
    pub fn two_way_media_s3_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.two_way_media_s3_role(input.into());
        self
    }
    /// <p>The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have <code>s3:PutObject</code> permission on the bucket and a trust policy allowing <code>sms-voice.amazonaws.com</code> to assume it. To remove the media configuration, pass the sentinel value <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3BucketName.</p>
    pub fn set_two_way_media_s3_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_two_way_media_s3_role(input);
        self
    }
    /// <p>The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have <code>s3:PutObject</code> permission on the bucket and a trust policy allowing <code>sms-voice.amazonaws.com</code> to assume it. To remove the media configuration, pass the sentinel value <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3BucketName.</p>
    pub fn get_two_way_media_s3_role(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_two_way_media_s3_role()
    }
    ///
    /// Appends an item to `TwoWayRcsEventsEnabled`.
    ///
    /// To override the contents of this collection use [`set_two_way_rcs_events_enabled`](Self::set_two_way_rcs_events_enabled).
    ///
    /// <p>The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value <code>ALL</code> enables all current and future event types and must be the sole element if used.</p>
    pub fn two_way_rcs_events_enabled(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.two_way_rcs_events_enabled(input.into());
        self
    }
    /// <p>The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value <code>ALL</code> enables all current and future event types and must be the sole element if used.</p>
    pub fn set_two_way_rcs_events_enabled(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_two_way_rcs_events_enabled(input);
        self
    }
    /// <p>The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value <code>ALL</code> enables all current and future event types and must be the sole element if used.</p>
    pub fn get_two_way_rcs_events_enabled(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_two_way_rcs_events_enabled()
    }
}