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 |
Synopsis
- data PublishBatchRequestEntry = PublishBatchRequestEntry' {}
- newPublishBatchRequestEntry :: Text -> Text -> PublishBatchRequestEntry
- publishBatchRequestEntry_messageAttributes :: Lens' PublishBatchRequestEntry (Maybe (HashMap Text MessageAttributeValue))
- publishBatchRequestEntry_messageDeduplicationId :: Lens' PublishBatchRequestEntry (Maybe Text)
- publishBatchRequestEntry_messageGroupId :: Lens' PublishBatchRequestEntry (Maybe Text)
- publishBatchRequestEntry_messageStructure :: Lens' PublishBatchRequestEntry (Maybe Text)
- publishBatchRequestEntry_subject :: Lens' PublishBatchRequestEntry (Maybe Text)
- publishBatchRequestEntry_id :: Lens' PublishBatchRequestEntry Text
- publishBatchRequestEntry_message :: Lens' PublishBatchRequestEntry Text
Documentation
data PublishBatchRequestEntry Source #
Contains the details of a single Amazon SNS message along with an Id
that identifies a message within the batch.
See: newPublishBatchRequestEntry
smart constructor.
PublishBatchRequestEntry' | |
|
Instances
newPublishBatchRequestEntry Source #
:: Text | |
-> Text | |
-> PublishBatchRequestEntry |
Create a value of PublishBatchRequestEntry
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:messageAttributes:PublishBatchRequestEntry'
, publishBatchRequestEntry_messageAttributes
- Each message attribute consists of a Name
, Type
, and Value
. For
more information, see
Amazon SNS message attributes
in the Amazon SNS Developer Guide.
$sel:messageDeduplicationId:PublishBatchRequestEntry'
, publishBatchRequestEntry_messageDeduplicationId
- This parameter applies only to FIFO (first-in-first-out) topics.
The token used for deduplication of messages within a 5-minute minimum
deduplication interval. If a message with a particular
MessageDeduplicationId
is sent successfully, subsequent messages with
the same MessageDeduplicationId
are accepted successfully but aren't
delivered.
Every message must have a unique
MessageDeduplicationId
.- You may provide a
MessageDeduplicationId
explicitly. - If you aren't able to provide a
MessageDeduplicationId
and you enableContentBasedDeduplication
for your topic, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationId
using the body of the message (but not the attributes of the message). - If you don't provide a
MessageDeduplicationId
and the topic doesn't haveContentBasedDeduplication
set, the action fails with an error. - If the topic has a
ContentBasedDeduplication
set, yourMessageDeduplicationId
overrides the generated one.
- You may provide a
- When
ContentBasedDeduplication
is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. - If you send one message with
ContentBasedDeduplication
enabled, and then another message with aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId
is available to the consumer of the message
(this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and
the message is resent with the same MessageDeduplicationId
after the
deduplication interval, Amazon SNS can't detect duplicate messages.
Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted.
The length of MessageDeduplicationId
is 128 characters.
MessageDeduplicationId
can contain alphanumeric characters
(a-z, A-Z, 0-9)
and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
$sel:messageGroupId:PublishBatchRequestEntry'
, publishBatchRequestEntry_messageGroupId
- This parameter applies only to FIFO (first-in-first-out) topics.
The tag that specifies that a message belongs to a specific message
group. Messages that belong to the same message group are processed in a
FIFO manner (however, messages in different message groups might be
processed out of order). To interleave multiple ordered streams within a
single topic, use MessageGroupId
values (for example, session data for
multiple users). In this scenario, multiple consumers can process the
topic, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId
with a message. If you
don't provide a MessageGroupId
, the action fails.
The length of MessageGroupId
is 128 characters.
MessageGroupId
can contain alphanumeric characters (a-z, A-Z, 0-9)
and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
MessageGroupId
is required for FIFO topics. You can't use it for
standard topics.
$sel:messageStructure:PublishBatchRequestEntry'
, publishBatchRequestEntry_messageStructure
- Set MessageStructure
to json
if you want to send a different message
for each protocol. For example, using one publish action, you can send a
short message to your SMS subscribers and a longer message to your email
subscribers. If you set MessageStructure
to json
, the value of the
Message
parameter must:
- be a syntactically valid JSON object; and
- contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http).
$sel:subject:PublishBatchRequestEntry'
, publishBatchRequestEntry_subject
- The subject of the batch message.
$sel:id:PublishBatchRequestEntry'
, publishBatchRequestEntry_id
- An identifier for the message in this batch.
The Ids
of a batch request must be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
$sel:message:PublishBatchRequestEntry'
, publishBatchRequestEntry_message
- The body of the message.
publishBatchRequestEntry_messageAttributes :: Lens' PublishBatchRequestEntry (Maybe (HashMap Text MessageAttributeValue)) Source #
Each message attribute consists of a Name
, Type
, and Value
. For
more information, see
Amazon SNS message attributes
in the Amazon SNS Developer Guide.
publishBatchRequestEntry_messageDeduplicationId :: Lens' PublishBatchRequestEntry (Maybe Text) Source #
This parameter applies only to FIFO (first-in-first-out) topics.
The token used for deduplication of messages within a 5-minute minimum
deduplication interval. If a message with a particular
MessageDeduplicationId
is sent successfully, subsequent messages with
the same MessageDeduplicationId
are accepted successfully but aren't
delivered.
Every message must have a unique
MessageDeduplicationId
.- You may provide a
MessageDeduplicationId
explicitly. - If you aren't able to provide a
MessageDeduplicationId
and you enableContentBasedDeduplication
for your topic, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationId
using the body of the message (but not the attributes of the message). - If you don't provide a
MessageDeduplicationId
and the topic doesn't haveContentBasedDeduplication
set, the action fails with an error. - If the topic has a
ContentBasedDeduplication
set, yourMessageDeduplicationId
overrides the generated one.
- You may provide a
- When
ContentBasedDeduplication
is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. - If you send one message with
ContentBasedDeduplication
enabled, and then another message with aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId
is available to the consumer of the message
(this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and
the message is resent with the same MessageDeduplicationId
after the
deduplication interval, Amazon SNS can't detect duplicate messages.
Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted.
The length of MessageDeduplicationId
is 128 characters.
MessageDeduplicationId
can contain alphanumeric characters
(a-z, A-Z, 0-9)
and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
publishBatchRequestEntry_messageGroupId :: Lens' PublishBatchRequestEntry (Maybe Text) Source #
This parameter applies only to FIFO (first-in-first-out) topics.
The tag that specifies that a message belongs to a specific message
group. Messages that belong to the same message group are processed in a
FIFO manner (however, messages in different message groups might be
processed out of order). To interleave multiple ordered streams within a
single topic, use MessageGroupId
values (for example, session data for
multiple users). In this scenario, multiple consumers can process the
topic, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId
with a message. If you
don't provide a MessageGroupId
, the action fails.
The length of MessageGroupId
is 128 characters.
MessageGroupId
can contain alphanumeric characters (a-z, A-Z, 0-9)
and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
MessageGroupId
is required for FIFO topics. You can't use it for
standard topics.
publishBatchRequestEntry_messageStructure :: Lens' PublishBatchRequestEntry (Maybe Text) Source #
Set MessageStructure
to json
if you want to send a different message
for each protocol. For example, using one publish action, you can send a
short message to your SMS subscribers and a longer message to your email
subscribers. If you set MessageStructure
to json
, the value of the
Message
parameter must:
- be a syntactically valid JSON object; and
- contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http).
publishBatchRequestEntry_subject :: Lens' PublishBatchRequestEntry (Maybe Text) Source #
The subject of the batch message.
publishBatchRequestEntry_id :: Lens' PublishBatchRequestEntry Text Source #
An identifier for the message in this batch.
The Ids
of a batch request must be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
publishBatchRequestEntry_message :: Lens' PublishBatchRequestEntry Text Source #
The body of the message.