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

Description

The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. This allows you to test notifications without setting up notifications for a real HIT type and trying to trigger them using the website. When you call this operation, the service attempts to send the test notification immediately.

Synopsis

Creating a Request

data SendTestEventNotification Source #

See: newSendTestEventNotification smart constructor.

Constructors

SendTestEventNotification' 

Fields

  • notification :: NotificationSpecification

    The notification specification to test. This value is identical to the value you would provide to the UpdateNotificationSettings operation when you establish the notification specification for a HIT type.

  • testEventType :: EventType

    The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event.

Instances

Instances details
Eq SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

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

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

Read SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

readsPrec :: Int -> ReadS SendTestEventNotification #

readList :: ReadS [SendTestEventNotification] #

readPrec :: ReadPrec SendTestEventNotification #

readListPrec :: ReadPrec [SendTestEventNotification] #

Show SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

showsPrec :: Int -> SendTestEventNotification -> ShowS #

show :: SendTestEventNotification -> String #

showList :: [SendTestEventNotification] -> ShowS #

Generic SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Associated Types

type Rep SendTestEventNotification :: Type -> Type #

Methods

from :: SendTestEventNotification -> Rep SendTestEventNotification x #

to :: Rep SendTestEventNotification x -> SendTestEventNotification #

NFData SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

rnf :: SendTestEventNotification -> () #

Hashable SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

hashWithSalt :: Int -> SendTestEventNotification -> Int #

hash :: SendTestEventNotification -> Int #

ToJSON SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

toJSON :: SendTestEventNotification -> Value #

toEncoding :: SendTestEventNotification -> Encoding #

toJSONList :: [SendTestEventNotification] -> Value #

toEncodingList :: [SendTestEventNotification] -> Encoding #

AWSRequest SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Associated Types

type AWSResponse SendTestEventNotification #

Methods

request :: SendTestEventNotification -> Request SendTestEventNotification #

response :: MonadResource m => Logger -> Service -> Proxy SendTestEventNotification -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendTestEventNotification))) #

ToHeaders SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

toHeaders :: SendTestEventNotification -> [Header] #

ToPath SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

toPath :: SendTestEventNotification -> ByteString #

ToQuery SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

toQuery :: SendTestEventNotification -> QueryString #

type Rep SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

type Rep SendTestEventNotification = D1 ('MetaData "SendTestEventNotification" "Amazonka.MechanicalTurk.SendTestEventNotification" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "SendTestEventNotification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NotificationSpecification) :*: S1 ('MetaSel ('Just "testEventType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EventType)))
type AWSResponse SendTestEventNotification Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

type AWSResponse SendTestEventNotification = SendTestEventNotificationResponse

newSendTestEventNotification Source #

Arguments

:: NotificationSpecification

$sel:notification:SendTestEventNotification'

-> EventType

$sel:testEventType:SendTestEventNotification'

-> SendTestEventNotification 

Create a value of SendTestEventNotification 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:notification:SendTestEventNotification', sendTestEventNotification_notification - The notification specification to test. This value is identical to the value you would provide to the UpdateNotificationSettings operation when you establish the notification specification for a HIT type.

$sel:testEventType:SendTestEventNotification', sendTestEventNotification_testEventType - The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event.

Request Lenses

sendTestEventNotification_notification :: Lens' SendTestEventNotification NotificationSpecification Source #

The notification specification to test. This value is identical to the value you would provide to the UpdateNotificationSettings operation when you establish the notification specification for a HIT type.

sendTestEventNotification_testEventType :: Lens' SendTestEventNotification EventType Source #

The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event.

Destructuring the Response

data SendTestEventNotificationResponse Source #

See: newSendTestEventNotificationResponse smart constructor.

Constructors

SendTestEventNotificationResponse' 

Fields

Instances

Instances details
Eq SendTestEventNotificationResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

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

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

Read SendTestEventNotificationResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

readsPrec :: Int -> ReadS SendTestEventNotificationResponse #

readList :: ReadS [SendTestEventNotificationResponse] #

readPrec :: ReadPrec SendTestEventNotificationResponse #

readListPrec :: ReadPrec [SendTestEventNotificationResponse] #

Show SendTestEventNotificationResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

showsPrec :: Int -> SendTestEventNotificationResponse -> ShowS #

show :: SendTestEventNotificationResponse -> String #

showList :: [SendTestEventNotificationResponse] -> ShowS #

Generic SendTestEventNotificationResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Associated Types

type Rep SendTestEventNotificationResponse :: Type -> Type #

Methods

from :: SendTestEventNotificationResponse -> Rep SendTestEventNotificationResponse x #

to :: Rep SendTestEventNotificationResponse x -> SendTestEventNotificationResponse #

NFData SendTestEventNotificationResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

Methods

rnf :: SendTestEventNotificationResponse -> () #

type Rep SendTestEventNotificationResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.SendTestEventNotification

type Rep SendTestEventNotificationResponse = D1 ('MetaData "SendTestEventNotificationResponse" "Amazonka.MechanicalTurk.SendTestEventNotification" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "SendTestEventNotificationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendTestEventNotificationResponse Source #

Arguments

:: Int

$sel:httpStatus:SendTestEventNotificationResponse'

-> SendTestEventNotificationResponse 

Create a value of SendTestEventNotificationResponse 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:httpStatus:SendTestEventNotificationResponse', sendTestEventNotificationResponse_httpStatus - The response's http status code.

Response Lenses

sendTestEventNotificationResponse_httpStatus :: Lens' SendTestEventNotificationResponse Int Source #

The response's http status code.