Notification - 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.

 

Notification

Description

The Notification data structure describes a HIT event notification for a HIT type.

The Notification data structure is used as a parameter for the following operations:

Note

The latest Amazon Mechanical Turk WSDL includes deprecated notification transport signature protocols for backwards compatibility.

Elements

The Notification structure can contain the elements described in the following table. When the structure is used in a request, elements described as Required must be included for the request to succeed.

Name Description Required

Destination

The destination for notification messages.

Type:

  • For email notifications (if Transport is Email), this is an email address.

  • For Amazon Simple Queue Service (Amazon SQS) notifications (if Transport is SQS), this is the URL for your Amazon SQS queue. For more information, see Notification Handling Using Amazon SQS.

Default: None

Yes

Transport

The method Amazon Mechanical Turk uses to send the notification.

Type: String

Valid Values: Email | SQS

Default: None

Yes

Version

The version of the Notification API WSDL/schema, see WSDL and Schema Locations.

Type: String

Default: None

Yes

EventType

The events that should cause notifications to be sent. You can specify multiple events by repeating this element. The Ping event is only valid for the SendTestEventNotification operation.

Type: String

Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | HITReviewable | HITExpired | Ping

Default: None

Yes

Example

In the following example the notification specification specifies that an event notification message will be sent by email when a Worker returns or abandons a HIT and the message will use the 2006-05-05 version of the notification message schema. 


<Notification>
  <Destination>janedoe@example.com</Destination>
  <Transport>Email</Transport>
  <Version>2006-05-05</Version>
  <EventType>AssignmentAbandoned</EventType>
  <EventType>AssignmentReturned</EventType>
</Notification>