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 |
- Service Configuration
- Errors
- InvalidBatchEntryId
- TooManyEntriesInBatchRequest
- QueueDeletedRecently
- QueueDoesNotExist
- InvalidAttributeName
- UnsupportedOperation
- InvalidMessageContents
- BatchRequestTooLong
- OverLimit
- QueueNameExists
- PurgeQueueInProgress
- InvalidIdFormat
- ReceiptHandleIsInvalid
- EmptyBatchRequest
- BatchEntryIdsNotDistinct
- MessageNotInflight
- Waiters
- Operations
- GetQueueUrl
- PurgeQueue
- ChangeMessageVisibilityBatch
- SendMessage
- RemovePermission
- GetQueueAttributes
- ListQueues (Paginated)
- ReceiveMessage
- DeleteQueue
- TagQueue
- DeleteMessageBatch
- SetQueueAttributes
- ListDeadLetterSourceQueues (Paginated)
- AddPermission
- DeleteMessage
- ListQueueTags
- CreateQueue
- UntagQueue
- SendMessageBatch
- ChangeMessageVisibility
- Types
- MessageAttribute
- MessageSystemAttributeNameForSends
- QueueAttributeName
- BatchResultErrorEntry
- ChangeMessageVisibilityBatchRequestEntry
- ChangeMessageVisibilityBatchResultEntry
- DeleteMessageBatchRequestEntry
- DeleteMessageBatchResultEntry
- Message
- MessageAttributeValue
- MessageSystemAttributeValue
- SendMessageBatchRequestEntry
- SendMessageBatchResultEntry
Derived from API version 2012-11-05
of the AWS service descriptions, licensed under Apache 2.0.
Welcome to the Amazon SQS API Reference.
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.
For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.
You can use Amazon Web Services 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 SQS Developer Guide
- Amazon SQS in the Command Line Interface
Amazon Web Services General Reference
Synopsis
- defaultService :: 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
- data GetQueueUrl = GetQueueUrl' (Maybe Text) Text
- newGetQueueUrl :: Text -> GetQueueUrl
- data GetQueueUrlResponse = GetQueueUrlResponse' Int Text
- newGetQueueUrlResponse :: Int -> Text -> GetQueueUrlResponse
- data PurgeQueue = PurgeQueue' Text
- newPurgeQueue :: Text -> PurgeQueue
- data PurgeQueueResponse = PurgeQueueResponse' {
- newPurgeQueueResponse :: PurgeQueueResponse
- data ChangeMessageVisibilityBatch = ChangeMessageVisibilityBatch' Text [ChangeMessageVisibilityBatchRequestEntry]
- newChangeMessageVisibilityBatch :: Text -> ChangeMessageVisibilityBatch
- data ChangeMessageVisibilityBatchResponse = ChangeMessageVisibilityBatchResponse' Int [ChangeMessageVisibilityBatchResultEntry] [BatchResultErrorEntry]
- newChangeMessageVisibilityBatchResponse :: Int -> ChangeMessageVisibilityBatchResponse
- data SendMessage = SendMessage' (Maybe (HashMap Text MessageAttributeValue)) (Maybe Int) (Maybe (HashMap MessageSystemAttributeNameForSends MessageSystemAttributeValue)) (Maybe Text) (Maybe Text) Text Text
- newSendMessage :: Text -> Text -> SendMessage
- data SendMessageResponse = SendMessageResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newSendMessageResponse :: Int -> SendMessageResponse
- data RemovePermission = RemovePermission' Text Text
- newRemovePermission :: Text -> Text -> RemovePermission
- data RemovePermissionResponse = RemovePermissionResponse' {
- newRemovePermissionResponse :: RemovePermissionResponse
- data GetQueueAttributes = GetQueueAttributes' (Maybe [QueueAttributeName]) Text
- newGetQueueAttributes :: Text -> GetQueueAttributes
- data GetQueueAttributesResponse = GetQueueAttributesResponse' (Maybe (HashMap QueueAttributeName Text)) Int
- newGetQueueAttributesResponse :: Int -> GetQueueAttributesResponse
- data ListQueues = ListQueues' (Maybe Text) (Maybe Text) (Maybe Int)
- newListQueues :: ListQueues
- data ListQueuesResponse = ListQueuesResponse' (Maybe [Text]) (Maybe Text) Int
- newListQueuesResponse :: Int -> ListQueuesResponse
- data ReceiveMessage = ReceiveMessage' (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe [MessageAttribute]) (Maybe Int) Text
- newReceiveMessage :: Text -> ReceiveMessage
- data ReceiveMessageResponse = ReceiveMessageResponse' (Maybe [Message]) Int
- newReceiveMessageResponse :: Int -> ReceiveMessageResponse
- data DeleteQueue = DeleteQueue' Text
- newDeleteQueue :: Text -> DeleteQueue
- data DeleteQueueResponse = DeleteQueueResponse' {
- newDeleteQueueResponse :: DeleteQueueResponse
- data TagQueue = TagQueue' Text (HashMap Text Text)
- newTagQueue :: Text -> TagQueue
- data TagQueueResponse = TagQueueResponse' {
- newTagQueueResponse :: TagQueueResponse
- data DeleteMessageBatch = DeleteMessageBatch' Text [DeleteMessageBatchRequestEntry]
- newDeleteMessageBatch :: Text -> DeleteMessageBatch
- data DeleteMessageBatchResponse = DeleteMessageBatchResponse' Int [DeleteMessageBatchResultEntry] [BatchResultErrorEntry]
- newDeleteMessageBatchResponse :: Int -> DeleteMessageBatchResponse
- data SetQueueAttributes = SetQueueAttributes' Text (HashMap QueueAttributeName Text)
- newSetQueueAttributes :: Text -> SetQueueAttributes
- data SetQueueAttributesResponse = SetQueueAttributesResponse' {
- newSetQueueAttributesResponse :: SetQueueAttributesResponse
- data ListDeadLetterSourceQueues = ListDeadLetterSourceQueues' (Maybe Text) (Maybe Int) Text
- newListDeadLetterSourceQueues :: Text -> ListDeadLetterSourceQueues
- data ListDeadLetterSourceQueuesResponse = ListDeadLetterSourceQueuesResponse' (Maybe Text) Int [Text]
- newListDeadLetterSourceQueuesResponse :: Int -> ListDeadLetterSourceQueuesResponse
- data AddPermission = AddPermission' Text Text [Text] [Text]
- newAddPermission :: Text -> Text -> AddPermission
- data AddPermissionResponse = AddPermissionResponse' {
- newAddPermissionResponse :: AddPermissionResponse
- data DeleteMessage = DeleteMessage' Text Text
- newDeleteMessage :: Text -> Text -> DeleteMessage
- data DeleteMessageResponse = DeleteMessageResponse' {
- newDeleteMessageResponse :: DeleteMessageResponse
- data ListQueueTags = ListQueueTags' Text
- newListQueueTags :: Text -> ListQueueTags
- data ListQueueTagsResponse = ListQueueTagsResponse' (Maybe (HashMap Text Text)) Int
- newListQueueTagsResponse :: Int -> ListQueueTagsResponse
- data CreateQueue = CreateQueue' (Maybe (HashMap QueueAttributeName Text)) (Maybe (HashMap Text Text)) Text
- newCreateQueue :: Text -> CreateQueue
- data CreateQueueResponse = CreateQueueResponse' (Maybe Text) Int
- newCreateQueueResponse :: Int -> CreateQueueResponse
- data UntagQueue = UntagQueue' Text [Text]
- newUntagQueue :: Text -> UntagQueue
- data UntagQueueResponse = UntagQueueResponse' {
- newUntagQueueResponse :: UntagQueueResponse
- data SendMessageBatch = SendMessageBatch' Text [SendMessageBatchRequestEntry]
- newSendMessageBatch :: Text -> SendMessageBatch
- data SendMessageBatchResponse = SendMessageBatchResponse' Int [SendMessageBatchResultEntry] [BatchResultErrorEntry]
- newSendMessageBatchResponse :: Int -> SendMessageBatchResponse
- data ChangeMessageVisibility = ChangeMessageVisibility' Text Text Int
- newChangeMessageVisibility :: Text -> Text -> Int -> ChangeMessageVisibility
- data ChangeMessageVisibilityResponse = ChangeMessageVisibilityResponse' {
- newChangeMessageVisibilityResponse :: ChangeMessageVisibilityResponse
- newtype MessageAttribute where
- MessageAttribute' { }
- pattern MessageAttribute_All :: MessageAttribute
- pattern MessageAttribute_ApproximateFirstReceiveTimestamp :: MessageAttribute
- pattern MessageAttribute_ApproximateReceiveCount :: MessageAttribute
- pattern MessageAttribute_SenderId :: MessageAttribute
- pattern MessageAttribute_SentTimestamp :: MessageAttribute
- newtype MessageSystemAttributeNameForSends where
- newtype QueueAttributeName where
- QueueAttributeName' { }
- pattern QueueAttributeName_All :: QueueAttributeName
- pattern QueueAttributeName_ApproximateNumberOfMessages :: QueueAttributeName
- pattern QueueAttributeName_ApproximateNumberOfMessagesDelayed :: QueueAttributeName
- pattern QueueAttributeName_ApproximateNumberOfMessagesNotVisible :: QueueAttributeName
- pattern QueueAttributeName_ContentBasedDeduplication :: QueueAttributeName
- pattern QueueAttributeName_CreatedTimestamp :: QueueAttributeName
- pattern QueueAttributeName_DeduplicationScope :: QueueAttributeName
- pattern QueueAttributeName_DelaySeconds :: QueueAttributeName
- pattern QueueAttributeName_FifoQueue :: QueueAttributeName
- pattern QueueAttributeName_FifoThroughputLimit :: QueueAttributeName
- pattern QueueAttributeName_KmsDataKeyReusePeriodSeconds :: QueueAttributeName
- pattern QueueAttributeName_KmsMasterKeyId :: QueueAttributeName
- pattern QueueAttributeName_LastModifiedTimestamp :: QueueAttributeName
- pattern QueueAttributeName_MaximumMessageSize :: QueueAttributeName
- pattern QueueAttributeName_MessageRetentionPeriod :: QueueAttributeName
- pattern QueueAttributeName_Policy :: QueueAttributeName
- pattern QueueAttributeName_QueueArn :: QueueAttributeName
- pattern QueueAttributeName_ReceiveMessageWaitTimeSeconds :: QueueAttributeName
- pattern QueueAttributeName_RedriveAllowPolicy :: QueueAttributeName
- pattern QueueAttributeName_RedrivePolicy :: QueueAttributeName
- pattern QueueAttributeName_VisibilityTimeout :: QueueAttributeName
- data BatchResultErrorEntry = BatchResultErrorEntry' (Maybe Text) Text Bool Text
- newBatchResultErrorEntry :: Text -> Bool -> Text -> BatchResultErrorEntry
- data ChangeMessageVisibilityBatchRequestEntry = ChangeMessageVisibilityBatchRequestEntry' (Maybe Int) Text Text
- newChangeMessageVisibilityBatchRequestEntry :: Text -> Text -> ChangeMessageVisibilityBatchRequestEntry
- data ChangeMessageVisibilityBatchResultEntry = ChangeMessageVisibilityBatchResultEntry' Text
- newChangeMessageVisibilityBatchResultEntry :: Text -> ChangeMessageVisibilityBatchResultEntry
- data DeleteMessageBatchRequestEntry = DeleteMessageBatchRequestEntry' Text Text
- newDeleteMessageBatchRequestEntry :: Text -> Text -> DeleteMessageBatchRequestEntry
- data DeleteMessageBatchResultEntry = DeleteMessageBatchResultEntry' Text
- newDeleteMessageBatchResultEntry :: Text -> DeleteMessageBatchResultEntry
- data Message = Message' (Maybe (HashMap Text MessageAttributeValue)) (Maybe Text) (Maybe Text) (Maybe (HashMap MessageAttribute Text)) (Maybe Text) (Maybe Text) (Maybe Text)
- newMessage :: Message
- data MessageAttributeValue = MessageAttributeValue' (Maybe Base64) (Maybe [Text]) (Maybe Text) (Maybe [Base64]) Text
- newMessageAttributeValue :: Text -> MessageAttributeValue
- data MessageSystemAttributeValue = MessageSystemAttributeValue' (Maybe Base64) (Maybe [Text]) (Maybe Text) (Maybe [Base64]) Text
- newMessageSystemAttributeValue :: Text -> MessageSystemAttributeValue
- data SendMessageBatchRequestEntry = SendMessageBatchRequestEntry' (Maybe (HashMap Text MessageAttributeValue)) (Maybe Int) (Maybe (HashMap MessageSystemAttributeNameForSends MessageSystemAttributeValue)) (Maybe Text) (Maybe Text) Text Text
- newSendMessageBatchRequestEntry :: Text -> Text -> SendMessageBatchRequestEntry
- data SendMessageBatchResultEntry = SendMessageBatchResultEntry' (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text
- newSendMessageBatchResultEntry :: Text -> Text -> Text -> SendMessageBatchResultEntry
Service Configuration
defaultService :: Service Source #
API version 2012-11-05
of the Amazon Simple Queue Service SDK 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 queue with the same name.
QueueDoesNotExist
_QueueDoesNotExist :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified queue doesn't exist.
InvalidAttributeName
_InvalidAttributeName :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified attribute 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 specified action violates a limit. For example, ReceiveMessage
returns this error if the maximum number of inflight messages is reached
and AddPermission
returns this error if the maximum number of
permissions for the queue is reached.
QueueNameExists
_QueueNameExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
A queue with this name already exists. 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 specified receipt handle isn't valid for the current version.
ReceiptHandleIsInvalid
_ReceiptHandleIsInvalid :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified receipt handle 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 specified message 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
data GetQueueUrl Source #
See: newGetQueueUrl
smart constructor.
Instances
Create a value of GetQueueUrl
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:queueOwnerAWSAccountId:GetQueueUrl'
, getQueueUrl_queueOwnerAWSAccountId
- The account ID of the account that created the queue.
$sel:queueName:GetQueueUrl'
, getQueueUrl_queueName
- The name of the queue whose URL must be fetched. Maximum 80 characters.
Valid values: alphanumeric characters, hyphens (-
), and underscores
(_
).
Queue URLs and names are case-sensitive.
data GetQueueUrlResponse Source #
For more information, see Interpreting Responses in the Amazon SQS Developer Guide.
See: newGetQueueUrlResponse
smart constructor.
Instances
newGetQueueUrlResponse Source #
:: Int | |
-> Text | |
-> GetQueueUrlResponse |
Create a value of GetQueueUrlResponse
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:httpStatus:GetQueueUrlResponse'
, getQueueUrlResponse_httpStatus
- The response's http status code.
$sel:queueUrl:GetQueueUrlResponse'
, getQueueUrlResponse_queueUrl
- The URL of the queue.
PurgeQueue
data PurgeQueue Source #
See: newPurgeQueue
smart constructor.
Instances
Create a value of PurgeQueue
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:queueUrl:PurgeQueue'
, purgeQueue_queueUrl
- The URL of the queue from which the PurgeQueue
action deletes
messages.
Queue URLs and names are case-sensitive.
data PurgeQueueResponse Source #
See: newPurgeQueueResponse
smart constructor.
Instances
Eq PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue (==) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool # (/=) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool # | |
Read PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue | |
Show PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue showsPrec :: Int -> PurgeQueueResponse -> ShowS # show :: PurgeQueueResponse -> String # showList :: [PurgeQueueResponse] -> ShowS # | |
Generic PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue type Rep PurgeQueueResponse :: Type -> Type # from :: PurgeQueueResponse -> Rep PurgeQueueResponse x # to :: Rep PurgeQueueResponse x -> PurgeQueueResponse # | |
NFData PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue rnf :: PurgeQueueResponse -> () # | |
type Rep PurgeQueueResponse Source # | |
newPurgeQueueResponse :: PurgeQueueResponse Source #
Create a value of PurgeQueueResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ChangeMessageVisibilityBatch
data ChangeMessageVisibilityBatch Source #
See: newChangeMessageVisibilityBatch
smart constructor.
Instances
newChangeMessageVisibilityBatch Source #
Create a value of ChangeMessageVisibilityBatch
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:queueUrl:ChangeMessageVisibilityBatch'
, changeMessageVisibilityBatch_queueUrl
- The URL of the Amazon SQS queue whose messages' visibility is changed.
Queue URLs and names are case-sensitive.
$sel:entries:ChangeMessageVisibilityBatch'
, changeMessageVisibilityBatch_entries
- A list of receipt handles of the messages for which the visibility
timeout must be changed.
data ChangeMessageVisibilityBatchResponse Source #
For each message in the batch, the response contains a
ChangeMessageVisibilityBatchResultEntry
tag if the message succeeds
or a BatchResultErrorEntry
tag if the message fails.
See: newChangeMessageVisibilityBatchResponse
smart constructor.
ChangeMessageVisibilityBatchResponse' Int [ChangeMessageVisibilityBatchResultEntry] [BatchResultErrorEntry] |
Instances
newChangeMessageVisibilityBatchResponse Source #
Create a value of ChangeMessageVisibilityBatchResponse
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:httpStatus:ChangeMessageVisibilityBatchResponse'
, changeMessageVisibilityBatchResponse_httpStatus
- The response's http status code.
$sel:successful:ChangeMessageVisibilityBatchResponse'
, changeMessageVisibilityBatchResponse_successful
- A list of ChangeMessageVisibilityBatchResultEntry
items.
$sel:failed:ChangeMessageVisibilityBatchResponse'
, changeMessageVisibilityBatchResponse_failed
- A list of BatchResultErrorEntry
items.
SendMessage
data SendMessage Source #
See: newSendMessage
smart constructor.
SendMessage' (Maybe (HashMap Text MessageAttributeValue)) (Maybe Int) (Maybe (HashMap MessageSystemAttributeNameForSends MessageSystemAttributeValue)) (Maybe Text) (Maybe Text) Text Text |
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.
data SendMessageResponse Source #
The MD5OfMessageBody
and MessageId
elements.
See: newSendMessageResponse
smart constructor.
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.
RemovePermission
data RemovePermission Source #
See: newRemovePermission
smart constructor.
Instances
Create a value of RemovePermission
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:queueUrl:RemovePermission'
, removePermission_queueUrl
- The URL of the Amazon SQS queue from which permissions are removed.
Queue URLs and names are case-sensitive.
$sel:label:RemovePermission'
, removePermission_label
- The identification of the permission to remove. This is the label added
using the AddPermission
action.
data RemovePermissionResponse Source #
See: newRemovePermissionResponse
smart constructor.
Instances
Eq RemovePermissionResponse Source # | |
Defined in Amazonka.SQS.RemovePermission | |
Read RemovePermissionResponse Source # | |
Show RemovePermissionResponse Source # | |
Defined in Amazonka.SQS.RemovePermission showsPrec :: Int -> RemovePermissionResponse -> ShowS # show :: RemovePermissionResponse -> String # showList :: [RemovePermissionResponse] -> ShowS # | |
Generic RemovePermissionResponse Source # | |
Defined in Amazonka.SQS.RemovePermission type Rep RemovePermissionResponse :: Type -> Type # | |
NFData RemovePermissionResponse Source # | |
Defined in Amazonka.SQS.RemovePermission rnf :: RemovePermissionResponse -> () # | |
type Rep RemovePermissionResponse Source # | |
newRemovePermissionResponse :: RemovePermissionResponse Source #
Create a value of RemovePermissionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetQueueAttributes
data GetQueueAttributes Source #
See: newGetQueueAttributes
smart constructor.
Instances
newGetQueueAttributes Source #
Create a value of GetQueueAttributes
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:attributeNames:GetQueueAttributes'
, getQueueAttributes_attributeNames
- A list of attributes for which to retrieve information.
The AttributeName.N
parameter is optional, but if you don't specify
values for this parameter, the request returns empty results.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
The following attributes are supported:
The ApproximateNumberOfMessagesDelayed
,
ApproximateNumberOfMessagesNotVisible
, and
ApproximateNumberOfMessagesVisible
metrics may not achieve consistency
until at least 1 minute after the producers stop sending messages. This
period is required for the queue metadata to reach eventual consistency.
All
– Returns all values.ApproximateNumberOfMessages
– Returns the approximate number of messages available for retrieval from the queue.ApproximateNumberOfMessagesDelayed
– Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.ApproximateNumberOfMessagesNotVisible
– Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.CreatedTimestamp
– Returns the time when the queue was created in seconds (epoch time).DelaySeconds
– Returns the default delay on the queue in seconds.LastModifiedTimestamp
– Returns the time when the queue was last changed in seconds (epoch time).MaximumMessageSize
– Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.MessageRetentionPeriod
– Returns the length of time, in seconds, for which Amazon SQS retains a message.Policy
– Returns the policy of the queue.QueueArn
– Returns the Amazon resource name (ARN) of the queue.ReceiveMessageWaitTimeSeconds
– Returns the length of time, in seconds, for which theReceiveMessage
action waits for a message to arrive.VisibilityTimeout
– Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to dead-letter queues:
RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value ofmaxReceiveCount
is exceeded.maxReceiveCount
– The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When theReceiveCount
for a message exceeds themaxReceiveCount
for a queue, Amazon SQS moves the message to the dead-letter-queue.
RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:redrivePermission
– The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue.denyAll
– No source queues can specify this queue as the dead-letter queue.byQueue
– Only queues specified by thesourceQueueArns
parameter can specify this queue as the dead-letter queue.
sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when theredrivePermission
parameter is set tobyQueue
. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set theredrivePermission
parameter toallowAll
.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId
– Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.KmsDataKeyReusePeriodSeconds
– Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. For more information, see How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue
– Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.To determine whether a queue is FIFO, you can check whether
QueueName
ends with the.fifo
suffix.ContentBasedDeduplication
– Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
The following attributes apply only to high throughput for FIFO queues:
DeduplicationScope
– Specifies whether message deduplication occurs at the message group or queue level. Valid values aremessageGroup
andqueue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values areperQueue
andperMessageGroupId
. TheperMessageGroupId
value is allowed only when the value forDeduplicationScope
ismessageGroup
.
To enable high throughput for FIFO queues, do the following:
- Set
DeduplicationScope
tomessageGroup
. - Set
FifoThroughputLimit
toperMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.
For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
$sel:queueUrl:GetQueueAttributes'
, getQueueAttributes_queueUrl
- The URL of the Amazon SQS queue whose attribute information is
retrieved.
Queue URLs and names are case-sensitive.
data GetQueueAttributesResponse Source #
A list of returned queue attributes.
See: newGetQueueAttributesResponse
smart constructor.
Instances
newGetQueueAttributesResponse Source #
Create a value of GetQueueAttributesResponse
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:attributes:GetQueueAttributesResponse'
, getQueueAttributesResponse_attributes
- A map of attributes to their respective values.
$sel:httpStatus:GetQueueAttributesResponse'
, getQueueAttributesResponse_httpStatus
- The response's http status code.
ListQueues (Paginated)
data ListQueues Source #
See: newListQueues
smart constructor.
Instances
newListQueues :: ListQueues Source #
Create a value of ListQueues
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:queueNamePrefix:ListQueues'
, listQueues_queueNamePrefix
- A string to use for filtering the list results. Only those queues whose
name begins with the specified string are returned.
Queue URLs and names are case-sensitive.
$sel:nextToken:ListQueues'
, listQueues_nextToken
- Pagination token to request the next set of results.
$sel:maxResults:ListQueues'
, listQueues_maxResults
- Maximum number of results to include in the response. Value range is 1
to 1000. You must set MaxResults
to receive a value for NextToken
in
the response.
data ListQueuesResponse Source #
A list of your queues.
See: newListQueuesResponse
smart constructor.
Instances
newListQueuesResponse Source #
Create a value of ListQueuesResponse
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:queueUrls:ListQueuesResponse'
, listQueuesResponse_queueUrls
- A list of queue URLs, up to 1,000 entries, or the value of MaxResults
that you sent in the request.
$sel:nextToken:ListQueues'
, listQueuesResponse_nextToken
- Pagination token to include in the next request. Token value is null
if there are no additional results to request, or if you did not set
MaxResults
in the request.
$sel:httpStatus:ListQueuesResponse'
, listQueuesResponse_httpStatus
- The response's http status code.
ReceiveMessage
data ReceiveMessage Source #
See: newReceiveMessage
smart constructor.
ReceiveMessage' (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe [MessageAttribute]) (Maybe Int) Text |
Instances
Create a value of ReceiveMessage
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:receiveRequestAttemptId:ReceiveMessage'
, receiveMessage_receiveRequestAttemptId
- This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of ReceiveMessage
calls. If a
networking issue occurs after a ReceiveMessage
action, and instead of
a response you receive a generic error, it is possible to retry the same
action with an identical ReceiveRequestAttemptId
to retrieve the same
set of messages, even if their visibility timeout has not yet expired.
- You can use
ReceiveRequestAttemptId
only for 5 minutes after aReceiveMessage
action. - When you set
FifoQueue
, a caller of theReceiveMessage
action can provide aReceiveRequestAttemptId
explicitly. - If a caller of the
ReceiveMessage
action doesn't provide aReceiveRequestAttemptId
, Amazon SQS generates aReceiveRequestAttemptId
. - It is possible to retry the
ReceiveMessage
action with the sameReceiveRequestAttemptId
if none of the messages have been modified (deleted or had their visibility changes). During a visibility timeout, subsequent calls with the same
ReceiveRequestAttemptId
return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.If a caller of the
ReceiveMessage
action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
- While messages with a particular
MessageGroupId
are invisible, no more messages belonging to the sameMessageGroupId
are returned until the visibility timeout expires. You can still receive messages with anotherMessageGroupId
as long as it is also visible. - If a caller of
ReceiveMessage
can't track theReceiveRequestAttemptId
, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId
is 128 characters.
ReceiveRequestAttemptId
can contain alphanumeric characters (a-z
,
A-Z
, 0-9
) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using ReceiveRequestAttemptId
, see
Using the ReceiveRequestAttemptId Request Parameter
in the Amazon SQS Developer Guide.
$sel:visibilityTimeout:ReceiveMessage'
, receiveMessage_visibilityTimeout
- The duration (in seconds) that the received messages are hidden from
subsequent retrieve requests after being retrieved by a ReceiveMessage
request.
$sel:messageAttributeNames:ReceiveMessage'
, receiveMessage_messageAttributeNames
- The name of the message attribute, where N is the index.
- The name can contain alphanumeric characters and the underscore
(
_
), hyphen (-
), and period (.
). - The name is case-sensitive and must be unique among all attribute names for the message.
- The name must not start with AWS-reserved prefixes such as
AWS.
orAmazon.
(or any casing variants). - The name must not start or end with a period (
.
), and it should not have periods in succession (..
). - The name can be up to 256 characters long.
When using ReceiveMessage
, you can send a list of attribute names to
receive, or you can return all of the attributes by specifying All
or
.*
in your request. You can also use all message attributes starting
with a prefix, for example bar.*
.
$sel:waitTimeSeconds:ReceiveMessage'
, receiveMessage_waitTimeSeconds
- The duration (in seconds) for which the call waits for a message to
arrive in the queue before returning. If a message is available, the
call returns sooner than WaitTimeSeconds
. If no messages are available
and the wait time expires, the call returns successfully with an empty
list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for
ReceiveMessage
requests is longer than the WaitTimeSeconds
parameter. For example, with the Java SDK, you can set HTTP transport
settings using the
NettyNioAsyncHttpClient
for asynchronous clients, or the
ApacheHttpClient
for synchronous clients.
$sel:attributeNames:ReceiveMessage'
, receiveMessage_attributeNames
- A list of attributes that need to be returned along with each message.
These attributes include:
All
– Returns all values.ApproximateFirstReceiveTimestamp
– Returns the time the message was first received from the queue (epoch time in milliseconds).ApproximateReceiveCount
– Returns the number of times a message has been received across all queues but not deleted.AWSTraceHeader
– Returns the X-Ray trace header string.SenderId
- For an IAM user, returns the IAM user ID, for example
ABCDEFGHI1JKLMNOPQ23R
. - For an IAM role, returns the IAM role ID, for example
ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
- For an IAM user, returns the IAM user ID, for example
SentTimestamp
– Returns the time the message was sent to the queue (epoch time in milliseconds).MessageDeduplicationId
– Returns the value provided by the producer that calls theSendMessage
action.MessageGroupId
– Returns the value provided by the producer that calls theSendMessage
action. Messages with the sameMessageGroupId
are returned in sequence.SequenceNumber
– Returns the value provided by Amazon SQS.
$sel:maxNumberOfMessages:ReceiveMessage'
, receiveMessage_maxNumberOfMessages
- The maximum number of messages to return. Amazon SQS never returns more
messages than this value (however, fewer messages might be returned).
Valid values: 1 to 10. Default: 1.
$sel:queueUrl:ReceiveMessage'
, receiveMessage_queueUrl
- The URL of the Amazon SQS queue from which messages are received.
Queue URLs and names are case-sensitive.
data ReceiveMessageResponse Source #
A list of received messages.
See: newReceiveMessageResponse
smart constructor.
Instances
newReceiveMessageResponse Source #
Create a value of ReceiveMessageResponse
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:messages:ReceiveMessageResponse'
, receiveMessageResponse_messages
- A list of messages.
$sel:httpStatus:ReceiveMessageResponse'
, receiveMessageResponse_httpStatus
- The response's http status code.
DeleteQueue
data DeleteQueue Source #
See: newDeleteQueue
smart constructor.
Instances
Create a value of DeleteQueue
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:queueUrl:DeleteQueue'
, deleteQueue_queueUrl
- The URL of the Amazon SQS queue to delete.
Queue URLs and names are case-sensitive.
data DeleteQueueResponse Source #
See: newDeleteQueueResponse
smart constructor.
Instances
Eq DeleteQueueResponse Source # | |
Defined in Amazonka.SQS.DeleteQueue (==) :: DeleteQueueResponse -> DeleteQueueResponse -> Bool # (/=) :: DeleteQueueResponse -> DeleteQueueResponse -> Bool # | |
Read DeleteQueueResponse Source # | |
Defined in Amazonka.SQS.DeleteQueue | |
Show DeleteQueueResponse Source # | |
Defined in Amazonka.SQS.DeleteQueue showsPrec :: Int -> DeleteQueueResponse -> ShowS # show :: DeleteQueueResponse -> String # showList :: [DeleteQueueResponse] -> ShowS # | |
Generic DeleteQueueResponse Source # | |
Defined in Amazonka.SQS.DeleteQueue type Rep DeleteQueueResponse :: Type -> Type # from :: DeleteQueueResponse -> Rep DeleteQueueResponse x # to :: Rep DeleteQueueResponse x -> DeleteQueueResponse # | |
NFData DeleteQueueResponse Source # | |
Defined in Amazonka.SQS.DeleteQueue rnf :: DeleteQueueResponse -> () # | |
type Rep DeleteQueueResponse Source # | |
newDeleteQueueResponse :: DeleteQueueResponse Source #
Create a value of DeleteQueueResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagQueue
See: newTagQueue
smart constructor.
Instances
Create a value of TagQueue
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:queueUrl:TagQueue'
, tagQueue_queueUrl
- The URL of the queue.
$sel:tags:TagQueue'
, tagQueue_tags
- The list of tags to be added to the specified queue.
data TagQueueResponse Source #
See: newTagQueueResponse
smart constructor.
Instances
Eq TagQueueResponse Source # | |
Defined in Amazonka.SQS.TagQueue (==) :: TagQueueResponse -> TagQueueResponse -> Bool # (/=) :: TagQueueResponse -> TagQueueResponse -> Bool # | |
Read TagQueueResponse Source # | |
Defined in Amazonka.SQS.TagQueue | |
Show TagQueueResponse Source # | |
Defined in Amazonka.SQS.TagQueue showsPrec :: Int -> TagQueueResponse -> ShowS # show :: TagQueueResponse -> String # showList :: [TagQueueResponse] -> ShowS # | |
Generic TagQueueResponse Source # | |
Defined in Amazonka.SQS.TagQueue type Rep TagQueueResponse :: Type -> Type # from :: TagQueueResponse -> Rep TagQueueResponse x # to :: Rep TagQueueResponse x -> TagQueueResponse # | |
NFData TagQueueResponse Source # | |
Defined in Amazonka.SQS.TagQueue rnf :: TagQueueResponse -> () # | |
type Rep TagQueueResponse Source # | |
newTagQueueResponse :: TagQueueResponse Source #
Create a value of TagQueueResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMessageBatch
data DeleteMessageBatch Source #
See: newDeleteMessageBatch
smart constructor.
Instances
newDeleteMessageBatch Source #
Create a value of DeleteMessageBatch
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:queueUrl:DeleteMessageBatch'
, deleteMessageBatch_queueUrl
- The URL of the Amazon SQS queue from which messages are deleted.
Queue URLs and names are case-sensitive.
$sel:entries:DeleteMessageBatch'
, deleteMessageBatch_entries
- A list of receipt handles for the messages to be deleted.
data DeleteMessageBatchResponse Source #
For each message in the batch, the response contains a
DeleteMessageBatchResultEntry
tag if the message is deleted or a
BatchResultErrorEntry
tag if the message can't be deleted.
See: newDeleteMessageBatchResponse
smart constructor.
Instances
newDeleteMessageBatchResponse Source #
Create a value of DeleteMessageBatchResponse
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:httpStatus:DeleteMessageBatchResponse'
, deleteMessageBatchResponse_httpStatus
- The response's http status code.
$sel:successful:DeleteMessageBatchResponse'
, deleteMessageBatchResponse_successful
- A list of DeleteMessageBatchResultEntry
items.
$sel:failed:DeleteMessageBatchResponse'
, deleteMessageBatchResponse_failed
- A list of BatchResultErrorEntry
items.
SetQueueAttributes
data SetQueueAttributes Source #
See: newSetQueueAttributes
smart constructor.
Instances
newSetQueueAttributes Source #
Create a value of SetQueueAttributes
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:queueUrl:SetQueueAttributes'
, setQueueAttributes_queueUrl
- The URL of the Amazon SQS queue whose attributes are set.
Queue URLs and names are case-sensitive.
$sel:attributes:SetQueueAttributes'
, setQueueAttributes_attributes
- A map of attributes to set.
The following lists the names, descriptions, and values of the special
request parameters that the SetQueueAttributes
action uses:
DelaySeconds
– The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.MaximumMessageSize
– The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).MessageRetentionPeriod
– The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).Policy
– The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Identity and Access Management User Guide.ReceiveMessageWaitTimeSeconds
– The length of time, in seconds, for which aReceiveMessage
action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.VisibilityTimeout
– The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to dead-letter queues:
RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value ofmaxReceiveCount
is exceeded.maxReceiveCount
– The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When theReceiveCount
for a message exceeds themaxReceiveCount
for a queue, Amazon SQS moves the message to the dead-letter-queue.
RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:redrivePermission
– The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue.denyAll
– No source queues can specify this queue as the dead-letter queue.byQueue
– Only queues specified by thesourceQueueArns
parameter can specify this queue as the dead-letter queue.
sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when theredrivePermission
parameter is set tobyQueue
. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set theredrivePermission
parameter toallowAll
.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is alwaysalias/aws/sqs
, the alias of a custom CMK can, for example, bealias/MyAlias
. For more examples, see KeyId in the Key Management Service API Reference.KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
The following attribute applies only to FIFO (first-in-first-out) queues:
ContentBasedDeduplication
– Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following: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 following attributes apply only to high throughput for FIFO queues:
DeduplicationScope
– Specifies whether message deduplication occurs at the message group or queue level. Valid values aremessageGroup
andqueue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values areperQueue
andperMessageGroupId
. TheperMessageGroupId
value is allowed only when the value forDeduplicationScope
ismessageGroup
.
To enable high throughput for FIFO queues, do the following:
- Set
DeduplicationScope
tomessageGroup
. - Set
FifoThroughputLimit
toperMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.
For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
data SetQueueAttributesResponse Source #
See: newSetQueueAttributesResponse
smart constructor.
Instances
newSetQueueAttributesResponse :: SetQueueAttributesResponse Source #
Create a value of SetQueueAttributesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListDeadLetterSourceQueues (Paginated)
data ListDeadLetterSourceQueues Source #
See: newListDeadLetterSourceQueues
smart constructor.
Instances
newListDeadLetterSourceQueues Source #
Create a value of ListDeadLetterSourceQueues
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:nextToken:ListDeadLetterSourceQueues'
, listDeadLetterSourceQueues_nextToken
- Pagination token to request the next set of results.
$sel:maxResults:ListDeadLetterSourceQueues'
, listDeadLetterSourceQueues_maxResults
- Maximum number of results to include in the response. Value range is 1
to 1000. You must set MaxResults
to receive a value for NextToken
in
the response.
$sel:queueUrl:ListDeadLetterSourceQueues'
, listDeadLetterSourceQueues_queueUrl
- The URL of a dead-letter queue.
Queue URLs and names are case-sensitive.
data ListDeadLetterSourceQueuesResponse Source #
A list of your dead letter source queues.
See: newListDeadLetterSourceQueuesResponse
smart constructor.
Instances
newListDeadLetterSourceQueuesResponse Source #
Create a value of ListDeadLetterSourceQueuesResponse
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:nextToken:ListDeadLetterSourceQueues'
, listDeadLetterSourceQueuesResponse_nextToken
- Pagination token to include in the next request. Token value is null
if there are no additional results to request, or if you did not set
MaxResults
in the request.
$sel:httpStatus:ListDeadLetterSourceQueuesResponse'
, listDeadLetterSourceQueuesResponse_httpStatus
- The response's http status code.
$sel:queueUrls:ListDeadLetterSourceQueuesResponse'
, listDeadLetterSourceQueuesResponse_queueUrls
- A list of source queue URLs that have the RedrivePolicy
queue
attribute configured with a dead-letter queue.
AddPermission
data AddPermission Source #
See: newAddPermission
smart constructor.
AddPermission' Text Text [Text] [Text] |
Instances
Create a value of AddPermission
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:queueUrl:AddPermission'
, addPermission_queueUrl
- The URL of the Amazon SQS queue to which permissions are added.
Queue URLs and names are case-sensitive.
$sel:label:AddPermission'
, addPermission_label
- The unique identification of the permission you're setting (for
example, AliceSendMessage
). Maximum 80 characters. Allowed characters
include alphanumeric characters, hyphens (-
), and underscores (_
).
$sel:aWSAccountIds:AddPermission'
, addPermission_aWSAccountIds
- The account numbers of the
principals
who are to receive permission. For information about locating the
account identification, see
Your Amazon Web Services Identifiers
in the Amazon SQS Developer Guide.
$sel:actions:AddPermission'
, addPermission_actions
- The action the client wants to allow for the specified principal. Valid
values: the name of any action or *
.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.
Specifying SendMessage
, DeleteMessage
, or ChangeMessageVisibility
for ActionName.n
also grants permissions for the corresponding batch
versions of those actions: SendMessageBatch
, DeleteMessageBatch
, and
ChangeMessageVisibilityBatch
.
data AddPermissionResponse Source #
See: newAddPermissionResponse
smart constructor.
Instances
Eq AddPermissionResponse Source # | |
Defined in Amazonka.SQS.AddPermission (==) :: AddPermissionResponse -> AddPermissionResponse -> Bool # (/=) :: AddPermissionResponse -> AddPermissionResponse -> Bool # | |
Read AddPermissionResponse Source # | |
Show AddPermissionResponse Source # | |
Defined in Amazonka.SQS.AddPermission showsPrec :: Int -> AddPermissionResponse -> ShowS # show :: AddPermissionResponse -> String # showList :: [AddPermissionResponse] -> ShowS # | |
Generic AddPermissionResponse Source # | |
Defined in Amazonka.SQS.AddPermission type Rep AddPermissionResponse :: Type -> Type # | |
NFData AddPermissionResponse Source # | |
Defined in Amazonka.SQS.AddPermission rnf :: AddPermissionResponse -> () # | |
type Rep AddPermissionResponse Source # | |
newAddPermissionResponse :: AddPermissionResponse Source #
Create a value of AddPermissionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMessage
data DeleteMessage Source #
See: newDeleteMessage
smart constructor.
Instances
Create a value of DeleteMessage
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:queueUrl:DeleteMessage'
, deleteMessage_queueUrl
- The URL of the Amazon SQS queue from which messages are deleted.
Queue URLs and names are case-sensitive.
$sel:receiptHandle:DeleteMessage'
, deleteMessage_receiptHandle
- The receipt handle associated with the message to delete.
data DeleteMessageResponse Source #
See: newDeleteMessageResponse
smart constructor.
Instances
Eq DeleteMessageResponse Source # | |
Defined in Amazonka.SQS.DeleteMessage (==) :: DeleteMessageResponse -> DeleteMessageResponse -> Bool # (/=) :: DeleteMessageResponse -> DeleteMessageResponse -> Bool # | |
Read DeleteMessageResponse Source # | |
Show DeleteMessageResponse Source # | |
Defined in Amazonka.SQS.DeleteMessage showsPrec :: Int -> DeleteMessageResponse -> ShowS # show :: DeleteMessageResponse -> String # showList :: [DeleteMessageResponse] -> ShowS # | |
Generic DeleteMessageResponse Source # | |
Defined in Amazonka.SQS.DeleteMessage type Rep DeleteMessageResponse :: Type -> Type # | |
NFData DeleteMessageResponse Source # | |
Defined in Amazonka.SQS.DeleteMessage rnf :: DeleteMessageResponse -> () # | |
type Rep DeleteMessageResponse Source # | |
newDeleteMessageResponse :: DeleteMessageResponse Source #
Create a value of DeleteMessageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListQueueTags
data ListQueueTags Source #
See: newListQueueTags
smart constructor.
Instances
Create a value of ListQueueTags
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:queueUrl:ListQueueTags'
, listQueueTags_queueUrl
- The URL of the queue.
data ListQueueTagsResponse Source #
See: newListQueueTagsResponse
smart constructor.
Instances
newListQueueTagsResponse Source #
Create a value of ListQueueTagsResponse
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:tags:ListQueueTagsResponse'
, listQueueTagsResponse_tags
- The list of all tags added to the specified queue.
$sel:httpStatus:ListQueueTagsResponse'
, listQueueTagsResponse_httpStatus
- The response's http status code.
CreateQueue
data CreateQueue Source #
See: newCreateQueue
smart constructor.
Instances
Create a value of CreateQueue
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:attributes:CreateQueue'
, createQueue_attributes
- A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special
request parameters that the CreateQueue
action uses:
DelaySeconds
– The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.MaximumMessageSize
– The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).MessageRetentionPeriod
– The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).Policy
– The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.ReceiveMessageWaitTimeSeconds
– The length of time, in seconds, for which aReceiveMessage
action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.VisibilityTimeout
– The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to dead-letter queues:
RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value ofmaxReceiveCount
is exceeded.maxReceiveCount
– The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When theReceiveCount
for a message exceeds themaxReceiveCount
for a queue, Amazon SQS moves the message to the dead-letter-queue.
RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:redrivePermission
– The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue.denyAll
– No source queues can specify this queue as the dead-letter queue.byQueue
– Only queues specified by thesourceQueueArns
parameter can specify this queue as the dead-letter queue.
sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when theredrivePermission
parameter is set tobyQueue
. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set theredrivePermission
parameter toallowAll
.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is alwaysalias/aws/sqs
, the alias of a custom CMK can, for example, bealias/MyAlias
. For more examples, see KeyId in the Key Management Service API Reference.KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue
– Designates a queue as FIFO. Valid values aretrue
andfalse
. If you don't specify theFifoQueue
attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide theMessageGroupId
for your messages explicitly.For more information, see FIFO queue logic in the Amazon SQS Developer Guide.
ContentBasedDeduplication
– Enables content-based deduplication. Valid values aretrue
andfalse
. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following: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 following attributes apply only to high throughput for FIFO queues:
DeduplicationScope
– Specifies whether message deduplication occurs at the message group or queue level. Valid values aremessageGroup
andqueue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values areperQueue
andperMessageGroupId
. TheperMessageGroupId
value is allowed only when the value forDeduplicationScope
ismessageGroup
.
To enable high throughput for FIFO queues, do the following:
- Set
DeduplicationScope
tomessageGroup
. - Set
FifoThroughputLimit
toperMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.
For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
$sel:tags:CreateQueue'
, createQueue_tags
- Add cost allocation tags to the specified Amazon SQS queue. For an
overview, see
Tagging Your Amazon SQS Queues
in the Amazon SQS Developer Guide.
When you use queue tags, keep the following guidelines in mind:
- Adding more than 50 tags to a queue isn't recommended.
- Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
- Tags are case-sensitive.
- A new tag with a key identical to that of an existing tag overwrites the existing tag.
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.
To be able to tag a queue on creation, you must have the
sqs:CreateQueue
and sqs:TagQueue
permissions.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
$sel:queueName:CreateQueue'
, createQueue_queueName
- The name of the new queue. The following limits apply to this name:
- A queue name can have up to 80 characters.
- Valid values: alphanumeric characters, hyphens (
-
), and underscores (_
). - A FIFO queue name must end with the
.fifo
suffix.
Queue URLs and names are case-sensitive.
data CreateQueueResponse Source #
Returns the QueueUrl
attribute of the created queue.
See: newCreateQueueResponse
smart constructor.
Instances
newCreateQueueResponse Source #
Create a value of CreateQueueResponse
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:queueUrl:CreateQueueResponse'
, createQueueResponse_queueUrl
- The URL of the created Amazon SQS queue.
$sel:httpStatus:CreateQueueResponse'
, createQueueResponse_httpStatus
- The response's http status code.
UntagQueue
data UntagQueue Source #
See: newUntagQueue
smart constructor.
Instances
Create a value of UntagQueue
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:queueUrl:UntagQueue'
, untagQueue_queueUrl
- The URL of the queue.
$sel:tagKeys:UntagQueue'
, untagQueue_tagKeys
- The list of tags to be removed from the specified queue.
data UntagQueueResponse Source #
See: newUntagQueueResponse
smart constructor.
Instances
Eq UntagQueueResponse Source # | |
Defined in Amazonka.SQS.UntagQueue (==) :: UntagQueueResponse -> UntagQueueResponse -> Bool # (/=) :: UntagQueueResponse -> UntagQueueResponse -> Bool # | |
Read UntagQueueResponse Source # | |
Defined in Amazonka.SQS.UntagQueue | |
Show UntagQueueResponse Source # | |
Defined in Amazonka.SQS.UntagQueue showsPrec :: Int -> UntagQueueResponse -> ShowS # show :: UntagQueueResponse -> String # showList :: [UntagQueueResponse] -> ShowS # | |
Generic UntagQueueResponse Source # | |
Defined in Amazonka.SQS.UntagQueue type Rep UntagQueueResponse :: Type -> Type # from :: UntagQueueResponse -> Rep UntagQueueResponse x # to :: Rep UntagQueueResponse x -> UntagQueueResponse # | |
NFData UntagQueueResponse Source # | |
Defined in Amazonka.SQS.UntagQueue rnf :: UntagQueueResponse -> () # | |
type Rep UntagQueueResponse Source # | |
newUntagQueueResponse :: UntagQueueResponse Source #
Create a value of UntagQueueResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SendMessageBatch
data SendMessageBatch Source #
See: newSendMessageBatch
smart constructor.
Instances
Create a value of SendMessageBatch
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:queueUrl:SendMessageBatch'
, sendMessageBatch_queueUrl
- The URL of the Amazon SQS queue to which batched messages are sent.
Queue URLs and names are case-sensitive.
$sel:entries:SendMessageBatch'
, sendMessageBatch_entries
- A list of SendMessageBatchRequestEntry
items.
data SendMessageBatchResponse Source #
For each message in the batch, the response contains a
SendMessageBatchResultEntry
tag if the message succeeds or a
BatchResultErrorEntry
tag if the message fails.
See: newSendMessageBatchResponse
smart constructor.
Instances
newSendMessageBatchResponse Source #
Create a value of SendMessageBatchResponse
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:httpStatus:SendMessageBatchResponse'
, sendMessageBatchResponse_httpStatus
- The response's http status code.
$sel:successful:SendMessageBatchResponse'
, sendMessageBatchResponse_successful
- A list of SendMessageBatchResultEntry
items.
$sel:failed:SendMessageBatchResponse'
, sendMessageBatchResponse_failed
- A list of BatchResultErrorEntry
items with error details about each
message that can't be enqueued.
ChangeMessageVisibility
data ChangeMessageVisibility Source #
See: newChangeMessageVisibility
smart constructor.
Instances
newChangeMessageVisibility Source #
:: Text | |
-> Text | |
-> Int | |
-> ChangeMessageVisibility |
Create a value of ChangeMessageVisibility
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:queueUrl:ChangeMessageVisibility'
, changeMessageVisibility_queueUrl
- The URL of the Amazon SQS queue whose message's visibility is changed.
Queue URLs and names are case-sensitive.
$sel:receiptHandle:ChangeMessageVisibility'
, changeMessageVisibility_receiptHandle
- The receipt handle associated with the message whose visibility timeout
is changed. This parameter is returned by the ReceiveMessage
action.
$sel:visibilityTimeout:ChangeMessageVisibility'
, changeMessageVisibility_visibilityTimeout
- The new value for the message's visibility timeout (in seconds). Values
range: 0
to 43200
. Maximum: 12 hours.
data ChangeMessageVisibilityResponse Source #
See: newChangeMessageVisibilityResponse
smart constructor.
Instances
newChangeMessageVisibilityResponse :: ChangeMessageVisibilityResponse Source #
Create a value of ChangeMessageVisibilityResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
MessageAttribute
newtype MessageAttribute Source #
pattern MessageAttribute_All :: MessageAttribute | |
pattern MessageAttribute_ApproximateFirstReceiveTimestamp :: MessageAttribute | |
pattern MessageAttribute_ApproximateReceiveCount :: MessageAttribute | |
pattern MessageAttribute_SenderId :: MessageAttribute | |
pattern MessageAttribute_SentTimestamp :: MessageAttribute |
Instances
MessageSystemAttributeNameForSends
newtype MessageSystemAttributeNameForSends Source #
Instances
QueueAttributeName
newtype QueueAttributeName Source #
Instances
BatchResultErrorEntry
data BatchResultErrorEntry Source #
Gives a detailed description of the result of an action on each entry in the request.
See: newBatchResultErrorEntry
smart constructor.
Instances
newBatchResultErrorEntry Source #
:: Text | |
-> Bool | |
-> Text | |
-> BatchResultErrorEntry |
Create a value of BatchResultErrorEntry
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:message:BatchResultErrorEntry'
, batchResultErrorEntry_message
- A message explaining why the action failed on this entry.
$sel:id:BatchResultErrorEntry'
, batchResultErrorEntry_id
- The Id
of an entry in a batch request.
$sel:senderFault:BatchResultErrorEntry'
, batchResultErrorEntry_senderFault
- Specifies whether the error happened due to the caller of the batch API
action.
$sel:code:BatchResultErrorEntry'
, batchResultErrorEntry_code
- 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.
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=your_receipt_handle
&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
See: newChangeMessageVisibilityBatchRequestEntry
smart constructor.
Instances
newChangeMessageVisibilityBatchRequestEntry Source #
:: Text | |
-> Text |
|
-> ChangeMessageVisibilityBatchRequestEntry |
Create a value of ChangeMessageVisibilityBatchRequestEntry
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:visibilityTimeout:ChangeMessageVisibilityBatchRequestEntry'
, changeMessageVisibilityBatchRequestEntry_visibilityTimeout
- The new value (in seconds) for the message's visibility timeout.
$sel:id:ChangeMessageVisibilityBatchRequestEntry'
, changeMessageVisibilityBatchRequestEntry_id
- An identifier for this particular receipt handle used to communicate the
result.
The Id
s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
$sel:receiptHandle:ChangeMessageVisibilityBatchRequestEntry'
, changeMessageVisibilityBatchRequestEntry_receiptHandle
- A receipt handle.
ChangeMessageVisibilityBatchResultEntry
data ChangeMessageVisibilityBatchResultEntry Source #
Encloses the Id
of an entry in ChangeMessageVisibilityBatch.
See: newChangeMessageVisibilityBatchResultEntry
smart constructor.
Instances
Eq ChangeMessageVisibilityBatchResultEntry Source # | |
Read ChangeMessageVisibilityBatchResultEntry Source # | |
Show ChangeMessageVisibilityBatchResultEntry Source # | |
Generic ChangeMessageVisibilityBatchResultEntry Source # | |
NFData ChangeMessageVisibilityBatchResultEntry Source # | |
Hashable ChangeMessageVisibilityBatchResultEntry Source # | |
FromXML ChangeMessageVisibilityBatchResultEntry Source # | |
type Rep ChangeMessageVisibilityBatchResultEntry Source # | |
Defined in Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry type Rep ChangeMessageVisibilityBatchResultEntry = D1 ('MetaData "ChangeMessageVisibilityBatchResultEntry" "Amazonka.SQS.Types.ChangeMessageVisibilityBatchResultEntry" "libZSservicesZSamazonka-sqsZSamazonka-sqs" 'False) (C1 ('MetaCons "ChangeMessageVisibilityBatchResultEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newChangeMessageVisibilityBatchResultEntry Source #
Create a value of ChangeMessageVisibilityBatchResultEntry
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:id:ChangeMessageVisibilityBatchResultEntry'
, changeMessageVisibilityBatchResultEntry_id
- Represents a message whose visibility timeout has been changed
successfully.
DeleteMessageBatchRequestEntry
data DeleteMessageBatchRequestEntry Source #
Encloses a receipt handle and an identifier for it.
See: newDeleteMessageBatchRequestEntry
smart constructor.
Instances
newDeleteMessageBatchRequestEntry Source #
Create a value of DeleteMessageBatchRequestEntry
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:id:DeleteMessageBatchRequestEntry'
, deleteMessageBatchRequestEntry_id
- An identifier for this particular receipt handle. This is used to
communicate the result.
The Id
s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
$sel:receiptHandle:DeleteMessageBatchRequestEntry'
, deleteMessageBatchRequestEntry_receiptHandle
- A receipt handle.
DeleteMessageBatchResultEntry
data DeleteMessageBatchResultEntry Source #
Encloses the Id
of an entry in DeleteMessageBatch.
See: newDeleteMessageBatchResultEntry
smart constructor.
Instances
newDeleteMessageBatchResultEntry Source #
Create a value of DeleteMessageBatchResultEntry
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:id:DeleteMessageBatchResultEntry'
, deleteMessageBatchResultEntry_id
- Represents a successfully deleted message.
Message
An Amazon SQS message.
See: newMessage
smart constructor.
Message' (Maybe (HashMap Text MessageAttributeValue)) (Maybe Text) (Maybe Text) (Maybe (HashMap MessageAttribute Text)) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newMessage :: Message Source #
Create a value of Message
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:Message'
, message_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:mD5OfBody:Message'
, message_mD5OfBody
- An MD5 digest of the non-URL-encoded message body string.
$sel:body:Message'
, message_body
- The message's contents (not URL-encoded).
$sel:attributes:Message'
, message_attributes
- A map of the attributes requested in ReceiveMessage
to their
respective values. Supported attributes:
ApproximateReceiveCount
ApproximateFirstReceiveTimestamp
MessageDeduplicationId
MessageGroupId
SenderId
SentTimestamp
SequenceNumber
ApproximateFirstReceiveTimestamp
and SentTimestamp
are each returned
as an integer representing the
epoch time in milliseconds.
$sel:receiptHandle:Message'
, message_receiptHandle
- 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.
$sel:messageId:Message'
, message_messageId
- A unique identifier for the message. A MessageId
is considered unique
across all accounts for an extended period of time.
$sel:mD5OfMessageAttributes:Message'
, message_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.
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: newMessageAttributeValue
smart constructor.
Instances
newMessageAttributeValue Source #
Create a value of MessageAttributeValue
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:binaryValue:MessageAttributeValue'
, messageAttributeValue_binaryValue
- 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.
$sel:stringListValues:MessageAttributeValue'
, messageAttributeValue_stringListValues
- Not implemented. Reserved for future use.
$sel:stringValue:MessageAttributeValue'
, messageAttributeValue_stringValue
- Strings are Unicode with UTF-8 binary encoding. For a list of code
values, see
ASCII Printable Characters.
$sel:binaryListValues:MessageAttributeValue'
, messageAttributeValue_binaryListValues
- Not implemented. Reserved for future use.
$sel:dataType:MessageAttributeValue'
, messageAttributeValue_dataType
- 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 Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
MessageSystemAttributeValue
data MessageSystemAttributeValue Source #
The user-specified message system 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.
See: newMessageSystemAttributeValue
smart constructor.
Instances
newMessageSystemAttributeValue Source #
Create a value of MessageSystemAttributeValue
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:binaryValue:MessageSystemAttributeValue'
, messageSystemAttributeValue_binaryValue
- 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.
$sel:stringListValues:MessageSystemAttributeValue'
, messageSystemAttributeValue_stringListValues
- Not implemented. Reserved for future use.
$sel:stringValue:MessageSystemAttributeValue'
, messageSystemAttributeValue_stringValue
- Strings are Unicode with UTF-8 binary encoding. For a list of code
values, see
ASCII Printable Characters.
$sel:binaryListValues:MessageSystemAttributeValue'
, messageSystemAttributeValue_binaryListValues
- Not implemented. Reserved for future use.
$sel:dataType:MessageSystemAttributeValue'
, messageSystemAttributeValue_dataType
- 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 Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
SendMessageBatchRequestEntry
data SendMessageBatchRequestEntry Source #
Contains the details of a single Amazon SQS message along with an Id
.
See: newSendMessageBatchRequestEntry
smart constructor.
Instances
newSendMessageBatchRequestEntry Source #
:: Text | |
-> Text | |
-> SendMessageBatchRequestEntry |
Create a value of SendMessageBatchRequestEntry
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:SendMessageBatchRequestEntry'
, sendMessageBatchRequestEntry_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:SendMessageBatchRequestEntry'
, sendMessageBatchRequestEntry_delaySeconds
- 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.
When you set FifoQueue
, you can't set DelaySeconds
per message. You
can set this parameter only on a queue level.
$sel:messageSystemAttributes:SendMessageBatchRequestEntry'
, sendMessageBatchRequestEntry_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:SendMessageBatchRequestEntry'
, sendMessageBatchRequestEntry_messageDeduplicationId
- 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 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 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:SendMessageBatchRequestEntry'
, sendMessageBatchRequestEntry_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:id:SendMessageBatchRequestEntry'
, sendMessageBatchRequestEntry_id
- An identifier for a message in this batch used to communicate the
result.
The Id
s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
$sel:messageBody:SendMessageBatchRequestEntry'
, sendMessageBatchRequestEntry_messageBody
- The body of the message.
SendMessageBatchResultEntry
data SendMessageBatchResultEntry Source #
Encloses a MessageId
for a successfully-enqueued message in a
SendMessageBatch.
See: newSendMessageBatchResultEntry
smart constructor.
Instances
newSendMessageBatchResultEntry Source #
:: Text | |
-> Text | |
-> Text | |
-> SendMessageBatchResultEntry |
Create a value of SendMessageBatchResultEntry
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:SendMessageBatchResultEntry'
, sendMessageBatchResultEntry_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. As SequenceNumber
continues to increase for a particular MessageGroupId
.
$sel:mD5OfMessageSystemAttributes:SendMessageBatchResultEntry'
, sendMessageBatchResultEntry_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. For information about MD5, see
RFC1321.
$sel:mD5OfMessageAttributes:SendMessageBatchResultEntry'
, sendMessageBatchResultEntry_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:id:SendMessageBatchResultEntry'
, sendMessageBatchResultEntry_id
- An identifier for the message in this batch.
$sel:messageId:SendMessageBatchResultEntry'
, sendMessageBatchResultEntry_messageId
- An identifier for the message.
$sel:mD5OfMessageBody:SendMessageBatchResultEntry'
, sendMessageBatchResultEntry_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.