/AWS1/CL_PPTVOICETMPLREQUEST¶
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_body TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The text of the script to use in messages that are based on the message template, in plain text format.
iv_defaultsubstitutions TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
iv_languagecode TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
it_tags TYPE /AWS1/CL_PPTMAPOF__STRING_W=>TT_MAPOF__STRING TT_MAPOF__STRING¶
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) 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.
iv_templatedescription TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
A custom description of the message template.
iv_voiceid TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
Queryable Attributes¶
Body¶
The text of the script to use in messages that are based on the message template, in plain text format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BODY() |
Getter for BODY, with configurable default |
ASK_BODY() |
Getter for BODY w/ exceptions if field has no value |
HAS_BODY() |
Determine if BODY has a value |
DefaultSubstitutions¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTSUBSTITUTIONS() |
Getter for DEFAULTSUBSTITUTIONS, with configurable default |
ASK_DEFAULTSUBSTITUTIONS() |
Getter for DEFAULTSUBSTITUTIONS w/ exceptions if field has n |
HAS_DEFAULTSUBSTITUTIONS() |
Determine if DEFAULTSUBSTITUTIONS has a value |
LanguageCode¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LANGUAGECODE() |
Getter for LANGUAGECODE, with configurable default |
ASK_LANGUAGECODE() |
Getter for LANGUAGECODE w/ exceptions if field has no value |
HAS_LANGUAGECODE() |
Determine if LANGUAGECODE has a value |
tags¶
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
TemplateDescription¶
A custom description of the message template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEMPLATEDESCRIPTION() |
Getter for TEMPLATEDESCRIPTION, with configurable default |
ASK_TEMPLATEDESCRIPTION() |
Getter for TEMPLATEDESCRIPTION w/ exceptions if field has no |
HAS_TEMPLATEDESCRIPTION() |
Determine if TEMPLATEDESCRIPTION has a value |
VoiceId¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VOICEID() |
Getter for VOICEID, with configurable default |
ASK_VOICEID() |
Getter for VOICEID w/ exceptions if field has no value |
HAS_VOICEID() |
Determine if VOICEID has a value |