Skip to content

Purge Queue

sqs_purge_queue R Documentation

Deletes available messages in a queue (including in-flight messages) specified by the QueueURL parameter

Description

Deletes available messages in a queue (including in-flight messages) specified by the QueueURL parameter.

When you use the purge_queue 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 purge_queue might be received but are deleted within the next minute.

Messages sent to the queue after you call purge_queue might be deleted while the queue is being purged.

Usage

sqs_purge_queue(QueueUrl)

Arguments

QueueUrl

[required] The URL of the queue from which the purge_queue action deletes messages.

Queue URLs and names are case-sensitive.

Value

An empty list.

Request syntax

svc$purge_queue(
  QueueUrl = "string"
)