Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the MessageRetentionPeriod
attribute can take up to 15 minutes.
Creating a Request
Creates a value of SetQueueAttributes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sqaQueueURL
- The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.sqaAttributes
- A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that theSetQueueAttributes
action uses: *DelaySeconds
- The number of seconds for which the delivery of all messages in the queue is delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero). *MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB). *MessageRetentionPeriod
- The number of seconds for which Amazon SQS retains a message. An integer representing seconds, from 60 (1 minute) to 120,9600 (14 days). The default is 345,600 (4 days). *Policy
- The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide . *ReceiveMessageWaitTimeSeconds
- The number of seconds for which aReceiveMessage
action will wait for a message to arrive. An integer from 0 to 20 (seconds). The default is 0. *RedrivePolicy
- The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide . *VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide . 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 . * Every message must have a uniqueMessageDeduplicationId
, * You may provide aMessageDeduplicationId
explicitly. * If you aren't able to provide aMessageDeduplicationId
and you enableContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate theMessageDeduplicationId
using the body of the message (but not the attributes of the message). * If you don't provide aMessageDeduplicationId
and the queue doesn't haveContentBasedDeduplication
set, the action fails with an error. * If the queue hasContentBasedDeduplication
set, yourMessageDeduplicationId
overrides the generated one. * WhenContentBasedDeduplication
is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. * You can also useContentBasedDeduplication
for messages with identical content to be treated as duplicates. * If you send one message withContentBasedDeduplication
enabled and then another message with aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters that are specified (such asApproximateNumberOfMessages
,ApproximateNumberOfMessagesDelayed
,ApproximateNumberOfMessagesNotVisible
,CreatedTimestamp
,LastModifiedTimestamp
, andQueueArn
) will be ignored.
data SetQueueAttributes Source #
See: setQueueAttributes
smart constructor.
Request Lenses
sqaQueueURL :: Lens' SetQueueAttributes Text Source #
The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.
sqaAttributes :: Lens' SetQueueAttributes (HashMap QueueAttributeName Text) Source #
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 number of seconds for which the delivery of all messages in the queue is delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero). * MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB). * MessageRetentionPeriod
- The number of seconds for which Amazon SQS retains a message. An integer representing seconds, from 60 (1 minute) to 120,9600 (14 days). The default is 345,600 (4 days). * Policy
- The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide . * ReceiveMessageWaitTimeSeconds
- The number of seconds for which a ReceiveMessage
action will wait for a message to arrive. An integer from 0 to 20 (seconds). The default is 0. * RedrivePolicy
- The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide . * VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide . 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 . * Every message must have a unique MessageDeduplicationId
, * You may provide a MessageDeduplicationId
explicitly. * If you aren't able to provide a MessageDeduplicationId
and you enable ContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message). * If you don't provide a MessageDeduplicationId
and the queue doesn't have ContentBasedDeduplication
set, the action fails with an error. * If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides the generated one. * When ContentBasedDeduplication
is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. * You can also use ContentBasedDeduplication
for messages with identical content to be treated as duplicates. * If you send one message with ContentBasedDeduplication
enabled and then another message with a MessageDeduplicationId
that is the same as the one generated for the first MessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages
, ApproximateNumberOfMessagesDelayed
, ApproximateNumberOfMessagesNotVisible
, CreatedTimestamp
, LastModifiedTimestamp
, and QueueArn
) will be ignored.
Destructuring the Response
setQueueAttributesResponse :: SetQueueAttributesResponse Source #
Creates a value of SetQueueAttributesResponse
with the minimum fields required to make a request.
data SetQueueAttributesResponse Source #
See: setQueueAttributesResponse
smart constructor.