Amazonka.SNS.Types.PublishBatchRequestEntry

Documentation

data PublishBatchRequestEntry

Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch.

See: newPublishBatchRequestEntry smart constructor.

Constructors

PublishBatchRequestEntry'

Fields

• messageAttributes :: Maybe (HashMap Text MessageAttributeValue)

  Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.

• messageDeduplicationId :: Maybe Text

  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 enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId 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 have ContentBasedDeduplication set, the action fails with an error.
    • If the topic has a ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
  • 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 a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, 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 (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

• messageGroupId :: Maybe Text

  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.

• messageStructure :: Maybe Text

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

• subject :: Maybe Text

  The subject of the batch message.

• id :: Text

  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 (_).

• message :: Text

  The body of the message.

Instances

ToQuery PublishBatchRequestEntry

Defined in Amazonka.SNS.Types.PublishBatchRequestEntry

Methods

toQuery :: PublishBatchRequestEntry -> QueryString

Generic PublishBatchRequestEntry

Defined in Amazonka.SNS.Types.PublishBatchRequestEntry

Associated Types

type Rep PublishBatchRequestEntry :: Type -> Type

Methods

from :: PublishBatchRequestEntry -> Rep PublishBatchRequestEntry x

to :: Rep PublishBatchRequestEntry x -> PublishBatchRequestEntry

Read PublishBatchRequestEntry

Defined in Amazonka.SNS.Types.PublishBatchRequestEntry

Methods

readsPrec :: Int -> ReadS PublishBatchRequestEntry

readList :: ReadS [PublishBatchRequestEntry]

readPrec :: ReadPrec PublishBatchRequestEntry

readListPrec :: ReadPrec [PublishBatchRequestEntry]

Show PublishBatchRequestEntry

Defined in Amazonka.SNS.Types.PublishBatchRequestEntry

Methods

showsPrec :: Int -> PublishBatchRequestEntry -> ShowS

show :: PublishBatchRequestEntry -> String

showList :: [PublishBatchRequestEntry] -> ShowS

NFData PublishBatchRequestEntry

Defined in Amazonka.SNS.Types.PublishBatchRequestEntry

Methods

rnf :: PublishBatchRequestEntry -> ()

Eq PublishBatchRequestEntry

Defined in Amazonka.SNS.Types.PublishBatchRequestEntry

Methods

(==) :: PublishBatchRequestEntry -> PublishBatchRequestEntry -> Bool

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

Hashable PublishBatchRequestEntry

Defined in Amazonka.SNS.Types.PublishBatchRequestEntry

Methods

hashWithSalt :: Int -> PublishBatchRequestEntry -> Int

hash :: PublishBatchRequestEntry -> Int

type Rep PublishBatchRequestEntry

Defined in Amazonka.SNS.Types.PublishBatchRequestEntry

type Rep PublishBatchRequestEntry = D1 ('MetaData "PublishBatchRequestEntry" "Amazonka.SNS.Types.PublishBatchRequestEntry" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "PublishBatchRequestEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messageAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MessageAttributeValue))) :*: (S1 ('MetaSel ('Just "messageDeduplicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "messageStructure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPublishBatchRequestEntry

Arguments

:: Text

$sel:id:PublishBatchRequestEntry'

-> Text

$sel:message:PublishBatchRequestEntry'

-> 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 enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId 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 have ContentBasedDeduplication set, the action fails with an error.
  • If the topic has a ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
• 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 a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, 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))

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)

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 enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId 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 have ContentBasedDeduplication set, the action fails with an error.
  • If the topic has a ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
• 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 a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, 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)

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)

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)

The subject of the batch message.

publishBatchRequestEntry_id :: Lens' PublishBatchRequestEntry Text

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

The body of the message.