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.

Deletes available messages in a queue (including in-flight messages) specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.

The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.

Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute.

Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to PurgeQueueAsync.

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

Syntax

C#
public virtual PurgeQueueResponse PurgeQueue(
         String queueUrl
)

Parameters

queueUrl
Type: System.String

The URL of the queue from which the PurgeQueue action deletes messages. Queue URLs and names are case-sensitive.

Return Value


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

Exceptions

ExceptionCondition
InvalidAddressException The accountId is invalid.
InvalidSecurityException When the request to a queue is not HTTPS and SigV4.
PurgeQueueInProgressException Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).
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 Framework:
Supported in: 4.5, 4.0, 3.5

See Also