Skip to content

PurgeQueue

Source: src/AWS/SQS/PurgeQueue.ts

Runtime binding for sqs:PurgeQueue.

Bind this operation to a Queue inside a function runtime to delete every message in the queue in one call. The purge takes up to 60 seconds to complete, and only one purge per queue is allowed every 60 seconds (a second call fails with the typed PurgeQueueInProgress error). The binding grants the host function sqs:PurgeQueue on the queue. Provide the PurgeQueueHttp layer on the Function to implement the binding.

Purging a Queue

Section titled “Purging a Queue”
// init (provide SQS.PurgeQueueHttp on the Function)
const purgeQueue = yield* SQS.PurgeQueue(queue);


// runtime: drop everything currently in the queue
yield* purgeQueue();