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

Description

Documentation

data EndpointSendConfiguration Source #

Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.

See: newEndpointSendConfiguration smart constructor.

Constructors

EndpointSendConfiguration'

Fields

substitutions :: Maybe (HashMap Text [Text])
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
titleOverride :: Maybe Text
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
context :: Maybe (HashMap Text Text)
A map of custom attributes to attach to the message for the address. 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 body of the message. If specified, this value overrides the default message body.

Instances

Instances details

Eq EndpointSendConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration Methods (==) :: EndpointSendConfiguration -> EndpointSendConfiguration -> Bool # (/=) :: EndpointSendConfiguration -> EndpointSendConfiguration -> Bool #
Read EndpointSendConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration Methods readsPrec :: Int -> ReadS EndpointSendConfiguration # readList :: ReadS [EndpointSendConfiguration] # readPrec :: ReadPrec EndpointSendConfiguration # readListPrec :: ReadPrec [EndpointSendConfiguration] #
Show EndpointSendConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration Methods showsPrec :: Int -> EndpointSendConfiguration -> ShowS # show :: EndpointSendConfiguration -> String # showList :: [EndpointSendConfiguration] -> ShowS #
Generic EndpointSendConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration Associated Types type Rep EndpointSendConfiguration :: Type -> Type # Methods from :: EndpointSendConfiguration -> Rep EndpointSendConfiguration x # to :: Rep EndpointSendConfiguration x -> EndpointSendConfiguration #
NFData EndpointSendConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration Methods rnf :: EndpointSendConfiguration -> () #
Hashable EndpointSendConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration Methods hashWithSalt :: Int -> EndpointSendConfiguration -> Int # hash :: EndpointSendConfiguration -> Int #
ToJSON EndpointSendConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration Methods toJSON :: EndpointSendConfiguration -> Value # toEncoding :: EndpointSendConfiguration -> Encoding # toJSONList :: [EndpointSendConfiguration] -> Value # toEncodingList :: [EndpointSendConfiguration] -> Encoding #
type Rep EndpointSendConfiguration Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration type Rep EndpointSendConfiguration = D1 ('MetaData "EndpointSendConfiguration" "Amazonka.Pinpoint.Types.EndpointSendConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointSendConfiguration'" '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))))))

newEndpointSendConfiguration :: EndpointSendConfiguration Source #

Create a value of EndpointSendConfiguration 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:EndpointSendConfiguration', endpointSendConfiguration_substitutions - A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.

$sel:titleOverride:EndpointSendConfiguration', endpointSendConfiguration_titleOverride - The title or subject line of the message. If specified, this value overrides the default message title or subject line.

$sel:context:EndpointSendConfiguration', endpointSendConfiguration_context - A map of custom attributes to attach to the message for the address. 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:EndpointSendConfiguration', endpointSendConfiguration_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:EndpointSendConfiguration', endpointSendConfiguration_bodyOverride - The body of the message. If specified, this value overrides the default message body.

endpointSendConfiguration_substitutions :: Lens' EndpointSendConfiguration (Maybe (HashMap Text [Text])) Source #

A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.

endpointSendConfiguration_titleOverride :: Lens' EndpointSendConfiguration (Maybe Text) Source #

The title or subject line of the message. If specified, this value overrides the default message title or subject line.

endpointSendConfiguration_context :: Lens' EndpointSendConfiguration (Maybe (HashMap Text Text)) Source #

A map of custom attributes to attach to the message for the address. 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.

endpointSendConfiguration_rawContent :: Lens' EndpointSendConfiguration (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.

endpointSendConfiguration_bodyOverride :: Lens' EndpointSendConfiguration (Maybe Text) Source #

The body of the message. If specified, this value overrides the default message body.