View a markdown version of this page

QualificationType - Amazon Mechanical Turk
DescriptionElementsExample

Amazon Mechanical Turk will permanently close on September 30, 2026. For Workers and Requesters currently using the service, visit our Amazon Mechanical Turk help page to learn how you can prepare for this closure.

QualificationType

Description

The QualificationType data structure represents a Qualification type, a description of a property of a Worker that must match the requirements of a HIT for the Worker to be able to accept the HIT. The type also describes how a Worker can obtain a Qualification of that type, such as through a Qualification test.

The QualificationType data structure is used as a response element for the following operations:

  • CreateQualificationType

  • GetQualificationType

  • ListQualificationTypes

  • UpdateQualificationType

Elements

The QualificationType structure can contain the elements described in the following table:

Name Description Required

QualificationTypeId

A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation operation, and it retains that ID forever. Can be up to 255 bytes in length.

Type: String

Default: None

No

CreationTime

The date and time the Qualification type was created

Type: a dateTime structure in the Coordinated Universal Time (Greenwich Mean Time) time zone, such as 2005-01-31T23:59:59Z.

Default: None

No

Name

The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.

Type: String

Default: None

No

Description

A long description for the Qualification type.

Type: String

Default: None

No

Keywords

One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

Type: String

Default: None

No

QualificationTypeStatus

The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type.

Type: String

Valid Values: Active | Inactive

Default: None

No

RetryDelayInSeconds

The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score.

Type: positive integer

Default: None. If not specified, retries are disabled and Workers can request a Qualification only once.

No

Test

The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type.

Type: a QuestionForm data structure.

Note

A Qualification test cannot use an ExternalQuestionQuestionForm like a HIT can.

Default: None

Constraints: must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.

No

TestDurationInSeconds

The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

Type: positive integer

Default: None

No

AnswerKey

The answers to the Qualification test specified in the Test parameter.

Type: an AnswerKey data structure.

Default: None. If not provided with a test, the Qualification author must process the Qualification request manually.

No

AutoGranted

Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Type: Boolean

Valid Values: true | false

Default: None

Constraints: A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.

No

AutoGrantedValue

The Qualification value to use for automatically granted Qualifications, if AutoGranted is true.

Type: Integer

Default: 1

No

IsRequestable

Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is false for Qualifications assigned automatically by the system.

Type: Boolean

Valid Values: true | false

Default: None

No

Example

The following example shows a QualificationType data structure returned by a call to the ListQualificationTypes operation. The GetQualificationType operation returns a QualificationType element.


QualificationType:{
  QualificationTypeId:"789RVWYBAZW00EXAMPLE",
  CreationTime:"2005-01-31T23:59:59Z",
  Name:"EnglishWritingAbility",
  Description:"The ability to write and edit text...",
  Keywords:"English, text, write, edit, language",
  QualificationTypeStatus:"Active",
  RetryDelayInSeconds:86400,
  IsRequestable:true
}