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 |
CreateQualificationType
Description
The CreateQualificationType
operation creates a new Qualification type, which is represented by a
QualificationType
data structure.
Request Parameters
CreateQualificationType
accepts parameters common to all
operations. Some common parameters are required. See Common Parameters for more
information.
The following parameters are specific to the CreateQualificationType
operation:
Name | Description | Required |
---|---|---|
|
The name of the operation. Type: String Valid Values: CreateQualificationType Default: None |
Yes |
|
The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. Type: String Default: None Constraints: Must be unique across all of your Qualification types. |
Yes |
|
A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type. Type: String Default: None Constraints: Must be less than or equal to 2000 characters. |
Yes |
|
One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search. Type: String Default: None Constraints: Must be less than or equal to 1000 characters, including commas and spaces. |
No |
|
The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request. Type: Non-negative integer Default: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled. |
No |
|
The initial status of the Qualification type. Type: String Valid Values: Active | Inactive Default: None |
Yes |
|
The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, Type: String Default: None. If not specified, the Worker may request the Qualification without answering any questions. Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be
specified if |
No |
|
The answers to the Qualification test specified in the
Type: String Default: None. If not specified, you must process Qualification requests manually. Constraints: Must not be longer than 65535 bytes. |
No |
|
The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification. Type: Integer Valid Values: Positive integer Default: None Conditions: Required if the |
Conditional |
|
Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Type: Boolean Valid Values: Default: None Constraints: If the |
No |
|
The Qualification value to use for automatically granted
Qualifications. This parameter is used only if the Type: Integer Default: 1 |
No |
Response Elements
A successful request for the CreateQualificationType
operation
includes the elements found in the following table:
Name | Description |
---|---|
|
The created Qualification type. Type: A QualificationType data structure. |
Examples
The following example shows how to use the CreateQualificationType
operation.
Sample Request
The following example creates a Qualification type.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=
[the Requester's Access Key ID]
&Version=2017-01-17 &Operation=CreateQualificationType &Signature=[signature for this request]
&Timestamp=[your system's local time]
&Name=EnglishWritingAbility &Description=The%20ability%20to%20write%20and%20edit%20text... &QualificationTypeStatus=Active
Sample Response
The following is an example response.
<CreateQualificationTypeResponse> <OperationRequest> <RequestId>5218189c-1d7e-49a3-abbf-672fb5e77c66</RequestId> </OperationRequest> <QualificationType> <Request> <IsValid>True</IsValid> </Request> <QualificationTypeId>ZSPJXD4F1SFZP7YNJWR0</QualificationTypeId> <CreationTime>2009-07-13T17:26:33Z</CreationTime> <Name>SampleQualificationTest</Name> <Description>Description of my qualification test.</Description> <QualificationTypeStatus>Active</QualificationTypeStatus> <AutoGranted>0</AutoGranted> </QualificationType> </CreateQualificationTypeResponse>