amazonka-sqs-1.4.5: Amazon Simple Queue Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SQS.SetQueueAttributes

Contents

Description

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.

Synopsis

Creating a Request

setQueueAttributes Source #

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 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.

data SetQueueAttributes Source #

See: setQueueAttributes smart constructor.

Instances

Eq SetQueueAttributes Source # 
Data SetQueueAttributes Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetQueueAttributes -> c SetQueueAttributes #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetQueueAttributes #

toConstr :: SetQueueAttributes -> Constr #

dataTypeOf :: SetQueueAttributes -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SetQueueAttributes) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetQueueAttributes) #

gmapT :: (forall b. Data b => b -> b) -> SetQueueAttributes -> SetQueueAttributes #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetQueueAttributes -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetQueueAttributes -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetQueueAttributes -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetQueueAttributes -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetQueueAttributes -> m SetQueueAttributes #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetQueueAttributes -> m SetQueueAttributes #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetQueueAttributes -> m SetQueueAttributes #

Read SetQueueAttributes Source # 
Show SetQueueAttributes Source # 
Generic SetQueueAttributes Source # 
Hashable SetQueueAttributes Source # 
NFData SetQueueAttributes Source # 

Methods

rnf :: SetQueueAttributes -> () #

AWSRequest SetQueueAttributes Source # 
ToPath SetQueueAttributes Source # 
ToHeaders SetQueueAttributes Source # 
ToQuery SetQueueAttributes Source # 
type Rep SetQueueAttributes Source # 
type Rep SetQueueAttributes = D1 (MetaData "SetQueueAttributes" "Network.AWS.SQS.SetQueueAttributes" "amazonka-sqs-1.4.5-4rQHB5Mk9mo8cQvbOgAp4I" False) (C1 (MetaCons "SetQueueAttributes'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_sqaQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_sqaAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map QueueAttributeName Text)))))
type Rs SetQueueAttributes Source # 

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.

Instances

Eq SetQueueAttributesResponse Source # 
Data SetQueueAttributesResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetQueueAttributesResponse -> c SetQueueAttributesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetQueueAttributesResponse #

toConstr :: SetQueueAttributesResponse -> Constr #

dataTypeOf :: SetQueueAttributesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SetQueueAttributesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetQueueAttributesResponse) #

gmapT :: (forall b. Data b => b -> b) -> SetQueueAttributesResponse -> SetQueueAttributesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetQueueAttributesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetQueueAttributesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetQueueAttributesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetQueueAttributesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetQueueAttributesResponse -> m SetQueueAttributesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetQueueAttributesResponse -> m SetQueueAttributesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetQueueAttributesResponse -> m SetQueueAttributesResponse #

Read SetQueueAttributesResponse Source # 
Show SetQueueAttributesResponse Source # 
Generic SetQueueAttributesResponse Source # 
NFData SetQueueAttributesResponse Source # 
type Rep SetQueueAttributesResponse Source # 
type Rep SetQueueAttributesResponse = D1 (MetaData "SetQueueAttributesResponse" "Network.AWS.SQS.SetQueueAttributes" "amazonka-sqs-1.4.5-4rQHB5Mk9mo8cQvbOgAp4I" False) (C1 (MetaCons "SetQueueAttributesResponse'" PrefixI False) U1)