/AWS1/CL_PPTTEMPLATERESPONSE¶
Provides information about a message template that's associated with your Amazon Pinpoint account.
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. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.
Optional arguments:¶
iv_arn TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
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 isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
it_tags TYPE /AWS1/CL_PPTMAPOF__STRING_W=>TT_MAPOF__STRING TT_MAPOF__STRING¶
A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
iv_templatedescription TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
iv_version TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The unique identifier, as an integer, for the active version of the message template.
Queryable Attributes¶
Arn¶
The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
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 |
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 isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
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 |
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 map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
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. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
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. Possible values are: EMAIL, PUSH, SMS, INAPP, and 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.
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 |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_LISTOFTEMPLATERESPONSE¶
TYPES TT_LISTOFTEMPLATERESPONSE TYPE STANDARD TABLE OF REF TO /AWS1/CL_PPTTEMPLATERESPONSE WITH DEFAULT KEY
.