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

Class: Aws::Pinpoint::Types::MessageConfiguration

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

Overview

Note:

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

{
  adm_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  apns_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  baidu_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  custom_message: {
    data: "__string",
  },
  default_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  email_message: {
    body: "__string",
    from_address: "__string",
    html_body: "__string",
    title: "__string",
  },
  gcm_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    time_to_live: 1,
    title: "__string",
    url: "__string",
  },
  sms_message: {
    body: "__string",
    message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
    sender_id: "__string",
  },
}

Specifies the message configuration settings for a campaign.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#adm_message ⇒ Types::Message

The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

Returns:

  • (Types::Message) —

    The message that the campaign sends through the ADM (Amazon Device Messaging) channel.

#apns_message ⇒ Types::Message

The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

Returns:

  • (Types::Message) —

    The message that the campaign sends through the APNs (Apple Push Notification service) channel.

#baidu_message ⇒ Types::Message

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

Returns:

  • (Types::Message) —

    The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.

#custom_message ⇒ Types::CampaignCustomMessage

The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

Returns:

  • (Types::CampaignCustomMessage) —

    The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign.

#default_message ⇒ Types::Message

The default message that the campaign sends through all the channels that are configured for the campaign.

Returns:

  • (Types::Message) —

    The default message that the campaign sends through all the channels that are configured for the campaign.

#email_message ⇒ Types::CampaignEmailMessage

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

Returns:

#gcm_message ⇒ Types::Message

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

Returns:

  • (Types::Message) —

    The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

#sms_message ⇒ Types::CampaignSmsMessage

The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

Returns: