|
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 |
ForceExpireHIT
Description
The ForceExpireHIT operation causes a HIT to expire immediately,
as if the LifetimeInSeconds parameter of the HIT had elapsed.
The effect is identical to the HIT expiring on its own; the HIT no longer appears on the Amazon Amazon Mechanical Turk web site, and no new Workers are allowed to accept the HIT. Workers who have accepted the HIT prior to expiration are allowed to complete it or return it, or allow the assignment duration to elapse (abandon the HIT). Once all remaining assignments have been submitted, the expired HIT becomes Reviewable, and will be returned by a call to the GetReviewableHITs operation.
Note
Unlike the DisableHIT
operation, the ForceExpireHIT operation does not have any
effect on assignments. If assignments have been submitted for the HIT, your
application still needs to approve or reject them before disposing of the HIT.
Request Parameters
The ForceExpireHIT 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 ForceExpireHIT
operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation Type: String Valid Values: ForceExpireHIT Default: None |
Yes |
|
|
The ID of the HIT, as returned by the Type: String Default: None |
Yes |
Response Elements
A successful request for the ForceExpireHIT 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 ForceExpireHIT
operation.
Sample Request
The following example causes the specified HIT to expire.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Operation=ForceExpireHIT &Signature=[signature for this request]&Timestamp=[your system's local time]&HITId=123RVWYBAZW00EXAMPLE
Sample Response
The following is an example response.
<ForceExpireHITResult> <Request> <IsValid>True</IsValid> </Request> </ForceExpireHITResult>
