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

Deletes up to ten messages from the specified queue. This is a batch version of * * DeleteMessage. The result of the action on each * message is reported individually in the response.

* *

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SQSClient, DeleteMessageBatchCommand } from "@aws-sdk/client-sqs"; // ES Modules import * // const { SQSClient, DeleteMessageBatchCommand } = 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 = { // DeleteMessageBatchRequest * QueueUrl: "STRING_VALUE", // required * Entries: [ // DeleteMessageBatchRequestEntryList // required * { // DeleteMessageBatchRequestEntry * Id: "STRING_VALUE", // required * ReceiptHandle: "STRING_VALUE", // required * }, * ], * }; * const command = new DeleteMessageBatchCommand(input); * const response = await client.send(command); * // { // DeleteMessageBatchResult * // Successful: [ // DeleteMessageBatchResultEntryList // required * // { // DeleteMessageBatchResultEntry * // Id: "STRING_VALUE", // required * // }, * // ], * // Failed: [ // BatchResultErrorEntryList // required * // { // BatchResultErrorEntry * // Id: "STRING_VALUE", // required * // SenderFault: true || false, // required * // Code: "STRING_VALUE", // required * // Message: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param DeleteMessageBatchCommandInput - {@link DeleteMessageBatchCommandInput} * @returns {@link DeleteMessageBatchCommandOutput} * @see {@link DeleteMessageBatchCommandInput} for command's `input` shape. * @see {@link DeleteMessageBatchCommandOutput} for command's `response` shape. * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link BatchEntryIdsNotDistinct} (client fault) *

Two or more batch entries in the request have the same Id.

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

The batch request doesn't contain any entries.

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

The specified ID is invalid.

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

The Id of a batch entry in a batch request doesn't abide by the * specification.

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

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

* * @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 TooManyEntriesInBatchRequest} (client fault) *

The batch request contains more entries than permissible. For Amazon SQS, the * maximum number of entries you can include in a single SendMessageBatch, DeleteMessageBatch, or ChangeMessageVisibilityBatch request is 10.

* * @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 DeleteMessageBatchCommand extends DeleteMessageBatchCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteMessageBatchRequest; output: DeleteMessageBatchResult; }; sdk: { input: DeleteMessageBatchCommandInput; output: DeleteMessageBatchCommandOutput; }; }; }