Amazonka.SQS.SetQueueAttributes

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 Grant cross-account permissions to a role and a user name 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.

Creating a Request

data SetQueueAttributes

See: newSetQueueAttributes smart constructor.

Constructors

SetQueueAttributes'

Fields

• queueUrl :: Text

  The URL of the Amazon SQS queue whose attributes are set.

  Queue URLs and names are case-sensitive.

• attributes :: HashMap QueueAttributeName 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 Overview of Amazon Web Services IAM Policies 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 Using Amazon SQS Dead-Letter Queues 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 Visibility Timeout in the Amazon SQS Developer Guide.

  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 always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/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?.
  • SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

  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 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 high throughput for FIFO queues:

  • 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 Quotas related to messages in the Amazon SQS Developer Guide.

Instances

ToHeaders SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Methods

toHeaders :: SetQueueAttributes -> [Header]

ToPath SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Methods

toPath :: SetQueueAttributes -> ByteString

ToQuery SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Methods

toQuery :: SetQueueAttributes -> QueryString

AWSRequest SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Associated Types

type AWSResponse SetQueueAttributes

Methods

request :: (Service -> Service) -> SetQueueAttributes -> Request SetQueueAttributes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetQueueAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetQueueAttributes)))

Generic SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Associated Types

type Rep SetQueueAttributes :: Type -> Type

Methods

from :: SetQueueAttributes -> Rep SetQueueAttributes x

to :: Rep SetQueueAttributes x -> SetQueueAttributes

Read SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Methods

readsPrec :: Int -> ReadS SetQueueAttributes

readList :: ReadS [SetQueueAttributes]

readPrec :: ReadPrec SetQueueAttributes

readListPrec :: ReadPrec [SetQueueAttributes]

Show SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Methods

showsPrec :: Int -> SetQueueAttributes -> ShowS

show :: SetQueueAttributes -> String

showList :: [SetQueueAttributes] -> ShowS

NFData SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Methods

rnf :: SetQueueAttributes -> ()

Eq SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Methods

(==) :: SetQueueAttributes -> SetQueueAttributes -> Bool

(/=) :: SetQueueAttributes -> SetQueueAttributes -> Bool

Hashable SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

Methods

hashWithSalt :: Int -> SetQueueAttributes -> Int

hash :: SetQueueAttributes -> Int

type AWSResponse SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

type AWSResponse SetQueueAttributes = SetQueueAttributesResponse

type Rep SetQueueAttributes

Defined in Amazonka.SQS.SetQueueAttributes

type Rep SetQueueAttributes = D1 ('MetaData "SetQueueAttributes" "Amazonka.SQS.SetQueueAttributes" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "SetQueueAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap QueueAttributeName Text))))

newSetQueueAttributes

Arguments

:: Text

$sel:queueUrl:SetQueueAttributes'

-> SetQueueAttributes

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.

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 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 Using Amazon SQS Dead-Letter Queues 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 Visibility Timeout in the Amazon SQS Developer Guide.

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 always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/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?.
• SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

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 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 high throughput for FIFO queues:

• 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 Quotas related to messages in the Amazon SQS Developer Guide.

Request Lenses

setQueueAttributes_queueUrl :: Lens' SetQueueAttributes Text

The URL of the Amazon SQS queue whose attributes are set.

Queue URLs and names are case-sensitive.

setQueueAttributes_attributes :: Lens' SetQueueAttributes (HashMap QueueAttributeName 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 Overview of Amazon Web Services IAM Policies 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 Using Amazon SQS Dead-Letter Queues 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 Visibility Timeout in the Amazon SQS Developer Guide.

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 always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/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?.
• SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

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 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 high throughput for FIFO queues:

• 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 Quotas related to messages in the Amazon SQS Developer Guide.

Destructuring the Response

data SetQueueAttributesResponse

See: newSetQueueAttributesResponse smart constructor.

Constructors

SetQueueAttributesResponse'

Instances

Generic SetQueueAttributesResponse

Defined in Amazonka.SQS.SetQueueAttributes

Associated Types

type Rep SetQueueAttributesResponse :: Type -> Type

Methods

from :: SetQueueAttributesResponse -> Rep SetQueueAttributesResponse x

to :: Rep SetQueueAttributesResponse x -> SetQueueAttributesResponse

Read SetQueueAttributesResponse

Defined in Amazonka.SQS.SetQueueAttributes

Methods

readsPrec :: Int -> ReadS SetQueueAttributesResponse

readList :: ReadS [SetQueueAttributesResponse]

readPrec :: ReadPrec SetQueueAttributesResponse

readListPrec :: ReadPrec [SetQueueAttributesResponse]

Show SetQueueAttributesResponse

Defined in Amazonka.SQS.SetQueueAttributes

Methods

showsPrec :: Int -> SetQueueAttributesResponse -> ShowS

show :: SetQueueAttributesResponse -> String

showList :: [SetQueueAttributesResponse] -> ShowS

NFData SetQueueAttributesResponse

Defined in Amazonka.SQS.SetQueueAttributes

Methods

rnf :: SetQueueAttributesResponse -> ()

Eq SetQueueAttributesResponse

Defined in Amazonka.SQS.SetQueueAttributes

Methods

(==) :: SetQueueAttributesResponse -> SetQueueAttributesResponse -> Bool

(/=) :: SetQueueAttributesResponse -> SetQueueAttributesResponse -> Bool

type Rep SetQueueAttributesResponse

Defined in Amazonka.SQS.SetQueueAttributes

type Rep SetQueueAttributesResponse = D1 ('MetaData "SetQueueAttributesResponse" "Amazonka.SQS.SetQueueAttributes" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "SetQueueAttributesResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetQueueAttributesResponse :: SetQueueAttributesResponse

Create a value of SetQueueAttributesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.