purge_queue

SQS.Client.purge_queue(**kwargs)

Deletes the messages in a queue specified by the QueueURL parameter.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.purge_queue(
    QueueUrl='string'
)

Parameters

QueueUrl (string) --

[REQUIRED]

The URL of the queue from which the PurgeQueue action deletes messages.

Queue URLs and names are case-sensitive.

Returns

None

Exceptions

• SQS.Client.exceptions.QueueDoesNotExist
• SQS.Client.exceptions.PurgeQueueInProgress