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

Class: Aws::SQS::Types::ChangeMessageVisibilityRequest

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 ChangeMessageVisibilityRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#queue_urlString

The URL of the Amazon SQS queue whose message's visibility is changed.

Queue URLs are case-sensitive.

Returns:

  • (String)


265
266
267
268
269
270
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 265

class ChangeMessageVisibilityRequest < Struct.new(
  :queue_url,
  :receipt_handle,
  :visibility_timeout)
  include Aws::Structure
end

#receipt_handleString

The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.

Returns:

  • (String)


265
266
267
268
269
270
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 265

class ChangeMessageVisibilityRequest < Struct.new(
  :queue_url,
  :receipt_handle,
  :visibility_timeout)
  include Aws::Structure
end

#visibility_timeoutInteger

The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours.

Returns:

  • (Integer)


265
266
267
268
269
270
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 265

class ChangeMessageVisibilityRequest < Struct.new(
  :queue_url,
  :receipt_handle,
  :visibility_timeout)
  include Aws::Structure
end