Elements of a Notification Message - Amazon Mechanical Turk
The Notification API VersionEvents

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.

 

Elements of a Notification Message

Notification messages contain one or more Event data structures that describe recent activity for HITs of a HIT type.

The Notification API Version

Similar to how a REST request that is sent to the Amazon Mechanical Turk Requester service must include a Version parameter to indicate which version of the service API the client is expecting to use, a notification message must also include a Version parameter. This version string is identical to the version that is included in the notification specification for the HIT type.

Tip

Your application may need to accommodate receiving notification messages of different versions at the same time if you want to upgrade your notification specifications to a new version without missing messages. You can avoid having to accommodate multiple API versions by first disabling the notification specifications that use the old version, upgrading your application to use the new version, then updating the notification specifications to use the new version and re-enable notifications.

When a new version of the notification API is made available, all existing notification specifications will continue to use the API versions they were using previously. You must update your notification specifications to use a new version of the API.

Events

A notification message describes one or more events that happened in regards to a HIT type. Each event includes:

  • the event type (EventType), a value corresponding to the EventType value in the notification specification data structure

  • the time of the event (EventTime), as a dateTime in the Coordinated Universal Time time zone, such as 2005-01-31T23:59:59Z

  • the HIT type ID for the event (HITTypeId)

  • the HIT ID for the event (HITId)

  • the assignment ID for the event, if applicable (AssignmentId)

Multiple events may be batched into a single notification message.