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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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`

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

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

<note markdown=“1”> The `Id`s 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 (_).

</note>

Returns:

  • (String)

202
203
204
205
206
207
208
# File 'lib/aws-sdk-sqs/types.rb', line 202

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

#receipt_handleString

A receipt handle.

Returns:

  • (String)

202
203
204
205
206
207
208
# File 'lib/aws-sdk-sqs/types.rb', line 202

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

#visibility_timeoutInteger

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

Returns:

  • (Integer)

202
203
204
205
206
207
208
# File 'lib/aws-sdk-sqs/types.rb', line 202

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