aws-sdk-pinpointsmsvoicev2 1.124.0

// 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 CreateRcsAgentOutput {
    /// <p>The Amazon Resource Name (ARN) of the newly created RCS agent.</p>
    pub rcs_agent_arn: ::std::string::String,
    /// <p>The unique identifier for the RCS agent.</p>
    pub rcs_agent_id: ::std::string::String,
    /// <p>The current status of the RCS agent.</p>
    pub status: crate::types::RcsAgentStatus,
    /// <p>When set to true deletion protection is enabled. By default this is set to false.</p>
    pub deletion_protection_enabled: bool,
    /// <p>The name of the OptOutList associated with the RCS agent.</p>
    pub opt_out_list_name: ::std::option::Option<::std::string::String>,
    /// <p>The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
    pub created_timestamp: ::aws_smithy_types::DateTime,
    /// <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 self_managed_opt_outs_enabled: 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 true you can receive incoming text messages from your end recipients.</p>
    pub two_way_enabled: bool,
    /// <p>The name of the S3 bucket where inbound RCS media files are stored.</p>
    pub two_way_media_s3_bucket_name: ::std::option::Option<::std::string::String>,
    /// <p>The key prefix used for inbound RCS media objects in the S3 bucket.</p>
    pub two_way_media_s3_key_prefix: ::std::option::Option<::std::string::String>,
    /// <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.</p>
    pub two_way_media_s3_role: ::std::option::Option<::std::string::String>,
    /// <p>The list of RCS event types enabled for two-way messaging on the agent.</p>
    pub two_way_rcs_events_enabled: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>An array of tags (key and value pairs) associated with the RCS agent.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    _request_id: Option<String>,
}
impl CreateRcsAgentOutput {
    /// <p>The Amazon Resource Name (ARN) of the newly created RCS agent.</p>
    pub fn rcs_agent_arn(&self) -> &str {
        use std::ops::Deref;
        self.rcs_agent_arn.deref()
    }
    /// <p>The unique identifier for the RCS agent.</p>
    pub fn rcs_agent_id(&self) -> &str {
        use std::ops::Deref;
        self.rcs_agent_id.deref()
    }
    /// <p>The current status of the RCS agent.</p>
    pub fn status(&self) -> &crate::types::RcsAgentStatus {
        &self.status
    }
    /// <p>When set to true deletion protection is enabled. By default this is set to false.</p>
    pub fn deletion_protection_enabled(&self) -> bool {
        self.deletion_protection_enabled
    }
    /// <p>The name of the OptOutList associated with the RCS agent.</p>
    pub fn opt_out_list_name(&self) -> ::std::option::Option<&str> {
        self.opt_out_list_name.as_deref()
    }
    /// <p>The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
    pub fn created_timestamp(&self) -> &::aws_smithy_types::DateTime {
        &self.created_timestamp
    }
    /// <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(&self) -> bool {
        self.self_managed_opt_outs_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 true you can receive incoming text messages from your end recipients.</p>
    pub fn two_way_enabled(&self) -> bool {
        self.two_way_enabled
    }
    /// <p>The name of the S3 bucket where inbound RCS media files are stored.</p>
    pub fn two_way_media_s3_bucket_name(&self) -> ::std::option::Option<&str> {
        self.two_way_media_s3_bucket_name.as_deref()
    }
    /// <p>The key prefix used for inbound RCS media objects in the S3 bucket.</p>
    pub fn two_way_media_s3_key_prefix(&self) -> ::std::option::Option<&str> {
        self.two_way_media_s3_key_prefix.as_deref()
    }
    /// <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.</p>
    pub fn two_way_media_s3_role(&self) -> ::std::option::Option<&str> {
        self.two_way_media_s3_role.as_deref()
    }
    /// <p>The list of RCS event types enabled for two-way messaging on the agent.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.two_way_rcs_events_enabled.is_none()`.
    pub fn two_way_rcs_events_enabled(&self) -> &[::std::string::String] {
        self.two_way_rcs_events_enabled.as_deref().unwrap_or_default()
    }
    /// <p>An array of tags (key and value pairs) associated with the RCS agent.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
}
impl ::aws_types::request_id::RequestId for CreateRcsAgentOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl CreateRcsAgentOutput {
    /// Creates a new builder-style object to manufacture [`CreateRcsAgentOutput`](crate::operation::create_rcs_agent::CreateRcsAgentOutput).
    pub fn builder() -> crate::operation::create_rcs_agent::builders::CreateRcsAgentOutputBuilder {
        crate::operation::create_rcs_agent::builders::CreateRcsAgentOutputBuilder::default()
    }
}

/// A builder for [`CreateRcsAgentOutput`](crate::operation::create_rcs_agent::CreateRcsAgentOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateRcsAgentOutputBuilder {
    pub(crate) rcs_agent_arn: ::std::option::Option<::std::string::String>,
    pub(crate) rcs_agent_id: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::RcsAgentStatus>,
    pub(crate) deletion_protection_enabled: ::std::option::Option<bool>,
    pub(crate) opt_out_list_name: ::std::option::Option<::std::string::String>,
    pub(crate) created_timestamp: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) self_managed_opt_outs_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) two_way_enabled: ::std::option::Option<bool>,
    pub(crate) two_way_media_s3_bucket_name: ::std::option::Option<::std::string::String>,
    pub(crate) two_way_media_s3_key_prefix: ::std::option::Option<::std::string::String>,
    pub(crate) two_way_media_s3_role: ::std::option::Option<::std::string::String>,
    pub(crate) two_way_rcs_events_enabled: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    _request_id: Option<String>,
}
impl CreateRcsAgentOutputBuilder {
    /// <p>The Amazon Resource Name (ARN) of the newly created RCS agent.</p>
    /// This field is required.
    pub fn rcs_agent_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.rcs_agent_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the newly created RCS agent.</p>
    pub fn set_rcs_agent_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.rcs_agent_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the newly created RCS agent.</p>
    pub fn get_rcs_agent_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.rcs_agent_arn
    }
    /// <p>The unique identifier for the RCS agent.</p>
    /// This field is required.
    pub fn rcs_agent_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.rcs_agent_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier for the RCS agent.</p>
    pub fn set_rcs_agent_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.rcs_agent_id = input;
        self
    }
    /// <p>The unique identifier for the RCS agent.</p>
    pub fn get_rcs_agent_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.rcs_agent_id
    }
    /// <p>The current status of the RCS agent.</p>
    /// This field is required.
    pub fn status(mut self, input: crate::types::RcsAgentStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current status of the RCS agent.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::RcsAgentStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The current status of the RCS agent.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::RcsAgentStatus> {
        &self.status
    }
    /// <p>When set to true deletion protection is enabled. By default this is set to false.</p>
    /// This field is required.
    pub fn deletion_protection_enabled(mut self, input: bool) -> Self {
        self.deletion_protection_enabled = ::std::option::Option::Some(input);
        self
    }
    /// <p>When set to true deletion protection is enabled. By default this is set to false.</p>
    pub fn set_deletion_protection_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.deletion_protection_enabled = input;
        self
    }
    /// <p>When set to true deletion protection is enabled. By default this is set to false.</p>
    pub fn get_deletion_protection_enabled(&self) -> &::std::option::Option<bool> {
        &self.deletion_protection_enabled
    }
    /// <p>The name of the OptOutList associated with the RCS agent.</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 name of the OptOutList associated with the RCS agent.</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 name of the OptOutList associated with the RCS agent.</p>
    pub fn get_opt_out_list_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.opt_out_list_name
    }
    /// <p>The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
    /// This field is required.
    pub fn created_timestamp(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_timestamp = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
    pub fn set_created_timestamp(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_timestamp = input;
        self
    }
    /// <p>The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
    pub fn get_created_timestamp(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_timestamp
    }
    /// <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>
    /// This field is required.
    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 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 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 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 true you can receive incoming text messages from your end recipients.</p>
    /// This field is required.
    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 name of the S3 bucket where inbound RCS media files are stored.</p>
    pub fn two_way_media_s3_bucket_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.two_way_media_s3_bucket_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the S3 bucket where inbound RCS media files are stored.</p>
    pub fn set_two_way_media_s3_bucket_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.two_way_media_s3_bucket_name = input;
        self
    }
    /// <p>The name of the S3 bucket where inbound RCS media files are stored.</p>
    pub fn get_two_way_media_s3_bucket_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.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.two_way_media_s3_key_prefix = ::std::option::Option::Some(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.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.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.</p>
    pub fn two_way_media_s3_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.two_way_media_s3_role = ::std::option::Option::Some(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.</p>
    pub fn set_two_way_media_s3_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.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.</p>
    pub fn get_two_way_media_s3_role(&self) -> &::std::option::Option<::std::string::String> {
        &self.two_way_media_s3_role
    }
    /// Appends an item to `two_way_rcs_events_enabled`.
    ///
    /// 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 enabled for two-way messaging on the agent.</p>
    pub fn two_way_rcs_events_enabled(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.two_way_rcs_events_enabled.unwrap_or_default();
        v.push(input.into());
        self.two_way_rcs_events_enabled = ::std::option::Option::Some(v);
        self
    }
    /// <p>The list of RCS event types enabled for two-way messaging on the agent.</p>
    pub fn set_two_way_rcs_events_enabled(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.two_way_rcs_events_enabled = input;
        self
    }
    /// <p>The list of RCS event types enabled for two-way messaging on the agent.</p>
    pub fn get_two_way_rcs_events_enabled(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.two_way_rcs_events_enabled
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>An array of tags (key and value pairs) associated with the RCS agent.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>An array of tags (key and value pairs) associated with the RCS agent.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>An array of tags (key and value pairs) associated with the RCS agent.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`CreateRcsAgentOutput`](crate::operation::create_rcs_agent::CreateRcsAgentOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`rcs_agent_arn`](crate::operation::create_rcs_agent::builders::CreateRcsAgentOutputBuilder::rcs_agent_arn)
    /// - [`rcs_agent_id`](crate::operation::create_rcs_agent::builders::CreateRcsAgentOutputBuilder::rcs_agent_id)
    /// - [`status`](crate::operation::create_rcs_agent::builders::CreateRcsAgentOutputBuilder::status)
    /// - [`created_timestamp`](crate::operation::create_rcs_agent::builders::CreateRcsAgentOutputBuilder::created_timestamp)
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_rcs_agent::CreateRcsAgentOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_rcs_agent::CreateRcsAgentOutput {
            rcs_agent_arn: self.rcs_agent_arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "rcs_agent_arn",
                    "rcs_agent_arn was not specified but it is required when building CreateRcsAgentOutput",
                )
            })?,
            rcs_agent_id: self.rcs_agent_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "rcs_agent_id",
                    "rcs_agent_id was not specified but it is required when building CreateRcsAgentOutput",
                )
            })?,
            status: self.status.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "status",
                    "status was not specified but it is required when building CreateRcsAgentOutput",
                )
            })?,
            deletion_protection_enabled: self.deletion_protection_enabled.unwrap_or_default(),
            opt_out_list_name: self.opt_out_list_name,
            created_timestamp: self.created_timestamp.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "created_timestamp",
                    "created_timestamp was not specified but it is required when building CreateRcsAgentOutput",
                )
            })?,
            self_managed_opt_outs_enabled: self.self_managed_opt_outs_enabled.unwrap_or_default(),
            two_way_channel_arn: self.two_way_channel_arn,
            two_way_channel_role: self.two_way_channel_role,
            two_way_enabled: self.two_way_enabled.unwrap_or_default(),
            two_way_media_s3_bucket_name: self.two_way_media_s3_bucket_name,
            two_way_media_s3_key_prefix: self.two_way_media_s3_key_prefix,
            two_way_media_s3_role: self.two_way_media_s3_role,
            two_way_rcs_events_enabled: self.two_way_rcs_events_enabled,
            tags: self.tags,
            _request_id: self._request_id,
        })
    }
}