Documentation

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

See: newHIT smart constructor.

Create a value of HIT with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:HIT', hit_creationTime - The date and time the HIT was created.

$sel:hITGroupId:HIT', hit_hITGroupId - The ID of the HIT Group of this HIT.

$sel:numberOfAssignmentsPending:HIT', hit_numberOfAssignmentsPending - 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.

$sel:hITTypeId:HIT', hit_hITTypeId - The ID of the HIT type of this HIT

$sel:expiration:HIT', hit_expiration - The date and time the HIT expires.

$sel:autoApprovalDelayInSeconds:HIT', hit_autoApprovalDelayInSeconds - 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.

$sel:requesterAnnotation:HIT', hit_requesterAnnotation - An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

$sel:hITStatus:HIT', hit_hITStatus - The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

$sel:maxAssignments:HIT', hit_maxAssignments - The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

$sel:numberOfAssignmentsCompleted:HIT', hit_numberOfAssignmentsCompleted - The number of assignments for this HIT that have been approved or rejected.

$sel:reward:HIT', hit_reward - Undocumented member.

$sel:keywords:HIT', hit_keywords - 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.

$sel:hITLayoutId:HIT', hit_hITLayoutId - The ID of the HIT Layout of this HIT.

$sel:qualificationRequirements:HIT', hit_qualificationRequirements - 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.

$sel:title:HIT', hit_title - The title of the HIT.

$sel:hITId:HIT', hit_hITId - A unique identifier for the HIT.

$sel:hITReviewStatus:HIT', hit_hITReviewStatus - Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

$sel:numberOfAssignmentsAvailable:HIT', hit_numberOfAssignmentsAvailable - The number of assignments for this HIT that are available for Workers to accept.

$sel:description:HIT', hit_description - A general description of the HIT.

$sel:question:HIT', hit_question - The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

$sel:assignmentDurationInSeconds:HIT', hit_assignmentDurationInSeconds - The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

The date and time the HIT was created.

The ID of the HIT Group of this HIT.

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.

The ID of the HIT type of this HIT

The date and time the HIT expires.

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.

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

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

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

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

Undocumented member.

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.

The ID of the HIT Layout of this HIT.

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.

The title of the HIT.

A unique identifier for the HIT.

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

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

A general description of the HIT.

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

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