Class DeleteMessageBatchCommandProtected

Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage.

Example

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

import { QueuesClient, DeleteMessageBatchCommand } from "@stedi/sdk-client-queues"; // ES Modules import
// const { QueuesClient, DeleteMessageBatchCommand } = require("@stedi/sdk-client-queues"); // CommonJS import
const client = new QueuesClient(config);
const input = { // DeleteMessageBatchInput
  queueUrl: "STRING_VALUE", // required
  messages: [ // DeleteMessageBatchItemList // required
    { // DeleteMessageBatchItem
      id: "STRING_VALUE", // required
      receiptHandle: "STRING_VALUE", // required
    },
  ],
};
const command = new DeleteMessageBatchCommand(input);
const response = await client.send(command);
// { // DeleteMessageBatchOutput
//   successful: [ // DeleteMessageBatchResultList
//     { // DeleteMessageBatchResult
//       id: "STRING_VALUE",
//     },
//   ],
//   failed: [ // BatchOperationErrorItemList
//     { // MessageBatchErrorItem
//       id: "STRING_VALUE",
//       senderFault: true || false,
//       code: "STRING_VALUE",
//       message: "STRING_VALUE",
//     },
//   ],
// };

Param

DeleteMessageBatchCommandInput

Returns

DeleteMessageBatchCommandOutput

See

• DeleteMessageBatchCommandInput for command's input shape.
• DeleteMessageBatchCommandOutput 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.