Purge an SQS queue

PUT 
/queues/:queue_name

Purges all messages when CanPurge is true. Requires system-settings.manage. action=purge is required. Not idempotent while a purge is already running.

Request

Responses

200

Queue was purged. Message is "{DisplayName} ({queue_name}) purged successfully".

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

400

Validation or authorization failure. Body is {"Message": " - "} except the router case below. Codes: AUTH-1001, AUTH-1003, AUTH-1030 (missing system-settings.manage), IPV-1002 (role_id). Unknown name, CanPurge false, and purge already in progress are wrapped as GE-1052. Missing or non-purge action (if it reaches Lambda) is {"Message": "Invalid query parameter. Use ?action=purge"} with no code. GenericFailure is HTTP 400. There is no 403, 404, or 409.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

500

Uncaught errors outside this PUT use {"Message": "RTE-1001 - ."}.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers