Skip to main content

qualification_types

Creates, updates, deletes, gets or lists a qualification_types resource.

Overview​

Namequalification_types
TypeResource
Idaws.mturk.qualification_types

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
answer_keystringThe answers to the Qualification test specified in the Test parameter.
auto_grantedbooleanSpecifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.
auto_granted_valueintegerThe Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.
creation_timestring (date-time)The date and time the Qualification type was created.
descriptionstringA long description for the Qualification type.
is_requestablebooleanSpecifies 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. Valid values are True | False.
keywordsstringOne or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.
namestringThe name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.
qualification_type_idstringA unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation. (pattern: <code>^[A-Z0-9]+$</code>)
qualification_type_statusstringThe 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. Valid values are Active | Inactive. (Active, Inactive)
retry_delay_in_secondsinteger (int64)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. If not specified, retries are disabled and Workers can request a Qualification only once.
teststringThe questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.
test_duration_in_secondsinteger (int64)The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_qualification_typeselectregionThe GetQualificationTypeoperation retrieves information about a Qualification type using its ID.
list_qualification_typesselectregionThe ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.
create_qualification_typeinsertregion, QualificationTypeStatusThe CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.
associate_qualification_with_workerupdateregion, QualificationTypeId, WorkerIdThe AssociateQualificationWithWorker operation gives a Worker a Qualification. AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It gives the Qualification directly to the Worker. You can only assign a Qualification of a Qualification type that you created (using the CreateQualificationType operation). Note: AssociateQualificationWithWorker does not affect any pending Qualification requests for the Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending Qualification request without affecting the Qualification the Worker already has, reject the request with the RejectQualificationRequest operation.
update_qualification_typeupdateregion, QualificationTypeIdThe UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes. Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries. You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key. If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test. If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values. If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually. You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.
delete_qualification_typedeleteregionThe DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type. This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types. DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType.
disassociate_qualification_from_workerexecregion, WorkerId, QualificationTypeIdThe DisassociateQualificationFromWorker revokes a previously granted Qualification from a user. You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

The GetQualificationTypeoperation retrieves information about a Qualification type using its ID.

SELECT
answer_key,
auto_granted,
auto_granted_value,
creation_time,
description,
is_requestable,
keywords,
name,
qualification_type_id,
qualification_type_status,
retry_delay_in_seconds,
test,
test_duration_in_seconds
FROM aws.mturk.qualification_types
WHERE region = '{{ region }}' -- required
;

INSERT examples​

The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.

INSERT INTO aws.mturk.qualification_types (
Name,
Keywords,
Description,
QualificationTypeStatus,
RetryDelayInSeconds,
Test,
AnswerKey,
TestDurationInSeconds,
AutoGranted,
AutoGrantedValue,
region
)
SELECT 
'{{ Name }}',
'{{ Keywords }}',
'{{ Description }}',
'{{ QualificationTypeStatus }}' /* required */,
{{ RetryDelayInSeconds }},
'{{ Test }}',
'{{ AnswerKey }}',
{{ TestDurationInSeconds }},
{{ AutoGranted }},
{{ AutoGrantedValue }},
'{{ region }}'
RETURNING
qualification_type
;

UPDATE examples​

The AssociateQualificationWithWorker operation gives a Worker a Qualification. AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It gives the Qualification directly to the Worker. You can only assign a Qualification of a Qualification type that you created (using the CreateQualificationType operation). Note: AssociateQualificationWithWorker does not affect any pending Qualification requests for the Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending Qualification request without affecting the Qualification the Worker already has, reject the request with the RejectQualificationRequest operation.

UPDATE aws.mturk.qualification_types
SET 
QualificationTypeId = '{{ QualificationTypeId }}',
WorkerId = '{{ WorkerId }}',
IntegerValue = {{ IntegerValue }},
SendNotification = {{ SendNotification }}
WHERE 
region = '{{ region }}' --required
AND QualificationTypeId = '{{ QualificationTypeId }}' --required
AND WorkerId = '{{ WorkerId }}' --required;

DELETE examples​

The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type. This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types. DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType.

DELETE FROM aws.mturk.qualification_types
WHERE region = '{{ region }}' --required
;

Lifecycle Methods​

The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user. You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message.

EXEC aws.mturk.qualification_types.disassociate_qualification_from_worker 
@region='{{ region }}' --required 
@@json=
'{
"WorkerId": "{{ WorkerId }}", 
"QualificationTypeId": "{{ QualificationTypeId }}", 
"Reason": "{{ Reason }}"
}'
;
Last updated on