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

Inherits:

Struct

• Object
• Struct
• Aws::MTurk::Types::NotificationSpecification

Defined in:

gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #destination ⇒ String

  The target for notification messages.

• #event_types ⇒ Array<String>

  The list of events that should cause notifications to be sent.

• #transport ⇒ String

  The method Amazon Mechanical Turk uses to send the notification.

• #version ⇒ String

  The version of the Notification API to use.

Instance Attribute Details

#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.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1781

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

#event_types ⇒ Array<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>)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1781

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

#transport ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1781

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

#version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1781

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