MTurk / Client / send_test_event_notification

send_test_event_notification#

MTurk.Client.send_test_event_notification(**kwargs)#

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 attempts to send the test notification immediately.

See also: AWS API Documentation

Request Syntax

response = client.send_test_event_notification(
    Notification={
        'Destination': 'string',
        'Transport': 'Email'|'SQS'|'SNS',
        'Version': 'string',
        'EventTypes': [
            'AssignmentAccepted'|'AssignmentAbandoned'|'AssignmentReturned'|'AssignmentSubmitted'|'AssignmentRejected'|'AssignmentApproved'|'HITCreated'|'HITExpired'|'HITReviewable'|'HITExtended'|'HITDisposed'|'Ping',
        ]
    },
    TestEventType='AssignmentAccepted'|'AssignmentAbandoned'|'AssignmentReturned'|'AssignmentSubmitted'|'AssignmentRejected'|'AssignmentApproved'|'HITCreated'|'HITExpired'|'HITReviewable'|'HITExtended'|'HITDisposed'|'Ping'
)
Parameters:

  • Notification (dict) –

    [REQUIRED]

    The notification specification to test. This value is identical to the value you would provide to the UpdateNotificationSettings operation when you establish the notification specification for a HIT type.

    • Destination (string) – [REQUIRED]

      The target for notification messages. The Destination’s format is determined by the specified Transport:

      • When Transport is Email, the Destination is your email address.

      • When Transport is SQS, the Destination is your queue URL.

      • When Transport is SNS, the Destination is the ARN of your topic.

    • Transport (string) – [REQUIRED]

      The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.

    • Version (string) – [REQUIRED]

      The version of the Notification API to use. Valid value is 2006-05-05.

    • EventTypes (list) – [REQUIRED]

      The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation.

      • (string) –

  • TestEventType (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • MTurk.Client.exceptions.ServiceFault

  • MTurk.Client.exceptions.RequestError