You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
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:

Instance Attribute Summary collapse

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

Returns:

  • (String) 


181
182
183
184
185
186
 
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 181

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

#receipt_handle ⇒ String

A receipt handle.

Returns:

  • (String) 


181
182
183
184
185
186
 
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 181

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

#visibility_timeout ⇒ Integer

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

Returns:

  • (Integer) 


181
182
183
184
185
186
 
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 181

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