/AWS1/CL_PPTVOICETMPLRESPONSE¶
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_creationdate TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The date, in ISO 8601 format, when the message template was created.
iv_lastmodifieddate TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The date, in ISO 8601 format, when the message template was last modified.
iv_templatename TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The name of the message template.
iv_templatetype TYPE /AWS1/PPTTEMPLATETYPE /AWS1/PPTTEMPLATETYPE¶
The type of channel that the message template is designed for. For a voice template, this value is VOICE.
Optional arguments:¶
iv_arn TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The Amazon Resource Name (ARN) of the message template.
iv_body TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The text of the script that's used in messages that are based on the message template, in plain text format.
iv_defaultsubstitutions TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The JSON object that specifies the default values that are used 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.
iv_languagecode TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The code for the language that's used 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¶
A string-to-string map of key-value pairs that identifies the tags that are associated 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¶
The custom description of the message template.
iv_version TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
iv_voiceid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
Queryable Attributes¶
Arn¶
The Amazon Resource Name (ARN) of the message template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
Body¶
The text of the script that's used 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 |
CreationDate¶
The date, in ISO 8601 format, when the message template was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
DefaultSubstitutions¶
The JSON object that specifies the default values that are used 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.
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 that's used 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 |
LastModifiedDate¶
The date, in ISO 8601 format, when the message template was last modified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE, with configurable default |
ASK_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE w/ exceptions if field has no va |
HAS_LASTMODIFIEDDATE() |
Determine if LASTMODIFIEDDATE has a value |
tags¶
A string-to-string map of key-value pairs that identifies the tags that are associated 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¶
The 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 |
TemplateName¶
The name of the message template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEMPLATENAME() |
Getter for TEMPLATENAME, with configurable default |
ASK_TEMPLATENAME() |
Getter for TEMPLATENAME w/ exceptions if field has no value |
HAS_TEMPLATENAME() |
Determine if TEMPLATENAME has a value |
TemplateType¶
The type of channel that the message template is designed for. For a voice template, this value is VOICE.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEMPLATETYPE() |
Getter for TEMPLATETYPE, with configurable default |
ASK_TEMPLATETYPE() |
Getter for TEMPLATETYPE w/ exceptions if field has no value |
HAS_TEMPLATETYPE() |
Determine if TEMPLATETYPE has a value |
Version¶
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSION() |
Getter for VERSION, with configurable default |
ASK_VERSION() |
Getter for VERSION w/ exceptions if field has no value |
HAS_VERSION() |
Determine if VERSION has a value |
VoiceId¶
The name of the voice that's used 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 |