GenerateNotification: Generate Notification

GenerateNotificationR Documentation

Generate Notification

Description

Generate a HITType Notification data structure for use in SetHITTypeNotification.

Usage

GenerateNotification(
  destination,
  transport = "Email",
  event.type,
  version = "2006-05-05"
)

Arguments

destination

Currently, a character string containing a complete email address (if transport="Email"), the SQS URL (if transport="SQS") or the SNS topic (if transport="SNS")

transport

Only “Email”, “SQS” and “SNS” are supported. AWS recommends the use of the SQS transport.

event.type

A character string containing one of: AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExtended, HITDisposed, HITReviewable, HITCreated, HITExtended, HITDisposed, HITReviewable, HITExpired (the default), or Ping.

version

Version of the HITType Notification API to use. Intended only for advanced users.

Details

Generate a Notification data structure for use in the notification option of SetHITTypeNotification.

Value

A dictionary object containing the Notification data structure.

Author(s)

Tyler Burleigh, Thomas J. Leeper

References

API Reference

API Reference: Concept

See Also

SetHITTypeNotification

SendTestEventNotification


pyMTurkR documentation built on May 29, 2024, 6:13 a.m.