You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::EndpointSendConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EndpointSendConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  body_override: "__string",
  context: {
    "__string" => "__string",
  },
  raw_content: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
  title_override: "__string",
}

Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#body_override ⇒ String

The body of the message. If specified, this value overrides the default message body.

Returns:

  • (String) —

    The body of the message.

#context ⇒ Hash<String,String>

A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

Returns:

  • (Hash<String,String>) —

    A map of custom attributes to attach to the message for the address.

#raw_content ⇒ String

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

Returns:

  • (String) —

    The raw, JSON-formatted string to use as the payload for the message.

#substitutions ⇒ Hash<String,Array<String>>

A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.

Returns:

  • (Hash<String,Array<String>>) —

    A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions).

#title_override ⇒ String

The title or subject line of the message. If specified, this value overrides the default message title or subject line.

Returns:

  • (String) —

    The title or subject line of the message.