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 |
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
|
#x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
Synopsis
- data SendMessage = SendMessage' {}
- newSendMessage :: Text -> Text -> SendMessage
- sendMessage_messageAttributes :: Lens' SendMessage (Maybe (HashMap Text MessageAttributeValue))
- sendMessage_delaySeconds :: Lens' SendMessage (Maybe Int)
- sendMessage_messageSystemAttributes :: Lens' SendMessage (Maybe (HashMap MessageSystemAttributeNameForSends MessageSystemAttributeValue))
- sendMessage_messageDeduplicationId :: Lens' SendMessage (Maybe Text)
- sendMessage_messageGroupId :: Lens' SendMessage (Maybe Text)
- sendMessage_queueUrl :: Lens' SendMessage Text
- sendMessage_messageBody :: Lens' SendMessage Text
- data SendMessageResponse = SendMessageResponse' {}
- newSendMessageResponse :: Int -> SendMessageResponse
- sendMessageResponse_sequenceNumber :: Lens' SendMessageResponse (Maybe Text)
- sendMessageResponse_mD5OfMessageSystemAttributes :: Lens' SendMessageResponse (Maybe Text)
- sendMessageResponse_messageId :: Lens' SendMessageResponse (Maybe Text)
- sendMessageResponse_mD5OfMessageBody :: Lens' SendMessageResponse (Maybe Text)
- sendMessageResponse_mD5OfMessageAttributes :: Lens' SendMessageResponse (Maybe Text)
- sendMessageResponse_httpStatus :: Lens' SendMessageResponse Int
Creating a Request
data SendMessage Source #
See: newSendMessage
smart constructor.
SendMessage' | |
|
Instances
Create a value of SendMessage
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:SendMessage'
, sendMessage_messageAttributes
- Each message attribute consists of a Name
, Type
, and Value
. For
more information, see
Amazon SQS message attributes
in the Amazon SQS Developer Guide.
$sel:delaySeconds:SendMessage'
, sendMessage_delaySeconds
- The length of time, in seconds, for which to delay a specific message.
Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive
DelaySeconds
value become available for processing after the delay
period is finished. If you don't specify a value, the default value for
the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per message. You
can set this parameter only on a queue level.
$sel:messageSystemAttributes:SendMessage'
, sendMessage_messageSystemAttributes
- The message system attribute to send. Each message system attribute
consists of a Name
, Type
, and Value
.
- Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
and its value must be a correctly formatted X-Ray trace header string. - The size of a message system attribute doesn't count towards the total size of a message.
$sel:messageDeduplicationId:SendMessage'
, sendMessage_messageDeduplicationId
- 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 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 a
MessageDeduplicationId
and the queue doesn't haveContentBasedDeduplication
set, the action fails with an error. - If the queue has
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 SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum 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 SQS Developer Guide.
$sel:messageGroupId:SendMessage'
, sendMessage_messageGroupId
- 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 consumers 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 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 of MessageGroupId
is 128 characters. Valid values:
alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see
Using the MessageGroupId Property
in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for
Standard queues.
$sel:queueUrl:SendMessage'
, sendMessage_queueUrl
- The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
$sel:messageBody:SendMessage'
, sendMessage_messageBody
- The message to send. The minimum size is one character. The maximum size
is 256 KB.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
|
#x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
Request Lenses
sendMessage_messageAttributes :: Lens' SendMessage (Maybe (HashMap Text MessageAttributeValue)) Source #
Each message attribute consists of a Name
, Type
, and Value
. For
more information, see
Amazon SQS message attributes
in the Amazon SQS Developer Guide.
sendMessage_delaySeconds :: Lens' SendMessage (Maybe Int) Source #
The length of time, in seconds, for which to delay a specific message.
Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive
DelaySeconds
value become available for processing after the delay
period is finished. If you don't specify a value, the default value for
the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per message. You
can set this parameter only on a queue level.
sendMessage_messageSystemAttributes :: Lens' SendMessage (Maybe (HashMap MessageSystemAttributeNameForSends MessageSystemAttributeValue)) Source #
The message system attribute to send. Each message system attribute
consists of a Name
, Type
, and Value
.
- Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
and its value must be a correctly formatted X-Ray trace header string. - The size of a message system attribute doesn't count towards the total size of a message.
sendMessage_messageDeduplicationId :: 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 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 a
MessageDeduplicationId
and the queue doesn't haveContentBasedDeduplication
set, the action fails with an error. - If the queue has
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 SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum 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 SQS Developer Guide.
sendMessage_messageGroupId :: 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 consumers 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 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 of MessageGroupId
is 128 characters. Valid values:
alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see
Using the MessageGroupId Property
in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for
Standard queues.
sendMessage_queueUrl :: Lens' SendMessage Text Source #
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
sendMessage_messageBody :: Lens' SendMessage Text Source #
The message to send. The minimum size is one character. The maximum size is 256 KB.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
|
#x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
Destructuring the Response
data SendMessageResponse Source #
The MD5OfMessageBody
and MessageId
elements.
See: newSendMessageResponse
smart constructor.
SendMessageResponse' | |
|
Instances
newSendMessageResponse Source #
Create a value of SendMessageResponse
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:sequenceNumber:SendMessageResponse'
, sendMessageResponse_sequenceNumber
- This parameter applies only to FIFO (first-in-first-out) queues.
The 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
.
$sel:mD5OfMessageSystemAttributes:SendMessageResponse'
, sendMessageResponse_mD5OfMessageSystemAttributes
- An MD5 digest of the non-URL-encoded message system attribute string.
You can use this attribute to verify that Amazon SQS received the
message correctly. Amazon SQS URL-decodes the message before creating
the MD5 digest.
$sel:messageId:SendMessageResponse'
, sendMessageResponse_messageId
- An attribute containing the MessageId
of the message sent to the
queue. For more information, see
Queue and Message Identifiers
in the Amazon SQS Developer Guide.
$sel:mD5OfMessageBody:SendMessageResponse'
, sendMessageResponse_mD5OfMessageBody
- An MD5 digest of the non-URL-encoded message body string. You can use
this attribute to verify that Amazon SQS received the message correctly.
Amazon SQS URL-decodes the message before creating the MD5 digest. For
information about MD5, see
RFC1321.
$sel:mD5OfMessageAttributes:SendMessageResponse'
, sendMessageResponse_mD5OfMessageAttributes
- An MD5 digest of the non-URL-encoded message attribute string. You can
use this attribute to verify that Amazon SQS received the message
correctly. Amazon SQS URL-decodes the message before creating the MD5
digest. For information about MD5, see
RFC1321.
$sel:httpStatus:SendMessageResponse'
, sendMessageResponse_httpStatus
- The response's http status code.
Response Lenses
sendMessageResponse_sequenceNumber :: Lens' SendMessageResponse (Maybe Text) Source #
This parameter applies only to FIFO (first-in-first-out) queues.
The 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
.
sendMessageResponse_mD5OfMessageSystemAttributes :: Lens' SendMessageResponse (Maybe Text) Source #
An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.
sendMessageResponse_messageId :: Lens' SendMessageResponse (Maybe Text) Source #
An attribute containing the MessageId
of the message sent to the
queue. For more information, see
Queue and Message Identifiers
in the Amazon SQS Developer Guide.
sendMessageResponse_mD5OfMessageBody :: Lens' SendMessageResponse (Maybe Text) Source #
An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
sendMessageResponse_mD5OfMessageAttributes :: Lens' SendMessageResponse (Maybe Text) Source #
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
sendMessageResponse_httpStatus :: Lens' SendMessageResponse Int Source #
The response's http status code.