Struct aws_sdk_pinpointsmsvoicev2::client::fluent_builders::SendTextMessage

pub struct SendTextMessage { /* private fields */ }

Fluent builder constructing a request to SendTextMessage.

Creates a new text message and sends it to a recipient's phone number.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.

Implementations

impl SendTextMessage

pub async fn send(
    self
) -> Result<SendTextMessageOutput, SdkError<SendTextMessageError>>

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, which can be set when configuring the client.

pub fn destination_phone_number(self, input: impl Into<String>) -> Self

The destination phone number in E.164 format.

pub fn set_destination_phone_number(self, input: Option<String>) -> Self

The destination phone number in E.164 format.

pub fn origination_identity(self, input: impl Into<String>) -> Self

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

pub fn set_origination_identity(self, input: Option<String>) -> Self

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

pub fn message_body(self, input: impl Into<String>) -> Self

The body of the text message.

pub fn set_message_body(self, input: Option<String>) -> Self

The body of the text message.

pub fn message_type(self, input: MessageType) -> Self

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

pub fn set_message_type(self, input: Option<MessageType>) -> Self

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

pub fn keyword(self, input: impl Into<String>) -> Self

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.

pub fn set_keyword(self, input: Option<String>) -> Self

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.

pub fn configuration_set_name(self, input: impl Into<String>) -> Self

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

pub fn set_configuration_set_name(self, input: Option<String>) -> Self

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

pub fn max_price(self, input: impl Into<String>) -> Self

The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

pub fn set_max_price(self, input: Option<String>) -> Self

The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

pub fn time_to_live(self, input: i32) -> Self

How long the text message is valid for. By default this is 72 hours.

pub fn set_time_to_live(self, input: Option<i32>) -> Self

How long the text message is valid for. By default this is 72 hours.

pub fn context(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Context.

To override the contents of this collection use set_context.

You can specify custom data in this field. If you do, that data is logged to the event destination.

pub fn set_context(self, input: Option<HashMap<String, String>>) -> Self

You can specify custom data in this field. If you do, that data is logged to the event destination.

pub fn destination_country_parameters(
    self,
    k: DestinationCountryParameterKey,
    v: impl Into<String>
) -> Self

Adds a key-value pair to DestinationCountryParameters.

To override the contents of this collection use set_destination_country_parameters.

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.

pub fn set_destination_country_parameters(
    self,
    input: Option<HashMap<DestinationCountryParameterKey, String>>
) -> Self

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.

pub fn dry_run(self, input: bool) -> Self

When set to true, the message is checked and validated, but isn't sent to the end recipient.

pub fn set_dry_run(self, input: Option<bool>) -> Self

When set to true, the message is checked and validated, but isn't sent to the end recipient.

Trait Implementations

impl Clone for SendTextMessage

fn clone(&self) -> SendTextMessage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendTextMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.