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
  version: "String",
  event_types: ["AssignmentAccepted"], # 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 destination for notification messages. or email notifications (if Transport is Email), this is an email address. For Amazon Simple Queue Service (Amazon SQS) notifications (if Transport is SQS), this is the URL for your Amazon SQS queue.

Returns:

  • (String)


2106
2107
2108
2109
2110
2111
2112
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2106

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>)


2106
2107
2108
2109
2110
2111
2112
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2106

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.

Returns:

  • (String)


2106
2107
2108
2109
2110
2111
2112
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2106

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)


2106
2107
2108
2109
2110
2111
2112
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2106

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