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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#assignment_duration_in_secondsInteger

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

Returns:

  • (Integer)

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

#auto_approval_delay_in_secondsInteger

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)

    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_timeTime

The date and time the HIT was created.

Returns:

  • (Time)

    The date and time the HIT was created.

#descriptionString

A general description of the HIT.

Returns:

  • (String)

    A general description of the HIT.

#expirationTime

The date and time the HIT expires.

Returns:

  • (Time)

    The date and time the HIT expires.

#hit_group_idString

The ID of the HIT Group of this HIT.

Returns:

  • (String)

    The ID of the HIT Group of this HIT.

#hit_idString

A unique identifier for the HIT.

Returns:

  • (String)

    A unique identifier for the HIT.

#hit_layout_idString

The ID of the HIT Layout of this HIT.

Returns:

  • (String)

    The ID of the HIT Layout of this HIT.

#hit_review_statusString

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

Possible values:

  • NotReviewed
  • MarkedForReview
  • ReviewedAppropriate
  • ReviewedInappropriate

Returns:

  • (String)

    Indicates the review status of the HIT.

#hit_statusString

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

Possible values:

  • Assignable
  • Unassignable
  • Reviewable
  • Reviewing
  • Disposed

Returns:

  • (String)

    The status of the HIT and its assignments.

#hit_type_idString

The ID of the HIT type of this HIT

Returns:

  • (String)

    The ID of the HIT type of this HIT.

#keywordsString

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)

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

#max_assignmentsInteger

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

Returns:

  • (Integer)

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

#number_of_assignments_availableInteger

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

Returns:

  • (Integer)

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

#number_of_assignments_completedInteger

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

Returns:

  • (Integer)

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

#number_of_assignments_pendingInteger

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)

    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_requirementsArray<Types::QualificationRequirement>

A condition 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 by a Worker\'s Qualifications for the Worker to accept the HIT.

Returns:

#questionString

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)

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

#requester_annotationString

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)

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

#rewardString

A string representing a currency amount.

Returns:

  • (String)

    A string representing a currency amount.

    .

#titleString

The title of the HIT.

Returns:

  • (String)

    The title of the HIT.