Class: Aws::MTurk::Types::NotificationSpecification

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-mturk/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destinationString

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.

Returns:

  • (String)


1781
1782
1783
1784
1785
1786
1787
1788
# File 'lib/aws-sdk-mturk/types.rb', line 1781

class NotificationSpecification < Struct.new(
  :destination,
  :transport,
  :version,
  :event_types)
  SENSITIVE = []
  include Aws::Structure
end

#event_typesArray<String>

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.

Returns:

  • (Array<String>)


1781
1782
1783
1784
1785
1786
1787
1788
# File 'lib/aws-sdk-mturk/types.rb', line 1781

class NotificationSpecification < Struct.new(
  :destination,
  :transport,
  :version,
  :event_types)
  SENSITIVE = []
  include Aws::Structure
end

#transportString

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

Returns:

  • (String)


1781
1782
1783
1784
1785
1786
1787
1788
# File 'lib/aws-sdk-mturk/types.rb', line 1781

class NotificationSpecification < Struct.new(
  :destination,
  :transport,
  :version,
  :event_types)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

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

Returns:

  • (String)


1781
1782
1783
1784
1785
1786
1787
1788
# File 'lib/aws-sdk-mturk/types.rb', line 1781

class NotificationSpecification < Struct.new(
  :destination,
  :transport,
  :version,
  :event_types)
  SENSITIVE = []
  include Aws::Structure
end