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 |
Synopsis
- data MessageRequest = MessageRequest' {}
- 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.
MessageRequest' | |
|
Instances
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.