Class: Aws::SQS::Types::ChangeMessageVisibilityBatchRequestEntry

Inherits:

Struct

• Object
• Struct
• Aws::SQS::Types::ChangeMessageVisibilityBatchRequestEntry

Defined in:

gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb

Overview

Note:

When making an API call, you may pass ChangeMessageVisibilityBatchRequestEntry data as a hash:

{
  id: "String", # required
  receipt_handle: "String", # required
  visibility_timeout: 1,
}

Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.

All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:

&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2

&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle

&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #id ⇒ String

  An identifier for this particular receipt handle used to communicate the result.

• #receipt_handle ⇒ String

  A receipt handle.

• #visibility_timeout ⇒ Integer

  The new value (in seconds) for the message's visibility timeout.

Instance Attribute Details

#id ⇒ String

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Returns:

• (String)

# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 203

class ChangeMessageVisibilityBatchRequestEntry < Struct.new(
  :id,
  :receipt_handle,
  :visibility_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#receipt_handle ⇒ String

A receipt handle.

Returns:

• (String)

# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 203

class ChangeMessageVisibilityBatchRequestEntry < Struct.new(
  :id,
  :receipt_handle,
  :visibility_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_timeout ⇒ Integer

The new value (in seconds) for the message's visibility timeout.

Returns:

• (Integer)

# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 203

class ChangeMessageVisibilityBatchRequestEntry < Struct.new(
  :id,
  :receipt_handle,
  :visibility_timeout)
  SENSITIVE = []
  include Aws::Structure
end