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 |
UnblockWorker
Description
The UnblockWorker
operation allows you to reinstate a blocked
Worker to work on your HITs. This operation reverses the effects of the BlockWorker operation.
You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully.
Request Parameters
The UnblockWorker
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 UnblockWorker
operation:
Name | Description | Required |
---|---|---|
|
The name of the operation Type: String Valid Values: UnblockWorker Default: None |
Yes |
|
The ID of the Worker to unblock. Type: String Default: None |
Yes |
|
A message that explains the reason for unblocking the Worker. The Worker does not see this message. Type: String Default: None |
No |
Response Elements
A successful request for the UnblockWorker
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 UnblockWorker
operation.
Sample Request
The following example unblocks a Worker and allows that Worker to work on your HITs.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=
[the Requester's Access Key ID]
&Version=2017-01-17 &Operation=UnblockWorker &Signature=[signature for this request]
&Timestamp=[your system's local time]
&WorkerId=AZ3456EXAMPLE
Sample Response
The following is an example response.
<UnblockWorkerResult> <Request> <IsValid>True</IsValid> </Request> </UnblockWorkerResult>