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

Description

Synopsis

data MessageRequest = MessageRequest' {
- traceId :: Maybe Text
- context :: Maybe (HashMap Text Text)
- addresses :: Maybe (HashMap Text AddressConfiguration)
- templateConfiguration :: Maybe TemplateConfiguration
- endpoints :: Maybe (HashMap Text EndpointSendConfiguration)
- messageConfiguration :: DirectMessageConfiguration
}
newMessageRequest :: DirectMessageConfiguration -> MessageRequest
messageRequest_traceId :: Lens' MessageRequest (Maybe Text)
messageRequest_context :: Lens' MessageRequest (Maybe (HashMap Text Text))
messageRequest_addresses :: Lens' MessageRequest (Maybe (HashMap Text AddressConfiguration))
messageRequest_templateConfiguration :: Lens' MessageRequest (Maybe TemplateConfiguration)
messageRequest_endpoints :: Lens' MessageRequest (Maybe (HashMap Text EndpointSendConfiguration))
messageRequest_messageConfiguration :: Lens' MessageRequest DirectMessageConfiguration

Documentation

data MessageRequest Source #

Specifies the configuration and other settings for a message.

See: newMessageRequest smart constructor.

Constructors

MessageRequest'

Fields

traceId :: Maybe Text
The unique identifier for tracing the message. This identifier is visible to message recipients.
context :: Maybe (HashMap Text Text)
A map of custom attributes to attach to the message. 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.
addresses :: Maybe (HashMap Text AddressConfiguration)
A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
templateConfiguration :: Maybe TemplateConfiguration
The message template to use for the message.
endpoints :: Maybe (HashMap Text EndpointSendConfiguration)
A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
messageConfiguration :: DirectMessageConfiguration
The settings and content for the default message and any default messages that you defined for specific channels.

Instances

Instances details

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

newMessageRequest Source #

Arguments

:: DirectMessageConfiguration	`$sel:messageConfiguration:MessageRequest'`
-> MessageRequest

Create a value of MessageRequest 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:traceId:MessageRequest', messageRequest_traceId - The unique identifier for tracing the message. This identifier is visible to message recipients.

$sel:context:MessageRequest', messageRequest_context - A map of custom attributes to attach to the message. 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:addresses:MessageRequest', messageRequest_addresses - A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

$sel:templateConfiguration:MessageRequest', messageRequest_templateConfiguration - The message template to use for the message.

$sel:endpoints:MessageRequest', messageRequest_endpoints - A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.

$sel:messageConfiguration:MessageRequest', messageRequest_messageConfiguration - The settings and content for the default message and any default messages that you defined for specific channels.

messageRequest_traceId :: Lens' MessageRequest (Maybe Text) Source #

The unique identifier for tracing the message. This identifier is visible to message recipients.

messageRequest_context :: Lens' MessageRequest (Maybe (HashMap Text Text)) Source #

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

messageRequest_addresses :: Lens' MessageRequest (Maybe (HashMap Text AddressConfiguration)) Source #

A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

messageRequest_templateConfiguration :: Lens' MessageRequest (Maybe TemplateConfiguration) Source #

The message template to use for the message.

messageRequest_endpoints :: Lens' MessageRequest (Maybe (HashMap Text EndpointSendConfiguration)) Source #

A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.

messageRequest_messageConfiguration :: Lens' MessageRequest DirectMessageConfiguration Source #

The settings and content for the default message and any default messages that you defined for specific channels.