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.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdatePhoneNumberInput {
    /// <p>The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.</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 phone_number_id: ::std::option::Option<::std::string::String>,
    /// <p>By default this is set to false. When set to true you can receive incoming text messages from your end recipients.</p>
    pub two_way_enabled: ::std::option::Option<bool>,
    /// <p>The Amazon Resource Name (ARN) of the two way channel.</p>
    pub two_way_channel_arn: ::std::option::Option<::std::string::String>,
    /// <p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p>
    pub two_way_channel_role: ::std::option::Option<::std::string::String>,
    /// <p>By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. 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 self_managed_opt_outs_enabled: ::std::option::Option<bool>,
    /// <p>The OptOutList to add the phone number to. You can use either the opt out list name or the opt out list ARN.</p>
    pub opt_out_list_name: ::std::option::Option<::std::string::String>,
    /// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
    pub international_sending_enabled: ::std::option::Option<bool>,
    /// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
    pub deletion_protection_enabled: ::std::option::Option<bool>,
}
impl UpdatePhoneNumberInput {
    /// <p>The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.</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 phone_number_id(&self) -> ::std::option::Option<&str> {
        self.phone_number_id.as_deref()
    }
    /// <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(&self) -> ::std::option::Option<bool> {
        self.two_way_enabled
    }
    /// <p>The Amazon Resource Name (ARN) of the two way channel.</p>
    pub fn two_way_channel_arn(&self) -> ::std::option::Option<&str> {
        self.two_way_channel_arn.as_deref()
    }
    /// <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(&self) -> ::std::option::Option<&str> {
        self.two_way_channel_role.as_deref()
    }
    /// <p>By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. 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(&self) -> ::std::option::Option<bool> {
        self.self_managed_opt_outs_enabled
    }
    /// <p>The OptOutList to add the phone number to. You can use either the opt out list name or the opt out list ARN.</p>
    pub fn opt_out_list_name(&self) -> ::std::option::Option<&str> {
        self.opt_out_list_name.as_deref()
    }
    /// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
    pub fn international_sending_enabled(&self) -> ::std::option::Option<bool> {
        self.international_sending_enabled
    }
    /// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
    pub fn deletion_protection_enabled(&self) -> ::std::option::Option<bool> {
        self.deletion_protection_enabled
    }
}
impl UpdatePhoneNumberInput {
    /// Creates a new builder-style object to manufacture [`UpdatePhoneNumberInput`](crate::operation::update_phone_number::UpdatePhoneNumberInput).
    pub fn builder() -> crate::operation::update_phone_number::builders::UpdatePhoneNumberInputBuilder {
        crate::operation::update_phone_number::builders::UpdatePhoneNumberInputBuilder::default()
    }
}

/// A builder for [`UpdatePhoneNumberInput`](crate::operation::update_phone_number::UpdatePhoneNumberInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdatePhoneNumberInputBuilder {
    pub(crate) phone_number_id: ::std::option::Option<::std::string::String>,
    pub(crate) two_way_enabled: ::std::option::Option<bool>,
    pub(crate) two_way_channel_arn: ::std::option::Option<::std::string::String>,
    pub(crate) two_way_channel_role: ::std::option::Option<::std::string::String>,
    pub(crate) self_managed_opt_outs_enabled: ::std::option::Option<bool>,
    pub(crate) opt_out_list_name: ::std::option::Option<::std::string::String>,
    pub(crate) international_sending_enabled: ::std::option::Option<bool>,
    pub(crate) deletion_protection_enabled: ::std::option::Option<bool>,
}
impl UpdatePhoneNumberInputBuilder {
    /// <p>The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.</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>
    /// This field is required.
    pub fn phone_number_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.phone_number_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.</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_phone_number_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.phone_number_id = input;
        self
    }
    /// <p>The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.</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_phone_number_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.phone_number_id
    }
    /// <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.two_way_enabled = ::std::option::Option::Some(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.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.two_way_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.two_way_channel_arn = ::std::option::Option::Some(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.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.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.two_way_channel_role = ::std::option::Option::Some(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.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.two_way_channel_role
    }
    /// <p>By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. 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.self_managed_opt_outs_enabled = ::std::option::Option::Some(input);
        self
    }
    /// <p>By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. 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.self_managed_opt_outs_enabled = input;
        self
    }
    /// <p>By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. 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.self_managed_opt_outs_enabled
    }
    /// <p>The OptOutList to add the phone number to. You can use either the opt out list name or the opt out list ARN.</p>
    pub fn opt_out_list_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.opt_out_list_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The OptOutList to add the phone number to. You can use either the opt out list name or the opt out list ARN.</p>
    pub fn set_opt_out_list_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.opt_out_list_name = input;
        self
    }
    /// <p>The OptOutList to add the phone number to. You can use either the opt out list name or the opt out list ARN.</p>
    pub fn get_opt_out_list_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.opt_out_list_name
    }
    /// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
    pub fn international_sending_enabled(mut self, input: bool) -> Self {
        self.international_sending_enabled = ::std::option::Option::Some(input);
        self
    }
    /// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
    pub fn set_international_sending_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.international_sending_enabled = input;
        self
    }
    /// <p>By default this is set to false. When set to true the international sending of phone number is Enabled.</p>
    pub fn get_international_sending_enabled(&self) -> &::std::option::Option<bool> {
        &self.international_sending_enabled
    }
    /// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
    pub fn deletion_protection_enabled(mut self, input: bool) -> Self {
        self.deletion_protection_enabled = ::std::option::Option::Some(input);
        self
    }
    /// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
    pub fn set_deletion_protection_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.deletion_protection_enabled = input;
        self
    }
    /// <p>By default this is set to false. When set to true the phone number can't be deleted.</p>
    pub fn get_deletion_protection_enabled(&self) -> &::std::option::Option<bool> {
        &self.deletion_protection_enabled
    }
    /// Consumes the builder and constructs a [`UpdatePhoneNumberInput`](crate::operation::update_phone_number::UpdatePhoneNumberInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_phone_number::UpdatePhoneNumberInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::update_phone_number::UpdatePhoneNumberInput {
            phone_number_id: self.phone_number_id,
            two_way_enabled: self.two_way_enabled,
            two_way_channel_arn: self.two_way_channel_arn,
            two_way_channel_role: self.two_way_channel_role,
            self_managed_opt_outs_enabled: self.self_managed_opt_outs_enabled,
            opt_out_list_name: self.opt_out_list_name,
            international_sending_enabled: self.international_sending_enabled,
            deletion_protection_enabled: self.deletion_protection_enabled,
        })
    }
}