|
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 |
SendTestEventNotification
Description
The SendTestEventNotification operation causes Amazon Mechanical
Turk to send a notification message as if a HIT event occurred, according to the
provided notification specification.
This allows you to test notifications without setting up notifications for a real HIT type and trying to trigger them
using the website.
When you call this operation, the service sends the test notification immediately.
Request Parameters
The SendTestEventNotification 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 SendTestEventNotification operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation. Type: String Valid Values: SendTestEventNotification Default: None |
Yes |
|
|
The notification specification to test. This value is identical to the value you would provide to the SetHITTypeNotification operation when you establish the notification specification for a HIT type. Type: a Notification data structure Default: None |
Yes |
|
|
The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event. Type: an Default: None |
Yes |
Response Elements
A successful request for the SendTestEventNotification 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 SendTestEventNotification operation.
Sample Request
The following example sends a notification message for a simulated AssignmentSubmitted event to an email address.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Operation=SendTestEventNotification &Signature=[signature for this request]&Timestamp=[your system's local time]&Notification.1.Destination=janedoe@example.com &Notification.1.Transport=Email &Notification.1.Version=2006-05-05 &Notification.1.EventType=AssignmentSubmitted &TestEventType=AssignmentSubmitted
Sample Response
The following is an example response.
<SendTestEventNotificationResult> <Request> <IsValid>True</IsValid> </Request> </SendTestEventNotificationResult>
