Skip to content

NotificationSpecification

Used by
Source code in docs_src/capo_mturk/types/notification_specification.py 
15
16
17
18
19
20
21
22
23
class NotificationSpecification(TypedDict, closed=True):
    destination: "capo_mturk.types.string.String"
    """<p> The target for notification messages. The Destination’s format is determined by the specified Transport: </p> <ul> <li> <p>When Transport is Email, the Destination is your email address.</p> </li> <li> <p>When Transport is SQS, the Destination is your queue URL.</p> </li> <li> <p>When Transport is SNS, the Destination is the ARN of your topic.</p> </li> </ul>"""
    transport: "capo_mturk.types.notification_transport.NotificationTransport"
    """<p> The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS. </p>"""
    version: "capo_mturk.types.string.String"
    """<p>The version of the Notification API to use. Valid value is 2006-05-05.</p>"""
    event_types: "capo_mturk.types.event_type_list.EventTypeList"
    """<p> 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. </p>"""

destination instance-attribute 

destination: String

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.

event_types instance-attribute 

event_types: EventTypeList

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.

transport instance-attribute 

transport: NotificationTransport

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

version instance-attribute 

version: String

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