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.AddressConfiguration

Description

Documentation

data AddressConfiguration Source #

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

See: newAddressConfiguration smart constructor.

Constructors

AddressConfiguration'

Fields

substitutions :: Maybe (HashMap Text [Text])
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.
titleOverride :: Maybe Text
The message title to use instead of the default message title. This value overrides the default message title.
context :: Maybe (HashMap Text Text)
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.
rawContent :: Maybe Text
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
bodyOverride :: Maybe Text
The message body to use instead of the default message body. This value overrides the default message body.
channelType :: Maybe ChannelType
The channel to use when sending the message.

Instances

Instances details

Eq AddressConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.AddressConfiguration Methods (==) :: AddressConfiguration -> AddressConfiguration -> Bool # (/=) :: AddressConfiguration -> AddressConfiguration -> Bool #
Read AddressConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.AddressConfiguration Methods readsPrec :: Int -> ReadS AddressConfiguration # readList :: ReadS [AddressConfiguration] # readPrec :: ReadPrec AddressConfiguration # readListPrec :: ReadPrec [AddressConfiguration] #
Show AddressConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.AddressConfiguration Methods showsPrec :: Int -> AddressConfiguration -> ShowS # show :: AddressConfiguration -> String # showList :: [AddressConfiguration] -> ShowS #
Generic AddressConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.AddressConfiguration Associated Types type Rep AddressConfiguration :: Type -> Type # Methods from :: AddressConfiguration -> Rep AddressConfiguration x # to :: Rep AddressConfiguration x -> AddressConfiguration #
NFData AddressConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.AddressConfiguration Methods rnf :: AddressConfiguration -> () #
Hashable AddressConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.AddressConfiguration Methods hashWithSalt :: Int -> AddressConfiguration -> Int # hash :: AddressConfiguration -> Int #
ToJSON AddressConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.AddressConfiguration Methods toJSON :: AddressConfiguration -> Value # toEncoding :: AddressConfiguration -> Encoding # toJSONList :: [AddressConfiguration] -> Value # toEncodingList :: [AddressConfiguration] -> Encoding #
type Rep AddressConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.AddressConfiguration type Rep AddressConfiguration = D1 ('MetaData "AddressConfiguration" "Amazonka.Pinpoint.Types.AddressConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "AddressConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :: (S1 ('MetaSel ('Just "titleOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "bodyOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType))))))

newAddressConfiguration :: AddressConfiguration Source #

Create a value of AddressConfiguration 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:substitutions:AddressConfiguration', addressConfiguration_substitutions - 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.

$sel:titleOverride:AddressConfiguration', addressConfiguration_titleOverride - The message title to use instead of the default message title. This value overrides the default message title.

$sel:context:AddressConfiguration', addressConfiguration_context - 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.

$sel:rawContent:AddressConfiguration', addressConfiguration_rawContent - The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

$sel:bodyOverride:AddressConfiguration', addressConfiguration_bodyOverride - The message body to use instead of the default message body. This value overrides the default message body.

$sel:channelType:AddressConfiguration', addressConfiguration_channelType - The channel to use when sending the message.

addressConfiguration_substitutions :: Lens' AddressConfiguration (Maybe (HashMap Text [Text])) Source #

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.

addressConfiguration_titleOverride :: Lens' AddressConfiguration (Maybe Text) Source #

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

addressConfiguration_context :: Lens' AddressConfiguration (Maybe (HashMap Text Text)) Source #

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.

addressConfiguration_rawContent :: Lens' AddressConfiguration (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

addressConfiguration_bodyOverride :: Lens' AddressConfiguration (Maybe Text) Source #

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

addressConfiguration_channelType :: Lens' AddressConfiguration (Maybe ChannelType) Source #

The channel to use when sending the message.