import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { PurgeQueueRequest } from "../models/models_0"; import type { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PurgeQueueCommand}. */ export interface PurgeQueueCommandInput extends PurgeQueueRequest { } /** * @public * * The output of {@link PurgeQueueCommand}. */ export interface PurgeQueueCommandOutput extends __MetadataBearer { } declare const PurgeQueueCommand_base: { new (input: PurgeQueueCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: PurgeQueueCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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

* *

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

*

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SQSClient, PurgeQueueCommand } from "@aws-sdk/client-sqs"; // ES Modules import * // const { SQSClient, PurgeQueueCommand } = require("@aws-sdk/client-sqs"); // CommonJS import * // import type { SQSClientConfig } from "@aws-sdk/client-sqs"; * const config = {}; // type is SQSClientConfig * const client = new SQSClient(config); * const input = { // PurgeQueueRequest * QueueUrl: "STRING_VALUE", // required * }; * const command = new PurgeQueueCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param PurgeQueueCommandInput - {@link PurgeQueueCommandInput} * @returns {@link PurgeQueueCommandOutput} * @see {@link PurgeQueueCommandInput} for command's `input` shape. * @see {@link PurgeQueueCommandOutput} for command's `response` shape. * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link PurgeQueueInProgress} (client fault) *

Indicates that the specified queue previously received a PurgeQueue * request within the last 60 seconds (the time it can take to delete the messages in the * queue).

* * @throws {@link QueueDoesNotExist} (client fault) *

Ensure that the QueueUrl is correct and that the queue has not been * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

* * * @throws {@link UnsupportedOperation} (client fault) *

Error code 400. Unsupported operation.

* * @throws {@link SQSServiceException} *

Base exception class for all service exceptions from SQS service.

* * * @public */ export declare class PurgeQueueCommand extends PurgeQueueCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: PurgeQueueRequest; output: {}; }; sdk: { input: PurgeQueueCommandInput; output: PurgeQueueCommandOutput; }; }; }