Class: Aws::Pinpoint::Types::PushNotificationTemplateResponse

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::PushNotificationTemplateResponse

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #adm ⇒ Types::AndroidPushNotificationTemplate

  The message template that’s used for the ADM (Amazon Device Messaging) channel.

• #apns ⇒ Types::APNSPushNotificationTemplate

  The message template that’s used for the APNs (Apple Push Notification service) channel.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the message template.

• #baidu ⇒ Types::AndroidPushNotificationTemplate

  The message template that’s used for the Baidu (Baidu Cloud Push) channel.

• #creation_date ⇒ String

  The date, in ISO 8601 format, when the message template was created.

• #default ⇒ Types::DefaultPushNotificationTemplate

  The default message template that’s used for push notification channels.

• #default_substitutions ⇒ String

  The JSON object that specifies the default values that are used for message variables in the message template.

• #gcm ⇒ Types::AndroidPushNotificationTemplate

  The message template that’s used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

• #last_modified_date ⇒ String

  The date, in ISO 8601 format, when the message template was last modified.

• #recommender_id ⇒ String

  The unique identifier for the recommender model that’s used by the message template.

• #tags ⇒ Hash<String,String>

  A string-to-string map of key-value pairs that identifies the tags that are associated with the message template.

• #template_description ⇒ String

  The custom description of the message template.

• #template_name ⇒ String

  The name of the message template.

• #template_type ⇒ String

  The type of channel that the message template is designed for.

• #version ⇒ String

  The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

Instance Attribute Details

#adm ⇒ Types::AndroidPushNotificationTemplate

The message template that’s used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

• (Types::AndroidPushNotificationTemplate)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#apns ⇒ Types::APNSPushNotificationTemplate

The message template that’s used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

• (Types::APNSPushNotificationTemplate)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the message template.

Returns:

• (String)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#baidu ⇒ Types::AndroidPushNotificationTemplate

The message template that’s used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

• (Types::AndroidPushNotificationTemplate)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#creation_date ⇒ String

The date, in ISO 8601 format, when the message template was created.

Returns:

• (String)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#default ⇒ Types::DefaultPushNotificationTemplate

The default message template that’s used for push notification channels.

Returns:

• (Types::DefaultPushNotificationTemplate)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#default_substitutions ⇒ String

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

Returns:

• (String)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#gcm ⇒ Types::AndroidPushNotificationTemplate

The message template that’s used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

• (Types::AndroidPushNotificationTemplate)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#last_modified_date ⇒ String

The date, in ISO 8601 format, when the message template was last modified.

Returns:

• (String)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#recommender_id ⇒ String

The unique identifier for the recommender model that’s used by the message template.

Returns:

• (String)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

Returns:

• (Hash<String,String>)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#template_description ⇒ String

The custom description of the message template.

Returns:

• (String)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#template_name ⇒ String

The name of the message template.

Returns:

• (String)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#template_type ⇒ String

The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

Returns:

• (String)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end

#version ⇒ String

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

Returns:

• (String)

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

class PushNotificationTemplateResponse < Struct.new(
  :adm,
  :apns,
  :arn,
  :baidu,
  :creation_date,
  :default,
  :default_substitutions,
  :gcm,
  :last_modified_date,
  :recommender_id,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version)
  include Aws::Structure
end