Skip to content

SQS  >  Operations  >  purge_queue

purge_queue

Operation

purge_queue async 

purge_queue(input: PurgeQueueInput, plugins: list[Plugin] | None = None) -> PurgeQueueOutput

Deletes available messages in a queue (including in-flight messages) 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.

Parameters:

Name Type Description Default
input PurgeQueueInput

An instance of PurgeQueueInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
PurgeQueueOutput

An instance of PurgeQueueOutput.

Input

PurgeQueueInput dataclass

Attributes

queue_url class-attribute instance-attribute 
queue_url: str | None = None

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

Queue URLs and names are case-sensitive.

Output

PurgeQueueOutput dataclass

Dataclass for PurgeQueueOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.