RegisterHITType - Amazon Mechanical Turk

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.

 

RegisterHITType

Description

The RegisterHITType operation creates a new HIT type.

The RegisterHITType operation lets you be explicit about which HITs ought to be the same type. It also gives you error checking, to ensure that you call the CreateHIT operation with a valid HIT type ID.

If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned.

Request Parameters

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

Name Description Required

Operation

The name of the operation

Type: String

Valid Values: RegisterHITType

Default: None

Yes

Title

The title for HITs of this type.

A Title parameter should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

Type: String

Default: None

Constraints: can be up to 128 characters in length

Yes

Description

A general description of HITs of this type

A Description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it. It should not include instructions for completing the HIT.

Type: String

Default: None

Constraints: must be less than 2,000 characters in length

Yes

Reward

The amount of money the Requester will pay a user for successfully completing a HIT of this type.

Type: a Price data structure

Default: None

Yes

AssignmentDurationInSeconds

The amount of time a Worker has to complete a HIT of this type after accepting it.

Type: positive integer

Default: None

Constraints: any integer between 30 (30 seconds) and 3153600 (365 days)

Yes

Keywords

One or more words or phrases that describe a HIT of this type, separated by commas. Searches for words similar to the keywords are more likely to return the HIT in the search results.

Type: String

Default: None

Constraints: The complete string, including commas and spaces, must be fewer than 1,000 characters.

No

AutoApprovalDelayInSeconds

An amount of time, in seconds, after an assignment for a HIT of this type has been submitted, that the assignment becomes Approved automatically, unless the Requester explicitly rejects it.

Type: positive integer

Default: 2592000 (30 days)

Constraints: must be between 0 (immediate) and 2592000 (30 days).

No

QualificationRequirement

A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete a HIT of this type.

Type: a QualificationRequirement data structure.

Default: None

Constraints: there can be no more than 10 QualificationRequirement data structures for each HIT.

No

Response Elements

A successful request for the RegisterHITType operation has a RegisterHITTypeResult element in the response.

The RegisterHITTypeResult element contains the following elements:

Name Description

HITTypeId

The ID of the newly registered HIT type

Type: String

Default: None

Examples

The following example shows how to use the GetHITsForQualificationType operation.

Sample Request

The following example registers a new HIT type.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID] &Version=2017-01-17 &Operation=RegisterHITType &Signature=[signature for this request] &Timestamp=[your system's local time] &Title=Location%20and%20Photograph%20Identification &Description=Select%20the%20image%20that%20best%20represents... &Reward.1.Amount=5 &Reward.1.CurrencyCode=USD &AssignmentDurationInSeconds=30 &Keywords=location,%20photograph,%20image,%20identification,%20opinion

Sample Response

The following is an example response.

<RegisterHITTypeResult> <Request> <IsValid>True</IsValid> </Request> <HITTypeId>KZ3GKTRXBWGYX8WXBW60</HITTypeId> </RegisterHITTypeResult>