Amazonka.Pinpoint.Types.MessageRequest

Documentation

data MessageRequest

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

ToJSON MessageRequest

Defined in Amazonka.Pinpoint.Types.MessageRequest

Methods

toJSON :: MessageRequest -> Value

toEncoding :: MessageRequest -> Encoding

toJSONList :: [MessageRequest] -> Value

toEncodingList :: [MessageRequest] -> Encoding

Generic MessageRequest

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

Defined in Amazonka.Pinpoint.Types.MessageRequest

Methods

readsPrec :: Int -> ReadS MessageRequest

readList :: ReadS [MessageRequest]

readPrec :: ReadPrec MessageRequest

readListPrec :: ReadPrec [MessageRequest]

Show MessageRequest

Defined in Amazonka.Pinpoint.Types.MessageRequest

Methods

showsPrec :: Int -> MessageRequest -> ShowS

show :: MessageRequest -> String

showList :: [MessageRequest] -> ShowS

NFData MessageRequest

Defined in Amazonka.Pinpoint.Types.MessageRequest

Methods

rnf :: MessageRequest -> ()

Eq MessageRequest

Defined in Amazonka.Pinpoint.Types.MessageRequest

Methods

(==) :: MessageRequest -> MessageRequest -> Bool

(/=) :: MessageRequest -> MessageRequest -> Bool

Hashable MessageRequest

Defined in Amazonka.Pinpoint.Types.MessageRequest

Methods

hashWithSalt :: Int -> MessageRequest -> Int

hash :: MessageRequest -> Int

type Rep MessageRequest

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

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))

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))

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))

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)

The message template to use for the message.

messageRequest_traceId :: Lens' MessageRequest (Maybe Text)

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

messageRequest_messageConfiguration :: Lens' MessageRequest DirectMessageConfiguration

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