|
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 |
DisposeHIT
Description
The DisposeHIT operation disposes of a HIT that is no longer needed. Only the Requester who created the HIT can dispose of it.
You can only dispose of HITs that are in the Reviewable state, with all
of their submitted assignments already either approved or rejected. If you call the
DisposeHIT operation on a HIT that is not in the Reviewable state (for example, that has not expired, or still
has active assignments), or on a HIT that is Reviewable
but without all of its submitted assignments already approved or rejected, the service
returns an error.
Notes
HITs are automatically disposed of after 120 days.
After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.
Disposed of HITs are not returned in results for the
SearchHITsoperation.Disposing of HITs can improve the performance of operations such as
GetReviewableHITsandSearchHITs.
Request Parameters
The DisposeHIT operation accepts parameters common to all
operations. Some common parameters are required. See Common Parameters for more information.
The following parameters are specific to the DisposeHIT
operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation Type: String Valid Values: DisposeHIT Default: None |
Yes |
|
|
The ID of the HIT, as returned by the CreateHIT operation. Type: String Default: None |
Yes |
Response Elements
A successful request for the DisposeHIT operation returns with
no errors. The response includes the elements described in the following table. The
operation returns no other data.
| Name | Description |
|---|---|
|
|
Contains a |
Examples
The following example shows how to use the DisposeHIT
operation.
Sample Request
The following example disposes of the HIT with the specified HIT ID.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2017-01-17 &Operation=DisposeHIT &Signature=[signature for this request]&Timestamp=[your system's local time]&HITId=123RVWYBAZW00EXAMPLE
Sample Response
The following is an example response.
<DisposeHITResult> <Request> <IsValid>True</IsValid> </Request> </DisposeHITResult>
