Amazon Web Services/PurgeQueue

Preview only · details below

Amazon Web ServicesAmazon SQS message-queue API

PurgeQueue

<p>Deletes available messages in a queue (including in-flight messages) specified by the <code>QueueURL</code> parameter.</p> <important> <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages deleted from a queue.</p> <p>The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size. </p> </important> <p>Messages sent to the queue <i>before</i> you call <code>PurgeQueue</code> might be received but are deleted within the next minute.</p> <p>Messages sent to the queue <i>after</i> you call <code>PurgeQueue</code> might be deleted while the queue is being purged.</p>

The complete 23-action Amazon Simple Queue Service API, preserving AWS JSON 1.0, AWS Query compatibility, SigV4, and regional endpoint rules. Hub provides documentation and a local SDK/CLI; it does not proxy queue calls.

Request

operationId
PurgeQueue
Server
https://sqs.{Region}.{PartitionResult#dnsSuffix}
Authentication
awsSigV4

Request parameters

No URL, query, or header parameters.

Request body

stringrequired

Responses

200

object

Successful response.

error

string

Declared service error

{}