paws.application.integration (version 0.1.11)

sqs_change_message_visibility_batch: Changes the visibility timeout of multiple messages

Description

Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 change_message_visibility requests with each change_message_visibility_batch action.

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.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&AttributeName.1=first

&AttributeName.2=second

Usage

sqs_change_message_visibility_batch(QueueUrl, Entries)

Arguments

QueueUrl

[required] The URL of the Amazon SQS queue whose messages' visibility is changed.

Queue URLs and names are case-sensitive.

Entries

[required] A list of receipt handles of the messages for which the visibility timeout must be changed.

Value

A list with the following syntax:

list(
  Successful = list(
    list(
      Id = "string"
    )
  ),
  Failed = list(
    list(
      Id = "string",
      SenderFault = TRUE|FALSE,
      Code = "string",
      Message = "string"
    )
  )
)

Request syntax

svc$change_message_visibility_batch(
  QueueUrl = "string",
  Entries = list(
    list(
      Id = "string",
      ReceiptHandle = "string",
      VisibilityTimeout = 123
    )
  )
)