ChangeHITTypeOfHIT - Amazon Mechanical Turk
DescriptionRequest ParametersResponse ElementsExamples

WARNING

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:

This Requester API is no longer supported. Please use the latest API using the official AWS SDK. https://aws.amazon.com/getting-started/tools-sdks

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 (SDKs) that have been widely adopted across the AWS community. This API can be accessed using the following AWS SDKs: Python/Boto (Boto3), Javascript (NodeJS or Browser), Java, .NET, Go, Ruby, PHP or C++. This version also makes it easier for customers to connect MTurk with other AWS services like S3, Lambda, Step Functions, Lex, Polly, Rekognition, Amazon SageMaker, AWS Batch, EC2, and more.

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. Please check whether you need to migrate and review the technical migration guide.

For support, contact requestor-apilegacydeprecation-support@amazon.com.

 

ChangeHITTypeOfHIT

Description

The ChangeHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties and associates it with the new HITType properties. The HIT takes on the properties of the new HITType in place of the old ones. For more information about HIT types, see the Amazon Mechanical Turk Developer Guide.

You can use ChangeHITTypeOfHIT to update any of the HITType properties of a HIT.

Request Parameters

The ChangeHITTypeOfHIT 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 ChangeHITTypeOfHIT operation:

Name Description Required

Operation

The name of the operation

Type: String

Valid Values: ChangeHITTypeOfHIT

Default: None

Yes

HITId

The ID of the HIT to change

Type: String

Default: None

Yes

HITTypeId

The ID of the new HIT type

Type: String

Default: None

Yes

Response Elements

A successful request for the ChangeHITTypeOfHIT operation returns with no errors. The response includes the elements described in the following table. The operation returns no other data.

Name Description

ChangeHITTypeOfHITResult

Contains a Request element if the Request ResponseGroup is specified.

Examples

The following example shows how to use the ChangeHITTypeOfHIT operation.

Sample Request

The following example changes the HIT type.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2017-01-17
&Operation=ChangeHITTypeOfHIT
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&HITId=123RVWYBAZW00EXAMPLE
&HITTypeId=T100CN9P324W00EXAMPLE

Sample Response

The following is an example response.

<ChangeHITTypeOfHITResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
</ChangeHITTypeOfHITResult>