Struct aws_sdk_pinpoint::model::CustomMessageActivity

#[non_exhaustive]
pub struct CustomMessageActivity {
    pub delivery_uri: Option<String>,
    pub endpoint_types: Option<Vec<EndpointTypesElement>>,
    pub message_config: Option<JourneyCustomMessage>,
    pub next_activity: Option<String>,
    pub template_name: Option<String>,
    pub template_version: Option<String>,
}

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

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.

delivery_uri: Option<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.

endpoint_types: Option<Vec<EndpointTypesElement>>

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.

message_config: Option<JourneyCustomMessage>

Specifies the message data included in a custom channel message that's sent to participants in a journey.

next_activity: Option<String>

The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

template_name: Option<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.

template_version: Option<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.

Implementations

impl CustomMessageActivity

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

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.

pub fn endpoint_types(&self) -> Option<&[EndpointTypesElement]>

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.

pub fn message_config(&self) -> Option<&JourneyCustomMessage>

Specifies the message data included in a custom channel message that's sent to participants in a journey.

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

The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

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

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.

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

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.

impl CustomMessageActivity

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CustomMessageActivity

Trait Implementations

impl Clone for CustomMessageActivity

fn clone(&self) -> CustomMessageActivity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomMessageActivity

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

Formats the value using the given formatter.

impl PartialEq<CustomMessageActivity> for CustomMessageActivity

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

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

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

This method tests for !=.

impl StructuralPartialEq for CustomMessageActivity