Menu
Amazon Mechanical Turk
API Reference (API Version 2017-01-17)

In 2017 Amazon Mechanical Turk (MTurk) launched support for the AWS Software Development Kits (SDKs). This gives more tool choices to MTurk Requester customers as you can now choose from nine new SDKs that are already widely used in the AWS community. The MTurk API can now be accessed using the following AWS SDKs: Python/Boto (Boto3), Javascript (NodeJS or Browser), Java, .NET, Go, Ruby, PHP or C++. This also makes it easier for customers to connect MTurk with other AWS services like S3, Lambda, Step Functions, Lex, Polly, Rekognition, Amazon Machine Learning, AWS Batch, EC2, and many more. As part of this launch, MTurk also released a new version of the Requester API (version: ‘2017–01–17’). This version significantly 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 with the SOAP protocol. These changes make the MTurk API consistent with other AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. You are browsing the API reference for this new release. Customers using the previous version of our API ('2014-08-15') with Mechanical Turk SDKs will not be affected by this change and can continue to operate as before. You can find the all the documentation for that version of the API here.

NotifyWorkers

Description

The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker.

Request Syntax

Copy
{ "Subject": String, "MessageText": String, "WorkerIds": Array of Strings }

Request Parameters

The request accepts the following data in JSON format:

Name Description Required

Subject

The subject line of the email message to send. Can include up to 200 characters.

Type: String

Yes

MessageText

The text of the email message to send. Can include up to 4,096 characters.

Type: String

Yes

WorkerIds

An array of WorkerIds to notify. You can notify upto 100 Workers at a time.

Type: Array of Strings

Yes

Response Elements

A successful request for the NotifyWorkers operation returns with no errors and an empty body.