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 |
ExtendHIT
Description
The ExtendHIT
operation increases the maximum number of
assignments, or extends the expiration date, of an existing HIT.
To extend the maximum number of assignments, specify the number of additional assignments.
To extend the expiration date, specify an amount of time as a number of seconds. If the HIT has not yet expired, the new expiration date is the existing date plus the amount of time specified. If the HIT has already expired, the new expiration date is the current time plus the amount of time specified.
Only the Requester who created a HIT can extend it.
Note
HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more assignments will result in an
AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease
exception.HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an
AWS.MechanicalTurk.HITTooOldForExtension
exception.
Request Parameters
The ExtendHIT
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 ExtendHIT
operation:
Name | Description | Required |
---|---|---|
|
The name of the operation Type: String Valid Values: ExtendHIT Default: None |
Yes |
|
The ID of the HIT to extend Type: String Default: None |
Yes |
|
The number of assignments by which to increment the Type: positive integer Valid Values: any integer between 1 and 1000000000 (one billion) Default: None |
No |
|
The amount of time, in seconds, by which to extend the expiration date. If the HIT has not yet expired, this amount is added to the HIT's expiration date. If the HIT has expired, the new expiration date is the current time plus this value. Type: positive integer Valid Values: any integer between 3600 (1 hour) and 31536000 (365 days) Default: None |
No |
|
A unique identifier for this request, which allows you to retry
the call on error without extending the HIT multiple times. This is
useful in cases such as network timeouts where it is unclear whether
or not the call succeeded on the server. If the extend HIT already
exists in the system from a previous call using the same
Type: String Default: None Constraints: must not be longer than 64 characters in length. Note: It is your responsibility to ensure uniqueness of the
token. The unique token expires after 24 hours. Subsequent calls
using the same |
No |
Response Elements
A successful request for the ExtendHIT
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 ExtendHIT
operation.
Sample Request
The following example extends the expiration date of a HIT by 5 days (432,000 seconds).
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=
[the Requester's Access Key ID]
&Version=2017-01-17 &Operation=ExtendHIT &Signature=[signature for this request]
&Timestamp=[your system's local time]
&HITId=123RVWYBAZW00EXAMPLE &ExpirationIncrementInSeconds=432000
Sample Response
The following is an example response.
<ExtendHITResult> <Request> <IsValid>True</IsValid> </Request> </ExtendHITResult>