Class: Aws::MTurk::Types::HIT

Inherits:

Struct

• Object
• Struct
• Aws::MTurk::Types::HIT

Defined in:

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

Overview

The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #assignment_duration_in_seconds ⇒ Integer

  The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

• #auto_approval_delay_in_seconds ⇒ Integer

  The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk.

• #creation_time ⇒ Time

  The date and time the HIT was created.

• #description ⇒ String

  A general description of the HIT.

• #expiration ⇒ Time

  The date and time the HIT expires.

• #hit_group_id ⇒ String

  The ID of the HIT Group of this HIT.

• #hit_id ⇒ String

  A unique identifier for the HIT.

• #hit_layout_id ⇒ String

  The ID of the HIT Layout of this HIT.

• #hit_review_status ⇒ String

  Indicates the review status of the HIT.

• #hit_status ⇒ String

  The status of the HIT and its assignments.

• #hit_type_id ⇒ String

  The ID of the HIT type of this HIT.

• #keywords ⇒ String

  One or more words or phrases that describe the HIT, separated by commas.

• #max_assignments ⇒ Integer

  The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

• #number_of_assignments_available ⇒ Integer

  The number of assignments for this HIT that are available for Workers to accept.

• #number_of_assignments_completed ⇒ Integer

  The number of assignments for this HIT that have been approved or rejected.

• #number_of_assignments_pending ⇒ Integer

  The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.

• #qualification_requirements ⇒ Array<Types::QualificationRequirement>

  Conditions that a Worker's Qualifications must meet in order to accept the HIT.

• #question ⇒ String

  The data the Worker completing the HIT uses produce the results.

• #requester_annotation ⇒ String

  An arbitrary data field the Requester who created the HIT can use.

• #reward ⇒ String

  A string representing a currency amount.

• #title ⇒ String

  The title of the HIT.

Instance Attribute Details

#assignment_duration_in_seconds ⇒ Integer

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

Returns:

• (Integer)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#auto_approval_delay_in_seconds ⇒ Integer

The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.

Returns:

• (Integer)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time the HIT was created.

Returns:

• (Time)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A general description of the HIT.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#expiration ⇒ Time

The date and time the HIT expires.

Returns:

• (Time)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#hit_group_id ⇒ String

The ID of the HIT Group of this HIT.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#hit_id ⇒ String

A unique identifier for the HIT.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#hit_layout_id ⇒ String

The ID of the HIT Layout of this HIT.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#hit_review_status ⇒ String

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#hit_status ⇒ String

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#hit_type_id ⇒ String

The ID of the HIT type of this HIT

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#keywords ⇒ String

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#max_assignments ⇒ Integer

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

Returns:

• (Integer)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_assignments_available ⇒ Integer

The number of assignments for this HIT that are available for Workers to accept.

Returns:

• (Integer)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_assignments_completed ⇒ Integer

The number of assignments for this HIT that have been approved or rejected.

Returns:

• (Integer)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_assignments_pending ⇒ Integer

The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.

Returns:

• (Integer)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#qualification_requirements ⇒ Array<Types::QualificationRequirement>

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Returns:

• (Array<Types::QualificationRequirement>)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#question ⇒ String

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#requester_annotation ⇒ String

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#reward ⇒ String

A string representing a currency amount.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the HIT.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1108

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  SENSITIVE = []
  include Aws::Structure
end