/AWS1/CL_PPTCUSTOMMSGACTIVITY¶
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_deliveryuri TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
it_endpointtypes TYPE /AWS1/CL_PPTLSTOF__ENDPTTYPE00=>TT_LISTOF__ENDPTTYPESELEMENT TT_LISTOF__ENDPTTYPESELEMENT¶
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
io_messageconfig TYPE REF TO /AWS1/CL_PPTJOURNEYCUSTOMMSG /AWS1/CL_PPTJOURNEYCUSTOMMSG¶
Specifies the message data included in a custom channel message that's sent to participants in a journey.
iv_nextactivity TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
iv_templatename TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
iv_templateversion TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Queryable Attributes¶
DeliveryUri¶
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELIVERYURI() |
Getter for DELIVERYURI, with configurable default |
ASK_DELIVERYURI() |
Getter for DELIVERYURI w/ exceptions if field has no value |
HAS_DELIVERYURI() |
Determine if DELIVERYURI has a value |
EndpointTypes¶
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDPOINTTYPES() |
Getter for ENDPOINTTYPES, with configurable default |
ASK_ENDPOINTTYPES() |
Getter for ENDPOINTTYPES w/ exceptions if field has no value |
HAS_ENDPOINTTYPES() |
Determine if ENDPOINTTYPES has a value |
MessageConfig¶
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGECONFIG() |
Getter for MESSAGECONFIG |
NextActivity¶
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NEXTACTIVITY() |
Getter for NEXTACTIVITY, with configurable default |
ASK_NEXTACTIVITY() |
Getter for NEXTACTIVITY w/ exceptions if field has no value |
HAS_NEXTACTIVITY() |
Determine if NEXTACTIVITY has a value |
TemplateName¶
The name of the custom message template to use for the message. If specified, this value must match the name of an existing 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 |
TemplateVersion¶
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEMPLATEVERSION() |
Getter for TEMPLATEVERSION, with configurable default |
ASK_TEMPLATEVERSION() |
Getter for TEMPLATEVERSION w/ exceptions if field has no val |
HAS_TEMPLATEVERSION() |
Determine if TEMPLATEVERSION has a value |