Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
- Service Configuration
- Errors
- InvalidBatchEntryId
- TooManyEntriesInBatchRequest
- QueueDeletedRecently
- QueueDoesNotExist
- InvalidAttributeName
- UnsupportedOperation
- InvalidMessageContents
- BatchRequestTooLong
- OverLimit
- QueueNameExists
- PurgeQueueInProgress
- InvalidIdFormat
- ReceiptHandleIsInvalid
- EmptyBatchRequest
- BatchEntryIdsNotDistinct
- MessageNotInflight
- Waiters
- Operations
- Types
Welcome to the Amazon Simple Queue Service API Reference .
Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
- Cryptographically sign your service requests
- Retry requests
- Handle error responses
Additional Information
- Amazon SQS Product Page
- Amazon Simple Queue Service Developer Guide
- Making API Requests
- Using Amazon SQS Message Attributes
- Using Amazon SQS Dead-Letter Queues
- Amazon Web Services General Reference
- Regions and Endpoints
Synopsis
- sqs :: Service
- _InvalidBatchEntryId :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyEntriesInBatchRequest :: AsError a => Getting (First ServiceError) a ServiceError
- _QueueDeletedRecently :: AsError a => Getting (First ServiceError) a ServiceError
- _QueueDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidAttributeName :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedOperation :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidMessageContents :: AsError a => Getting (First ServiceError) a ServiceError
- _BatchRequestTooLong :: AsError a => Getting (First ServiceError) a ServiceError
- _OverLimit :: AsError a => Getting (First ServiceError) a ServiceError
- _QueueNameExists :: AsError a => Getting (First ServiceError) a ServiceError
- _PurgeQueueInProgress :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidIdFormat :: AsError a => Getting (First ServiceError) a ServiceError
- _ReceiptHandleIsInvalid :: AsError a => Getting (First ServiceError) a ServiceError
- _EmptyBatchRequest :: AsError a => Getting (First ServiceError) a ServiceError
- _BatchEntryIdsNotDistinct :: AsError a => Getting (First ServiceError) a ServiceError
- _MessageNotInflight :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.SQS.GetQueueURL
- module Network.AWS.SQS.PurgeQueue
- module Network.AWS.SQS.ChangeMessageVisibilityBatch
- module Network.AWS.SQS.SendMessage
- module Network.AWS.SQS.RemovePermission
- module Network.AWS.SQS.GetQueueAttributes
- module Network.AWS.SQS.ListQueues
- module Network.AWS.SQS.ReceiveMessage
- module Network.AWS.SQS.DeleteQueue
- module Network.AWS.SQS.TagQueue
- module Network.AWS.SQS.DeleteMessageBatch
- module Network.AWS.SQS.SetQueueAttributes
- module Network.AWS.SQS.ListDeadLetterSourceQueues
- module Network.AWS.SQS.AddPermission
- module Network.AWS.SQS.DeleteMessage
- module Network.AWS.SQS.ListQueueTags
- module Network.AWS.SQS.CreateQueue
- module Network.AWS.SQS.UntagQueue
- module Network.AWS.SQS.SendMessageBatch
- module Network.AWS.SQS.ChangeMessageVisibility
- data MessageAttribute
- data QueueAttributeName
- = QANAll
- | QANApproximateNumberOfMessages
- | QANApproximateNumberOfMessagesDelayed
- | QANApproximateNumberOfMessagesNotVisible
- | QANContentBasedDeduplication
- | QANCreatedTimestamp
- | QANDelaySeconds
- | QANFifoQueue
- | QANKMSDataKeyReusePeriodSeconds
- | QANKMSMasterKeyId
- | QANLastModifiedTimestamp
- | QANMaximumMessageSize
- | QANMessageRetentionPeriod
- | QANPolicy
- | QANQueueARN
- | QANReceiveMessageWaitTimeSeconds
- | QANRedrivePolicy
- | QANVisibilityTimeout
- data BatchResultErrorEntry
- batchResultErrorEntry :: Text -> Bool -> Text -> BatchResultErrorEntry
- breeMessage :: Lens' BatchResultErrorEntry (Maybe Text)
- breeId :: Lens' BatchResultErrorEntry Text
- breeSenderFault :: Lens' BatchResultErrorEntry Bool
- breeCode :: Lens' BatchResultErrorEntry Text
- data ChangeMessageVisibilityBatchRequestEntry
- changeMessageVisibilityBatchRequestEntry :: Text -> Text -> ChangeMessageVisibilityBatchRequestEntry
- cVisibilityTimeout :: Lens' ChangeMessageVisibilityBatchRequestEntry (Maybe Int)
- cId :: Lens' ChangeMessageVisibilityBatchRequestEntry Text
- cReceiptHandle :: Lens' ChangeMessageVisibilityBatchRequestEntry Text
- data ChangeMessageVisibilityBatchResultEntry
- changeMessageVisibilityBatchResultEntry :: Text -> ChangeMessageVisibilityBatchResultEntry
- cmvbreId :: Lens' ChangeMessageVisibilityBatchResultEntry Text
- data DeleteMessageBatchRequestEntry
- deleteMessageBatchRequestEntry :: Text -> Text -> DeleteMessageBatchRequestEntry
- dmbreId :: Lens' DeleteMessageBatchRequestEntry Text
- dmbreReceiptHandle :: Lens' DeleteMessageBatchRequestEntry Text
- data DeleteMessageBatchResultEntry
- deleteMessageBatchResultEntry :: Text -> DeleteMessageBatchResultEntry
- dId :: Lens' DeleteMessageBatchResultEntry Text
- data Message
- message :: Message
- mMessageAttributes :: Lens' Message (HashMap Text MessageAttributeValue)
- mMD5OfBody :: Lens' Message (Maybe Text)
- mBody :: Lens' Message (Maybe Text)
- mAttributes :: Lens' Message (HashMap MessageAttribute Text)
- mReceiptHandle :: Lens' Message (Maybe Text)
- mMessageId :: Lens' Message (Maybe Text)
- mMD5OfMessageAttributes :: Lens' Message (Maybe Text)
- data MessageAttributeValue
- messageAttributeValue :: Text -> MessageAttributeValue
- mavBinaryValue :: Lens' MessageAttributeValue (Maybe ByteString)
- mavStringListValues :: Lens' MessageAttributeValue [Text]
- mavStringValue :: Lens' MessageAttributeValue (Maybe Text)
- mavBinaryListValues :: Lens' MessageAttributeValue [ByteString]
- mavDataType :: Lens' MessageAttributeValue Text
- data SendMessageBatchRequestEntry
- sendMessageBatchRequestEntry :: Text -> Text -> SendMessageBatchRequestEntry
- sMessageAttributes :: Lens' SendMessageBatchRequestEntry (HashMap Text MessageAttributeValue)
- sDelaySeconds :: Lens' SendMessageBatchRequestEntry (Maybe Int)
- sMessageDeduplicationId :: Lens' SendMessageBatchRequestEntry (Maybe Text)
- sMessageGroupId :: Lens' SendMessageBatchRequestEntry (Maybe Text)
- sId :: Lens' SendMessageBatchRequestEntry Text
- sMessageBody :: Lens' SendMessageBatchRequestEntry Text
- data SendMessageBatchResultEntry
- sendMessageBatchResultEntry :: Text -> Text -> Text -> SendMessageBatchResultEntry
- smbreSequenceNumber :: Lens' SendMessageBatchResultEntry (Maybe Text)
- smbreMD5OfMessageAttributes :: Lens' SendMessageBatchResultEntry (Maybe Text)
- smbreId :: Lens' SendMessageBatchResultEntry Text
- smbreMessageId :: Lens' SendMessageBatchResultEntry Text
- smbreMD5OfMessageBody :: Lens' SendMessageBatchResultEntry Text
Service Configuration
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SQS
.
InvalidBatchEntryId
_InvalidBatchEntryId :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Id
of a batch entry in a batch request doesn't abide by the specification.
TooManyEntriesInBatchRequest
_TooManyEntriesInBatchRequest :: AsError a => Getting (First ServiceError) a ServiceError Source #
The batch request contains more entries than permissible.
QueueDeletedRecently
_QueueDeletedRecently :: AsError a => Getting (First ServiceError) a ServiceError Source #
You must wait 60 seconds after deleting a queue before you can create another one with the same name.
QueueDoesNotExist
_QueueDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError Source #
The queue referred to doesn't exist.
InvalidAttributeName
_InvalidAttributeName :: AsError a => Getting (First ServiceError) a ServiceError Source #
The attribute referred to doesn't exist.
UnsupportedOperation
_UnsupportedOperation :: AsError a => Getting (First ServiceError) a ServiceError Source #
Error code 400. Unsupported operation.
InvalidMessageContents
_InvalidMessageContents :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message contains characters outside the allowed set.
BatchRequestTooLong
_BatchRequestTooLong :: AsError a => Getting (First ServiceError) a ServiceError Source #
The length of all the messages put together is more than the limit.
OverLimit
_OverLimit :: AsError a => Getting (First ServiceError) a ServiceError Source #
The action that you requested would violate a limit. For example, ReceiveMessage
returns this error if the maximum number of inflight messages is reached.
returns this error if the maximum number of permissions for the queue is reached.AddPermission
QueueNameExists
_QueueNameExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.
PurgeQueueInProgress
_PurgeQueueInProgress :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the specified queue previously received a PurgeQueue
request within the last 60 seconds (the time it can take to delete the messages in the queue).
InvalidIdFormat
_InvalidIdFormat :: AsError a => Getting (First ServiceError) a ServiceError Source #
The receipt handle isn't valid for the current version.
ReceiptHandleIsInvalid
_ReceiptHandleIsInvalid :: AsError a => Getting (First ServiceError) a ServiceError Source #
The receipt handle provided isn't valid.
EmptyBatchRequest
_EmptyBatchRequest :: AsError a => Getting (First ServiceError) a ServiceError Source #
The batch request doesn't contain any entries.
BatchEntryIdsNotDistinct
_BatchEntryIdsNotDistinct :: AsError a => Getting (First ServiceError) a ServiceError Source #
Two or more batch entries in the request have the same Id
.
MessageNotInflight
_MessageNotInflight :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message referred to isn't in flight.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetQueueURL
module Network.AWS.SQS.GetQueueURL
PurgeQueue
module Network.AWS.SQS.PurgeQueue
ChangeMessageVisibilityBatch
SendMessage
module Network.AWS.SQS.SendMessage
RemovePermission
GetQueueAttributes
ListQueues
module Network.AWS.SQS.ListQueues
ReceiveMessage
DeleteQueue
module Network.AWS.SQS.DeleteQueue
TagQueue
module Network.AWS.SQS.TagQueue
DeleteMessageBatch
SetQueueAttributes
ListDeadLetterSourceQueues
AddPermission
DeleteMessage
ListQueueTags
CreateQueue
module Network.AWS.SQS.CreateQueue
UntagQueue
module Network.AWS.SQS.UntagQueue
SendMessageBatch
ChangeMessageVisibility
Types
MessageAttribute
data MessageAttribute Source #
Instances
QueueAttributeName
data QueueAttributeName Source #
Instances
BatchResultErrorEntry
data BatchResultErrorEntry Source #
This is used in the responses of batch API to give a detailed description of the result of an action on each entry in the request.
See: batchResultErrorEntry
smart constructor.
Instances
batchResultErrorEntry Source #
Creates a value of BatchResultErrorEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
breeMessage
- A message explaining why the action failed on this entry.breeId
- TheId
of an entry in a batch request.breeSenderFault
- Specifies whether the error happened due to the sender's fault.breeCode
- An error code representing why the action failed on this entry.
breeMessage :: Lens' BatchResultErrorEntry (Maybe Text) Source #
A message explaining why the action failed on this entry.
breeSenderFault :: Lens' BatchResultErrorEntry Bool Source #
Specifies whether the error happened due to the sender's fault.
breeCode :: Lens' BatchResultErrorEntry Text Source #
An error code representing why the action failed on this entry.
ChangeMessageVisibilityBatchRequestEntry
data ChangeMessageVisibilityBatchRequestEntry Source #
Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch
.
Important: All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n
, where n
is an integer value starting with 1
. For example, a parameter list for this action might look like this:
&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=replaceableYour_Receipt_Handle/replaceable
&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
See: changeMessageVisibilityBatchRequestEntry
smart constructor.
Instances
changeMessageVisibilityBatchRequestEntry Source #
Creates a value of ChangeMessageVisibilityBatchRequestEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cVisibilityTimeout
- The new value (in seconds) for the message's visibility timeout.cId
- An identifier for this particular receipt handle used to communicate the result.cReceiptHandle
- A receipt handle.
cVisibilityTimeout :: Lens' ChangeMessageVisibilityBatchRequestEntry (Maybe Int) Source #
The new value (in seconds) for the message's visibility timeout.
cId :: Lens' ChangeMessageVisibilityBatchRequestEntry Text Source #
An identifier for this particular receipt handle used to communicate the result.
cReceiptHandle :: Lens' ChangeMessageVisibilityBatchRequestEntry Text Source #
A receipt handle.
ChangeMessageVisibilityBatchResultEntry
data ChangeMessageVisibilityBatchResultEntry Source #
Encloses the Id
of an entry in ChangeMessageVisibilityBatch
.
See: changeMessageVisibilityBatchResultEntry
smart constructor.
Instances
changeMessageVisibilityBatchResultEntry Source #
Creates a value of ChangeMessageVisibilityBatchResultEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmvbreId
- Represents a message whose visibility timeout has been changed successfully.
cmvbreId :: Lens' ChangeMessageVisibilityBatchResultEntry Text Source #
Represents a message whose visibility timeout has been changed successfully.
DeleteMessageBatchRequestEntry
data DeleteMessageBatchRequestEntry Source #
Encloses a receipt handle and an identifier for it.
See: deleteMessageBatchRequestEntry
smart constructor.
Instances
deleteMessageBatchRequestEntry Source #
Creates a value of DeleteMessageBatchRequestEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dmbreId
- An identifier for this particular receipt handle. This is used to communicate the result.dmbreReceiptHandle
- A receipt handle.
dmbreId :: Lens' DeleteMessageBatchRequestEntry Text Source #
An identifier for this particular receipt handle. This is used to communicate the result.
dmbreReceiptHandle :: Lens' DeleteMessageBatchRequestEntry Text Source #
A receipt handle.
DeleteMessageBatchResultEntry
data DeleteMessageBatchResultEntry Source #
Encloses the Id
of an entry in DeleteMessageBatch
.
See: deleteMessageBatchResultEntry
smart constructor.
Instances
deleteMessageBatchResultEntry Source #
Creates a value of DeleteMessageBatchResultEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dId
- Represents a successfully deleted message.
Message
An Amazon SQS message.
See: message
smart constructor.
Instances
Creates a value of Message
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mMessageAttributes
- Each message attribute consists of aName
,Type
, andValue
. For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide .mMD5OfBody
- An MD5 digest of the non-URL-encoded message body string.mBody
- The message's contents (not URL-encoded).mAttributes
-SenderId
,SentTimestamp
,ApproximateReceiveCount
, andorApproximateFirstReceiveTimestamp
.SentTimestamp
andApproximateFirstReceiveTimestamp
are each returned as an integer representing the <http:en.wikipedia.orgwiki/Unix_time epoch time> in milliseconds.mReceiptHandle
- An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.mMessageId
- A unique identifier for the message. AMessageId
is considered unique across all AWS accounts for an extended period of time.mMD5OfMessageAttributes
- 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 .
mMessageAttributes :: Lens' Message (HashMap Text MessageAttributeValue) Source #
Each message attribute consists of a Name
, Type
, and Value
. For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide .
mMD5OfBody :: Lens' Message (Maybe Text) Source #
An MD5 digest of the non-URL-encoded message body string.
mAttributes :: Lens' Message (HashMap MessageAttribute Text) Source #
SenderId
, SentTimestamp
, ApproximateReceiveCount
, andor ApproximateFirstReceiveTimestamp
. SentTimestamp
and ApproximateFirstReceiveTimestamp
are each returned as an integer representing the <http:en.wikipedia.orgwiki/Unix_time epoch time> in milliseconds.
mReceiptHandle :: Lens' Message (Maybe Text) Source #
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
mMessageId :: Lens' Message (Maybe Text) Source #
A unique identifier for the message. A MessageId
is considered unique across all AWS accounts for an extended period of time.
mMD5OfMessageAttributes :: Lens' Message (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 .
MessageAttributeValue
data MessageAttributeValue Source #
The user-specified message attribute value. For string data types, the Value
attribute has the same restrictions on the content as the message body. For more information, see SendMessage
.
Name
, type
, value
and the message body must not be empty or null. All parts of the message attribute, including Name
, Type
, and Value
, are part of the message size restriction (256 KB or 262,144 bytes).
See: messageAttributeValue
smart constructor.
Instances
messageAttributeValue Source #
Creates a value of MessageAttributeValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mavBinaryValue
- Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.-- Note: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
accepts and returns only raw unencoded data.mavStringListValues
- Not implemented. Reserved for future use.mavStringValue
- Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters .mavBinaryListValues
- Not implemented. Reserved for future use.mavDataType
- Amazon SQS supports the following logical data types:String
,Number
, andBinary
. For theNumber
data type, you must useStringValue
. You can also append custom labels. For more information, see Message Attribute Data Types and Validation in the Amazon Simple Queue Service Developer Guide .
mavBinaryValue :: Lens' MessageAttributeValue (Maybe ByteString) Source #
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.-- Note: This Lens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens
accepts and returns only raw unencoded data.
mavStringListValues :: Lens' MessageAttributeValue [Text] Source #
Not implemented. Reserved for future use.
mavStringValue :: Lens' MessageAttributeValue (Maybe Text) Source #
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters .
mavBinaryListValues :: Lens' MessageAttributeValue [ByteString] Source #
Not implemented. Reserved for future use.
mavDataType :: Lens' MessageAttributeValue Text Source #
Amazon SQS supports the following logical data types: String
, Number
, and Binary
. For the Number
data type, you must use StringValue
. You can also append custom labels. For more information, see Message Attribute Data Types and Validation in the Amazon Simple Queue Service Developer Guide .
SendMessageBatchRequestEntry
data SendMessageBatchRequestEntry Source #
Contains the details of a single Amazon SQS message along with an Id
.
See: sendMessageBatchRequestEntry
smart constructor.
Instances
sendMessageBatchRequestEntry Source #
Creates a value of SendMessageBatchRequestEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sMessageAttributes
- Each message attribute consists of aName
,Type
, andValue
. For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide .sDelaySeconds
- The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positiveDelaySeconds
value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.sMessageDeduplicationId
- This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particularMessageDeduplicationId
is sent successfully, subsequent messages with the sameMessageDeduplicationId
are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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. * 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 .sMessageGroupId
- 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 . Important:
MessageGroupId@ is required for FIFO queues. You can't use it for Standard queues.sId
- An identifier for a message in this batch used to communicate the result.sMessageBody
- The body of the message.
sMessageAttributes :: Lens' SendMessageBatchRequestEntry (HashMap Text MessageAttributeValue) Source #
Each message attribute consists of a Name
, Type
, and Value
. For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide .
sDelaySeconds :: Lens' SendMessageBatchRequestEntry (Maybe Int) Source #
The length of time, in seconds, for which a specific message is delayed. 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 is applied.
sMessageDeduplicationId :: Lens' SendMessageBatchRequestEntry (Maybe Text) Source #
This parameter applies only to FIFO (first-in-first-out) queues. 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. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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. * 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 .
sMessageGroupId :: Lens' SendMessageBatchRequestEntry (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 . Important:
MessageGroupId@ is required for FIFO queues. You can't use it for Standard queues.
sId :: Lens' SendMessageBatchRequestEntry Text Source #
An identifier for a message in this batch used to communicate the result.
sMessageBody :: Lens' SendMessageBatchRequestEntry Text Source #
The body of the message.
SendMessageBatchResultEntry
data SendMessageBatchResultEntry Source #
Encloses a MessageId
for a successfully-enqueued message in a SendMessageBatch
.
See: sendMessageBatchResultEntry
smart constructor.
Instances
sendMessageBatchResultEntry Source #
Creates a value of SendMessageBatchResultEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smbreSequenceNumber
- 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 ofSequenceNumber
is 128 bits. AsSequenceNumber
continues to increase for a particularMessageGroupId
.smbreMD5OfMessageAttributes
- 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 .smbreId
- An identifier for the message in this batch.smbreMessageId
- An identifier for the message.smbreMD5OfMessageBody
- 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 .
smbreSequenceNumber :: Lens' SendMessageBatchResultEntry (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. As SequenceNumber
continues to increase for a particular MessageGroupId
.
smbreMD5OfMessageAttributes :: Lens' SendMessageBatchResultEntry (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 .
smbreId :: Lens' SendMessageBatchResultEntry Text Source #
An identifier for the message in this batch.
smbreMessageId :: Lens' SendMessageBatchResultEntry Text Source #
An identifier for the message.
smbreMD5OfMessageBody :: Lens' SendMessageBatchResultEntry 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 .