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. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/#charsets If you send any characters not included in the list, your request will be rejected.
- sendMessage :: Text -> Text -> SendMessage
- data SendMessage
- smMessageAttributes :: Lens' SendMessage (HashMap Text MessageAttributeValue)
- smDelaySeconds :: Lens' SendMessage (Maybe Int)
- smQueueURL :: Lens' SendMessage Text
- smMessageBody :: Lens' SendMessage Text
- sendMessageResponse :: Int -> SendMessageResponse
- data SendMessageResponse
- 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:
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.
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.
smQueueURL :: Lens' SendMessage Text Source #
The URL of the Amazon SQS queue to take action on.
smMessageBody :: Lens' SendMessage Text Source #
The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important 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:
data SendMessageResponse Source #
The MD5OfMessageBody and MessageId elements.
See: sendMessageResponse
smart constructor.
Response Lenses
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, go to http://www.faqs.org/rfcs/rfc1321.html.
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, go to http://www.faqs.org/rfcs/rfc1321.html.
smrsResponseStatus :: Lens' SendMessageResponse Int Source #
The response status code.