AssignQualification - 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.

 

AssignQualification

Description

The AssignQualification operation gives a Worker a Qualification. AssignQualification 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).

Tip

AssignQualification 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.

Request Parameters

The AssignQualification operation accepts parameters common to all operations. Some common parameters are required. See CommonParameters for more information.

The following parameters are specific to the AssignQualification operation:

Name Description Required

Operation

The name of the operation

Type: String

Valid Values: AssignQualifcation

Default: None

Yes

QualificationTypeId

The ID of the Qualification type to use for the assigned Qualification.

Type: String

Default: None

Constraints: must be a valid Qualification type ID, as returned by the CreateQualificationType operation.

Yes

WorkerId

The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT assignments and Qualification requests.

Type: String

Default: None

Yes

IntegerValue

The value of the Qualification to assign.

Type: Integer

Default: 1

No

SendNotification

Specifies whether to send a notification email message to the Worker saying that the qualification was assigned to the Worker.

Type: Boolean

Valid Values: true | false.

Default: true

No

Response Elements

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

Name Description

AssignQualificationResult

Contains a Request element if the Request ResponseGroup is specified.

Examples

The following example shows how to use the AssignQualification operation.

Sample Request

The following example assigns a Qualification of a specified type to a Worker with the specified ID, using the specified Qualification value. By default, Amazon Mechanical Turk sends the Worker an e-mail message saying that the Worker has received the Qualification.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID] &Version=2017-01-17 &Operation=AssignQualification &Signature=[signature for this request] &Timestamp=[your system's local time] &QualificationTypeId=789RVWYBAZW00EXAMPLE &WorkerId=AZ3456EXAMPLE &IntegerValue=800

Sample Response

The following is an example response.

<AssignQualificationResult> <Request> <IsValid>True</IsValid> </Request> </AssignQualificationResult>