// 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 SendMediaMessageInput {
/// <p>The destination phone number in E.164 format.</p>
pub destination_phone_number: ::std::option::Option<::std::string::String>,
/// <p>The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.</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 origination_identity: ::std::option::Option<::std::string::String>,
/// <p>The text body of the message.</p>
pub message_body: ::std::option::Option<::std::string::String>,
/// <p>An array of URLs to each media file to send.</p>
/// <p>The media files have to be stored in an S3 bucket. Supported media file formats are listed in <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html">MMS file types, size and character limits</a>. For more information on creating an S3 bucket and managing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html">Creating a bucket</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html">Uploading objects</a> in the <i>Amazon S3 User Guide</i>, and <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/send-mms-message.html#send-mms-message-bucket">Setting up an Amazon S3 bucket for MMS files</a> in the <i>Amazon Web Services End User Messaging SMS User Guide</i>.</p>
pub media_urls: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub configuration_set_name: ::std::option::Option<::std::string::String>,
/// <p>The maximum amount that you want to spend, in US dollars, per each MMS message.</p>
pub max_price: ::std::option::Option<::std::string::String>,
/// <p>How long the media message is valid for. By default this is 72 hours.</p>
pub time_to_live: ::std::option::Option<i32>,
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub context: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub dry_run: ::std::option::Option<bool>,
/// <p>The unique identifier of the protect configuration to use.</p>
pub protect_configuration_id: ::std::option::Option<::std::string::String>,
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub message_feedback_enabled: ::std::option::Option<bool>,
}
impl SendMediaMessageInput {
/// <p>The destination phone number in E.164 format.</p>
pub fn destination_phone_number(&self) -> ::std::option::Option<&str> {
self.destination_phone_number.as_deref()
}
/// <p>The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.</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 origination_identity(&self) -> ::std::option::Option<&str> {
self.origination_identity.as_deref()
}
/// <p>The text body of the message.</p>
pub fn message_body(&self) -> ::std::option::Option<&str> {
self.message_body.as_deref()
}
/// <p>An array of URLs to each media file to send.</p>
/// <p>The media files have to be stored in an S3 bucket. Supported media file formats are listed in <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html">MMS file types, size and character limits</a>. For more information on creating an S3 bucket and managing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html">Creating a bucket</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html">Uploading objects</a> in the <i>Amazon S3 User Guide</i>, and <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/send-mms-message.html#send-mms-message-bucket">Setting up an Amazon S3 bucket for MMS files</a> in the <i>Amazon Web Services End User Messaging SMS User Guide</i>.</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 `.media_urls.is_none()`.
pub fn media_urls(&self) -> &[::std::string::String] {
self.media_urls.as_deref().unwrap_or_default()
}
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub fn configuration_set_name(&self) -> ::std::option::Option<&str> {
self.configuration_set_name.as_deref()
}
/// <p>The maximum amount that you want to spend, in US dollars, per each MMS message.</p>
pub fn max_price(&self) -> ::std::option::Option<&str> {
self.max_price.as_deref()
}
/// <p>How long the media message is valid for. By default this is 72 hours.</p>
pub fn time_to_live(&self) -> ::std::option::Option<i32> {
self.time_to_live
}
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub fn context(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.context.as_ref()
}
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub fn dry_run(&self) -> ::std::option::Option<bool> {
self.dry_run
}
/// <p>The unique identifier of the protect configuration to use.</p>
pub fn protect_configuration_id(&self) -> ::std::option::Option<&str> {
self.protect_configuration_id.as_deref()
}
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub fn message_feedback_enabled(&self) -> ::std::option::Option<bool> {
self.message_feedback_enabled
}
}
impl SendMediaMessageInput {
/// Creates a new builder-style object to manufacture [`SendMediaMessageInput`](crate::operation::send_media_message::SendMediaMessageInput).
pub fn builder() -> crate::operation::send_media_message::builders::SendMediaMessageInputBuilder {
crate::operation::send_media_message::builders::SendMediaMessageInputBuilder::default()
}
}
/// A builder for [`SendMediaMessageInput`](crate::operation::send_media_message::SendMediaMessageInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SendMediaMessageInputBuilder {
pub(crate) destination_phone_number: ::std::option::Option<::std::string::String>,
pub(crate) origination_identity: ::std::option::Option<::std::string::String>,
pub(crate) message_body: ::std::option::Option<::std::string::String>,
pub(crate) media_urls: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) configuration_set_name: ::std::option::Option<::std::string::String>,
pub(crate) max_price: ::std::option::Option<::std::string::String>,
pub(crate) time_to_live: ::std::option::Option<i32>,
pub(crate) context: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) dry_run: ::std::option::Option<bool>,
pub(crate) protect_configuration_id: ::std::option::Option<::std::string::String>,
pub(crate) message_feedback_enabled: ::std::option::Option<bool>,
}
impl SendMediaMessageInputBuilder {
/// <p>The destination phone number in E.164 format.</p>
/// This field is required.
pub fn destination_phone_number(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.destination_phone_number = ::std::option::Option::Some(input.into());
self
}
/// <p>The destination phone number in E.164 format.</p>
pub fn set_destination_phone_number(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.destination_phone_number = input;
self
}
/// <p>The destination phone number in E.164 format.</p>
pub fn get_destination_phone_number(&self) -> &::std::option::Option<::std::string::String> {
&self.destination_phone_number
}
/// <p>The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.</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 origination_identity(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.origination_identity = ::std::option::Option::Some(input.into());
self
}
/// <p>The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.</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_origination_identity(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.origination_identity = input;
self
}
/// <p>The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.</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_origination_identity(&self) -> &::std::option::Option<::std::string::String> {
&self.origination_identity
}
/// <p>The text body of the message.</p>
pub fn message_body(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.message_body = ::std::option::Option::Some(input.into());
self
}
/// <p>The text body of the message.</p>
pub fn set_message_body(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.message_body = input;
self
}
/// <p>The text body of the message.</p>
pub fn get_message_body(&self) -> &::std::option::Option<::std::string::String> {
&self.message_body
}
/// Appends an item to `media_urls`.
///
/// To override the contents of this collection use [`set_media_urls`](Self::set_media_urls).
///
/// <p>An array of URLs to each media file to send.</p>
/// <p>The media files have to be stored in an S3 bucket. Supported media file formats are listed in <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html">MMS file types, size and character limits</a>. For more information on creating an S3 bucket and managing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html">Creating a bucket</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html">Uploading objects</a> in the <i>Amazon S3 User Guide</i>, and <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/send-mms-message.html#send-mms-message-bucket">Setting up an Amazon S3 bucket for MMS files</a> in the <i>Amazon Web Services End User Messaging SMS User Guide</i>.</p>
pub fn media_urls(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.media_urls.unwrap_or_default();
v.push(input.into());
self.media_urls = ::std::option::Option::Some(v);
self
}
/// <p>An array of URLs to each media file to send.</p>
/// <p>The media files have to be stored in an S3 bucket. Supported media file formats are listed in <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html">MMS file types, size and character limits</a>. For more information on creating an S3 bucket and managing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html">Creating a bucket</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html">Uploading objects</a> in the <i>Amazon S3 User Guide</i>, and <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/send-mms-message.html#send-mms-message-bucket">Setting up an Amazon S3 bucket for MMS files</a> in the <i>Amazon Web Services End User Messaging SMS User Guide</i>.</p>
pub fn set_media_urls(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.media_urls = input;
self
}
/// <p>An array of URLs to each media file to send.</p>
/// <p>The media files have to be stored in an S3 bucket. Supported media file formats are listed in <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html">MMS file types, size and character limits</a>. For more information on creating an S3 bucket and managing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html">Creating a bucket</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html">Uploading objects</a> in the <i>Amazon S3 User Guide</i>, and <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/send-mms-message.html#send-mms-message-bucket">Setting up an Amazon S3 bucket for MMS files</a> in the <i>Amazon Web Services End User Messaging SMS User Guide</i>.</p>
pub fn get_media_urls(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.media_urls
}
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub fn configuration_set_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.configuration_set_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub fn set_configuration_set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.configuration_set_name = input;
self
}
/// <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
pub fn get_configuration_set_name(&self) -> &::std::option::Option<::std::string::String> {
&self.configuration_set_name
}
/// <p>The maximum amount that you want to spend, in US dollars, per each MMS message.</p>
pub fn max_price(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.max_price = ::std::option::Option::Some(input.into());
self
}
/// <p>The maximum amount that you want to spend, in US dollars, per each MMS message.</p>
pub fn set_max_price(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.max_price = input;
self
}
/// <p>The maximum amount that you want to spend, in US dollars, per each MMS message.</p>
pub fn get_max_price(&self) -> &::std::option::Option<::std::string::String> {
&self.max_price
}
/// <p>How long the media message is valid for. By default this is 72 hours.</p>
pub fn time_to_live(mut self, input: i32) -> Self {
self.time_to_live = ::std::option::Option::Some(input);
self
}
/// <p>How long the media message is valid for. By default this is 72 hours.</p>
pub fn set_time_to_live(mut self, input: ::std::option::Option<i32>) -> Self {
self.time_to_live = input;
self
}
/// <p>How long the media message is valid for. By default this is 72 hours.</p>
pub fn get_time_to_live(&self) -> &::std::option::Option<i32> {
&self.time_to_live
}
/// Adds a key-value pair to `context`.
///
/// To override the contents of this collection use [`set_context`](Self::set_context).
///
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub fn context(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.context.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.context = ::std::option::Option::Some(hash_map);
self
}
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub fn set_context(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.context = input;
self
}
/// <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
pub fn get_context(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.context
}
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub fn dry_run(mut self, input: bool) -> Self {
self.dry_run = ::std::option::Option::Some(input);
self
}
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
self.dry_run = input;
self
}
/// <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
&self.dry_run
}
/// <p>The unique identifier of the protect configuration to use.</p>
pub fn protect_configuration_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.protect_configuration_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique identifier of the protect configuration to use.</p>
pub fn set_protect_configuration_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.protect_configuration_id = input;
self
}
/// <p>The unique identifier of the protect configuration to use.</p>
pub fn get_protect_configuration_id(&self) -> &::std::option::Option<::std::string::String> {
&self.protect_configuration_id
}
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub fn message_feedback_enabled(mut self, input: bool) -> Self {
self.message_feedback_enabled = ::std::option::Option::Some(input);
self
}
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub fn set_message_feedback_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.message_feedback_enabled = input;
self
}
/// <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <code>PutMessageFeedback</code>.</p>
pub fn get_message_feedback_enabled(&self) -> &::std::option::Option<bool> {
&self.message_feedback_enabled
}
/// Consumes the builder and constructs a [`SendMediaMessageInput`](crate::operation::send_media_message::SendMediaMessageInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::send_media_message::SendMediaMessageInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::send_media_message::SendMediaMessageInput {
destination_phone_number: self.destination_phone_number,
origination_identity: self.origination_identity,
message_body: self.message_body,
media_urls: self.media_urls,
configuration_set_name: self.configuration_set_name,
max_price: self.max_price,
time_to_live: self.time_to_live,
context: self.context,
dry_run: self.dry_run,
protect_configuration_id: self.protect_configuration_id,
message_feedback_enabled: self.message_feedback_enabled,
})
}
}