libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MechanicalTurk.Types.NotificationSpecification

Description

 
Synopsis

Documentation

data NotificationSpecification Source #

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

See: newNotificationSpecification smart constructor.

Constructors

NotificationSpecification' 

Fields

  • destination :: Text

    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.
  • transport :: NotificationTransport

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

  • version :: Text

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

  • eventTypes :: [EventType]

    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.

Instances

Instances details
Eq NotificationSpecification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.NotificationSpecification

Methods

(==) :: NotificationSpecification -> NotificationSpecification -> Bool #

(/=) :: NotificationSpecification -> NotificationSpecification -> Bool #

Read NotificationSpecification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.NotificationSpecification

Methods

readsPrec :: Int -> ReadS NotificationSpecification #

readList :: ReadS [NotificationSpecification] #

readPrec :: ReadPrec NotificationSpecification #

readListPrec :: ReadPrec [NotificationSpecification] #

Show NotificationSpecification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.NotificationSpecification

Methods

showsPrec :: Int -> NotificationSpecification -> ShowS #

show :: NotificationSpecification -> String #

showList :: [NotificationSpecification] -> ShowS #

Generic NotificationSpecification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.NotificationSpecification

Associated Types

type Rep NotificationSpecification :: Type -> Type #

Methods

from :: NotificationSpecification -> Rep NotificationSpecification x #

to :: Rep NotificationSpecification x -> NotificationSpecification #

NFData NotificationSpecification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.NotificationSpecification

Methods

rnf :: NotificationSpecification -> () #

Hashable NotificationSpecification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.NotificationSpecification

Methods

hashWithSalt :: Int -> NotificationSpecification -> Int #

hash :: NotificationSpecification -> Int #

ToJSON NotificationSpecification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.NotificationSpecification

Methods

toJSON :: NotificationSpecification -> Value #

toEncoding :: NotificationSpecification -> Encoding #

toJSONList :: [NotificationSpecification] -> Value #

toEncodingList :: [NotificationSpecification] -> Encoding #

type Rep NotificationSpecification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.NotificationSpecification

type Rep NotificationSpecification = D1 ('MetaData "NotificationSpecification" "Amazonka.MechanicalTurk.Types.NotificationSpecification" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "NotificationSpecification'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "transport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NotificationTransport)) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "eventTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EventType]))))

newNotificationSpecification Source #

Arguments

:: Text

$sel:destination:NotificationSpecification'

-> NotificationTransport

$sel:transport:NotificationSpecification'

-> Text

$sel:version:NotificationSpecification'

-> NotificationSpecification 

Create a value of NotificationSpecification with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:destination:NotificationSpecification', notificationSpecification_destination - 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.

$sel:transport:NotificationSpecification', notificationSpecification_transport - The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.

$sel:version:NotificationSpecification', notificationSpecification_version - The version of the Notification API to use. Valid value is 2006-05-05.

$sel:eventTypes:NotificationSpecification', notificationSpecification_eventTypes - 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.

notificationSpecification_destination :: Lens' NotificationSpecification Text Source #

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.

notificationSpecification_transport :: Lens' NotificationSpecification NotificationTransport Source #

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

notificationSpecification_version :: Lens' NotificationSpecification Text Source #

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

notificationSpecification_eventTypes :: Lens' NotificationSpecification [EventType] Source #

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.