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

Description

Documentation

data SendUsersMessageRequest Source #

Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

See: newSendUsersMessageRequest smart constructor.

Constructors

SendUsersMessageRequest'

Fields

context :: Maybe (HashMap Text Text)
A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
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.
users :: HashMap Text EndpointSendConfiguration
A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

Instances

Instances details

ToJSON SendUsersMessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest Methods toJSON :: SendUsersMessageRequest -> Value # toEncoding :: SendUsersMessageRequest -> Encoding # toJSONList :: [SendUsersMessageRequest] -> Value # toEncodingList :: [SendUsersMessageRequest] -> Encoding #
Generic SendUsersMessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest Associated Types type Rep SendUsersMessageRequest :: Type -> Type # Methods from :: SendUsersMessageRequest -> Rep SendUsersMessageRequest x # to :: Rep SendUsersMessageRequest x -> SendUsersMessageRequest #
Read SendUsersMessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest Methods readsPrec :: Int -> ReadS SendUsersMessageRequest # readList :: ReadS [SendUsersMessageRequest] # readPrec :: ReadPrec SendUsersMessageRequest # readListPrec :: ReadPrec [SendUsersMessageRequest] #
Show SendUsersMessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest Methods showsPrec :: Int -> SendUsersMessageRequest -> ShowS # show :: SendUsersMessageRequest -> String # showList :: [SendUsersMessageRequest] -> ShowS #
NFData SendUsersMessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest Methods rnf :: SendUsersMessageRequest -> () #
Eq SendUsersMessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest Methods (==) :: SendUsersMessageRequest -> SendUsersMessageRequest -> Bool # (/=) :: SendUsersMessageRequest -> SendUsersMessageRequest -> Bool #
Hashable SendUsersMessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest Methods hashWithSalt :: Int -> SendUsersMessageRequest -> Int # hash :: SendUsersMessageRequest -> Int #
type Rep SendUsersMessageRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest type Rep SendUsersMessageRequest = D1 ('MetaData "SendUsersMessageRequest" "Amazonka.Pinpoint.Types.SendUsersMessageRequest" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "SendUsersMessageRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: 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) :: S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text EndpointSendConfiguration))))))

newSendUsersMessageRequest Source #

Arguments

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

Create a value of SendUsersMessageRequest 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:

SendUsersMessageRequest, sendUsersMessageRequest_context - A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

$sel:templateConfiguration:SendUsersMessageRequest', sendUsersMessageRequest_templateConfiguration - The message template to use for the message.

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

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

$sel:users:SendUsersMessageRequest', sendUsersMessageRequest_users - A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

sendUsersMessageRequest_context :: Lens' SendUsersMessageRequest (Maybe (HashMap Text Text)) Source #

A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

sendUsersMessageRequest_templateConfiguration :: Lens' SendUsersMessageRequest (Maybe TemplateConfiguration) Source #

The message template to use for the message.

sendUsersMessageRequest_traceId :: Lens' SendUsersMessageRequest (Maybe Text) Source #

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

sendUsersMessageRequest_messageConfiguration :: Lens' SendUsersMessageRequest DirectMessageConfiguration Source #

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

sendUsersMessageRequest_users :: Lens' SendUsersMessageRequest (HashMap Text EndpointSendConfiguration) Source #

A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.