amazonka-mechanicalturk-1.6.1: Amazon Mechanical Turk SDK.

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

Network.AWS.MechanicalTurk.NotifyWorkers

Contents

Description

The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker.

Synopsis

Creating a Request

notifyWorkers Source #

Creates a value of NotifyWorkers with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • nwSubject - The subject line of the email message to send. Can include up to 200 characters.
  • nwMessageText - The text of the email message to send. Can include up to 4,096 characters
  • nwWorkerIds - A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.

data NotifyWorkers Source #

See: notifyWorkers smart constructor.

Instances
Eq NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Data NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NotifyWorkers -> c NotifyWorkers #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NotifyWorkers #

toConstr :: NotifyWorkers -> Constr #

dataTypeOf :: NotifyWorkers -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NotifyWorkers) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NotifyWorkers) #

gmapT :: (forall b. Data b => b -> b) -> NotifyWorkers -> NotifyWorkers #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NotifyWorkers -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NotifyWorkers -> r #

gmapQ :: (forall d. Data d => d -> u) -> NotifyWorkers -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> NotifyWorkers -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NotifyWorkers -> m NotifyWorkers #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NotifyWorkers -> m NotifyWorkers #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NotifyWorkers -> m NotifyWorkers #

Read NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Show NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Generic NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Associated Types

type Rep NotifyWorkers :: Type -> Type #

Hashable NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

ToJSON NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

AWSRequest NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Associated Types

type Rs NotifyWorkers :: Type #

ToHeaders NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

ToPath NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

ToQuery NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

NFData NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Methods

rnf :: NotifyWorkers -> () #

type Rep NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

type Rep NotifyWorkers = D1 (MetaData "NotifyWorkers" "Network.AWS.MechanicalTurk.NotifyWorkers" "amazonka-mechanicalturk-1.6.1-GV5ehA4FkQY3BZvWX2sEC2" False) (C1 (MetaCons "NotifyWorkers'" PrefixI True) (S1 (MetaSel (Just "_nwSubject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_nwMessageText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_nwWorkerIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text]))))
type Rs NotifyWorkers Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Request Lenses

nwSubject :: Lens' NotifyWorkers Text Source #

The subject line of the email message to send. Can include up to 200 characters.

nwMessageText :: Lens' NotifyWorkers Text Source #

The text of the email message to send. Can include up to 4,096 characters

nwWorkerIds :: Lens' NotifyWorkers [Text] Source #

A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.

Destructuring the Response

notifyWorkersResponse Source #

Creates a value of NotifyWorkersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data NotifyWorkersResponse Source #

See: notifyWorkersResponse smart constructor.

Instances
Eq NotifyWorkersResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Data NotifyWorkersResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NotifyWorkersResponse -> c NotifyWorkersResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NotifyWorkersResponse #

toConstr :: NotifyWorkersResponse -> Constr #

dataTypeOf :: NotifyWorkersResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NotifyWorkersResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NotifyWorkersResponse) #

gmapT :: (forall b. Data b => b -> b) -> NotifyWorkersResponse -> NotifyWorkersResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NotifyWorkersResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NotifyWorkersResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> NotifyWorkersResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> NotifyWorkersResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NotifyWorkersResponse -> m NotifyWorkersResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NotifyWorkersResponse -> m NotifyWorkersResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NotifyWorkersResponse -> m NotifyWorkersResponse #

Read NotifyWorkersResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Show NotifyWorkersResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Generic NotifyWorkersResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Associated Types

type Rep NotifyWorkersResponse :: Type -> Type #

NFData NotifyWorkersResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

Methods

rnf :: NotifyWorkersResponse -> () #

type Rep NotifyWorkersResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.NotifyWorkers

type Rep NotifyWorkersResponse = D1 (MetaData "NotifyWorkersResponse" "Network.AWS.MechanicalTurk.NotifyWorkers" "amazonka-mechanicalturk-1.6.1-GV5ehA4FkQY3BZvWX2sEC2" False) (C1 (MetaCons "NotifyWorkersResponse'" PrefixI True) (S1 (MetaSel (Just "_nwrsNotifyWorkersFailureStatuses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [NotifyWorkersFailureStatus])) :*: S1 (MetaSel (Just "_nwrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

nwrsNotifyWorkersFailureStatuses :: Lens' NotifyWorkersResponse [NotifyWorkersFailureStatus] Source #

When MTurk sends notifications to the list of Workers, it returns back any failures it encounters in this list of NotifyWorkersFailureStatus objects.

nwrsResponseStatus :: Lens' NotifyWorkersResponse Int Source #

  • - | The response status code.