Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pinpoint.Types.MessageRequest

Description

Synopsis

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

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.
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.
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.
templateConfiguration :: Maybe TemplateConfiguration
The message template to use for the message.
traceId :: Maybe Text
The unique identifier for tracing the message. This identifier is visible to message recipients.
messageConfiguration :: DirectMessageConfiguration
The settings and content for the default message and any default messages that you defined for specific channels.

Instances

Instances details

ToJSON MessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.MessageRequest Methods toJSON :: MessageRequest -> Value # toEncoding :: MessageRequest -> Encoding # toJSONList :: [MessageRequest] -> Value # toEncodingList :: [MessageRequest] -> Encoding #
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 #
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 #
NFData MessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.MessageRequest Methods rnf :: MessageRequest -> () #
Eq MessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.MessageRequest Methods (==) :: MessageRequest -> MessageRequest -> Bool # (/=) :: MessageRequest -> MessageRequest -> Bool #
Hashable MessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.MessageRequest Methods hashWithSalt :: Int -> MessageRequest -> Int # hash :: MessageRequest -> Int #
type Rep MessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.MessageRequest type Rep MessageRequest = D1 ('MetaData "MessageRequest" "Amazonka.Pinpoint.Types.MessageRequest" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "MessageRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AddressConfiguration))) :: (S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text EndpointSendConfiguration))))) :: (S1 ('MetaSel ('Just "templateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateConfiguration)) :: (S1 ('MetaSel ('Just "traceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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: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.

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: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:templateConfiguration:MessageRequest', messageRequest_templateConfiguration - The message template to use for the message.

$sel:traceId:MessageRequest', messageRequest_traceId - The unique identifier for tracing the message. This identifier is visible to message recipients.

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

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_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_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_templateConfiguration :: Lens' MessageRequest (Maybe TemplateConfiguration) Source #

The message template to use for the message.

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

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

messageRequest_messageConfiguration :: Lens' MessageRequest DirectMessageConfiguration Source #

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