Struct aws_sdk_pinpoint::model::JourneySmsMessage

#[non_exhaustive]
pub struct JourneySmsMessage {
    pub message_type: Option<MessageType>,
    pub origination_number: Option<String>,
    pub sender_id: Option<String>,
    pub entity_id: Option<String>,
    pub template_id: Option<String>,
}

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

message_type: Option<MessageType>

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

origination_number: Option<String>

The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

sender_id: Option<String>

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

entity_id: Option<String>

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

template_id: Option<String>

The template ID received from the regulatory body for sending SMS in your country.

Implementations

impl JourneySmsMessage

pub fn message_type(&self) -> Option<&MessageType>

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

pub fn origination_number(&self) -> Option<&str>

The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

pub fn sender_id(&self) -> Option<&str>

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

pub fn entity_id(&self) -> Option<&str>

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

pub fn template_id(&self) -> Option<&str>

The template ID received from the regulatory body for sending SMS in your country.

impl JourneySmsMessage

pub fn builder() -> Builder

Creates a new builder-style object to manufacture JourneySmsMessage

Trait Implementations

impl Clone for JourneySmsMessage

fn clone(&self) -> JourneySmsMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JourneySmsMessage

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

Formats the value using the given formatter.

impl PartialEq<JourneySmsMessage> for JourneySmsMessage

fn eq(&self, other: &JourneySmsMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &JourneySmsMessage) -> bool

This method tests for !=.

impl StructuralPartialEq for JourneySmsMessage