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 the messages in a queue 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(
         PurgeQueueRequest request
)
Parameters
request
Type: Amazon.SQS.Model.PurgeQueueRequest

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

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

Exceptions

ExceptionCondition
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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also