WorkerBlock - Amazon Mechanical Turk
DescriptionElementsExample

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.

 

WorkerBlock

Description

The WorkerBlock data structure represents a Worker who has been blocked. It has two elements: the WorkerId and the Reason for the block.

The WorkerBlock data structure is used in the results of the following operation:

Elements

The WorkerBlock structure contains the elements described in the following table.

Name Description

WorkerId

The ID of the Worker who accepted the HIT.

Type: String

Default: None

Reason

A message explaining the reason the Worker was blocked.

Type: String

Default: None

Example

The following example shows a sample WorkerBlock data structure in a response from the GetBlockedWorkers operation.

In a SOAP request, the WorkerBlock data structure is specified as the WorkerBlock parameter in XML: 

<WorkerBlock>
  <WorkerId>AZ3456EXAMPLE</WorkerId>
  <Reason>After several  warnings, he continued to submit answers without reading the instructions carefully.</Reason>
</WorkerBlock>

In a REST request, the components of the WorkerBlock data structure are specified as separate parameters:

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
[...]
&WorkerBlock.1.WorkerId=AZ3456EXAMPLE
&WorkerBlock.1.Reason=After%20several%20warnings,%20he%20continued%20to%20submit%20answers%20without%20reading%20the%20instructions%20carefully