Struct aws_sdk_pinpoint::model::SmsTemplateRequest

#[non_exhaustive]
pub struct SmsTemplateRequest {
    pub body: Option<String>,
    pub default_substitutions: Option<String>,
    pub recommender_id: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub template_description: Option<String>,
}

Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

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.

body: Option<String>

The message body to use in text messages that are based on the message template.

default_substitutions: Option<String>

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

recommender_id: Option<String>

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

tags: Option<HashMap<String, String>>

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

template_description: Option<String>

A custom description of the message template.

Implementations

impl SmsTemplateRequest

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

The message body to use in text messages that are based on the message template.

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

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

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

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

pub fn tags(&self) -> Option<&HashMap<String, String>>

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

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

A custom description of the message template.

impl SmsTemplateRequest

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SmsTemplateRequest

Trait Implementations

impl Clone for SmsTemplateRequest

fn clone(&self) -> SmsTemplateRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SmsTemplateRequest

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

Formats the value using the given formatter.

impl PartialEq<SmsTemplateRequest> for SmsTemplateRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for SmsTemplateRequest