Class: Aws::Pinpoint::Types::CustomMessageActivity

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::CustomMessageActivity

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #delivery_uri ⇒ String

  The destination to send the campaign or treatment to.

• #endpoint_types ⇒ Array<String>

  The types of endpoints to send the custom message to.

• #message_config ⇒ Types::JourneyCustomMessage

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

• #next_activity ⇒ String

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

• #template_name ⇒ String

  The name of the custom message template to use for the message.

• #template_version ⇒ String

  The unique identifier for the version of the message template to use for the message.

Instance Attribute Details

#delivery_uri ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3254

class CustomMessageActivity < Struct.new(
  :delivery_uri,
  :endpoint_types,
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_types ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3254

class CustomMessageActivity < Struct.new(
  :delivery_uri,
  :endpoint_types,
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end

#message_config ⇒ Types::JourneyCustomMessage

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

Returns:

• (Types::JourneyCustomMessage)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3254

class CustomMessageActivity < Struct.new(
  :delivery_uri,
  :endpoint_types,
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end

#next_activity ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3254

class CustomMessageActivity < Struct.new(
  :delivery_uri,
  :endpoint_types,
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3254

class CustomMessageActivity < Struct.new(
  :delivery_uri,
  :endpoint_types,
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end

#template_version ⇒ 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 <link linkend=“templates-template-name-template-type-versions” />

Template Versions</link> 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.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3254

class CustomMessageActivity < Struct.new(
  :delivery_uri,
  :endpoint_types,
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  SENSITIVE = []
  include Aws::Structure
end