Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Delivers a message to the specified queue.
Important: The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:
#x9
| #xA
| #xD
| [#x20
to #xD7FF
] | [#xE000
to #xFFFD
] | [#x10000
to #x10FFFF
]
For more information, see RFC1321 . If you send any characters that aren't included in this list, your request will be rejected.
- sendMessage :: Text -> Text -> SendMessage
- data SendMessage
- smMessageAttributes :: Lens' SendMessage (HashMap Text MessageAttributeValue)
- smDelaySeconds :: Lens' SendMessage (Maybe Int)
- smMessageDeduplicationId :: Lens' SendMessage (Maybe Text)
- smMessageGroupId :: Lens' SendMessage (Maybe Text)
- smQueueURL :: Lens' SendMessage Text
- smMessageBody :: Lens' SendMessage Text
- sendMessageResponse :: Int -> SendMessageResponse
- data SendMessageResponse
- smrsSequenceNumber :: Lens' SendMessageResponse (Maybe Text)
- smrsMessageId :: Lens' SendMessageResponse (Maybe Text)
- smrsMD5OfMessageBody :: Lens' SendMessageResponse (Maybe Text)
- smrsMD5OfMessageAttributes :: Lens' SendMessageResponse (Maybe Text)
- smrsResponseStatus :: Lens' SendMessageResponse Int
Creating a Request
Creates a value of SendMessage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smMessageAttributes
- Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide .smDelaySeconds
- The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positiveDelaySeconds
value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.smMessageDeduplicationId
- This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particularMessageDeduplicationId
is sent successfully, any messages sent with the sameMessageDeduplicationId
are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide . * Every message must have a uniqueMessageDeduplicationId
, * You may provide aMessageDeduplicationId
explicitly. * If you aren't able to provide aMessageDeduplicationId
and you enableContentBasedDeduplication
for your queue, Amazon SQS 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 aMessageDeduplicationId
and the queue doesn't haveContentBasedDeduplication
set, the action fails with an error. * If the queue hasContentBasedDeduplication
set, yourMessageDeduplicationId
overrides the generated one. * WhenContentBasedDeduplication
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. * You can also useContentBasedDeduplication
for messages with identical content to be treated as duplicates. * If you send one message withContentBasedDeduplication
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 length ofMessageDeduplicationId
is 128 characters.MessageDeduplicationId
can contain alphanumeric characters (a-z
,A-Z
,0-9
) and punctuation (!"#$%&'()*+,-./:;=?
[]^_`{|}~). For best practices of using
MessageDeduplicationId@ , see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide .smMessageGroupId
- This parameter applies only to FIFO (first-in-first-out) queues. 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 queue, useMessageGroupId
values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion. * You must associate a non-emptyMessageGroupId
with a message. If you don't provide aMessageGroupId
, the action fails. *ReceiveMessage
might return messages with multipleMessageGroupId
values. For eachMessageGroupId
, the messages are sorted by time sent. The caller can't specify aMessageGroupId
. The length ofMessageGroupId
is 128 characters. Valid values are alphanumeric characters and punctuation(!"#$%&'()*+,-./:;=?
[]^_`{|}~). For best practices of using
MessageGroupId@ , see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide .smQueueURL
- The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.smMessageBody
- The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
data SendMessage Source #
See: sendMessage
smart constructor.
Request Lenses
smMessageAttributes :: Lens' SendMessage (HashMap Text MessageAttributeValue) Source #
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide .
smDelaySeconds :: Lens' SendMessage (Maybe Int) Source #
The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds
value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.
smMessageDeduplicationId :: Lens' SendMessage (Maybe Text) Source #
This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId
is sent successfully, any messages sent with the same MessageDeduplicationId
are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide . * 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 queue, Amazon SQS 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 queue doesn't have ContentBasedDeduplication
set, the action fails with an error. * If the queue has 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. * You can also use ContentBasedDeduplication
for messages with identical content to be treated as duplicates. * 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 length of MessageDeduplicationId
is 128 characters. MessageDeduplicationId
can contain alphanumeric characters (a-z
, A-Z
, 0-9
) and punctuation (!"#$%&'()*+,-./:;=?
[]^_`{|}~ ). For best practices of using
MessageDeduplicationId@ , see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide .
smMessageGroupId :: Lens' SendMessage (Maybe Text) Source #
This parameter applies only to FIFO (first-in-first-out) queues. 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 queue, use MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, 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. * ReceiveMessage
might return messages with multiple MessageGroupId
values. For each MessageGroupId
, the messages are sorted by time sent. The caller can't specify a MessageGroupId
. The length of MessageGroupId
is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;=?
[]^_`{|}~) . For best practices of using
MessageGroupId@ , see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide .
smQueueURL :: Lens' SendMessage Text Source #
The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.
smMessageBody :: Lens' SendMessage Text Source #
The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
Destructuring the Response
Creates a value of SendMessageResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smrsSequenceNumber
- This element applies only to FIFO (first-in-first-out) queues. A large, non-consecutive number that Amazon SQS assigns to each message. The length ofSequenceNumber
is 128 bits.SequenceNumber
continues to increase for a particularMessageGroupId
.smrsMessageId
- An element containing the message ID of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .smrsMD5OfMessageBody
- An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .smrsMD5OfMessageAttributes
- An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .smrsResponseStatus
- -- | The response status code.
data SendMessageResponse Source #
The MD5OfMessageBody and MessageId elements.
See: sendMessageResponse
smart constructor.
Response Lenses
smrsSequenceNumber :: Lens' SendMessageResponse (Maybe Text) Source #
This element applies only to FIFO (first-in-first-out) queues. A large, non-consecutive number that Amazon SQS assigns to each message. The length of SequenceNumber
is 128 bits. SequenceNumber
continues to increase for a particular MessageGroupId
.
smrsMessageId :: Lens' SendMessageResponse (Maybe Text) Source #
An element containing the message ID of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .
smrsMD5OfMessageBody :: Lens' SendMessageResponse (Maybe Text) Source #
An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .
smrsMD5OfMessageAttributes :: Lens' SendMessageResponse (Maybe Text) Source #
An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .
smrsResponseStatus :: Lens' SendMessageResponse Int Source #
- - | The response status code.