|
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 |
BlockWorker
Description
The BlockWorker operation allows you to prevent a Worker from
working on your HITs. For example, you can block a Worker who is producing poor quality
work. You can block up to 100,000 Workers.
Note
BlockWorker prevents a Worker from accepting more of your HITs after you block them. However,
BlockWorker does not prevent a Worker from submitting
assignments that they accepted before you blocked them.
You need the Worker ID to use this operation. You can get the Worker ID in the assignment data returned by a call to the GetAssignmentsForHIT operation. If the Worker ID is missing or invalid, this operation returns with the failure message "WorkerId is invalid." If the Worker is already blocked, this operation returns successfully.
Request Parameters
The BlockWorker 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 BlockWorker
operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation Type: String Valid Values: BlockWorker Default: None |
Yes |
|
|
The ID of the Worker to block. Type: String Default: None |
Yes |
|
|
A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message. Type: String Default: None |
Yes |
Response Elements
A successful request for the BlockWorker operation returns with
no errors. The response includes the elements described in the following table. The
operation returns no other data.
| Name | Description |
|---|---|
|
|
Contains a |
Examples
The following example shows how to use the BlockWorker
operation.
Sample Request
The following example blocks a Worker from working on your HITs.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2017-01-17 &Operation=BlockWorker &Signature=[signature for this request]&Timestamp=[your system's local time]&WorkerId=AZ3456EXAMPLE &Reason=After%20several%20warnings,%20he%20continued%20to%20submit%20answers%20without%20reading%20the%20instructions%20carefully.
Sample Response
The following is an example response.
<BlockWorkerResult> <Request> <IsValid>True</IsValid> </Request> </BlockWorkerResult>
Related Operations
To unblock a Worker use the UnblockWorker operation.
