Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.PushNotificationTemplateRequest

Description

Synopsis

Documentation

data PushNotificationTemplateRequest Source #

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

See: newPushNotificationTemplateRequest smart constructor.

Constructors

PushNotificationTemplateRequest'

Fields

default' :: Maybe DefaultPushNotificationTemplate
The default message template to use for push notification channels.
templateDescription :: Maybe Text
A custom description of the message template.
gcm :: Maybe AndroidPushNotificationTemplate
The message template to use 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).
apns :: Maybe APNSPushNotificationTemplate
The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
defaultSubstitutions :: Maybe Text
A JSON object that specifies the default values to use 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. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
adm :: Maybe AndroidPushNotificationTemplate
The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
baidu :: Maybe AndroidPushNotificationTemplate
The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
recommenderId :: Maybe Text
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
tags :: Maybe (HashMap Text Text)
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Instances

Instances details

Eq PushNotificationTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest Methods (==) :: PushNotificationTemplateRequest -> PushNotificationTemplateRequest -> Bool # (/=) :: PushNotificationTemplateRequest -> PushNotificationTemplateRequest -> Bool #
Read PushNotificationTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest Methods readsPrec :: Int -> ReadS PushNotificationTemplateRequest # readList :: ReadS [PushNotificationTemplateRequest] # readPrec :: ReadPrec PushNotificationTemplateRequest # readListPrec :: ReadPrec [PushNotificationTemplateRequest] #
Show PushNotificationTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest Methods showsPrec :: Int -> PushNotificationTemplateRequest -> ShowS # show :: PushNotificationTemplateRequest -> String # showList :: [PushNotificationTemplateRequest] -> ShowS #
Generic PushNotificationTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest Associated Types type Rep PushNotificationTemplateRequest :: Type -> Type # Methods from :: PushNotificationTemplateRequest -> Rep PushNotificationTemplateRequest x # to :: Rep PushNotificationTemplateRequest x -> PushNotificationTemplateRequest #
NFData PushNotificationTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest Methods rnf :: PushNotificationTemplateRequest -> () #
Hashable PushNotificationTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest Methods hashWithSalt :: Int -> PushNotificationTemplateRequest -> Int # hash :: PushNotificationTemplateRequest -> Int #
ToJSON PushNotificationTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest Methods toJSON :: PushNotificationTemplateRequest -> Value # toEncoding :: PushNotificationTemplateRequest -> Encoding # toJSONList :: [PushNotificationTemplateRequest] -> Value # toEncodingList :: [PushNotificationTemplateRequest] -> Encoding #
type Rep PushNotificationTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest type Rep PushNotificationTemplateRequest = D1 ('MetaData "PushNotificationTemplateRequest" "Amazonka.Pinpoint.Types.PushNotificationTemplateRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "PushNotificationTemplateRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "default'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultPushNotificationTemplate)) :: S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "gcm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AndroidPushNotificationTemplate)) :: S1 ('MetaSel ('Just "apns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe APNSPushNotificationTemplate)))) :: ((S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "adm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AndroidPushNotificationTemplate))) :: (S1 ('MetaSel ('Just "baidu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AndroidPushNotificationTemplate)) :: (S1 ('MetaSel ('Just "recommenderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))))

newPushNotificationTemplateRequest :: PushNotificationTemplateRequest Source #

Create a value of PushNotificationTemplateRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:default':PushNotificationTemplateRequest', pushNotificationTemplateRequest_default - The default message template to use for push notification channels.

$sel:templateDescription:PushNotificationTemplateRequest', pushNotificationTemplateRequest_templateDescription - A custom description of the message template.

$sel:gcm:PushNotificationTemplateRequest', pushNotificationTemplateRequest_gcm - The message template to use 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).

$sel:apns:PushNotificationTemplateRequest', pushNotificationTemplateRequest_apns - The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:defaultSubstitutions:PushNotificationTemplateRequest', pushNotificationTemplateRequest_defaultSubstitutions - A JSON object that specifies the default values to use 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. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

$sel:adm:PushNotificationTemplateRequest', pushNotificationTemplateRequest_adm - The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:baidu:PushNotificationTemplateRequest', pushNotificationTemplateRequest_baidu - The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:recommenderId:PushNotificationTemplateRequest', pushNotificationTemplateRequest_recommenderId - The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

$sel:tags:PushNotificationTemplateRequest', pushNotificationTemplateRequest_tags - A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

pushNotificationTemplateRequest_default :: Lens' PushNotificationTemplateRequest (Maybe DefaultPushNotificationTemplate) Source #

The default message template to use for push notification channels.

pushNotificationTemplateRequest_templateDescription :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #

A custom description of the message template.

pushNotificationTemplateRequest_gcm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #

The message template to use 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).

pushNotificationTemplateRequest_apns :: Lens' PushNotificationTemplateRequest (Maybe APNSPushNotificationTemplate) Source #

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_defaultSubstitutions :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #

A JSON object that specifies the default values to use 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. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

pushNotificationTemplateRequest_adm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_baidu :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_recommenderId :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

pushNotificationTemplateRequest_tags :: Lens' PushNotificationTemplateRequest (Maybe (HashMap Text Text)) Source #

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