You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass NotificationSpecification data as a hash:

{
  destination: "String", # required
  transport: "Email", # required, accepts Email, SQS, SNS
  version: "String", # required
  event_types: ["AssignmentAccepted"], # required, accepts AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping
}

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

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)


2110
2111
2112
2113
2114
2115
2116
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2110

class NotificationSpecification < Struct.new(
  :destination,
  :transport,
  :version,
  :event_types)
  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>)


2110
2111
2112
2113
2114
2115
2116
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2110

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

#transportString

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

Returns:

  • (String)


2110
2111
2112
2113
2114
2115
2116
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2110

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

#versionString

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

Returns:

  • (String)


2110
2111
2112
2113
2114
2115
2116
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2110

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