You are browsing the documentation for a deprecated version ('2014-08-15') of the Amazon Mechanical Turk Requester API. This version of the API will be deprecated and will be rendered unusable as of June 1st, 2019. If you request against a legacy API version (https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI-legacy/Welcome.html) on or after June 1, 2019, you will receive the following response:
The latest version of our API ('2017-01-17') provides you with additional tool choices and enables you to select from nine AWS Software Development Kits This version also updates naming conventions used in the API and adopts the AWS standard of Signature Version 4 to authenticate requests securely. The API uses REST requests and no longer requires that developers be familiar with SOAP protocol. These changes make the MTurk API consistent with AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. The legacy MTurk Command Line Tools and .NET, Java, Ruby, and Perl SDKs were marked as deprecated in January 2018. We will be deprecating the legacy APIs as of June 1, 2019. If you are on a legacy API, you must migrate to the latest
version of our API. You can find documentation for the latest API here and the AWS SDKs here For support, contact requestor-apilegacydeprecation-support@amazon.com |
HIT
Description
The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.
The HIT data structure is used as a response element for the following operations:
HITs and Response Groups
Operations that return a HIT data structure use response groups to determine how much
information to return. As described in Common Parameters,
the ResponseGroup
parameter specifies which sets of
elements the service should return, as a set of named groups. For example, the
Request
response group includes the contents of the operation request in
the response.
For the HIT data structure, the Minimal
response group returns the
HITId
. For information about the contents of other HIT data structure related response group content,
see Common Parameters.
The GetHIT
operation returns the HITDetail
,
HITQuestion
and Minimal
response groups by
default. The HITAssignmentSummary
response group is off by default.
The SearchHITs
operation includes HITDetail
,
Minimal
, and HITAssignmentSummary
as default
response groups. You can also specify HITQuestion
with
SearchHITs
.
CreateHIT
and DisableHIT
can also return additional HIT
fields, but their default is Minimal
.
Currently, the GetReviewableHITs
operation only supports the
Minimal
response group. To retrieve additional HIT data for HITs
returned by this operation, use the HIT IDs in the results with GetHIT
.
Elements
The HIT structure can contain the elements described in the following table.
Name | Description | Required |
---|---|---|
|
A unique identifier for the HIT. The CreateHIT operation gives a HIT the HIT ID and the HIT retains that ID forever. Type: String Default: None |
No |
|
The ID of the HIT type of this HIT Type: String Default: None |
No |
|
The ID of the HIT Group of this HIT Type: String Default: None |
No |
|
The ID of the HIT Layout of this HIT Type: String Default: None |
No |
|
The date and time the HIT was created Type: a dateTime Default: None |
No |
|
The title of the HIT Type: String Default: None |
No |
|
A general description of the HIT Type: String Default: None |
No |
|
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. Type: String Default: None |
No |
|
The status of the HIT and its assignments Type: String Valid Values: Assignable | Unassignable | Reviewable | Reviewing | Disposed Default: None |
No |
|
The amount of money the Requester will pay a Worker for successfully completing the HIT. Type: a Price data structure Default: None |
No |
|
The amount of time, in seconds, after which the HIT is no longer available for users
to accept. The HIT becomes unavailable even if the requested number
of assignments, specified by Type: positive integer Default: None |
No |
|
The length of time, in seconds, that a Worker has to complete the HIT after accepting it. Type: positive integer Default: None |
No |
|
The number of times the HIT can be accepted and completed before the HIT becomes unavailable. Type: positive integer Default: 1 |
No |
|
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. Type: positive integer Default: None |
No |
|
The date and time the HIT expires Type: a dateTime Default: None |
No |
|
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. Type: a QualificationRequirement data structure. Default: None |
No |
|
The data the Worker completing the HIT uses produce the results. Type: either a QuestionForm or an ExternalQuestion data structure. Default: None |
No |
|
An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT. Type: String Default: None |
No |
|
Indicates the review status of the HIT. Type: String Valid Values: NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate Default: None |
No |
|
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. Type: non-negative integer Default: None Conditions: This element is returned only if the
|
Conditional |
|
The number of assignments for this HIT that are available for Workers to accept Type: non-negative integer Default: None Conditions: This element is returned only if the
|
Conditional |
|
The number of assignments for this HIT that have been approved or rejected. Type: non-negative integer Default: None Conditions: This element is returned only if the
|
Conditional |
Example
The following example shows a HIT data structure returned by the CreateHIT operation. The CreateHIT operation returns an element named
HIT
that represents the HIT that was created by the call.
<HIT> <HITId>123RVWYBAZW00EXAMPLE</HITId> <HITTypeId>T100CN9P324W00EXAMPLE</HITTypeId> <CreationTime>2005-06-30T23:59:59</CreationTime> <HITStatus>Assignable</HITStatus> <MaxAssignments>5</MaxAssignments> <AutoApprovalDelayInSeconds>86400</AutoApprovalDelayInSeconds> <LifetimeInSeconds>86400</LifetimeInSeconds> <AssignmentDurationInSeconds>300</AssignmentDurationInSeconds> <Reward> <Amount>25</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$0.25</FormattedPrice> </Reward> <Title>Location and Photograph Identification</Title> <Description>Select the image that best represents...</Description> <Keywords>location, photograph, image, identification, opinion</Keywords> <Question> <QuestionForm>
[XML-encoded Question data]
</QuestionForm> </Question> <QualificationRequirement> <QualificationTypeId>789RVWYBAZW00EXAMPLE</QualificationTypeId> <Comparator>GreaterThan</Comparator> <Value>18</Value> </QualificationRequirement> <HITReviewStatus>NotReviewed</HITReviewStatus> </HIT>