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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#admTypes::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).



12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#apnsTypes::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).



12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

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

Returns:

  • (String)


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#baiduTypes::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).



12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateString

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

Returns:

  • (String)


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#defaultTypes::DefaultPushNotificationTemplate

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



12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#default_substitutionsString

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)


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#gcmTypes::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).



12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_dateString

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

Returns:

  • (String)


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#recommender_idString

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

Returns:

  • (String)


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

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


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#template_descriptionString

The custom description of the message template.

Returns:

  • (String)


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#template_nameString

The name of the message template.

Returns:

  • (String)


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#template_typeString

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

Returns:

  • (String)


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

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)


12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12921

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)
  SENSITIVE = []
  include Aws::Structure
end