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
Operation	The name of the operation Type: String Valid Values: ExtendHIT Default: None	Yes
HITId	The ID of the HIT to extend Type: String Default: None	Yes
MaxAssignmentsIncrement	The number of assignments by which to increment the MaxAssignments parameter of the HIT. Type: positive integer Valid Values: any integer between 1 and 1000000000 (one billion) Default: None	No
ExpirationIncrementInSeconds	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
UniqueRequestToken	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 UniqueRequestToken, subsequent calls will return an error with a message containing the request ID. 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 UniqueRequestToken made after the 24 hour limit could extend the HIT multiple times.	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
ExtendHITResult	Contains a Request element if the Request ResponseGroup is specified.

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>