{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.SQS.SetQueueAttributes -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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. -- -- - 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. -- -- - Cross-account permissions don\'t apply to this action. For more -- information, see -- -- in the /Amazon SQS Developer Guide/. -- -- - To remove the ability to change queue permissions, you must deny -- permission to the @AddPermission@, @RemovePermission@, and -- @SetQueueAttributes@ actions in your IAM policy. module Amazonka.SQS.SetQueueAttributes ( -- * Creating a Request SetQueueAttributes (..), newSetQueueAttributes, -- * Request Lenses setQueueAttributes_queueUrl, setQueueAttributes_attributes, -- * Destructuring the Response SetQueueAttributesResponse (..), newSetQueueAttributesResponse, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response import Amazonka.SQS.Types -- | -- -- /See:/ 'newSetQueueAttributes' smart constructor. data SetQueueAttributes = SetQueueAttributes' { -- | The URL of the Amazon SQS queue whose attributes are set. -- -- Queue URLs and names are case-sensitive. queueUrl :: Prelude.Text, -- | 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 -- -- in the /Identity and Access Management 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). Default: 0. -- -- - @RedrivePolicy@ – The string that includes the parameters for the -- dead-letter queue functionality of the source queue as a JSON -- object. For more information about the redrive policy and -- dead-letter queues, see -- -- in the /Amazon SQS 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. -- When the @ReceiveCount@ for a message exceeds the -- @maxReceiveCount@ for a queue, Amazon SQS moves the message to -- the dead-letter-queue. -- -- 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. -- -- - @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 -- -- in the /Amazon SQS Developer Guide/. -- -- The following attributes apply only to -- : -- -- - @KmsMasterKeyId@ – The ID of an Amazon Web Services managed customer -- master key (CMK) for Amazon SQS or a custom CMK. For more -- information, see -- . -- While the alias of the AWS-managed CMK for Amazon SQS is always -- @alias\/aws\/sqs@, the alias of a custom CMK can, for example, be -- @alias\/@/@MyAlias@/@ @. For more examples, see -- -- in the /Key Management Service API Reference/. -- -- - @KmsDataKeyReusePeriodSeconds@ – The length of time, in seconds, for -- which Amazon SQS can reuse a -- -- 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 -- . -- -- - @SqsManagedSseEnabled@ – Enables server-side queue encryption using -- SQS owned encryption keys. Only one server-side encryption option is -- supported per queue (e.g. -- -- or -- ). -- -- The following attribute applies only to -- : -- -- - @ContentBasedDeduplication@ – Enables content-based deduplication. -- For more information, see -- -- 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 enable @ContentBasedDeduplication@ for your queue, -- Amazon SQS uses a SHA-256 hash to generate the -- @MessageDeduplicationId@ using the body of the message (but -- not the attributes of the message). -- -- - If you don\'t provide a @MessageDeduplicationId@ and the -- queue doesn\'t have @ContentBasedDeduplication@ set, the -- action fails with an error. -- -- - If the queue has @ContentBasedDeduplication@ set, your -- @MessageDeduplicationId@ overrides the generated one. -- -- - When @ContentBasedDeduplication@ is in effect, messages with -- identical content sent within the deduplication interval are -- treated as duplicates and only one copy of the message is -- delivered. -- -- - If you send one message with @ContentBasedDeduplication@ enabled -- and then another message with a @MessageDeduplicationId@ that is -- the same as the one generated for the first -- @MessageDeduplicationId@, the two messages are treated as -- duplicates and only one copy of the message is delivered. -- -- The following attributes apply only to -- : -- -- - @DeduplicationScope@ – Specifies whether message deduplication -- occurs at the message group or queue level. Valid values are -- @messageGroup@ and @queue@. -- -- - @FifoThroughputLimit@ – Specifies whether the FIFO queue throughput -- quota applies to the entire queue or per message group. Valid values -- are @perQueue@ and @perMessageGroupId@. The @perMessageGroupId@ -- value is allowed only when the value for @DeduplicationScope@ is -- @messageGroup@. -- -- To enable high throughput for FIFO queues, do the following: -- -- - Set @DeduplicationScope@ to @messageGroup@. -- -- - Set @FifoThroughputLimit@ to @perMessageGroupId@. -- -- 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 -- -- in the /Amazon SQS Developer Guide/. attributes :: Prelude.HashMap QueueAttributeName Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'SetQueueAttributes' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'queueUrl', 'setQueueAttributes_queueUrl' - The URL of the Amazon SQS queue whose attributes are set. -- -- Queue URLs and names are case-sensitive. -- -- 'attributes', '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 -- -- in the /Identity and Access Management 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). Default: 0. -- -- - @RedrivePolicy@ – The string that includes the parameters for the -- dead-letter queue functionality of the source queue as a JSON -- object. For more information about the redrive policy and -- dead-letter queues, see -- -- in the /Amazon SQS 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. -- When the @ReceiveCount@ for a message exceeds the -- @maxReceiveCount@ for a queue, Amazon SQS moves the message to -- the dead-letter-queue. -- -- 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. -- -- - @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 -- -- in the /Amazon SQS Developer Guide/. -- -- The following attributes apply only to -- : -- -- - @KmsMasterKeyId@ – The ID of an Amazon Web Services managed customer -- master key (CMK) for Amazon SQS or a custom CMK. For more -- information, see -- . -- While the alias of the AWS-managed CMK for Amazon SQS is always -- @alias\/aws\/sqs@, the alias of a custom CMK can, for example, be -- @alias\/@/@MyAlias@/@ @. For more examples, see -- -- in the /Key Management Service API Reference/. -- -- - @KmsDataKeyReusePeriodSeconds@ – The length of time, in seconds, for -- which Amazon SQS can reuse a -- -- 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 -- . -- -- - @SqsManagedSseEnabled@ – Enables server-side queue encryption using -- SQS owned encryption keys. Only one server-side encryption option is -- supported per queue (e.g. -- -- or -- ). -- -- The following attribute applies only to -- : -- -- - @ContentBasedDeduplication@ – Enables content-based deduplication. -- For more information, see -- -- 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 enable @ContentBasedDeduplication@ for your queue, -- Amazon SQS uses a SHA-256 hash to generate the -- @MessageDeduplicationId@ using the body of the message (but -- not the attributes of the message). -- -- - If you don\'t provide a @MessageDeduplicationId@ and the -- queue doesn\'t have @ContentBasedDeduplication@ set, the -- action fails with an error. -- -- - If the queue has @ContentBasedDeduplication@ set, your -- @MessageDeduplicationId@ overrides the generated one. -- -- - When @ContentBasedDeduplication@ is in effect, messages with -- identical content sent within the deduplication interval are -- treated as duplicates and only one copy of the message is -- delivered. -- -- - If you send one message with @ContentBasedDeduplication@ enabled -- and then another message with a @MessageDeduplicationId@ that is -- the same as the one generated for the first -- @MessageDeduplicationId@, the two messages are treated as -- duplicates and only one copy of the message is delivered. -- -- The following attributes apply only to -- : -- -- - @DeduplicationScope@ – Specifies whether message deduplication -- occurs at the message group or queue level. Valid values are -- @messageGroup@ and @queue@. -- -- - @FifoThroughputLimit@ – Specifies whether the FIFO queue throughput -- quota applies to the entire queue or per message group. Valid values -- are @perQueue@ and @perMessageGroupId@. The @perMessageGroupId@ -- value is allowed only when the value for @DeduplicationScope@ is -- @messageGroup@. -- -- To enable high throughput for FIFO queues, do the following: -- -- - Set @DeduplicationScope@ to @messageGroup@. -- -- - Set @FifoThroughputLimit@ to @perMessageGroupId@. -- -- 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 -- -- in the /Amazon SQS Developer Guide/. newSetQueueAttributes :: -- | 'queueUrl' Prelude.Text -> SetQueueAttributes newSetQueueAttributes pQueueUrl_ = SetQueueAttributes' { queueUrl = pQueueUrl_, attributes = Prelude.mempty } -- | The URL of the Amazon SQS queue whose attributes are set. -- -- Queue URLs and names are case-sensitive. setQueueAttributes_queueUrl :: Lens.Lens' SetQueueAttributes Prelude.Text setQueueAttributes_queueUrl = Lens.lens (\SetQueueAttributes' {queueUrl} -> queueUrl) (\s@SetQueueAttributes' {} a -> s {queueUrl = a} :: SetQueueAttributes) -- | 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 -- -- in the /Identity and Access Management 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). Default: 0. -- -- - @RedrivePolicy@ – The string that includes the parameters for the -- dead-letter queue functionality of the source queue as a JSON -- object. For more information about the redrive policy and -- dead-letter queues, see -- -- in the /Amazon SQS 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. -- When the @ReceiveCount@ for a message exceeds the -- @maxReceiveCount@ for a queue, Amazon SQS moves the message to -- the dead-letter-queue. -- -- 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. -- -- - @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 -- -- in the /Amazon SQS Developer Guide/. -- -- The following attributes apply only to -- : -- -- - @KmsMasterKeyId@ – The ID of an Amazon Web Services managed customer -- master key (CMK) for Amazon SQS or a custom CMK. For more -- information, see -- . -- While the alias of the AWS-managed CMK for Amazon SQS is always -- @alias\/aws\/sqs@, the alias of a custom CMK can, for example, be -- @alias\/@/@MyAlias@/@ @. For more examples, see -- -- in the /Key Management Service API Reference/. -- -- - @KmsDataKeyReusePeriodSeconds@ – The length of time, in seconds, for -- which Amazon SQS can reuse a -- -- 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 -- . -- -- - @SqsManagedSseEnabled@ – Enables server-side queue encryption using -- SQS owned encryption keys. Only one server-side encryption option is -- supported per queue (e.g. -- -- or -- ). -- -- The following attribute applies only to -- : -- -- - @ContentBasedDeduplication@ – Enables content-based deduplication. -- For more information, see -- -- 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 enable @ContentBasedDeduplication@ for your queue, -- Amazon SQS uses a SHA-256 hash to generate the -- @MessageDeduplicationId@ using the body of the message (but -- not the attributes of the message). -- -- - If you don\'t provide a @MessageDeduplicationId@ and the -- queue doesn\'t have @ContentBasedDeduplication@ set, the -- action fails with an error. -- -- - If the queue has @ContentBasedDeduplication@ set, your -- @MessageDeduplicationId@ overrides the generated one. -- -- - When @ContentBasedDeduplication@ is in effect, messages with -- identical content sent within the deduplication interval are -- treated as duplicates and only one copy of the message is -- delivered. -- -- - If you send one message with @ContentBasedDeduplication@ enabled -- and then another message with a @MessageDeduplicationId@ that is -- the same as the one generated for the first -- @MessageDeduplicationId@, the two messages are treated as -- duplicates and only one copy of the message is delivered. -- -- The following attributes apply only to -- : -- -- - @DeduplicationScope@ – Specifies whether message deduplication -- occurs at the message group or queue level. Valid values are -- @messageGroup@ and @queue@. -- -- - @FifoThroughputLimit@ – Specifies whether the FIFO queue throughput -- quota applies to the entire queue or per message group. Valid values -- are @perQueue@ and @perMessageGroupId@. The @perMessageGroupId@ -- value is allowed only when the value for @DeduplicationScope@ is -- @messageGroup@. -- -- To enable high throughput for FIFO queues, do the following: -- -- - Set @DeduplicationScope@ to @messageGroup@. -- -- - Set @FifoThroughputLimit@ to @perMessageGroupId@. -- -- 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 -- -- in the /Amazon SQS Developer Guide/. setQueueAttributes_attributes :: Lens.Lens' SetQueueAttributes (Prelude.HashMap QueueAttributeName Prelude.Text) setQueueAttributes_attributes = Lens.lens (\SetQueueAttributes' {attributes} -> attributes) (\s@SetQueueAttributes' {} a -> s {attributes = a} :: SetQueueAttributes) Prelude.. Lens.coerced instance Core.AWSRequest SetQueueAttributes where type AWSResponse SetQueueAttributes = SetQueueAttributesResponse request overrides = Request.postQuery (overrides defaultService) response = Response.receiveNull SetQueueAttributesResponse' instance Prelude.Hashable SetQueueAttributes where hashWithSalt _salt SetQueueAttributes' {..} = _salt `Prelude.hashWithSalt` queueUrl `Prelude.hashWithSalt` attributes instance Prelude.NFData SetQueueAttributes where rnf SetQueueAttributes' {..} = Prelude.rnf queueUrl `Prelude.seq` Prelude.rnf attributes instance Data.ToHeaders SetQueueAttributes where toHeaders = Prelude.const Prelude.mempty instance Data.ToPath SetQueueAttributes where toPath = Prelude.const "/" instance Data.ToQuery SetQueueAttributes where toQuery SetQueueAttributes' {..} = Prelude.mconcat [ "Action" Data.=: ("SetQueueAttributes" :: Prelude.ByteString), "Version" Data.=: ("2012-11-05" :: Prelude.ByteString), "QueueUrl" Data.=: queueUrl, Data.toQueryMap "Attribute" "Name" "Value" attributes ] -- | /See:/ 'newSetQueueAttributesResponse' smart constructor. data SetQueueAttributesResponse = SetQueueAttributesResponse' { } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'SetQueueAttributesResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. newSetQueueAttributesResponse :: SetQueueAttributesResponse newSetQueueAttributesResponse = SetQueueAttributesResponse' instance Prelude.NFData SetQueueAttributesResponse where rnf _ = ()