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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass EndpointSendConfiguration data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#body_overrideString

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

Returns:

  • (String)


7219
7220
7221
7222
7223
7224
7225
7226
7227
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7219

class EndpointSendConfiguration < Struct.new(
  :body_override,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  SENSITIVE = []
  include Aws::Structure
end

#contextHash<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>)


7219
7220
7221
7222
7223
7224
7225
7226
7227
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7219

class EndpointSendConfiguration < Struct.new(
  :body_override,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  SENSITIVE = []
  include Aws::Structure
end

#raw_contentString

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)


7219
7220
7221
7222
7223
7224
7225
7226
7227
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7219

class EndpointSendConfiguration < Struct.new(
  :body_override,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  SENSITIVE = []
  include Aws::Structure
end

#substitutionsHash<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>>)


7219
7220
7221
7222
7223
7224
7225
7226
7227
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7219

class EndpointSendConfiguration < Struct.new(
  :body_override,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  SENSITIVE = []
  include Aws::Structure
end

#title_overrideString

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

Returns:

  • (String)


7219
7220
7221
7222
7223
7224
7225
7226
7227
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7219

class EndpointSendConfiguration < Struct.new(
  :body_override,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  SENSITIVE = []
  include Aws::Structure
end