Struct aws_sdk_pinpoint::model::VoiceTemplateRequest

#[non_exhaustive]
pub struct VoiceTemplateRequest {
    pub body: Option<String>,
    pub default_substitutions: Option<String>,
    pub language_code: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub template_description: Option<String>,
    pub voice_id: Option<String>,
}

Specifies the content and settings for a message template that can be used in messages that are sent through the voice 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 text of the script to use in messages that are based on the message template, in plain text format.

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.

language_code: Option<String>

The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

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.

voice_id: Option<String>

The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

Implementations

impl VoiceTemplateRequest

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

The text of the script to use in messages that are based on the message template, in plain text format.

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 language_code(&self) -> Option<&str>

The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

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.

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

The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

impl VoiceTemplateRequest

pub fn builder() -> Builder

Creates a new builder-style object to manufacture VoiceTemplateRequest

Trait Implementations

impl Clone for VoiceTemplateRequest

fn clone(&self) -> VoiceTemplateRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VoiceTemplateRequest

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

Formats the value using the given formatter.

impl PartialEq<VoiceTemplateRequest> for VoiceTemplateRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for VoiceTemplateRequest