AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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 and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginSetQueueAttributes and EndSetQueueAttributes.

Namespace: Amazon.SQS
Assembly: AWSSDK.SQS.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<SetQueueAttributesResponse> SetQueueAttributesAsync(
         SetQueueAttributesRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.SQS.Model.SetQueueAttributesRequest

Container for the necessary parameters to execute the SetQueueAttributes service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the SetQueueAttributes service method, as returned by SQS.

Exceptions

ExceptionCondition
InvalidAddressException The accountId is invalid.
InvalidAttributeNameException The specified attribute doesn't exist.
InvalidAttributeValueException A queue attribute value is invalid.
InvalidSecurityException When the request to a queue is not HTTPS and SigV4.
OverLimitException The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of in flight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.
QueueDoesNotExistException The specified queue doesn't exist.
RequestThrottledException The request was denied due to request throttling. The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region. A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key." Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
UnsupportedOperationException Error code 400. Unsupported operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also