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

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@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 Amazon 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 whose attributes are set. 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 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). The default is 0 (zero). * 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). The default is 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). 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 length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). The default is 0. * RedrivePolicy - The string that includes 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 Simple Queue Service Developer Guide . * deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. * maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. * VisibilityTimeout - The visibility timeout for the queue. Valid values: an integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide . The following attributes apply only to server-side-encryption : * KmsMasterKeyId - The ID of an AWS-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 always aliasawssqs , the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS 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 AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 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 Simple Queue Service Developer Guide . * Every message must have a unique MessageDeduplicationId , * You may provide a MessageDeduplicationId explicitly. * If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). * If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. * If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. * When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. * If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId , the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters (such as the following) are ignored: * ApproximateNumberOfMessages * ApproximateNumberOfMessagesDelayed * ApproximateNumberOfMessagesNotVisible * CreatedTimestamp * LastModifiedTimestamp * QueueArn

data SetQueueAttributes Source #

See: setQueueAttributes smart constructor.

Instances
Eq SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Data SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

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 # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Show SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Generic SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Associated Types

type Rep SetQueueAttributes :: Type -> Type #

Hashable SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

AWSRequest SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Associated Types

type Rs SetQueueAttributes :: Type #

ToHeaders SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

ToPath SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

ToQuery SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

NFData SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Methods

rnf :: SetQueueAttributes -> () #

type Rep SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

type Rep SetQueueAttributes = D1 (MetaData "SetQueueAttributes" "Network.AWS.SQS.SetQueueAttributes" "amazonka-sqs-1.6.1-4KwGv5jRSGR2noZdqwtyOA" False) (C1 (MetaCons "SetQueueAttributes'" PrefixI True) (S1 (MetaSel (Just "_sqaQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sqaAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map QueueAttributeName Text))))
type Rs SetQueueAttributes Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Request Lenses

sqaQueueURL :: Lens' SetQueueAttributes Text Source #

The URL of the Amazon SQS queue whose attributes are set. 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 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). The default is 0 (zero). * 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). The default is 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). 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 length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). The default is 0. * RedrivePolicy - The string that includes 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 Simple Queue Service Developer Guide . * deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. * maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. * VisibilityTimeout - The visibility timeout for the queue. Valid values: an integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide . The following attributes apply only to server-side-encryption : * KmsMasterKeyId - The ID of an AWS-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 always aliasawssqs , the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS 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 AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 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 Simple Queue Service Developer Guide . * Every message must have a unique MessageDeduplicationId , * You may provide a MessageDeduplicationId explicitly. * If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). * If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. * If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. * When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. * If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId , the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters (such as the following) are ignored: * ApproximateNumberOfMessages * ApproximateNumberOfMessagesDelayed * ApproximateNumberOfMessagesNotVisible * CreatedTimestamp * LastModifiedTimestamp * QueueArn

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 # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Data SetQueueAttributesResponse Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

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 # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Show SetQueueAttributesResponse Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Generic SetQueueAttributesResponse Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

Associated Types

type Rep SetQueueAttributesResponse :: Type -> Type #

NFData SetQueueAttributesResponse Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

type Rep SetQueueAttributesResponse Source # 
Instance details

Defined in Network.AWS.SQS.SetQueueAttributes

type Rep SetQueueAttributesResponse = D1 (MetaData "SetQueueAttributesResponse" "Network.AWS.SQS.SetQueueAttributes" "amazonka-sqs-1.6.1-4KwGv5jRSGR2noZdqwtyOA" False) (C1 (MetaCons "SetQueueAttributesResponse'" PrefixI False) (U1 :: Type -> Type))