Class PurgeQueueCommandProtected

Deletes all the messages in a queue.

Example

Use a bare-bones client and the command you need to make an API call.

import { QueuesClient, PurgeQueueCommand } from "@stedi/sdk-client-queues"; // ES Modules import
// const { QueuesClient, PurgeQueueCommand } = require("@stedi/sdk-client-queues"); // CommonJS import
const client = new QueuesClient(config);
const input = { // PurgeQueueInput
  queueUrl: "STRING_VALUE", // required
};
const command = new PurgeQueueCommand(input);
const response = await client.send(command);
// {};

Param

PurgeQueueCommandInput

Returns

PurgeQueueCommandOutput

See

• PurgeQueueCommandInput for command's input shape.
• PurgeQueueCommandOutput for command's response shape.
• config for QueuesClient's config shape.

Throws

AccessDeniedException (client fault)

Throws

ProductUnavailableException (client fault)

Throws

ResourceAlreadyExistsException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ResourceUnderChangeException (client fault)

Throws

ServiceException (server fault)

Throws

QueuesServiceException

Base exception class for all service exceptions from Queues service.