Class: Aws::SQS::Types::ListMessageMoveTasksResultEntry

Inherits:

Struct

• Object
• Struct
• Aws::SQS::Types::ListMessageMoveTasksResultEntry

Defined in:

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

Overview

Contains the details of a message movement task.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #approximate_number_of_messages_moved ⇒ Integer

  The approximate number of messages already moved to the destination queue.

• #approximate_number_of_messages_to_move ⇒ Integer

  The number of messages to be moved from the source queue.

• #destination_arn ⇒ String

  The ARN of the destination queue if it has been specified in the StartMessageMoveTask request.

• #failure_reason ⇒ String

  The task failure reason (only included if the task status is FAILED).

• #max_number_of_messages_per_second ⇒ Integer

  The number of messages to be moved per second (the message movement rate), if it has been specified in the StartMessageMoveTask request.

• #source_arn ⇒ String

  The ARN of the queue that contains the messages to be moved to another queue.

• #started_timestamp ⇒ Integer

  The timestamp of starting the message movement task.

• #status ⇒ String

  The status of the message movement task.

• #task_handle ⇒ String

  An identifier associated with a message movement task.

Instance Attribute Details

#approximate_number_of_messages_moved ⇒ Integer

The approximate number of messages already moved to the destination queue.

Returns:

• (Integer)

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

class ListMessageMoveTasksResultEntry < Struct.new(
  :task_handle,
  :status,
  :source_arn,
  :destination_arn,
  :max_number_of_messages_per_second,
  :approximate_number_of_messages_moved,
  :approximate_number_of_messages_to_move,
  :failure_reason,
  :started_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#approximate_number_of_messages_to_move ⇒ Integer

The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task and is only included after the message movement task is selected to start.

Returns:

• (Integer)

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

class ListMessageMoveTasksResultEntry < Struct.new(
  :task_handle,
  :status,
  :source_arn,
  :destination_arn,
  :max_number_of_messages_per_second,
  :approximate_number_of_messages_moved,
  :approximate_number_of_messages_to_move,
  :failure_reason,
  :started_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#destination_arn ⇒ String

The ARN of the destination queue if it has been specified in the StartMessageMoveTask request. If a DestinationArn has not been specified in the StartMessageMoveTask request, this field value will be NULL.

Returns:

• (String)

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

class ListMessageMoveTasksResultEntry < Struct.new(
  :task_handle,
  :status,
  :source_arn,
  :destination_arn,
  :max_number_of_messages_per_second,
  :approximate_number_of_messages_moved,
  :approximate_number_of_messages_to_move,
  :failure_reason,
  :started_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

The task failure reason (only included if the task status is FAILED).

Returns:

• (String)

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

class ListMessageMoveTasksResultEntry < Struct.new(
  :task_handle,
  :status,
  :source_arn,
  :destination_arn,
  :max_number_of_messages_per_second,
  :approximate_number_of_messages_moved,
  :approximate_number_of_messages_to_move,
  :failure_reason,
  :started_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#max_number_of_messages_per_second ⇒ Integer

The number of messages to be moved per second (the message movement rate), if it has been specified in the StartMessageMoveTask request. If a MaxNumberOfMessagesPerSecond has not been specified in the StartMessageMoveTask request, this field value will be NULL.

Returns:

• (Integer)

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

class ListMessageMoveTasksResultEntry < Struct.new(
  :task_handle,
  :status,
  :source_arn,
  :destination_arn,
  :max_number_of_messages_per_second,
  :approximate_number_of_messages_moved,
  :approximate_number_of_messages_to_move,
  :failure_reason,
  :started_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#source_arn ⇒ String

The ARN of the queue that contains the messages to be moved to another queue.

Returns:

• (String)

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

class ListMessageMoveTasksResultEntry < Struct.new(
  :task_handle,
  :status,
  :source_arn,
  :destination_arn,
  :max_number_of_messages_per_second,
  :approximate_number_of_messages_moved,
  :approximate_number_of_messages_to_move,
  :failure_reason,
  :started_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#started_timestamp ⇒ Integer

The timestamp of starting the message movement task.

Returns:

• (Integer)

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

class ListMessageMoveTasksResultEntry < Struct.new(
  :task_handle,
  :status,
  :source_arn,
  :destination_arn,
  :max_number_of_messages_per_second,
  :approximate_number_of_messages_moved,
  :approximate_number_of_messages_to_move,
  :failure_reason,
  :started_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the message movement task. Possible values are: RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.

Returns:

• (String)

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

class ListMessageMoveTasksResultEntry < Struct.new(
  :task_handle,
  :status,
  :source_arn,
  :destination_arn,
  :max_number_of_messages_per_second,
  :approximate_number_of_messages_moved,
  :approximate_number_of_messages_to_move,
  :failure_reason,
  :started_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#task_handle ⇒ String

An identifier associated with a message movement task. When this field is returned in the response of the ListMessageMoveTasks action, it is only populated for tasks that are in RUNNING status.

Returns:

• (String)

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

class ListMessageMoveTasksResultEntry < Struct.new(
  :task_handle,
  :status,
  :source_arn,
  :destination_arn,
  :max_number_of_messages_per_second,
  :approximate_number_of_messages_moved,
  :approximate_number_of_messages_to_move,
  :failure_reason,
  :started_timestamp)
  SENSITIVE = []
  include Aws::Structure
end