#[non_exhaustive]pub struct SendTextMessageInput {Show 13 fields
pub destination_phone_number: Option<String>,
pub origination_identity: Option<String>,
pub message_body: Option<String>,
pub message_type: Option<MessageType>,
pub keyword: Option<String>,
pub configuration_set_name: Option<String>,
pub max_price: Option<String>,
pub time_to_live: Option<i32>,
pub context: Option<HashMap<String, String>>,
pub destination_country_parameters: Option<HashMap<DestinationCountryParameterKey, String>>,
pub dry_run: Option<bool>,
pub protect_configuration_id: Option<String>,
pub message_feedback_enabled: Option<bool>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.destination_phone_number: Option<String>The destination phone number in E.164 format.
origination_identity: Option<String>The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
message_body: Option<String>The body of the text message.
message_type: Option<MessageType>The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
keyword: Option<String>When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
configuration_set_name: Option<String>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
max_price: Option<String>The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.
time_to_live: Option<i32>How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.
context: Option<HashMap<String, String>>You can specify custom data in this field. If you do, that data is logged to the event destination.
destination_country_parameters: Option<HashMap<DestinationCountryParameterKey, String>>This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
-
IN_ENTITY_IDThe entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process. -
IN_TEMPLATE_IDThe template ID that you received after completing the sender ID registration process.Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.
dry_run: Option<bool>When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.
The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..
protect_configuration_id: Option<String>The unique identifier for the protect configuration.
message_feedback_enabled: Option<bool>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
Implementations§
Source§impl SendTextMessageInput
impl SendTextMessageInput
Sourcepub fn destination_phone_number(&self) -> Option<&str>
pub fn destination_phone_number(&self) -> Option<&str>
The destination phone number in E.164 format.
Sourcepub fn origination_identity(&self) -> Option<&str>
pub fn origination_identity(&self) -> Option<&str>
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Sourcepub fn message_body(&self) -> Option<&str>
pub fn message_body(&self) -> Option<&str>
The body of the text message.
Sourcepub fn message_type(&self) -> Option<&MessageType>
pub fn message_type(&self) -> Option<&MessageType>
The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
Sourcepub fn keyword(&self) -> Option<&str>
pub fn keyword(&self) -> Option<&str>
When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
Sourcepub fn configuration_set_name(&self) -> Option<&str>
pub fn configuration_set_name(&self) -> Option<&str>
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
Sourcepub fn max_price(&self) -> Option<&str>
pub fn max_price(&self) -> Option<&str>
The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.
Sourcepub fn time_to_live(&self) -> Option<i32>
pub fn time_to_live(&self) -> Option<i32>
How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.
Sourcepub fn context(&self) -> Option<&HashMap<String, String>>
pub fn context(&self) -> Option<&HashMap<String, String>>
You can specify custom data in this field. If you do, that data is logged to the event destination.
Sourcepub fn destination_country_parameters(
&self,
) -> Option<&HashMap<DestinationCountryParameterKey, String>>
pub fn destination_country_parameters( &self, ) -> Option<&HashMap<DestinationCountryParameterKey, String>>
This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
-
IN_ENTITY_IDThe entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process. -
IN_TEMPLATE_IDThe template ID that you received after completing the sender ID registration process.Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.
Sourcepub fn dry_run(&self) -> Option<bool>
pub fn dry_run(&self) -> Option<bool>
When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.
The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..
Sourcepub fn protect_configuration_id(&self) -> Option<&str>
pub fn protect_configuration_id(&self) -> Option<&str>
The unique identifier for the protect configuration.
Sourcepub fn message_feedback_enabled(&self) -> Option<bool>
pub fn message_feedback_enabled(&self) -> Option<bool>
Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
Source§impl SendTextMessageInput
impl SendTextMessageInput
Sourcepub fn builder() -> SendTextMessageInputBuilder
pub fn builder() -> SendTextMessageInputBuilder
Creates a new builder-style object to manufacture SendTextMessageInput.
Trait Implementations§
Source§impl Clone for SendTextMessageInput
impl Clone for SendTextMessageInput
Source§fn clone(&self) -> SendTextMessageInput
fn clone(&self) -> SendTextMessageInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SendTextMessageInput
impl Debug for SendTextMessageInput
Source§impl PartialEq for SendTextMessageInput
impl PartialEq for SendTextMessageInput
impl StructuralPartialEq for SendTextMessageInput
Auto Trait Implementations§
impl Freeze for SendTextMessageInput
impl RefUnwindSafe for SendTextMessageInput
impl Send for SendTextMessageInput
impl Sync for SendTextMessageInput
impl Unpin for SendTextMessageInput
impl UnwindSafe for SendTextMessageInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);