|
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 |
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.
Note
The NotifyWorkers operation will send a notification email to a Worker
only if you have previously approved or rejected work from the Worker.
Request Parameters
The NotifyWorkers 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 NotifyWorkers
operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation Type: String Valid Values: NotifyWorkers Default: None |
Yes |
|
|
The subject line of the email message to send. Type: String Default: None Constraints: can include up to 200 characters. |
Yes |
|
|
The text of the email message to send Type: String Default: None Constraints: can include up to 4,096 characters |
Yes |
|
|
The ID of the Worker to notify, as returned by the GetAssignmentsForHIT operation. Type: String Default: None Constraints: You can repeat this parameter up to 100 times to notify multiple Workers. |
Yes |
Response Elements
A successful request for the NotifyWorkers 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 NotifyWorkers
operation.
Sample Request
The following example sends an email message to three Workers.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2017-01-17 &Operation=NotifyWorkers &Signature=[signature for this request]&Timestamp=[your system's local time]&Subject=Thank%20you &MessageText=Hello!%20Just%20wanted%20to%20say%20thank%20you... &WorkerId.1=AZ3123EXAMPLE &WorkerId.2=AZ3456EXAMPLE &WorkerId.3=AZ3789EXAMPLE
Sample Response
The following is an example response.
<NotifyWorkersResult> <Request> <IsValid>True</IsValid> </Request> </NotifyWorkersResult>
