Class ChangeMessageVisibilityBatchCommandProtected

Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility.

Example

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

import { QueuesClient, ChangeMessageVisibilityBatchCommand } from "@stedi/sdk-client-queues"; // ES Modules import
// const { QueuesClient, ChangeMessageVisibilityBatchCommand } = require("@stedi/sdk-client-queues"); // CommonJS import
const client = new QueuesClient(config);
const input = { // ChangeMessageVisibilityBatchInput
  queueUrl: "STRING_VALUE", // required
  messages: [ // ChangeMessageVisibilityBatchItemList
    { // ChangeMessageVisibilityBatchItem
      id: "STRING_VALUE", // required
      receiptHandle: "STRING_VALUE", // required
      visibilityTimeout: Number("int"), // required
    },
  ],
};
const command = new ChangeMessageVisibilityBatchCommand(input);
const response = await client.send(command);
// { // ChangeMessageVisibilityBatchOutput
//   successful: [ // ChangeMessageVisibilityBatchResultList
//     { // ChangeMessageVisibilityBatchResult
//       id: "STRING_VALUE",
//     },
//   ],
//   failed: [ // BatchOperationErrorItemList
//     { // MessageBatchErrorItem
//       id: "STRING_VALUE",
//       senderFault: true || false,
//       code: "STRING_VALUE",
//       message: "STRING_VALUE",
//     },
//   ],
// };

Param

ChangeMessageVisibilityBatchCommandInput

Returns

ChangeMessageVisibilityBatchCommandOutput

See

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