Class: Aws::Pinpoint::Types::AddressConfiguration

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 AddressConfiguration data as a hash:

{
  body_override: "__string",
  channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
  context: {
    "__string" => "__string",
  },
  raw_content: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
  title_override: "__string",
}

Specifies address-based configuration settings for a message that's sent directly to an endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#body_overrideString

The message body to use instead of the default message body. This value overrides the default message body.

Returns:

  • (String)


1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1730

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

#channel_typeString

The channel to use when sending the message.

Returns:

  • (String)


1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1730

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

#contextHash<String,String>

An object that maps custom attributes to attributes for the address and is attached to the message. 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>)


1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1730

class AddressConfiguration < Struct.new(
  :body_override,
  :channel_type,
  :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)


1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1730

class AddressConfiguration < Struct.new(
  :body_override,
  :channel_type,
  :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 by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

Returns:

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


1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1730

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

#title_overrideString

The message title to use instead of the default message title. This value overrides the default message title.

Returns:

  • (String)


1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1730

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