|
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 |
DisableHIT
Description
The DisableHIT operation removes a HIT from the Amazon Mechanical Turk
marketplace, approves any submitted assignments pending approval or rejection, and
disposes of the HIT and all assignment data. Assignment results data cannot be retrieved
for a HIT that has been disposed.
Assignments in progress at the time of the call to the DisableHIT operation are
approved once the assignments are submitted. You will be charged for approval of these assignments.
When either all of the HIT's assignments have been submitted by Workers, or the HIT has expired and all assignments have either been submitted, returned or abandoned, the HIT is considered Reviewable. For more information about the Reviewable state, see Creating and Managing Assignments.
The DisableHIT operation does not work on HITs in the Reviewable state.
For HITs in the Reviewable state, call the ApproveAssignment or the RejectAssignment operation for each
submitted assignment for the HIT. Then call the DisposeHIT operation to dispose of the HIT.
Only the Requester who created the HIT can disable it.
Request Parameters
The DisableHIT 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 DisableHIT
operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation Type: String Valid Values: DisableHIT 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 DisableHIT operation returns with
no errors. The response includes the elements in the following table. The operation
returns no other data.
| Name | Description |
|---|---|
|
|
Contains a |
Examples
The following example shows how to use the DisableHIT
operation.
Sample Request
The following example disables a HIT with a specified HIT ID.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2017-01-17 &Operation=DisableHIT &Signature=[signature for this request]&Timestamp=[your system's local time]&HITId=123RVWYBAZW00EXAMPLE
Sample Response
The following is an example response.
<DisableHITResult> <Request> <IsValid>True</IsValid> </Request> </DisableHITResult>
