Network.AWS.MechanicalTurk.NotifyWorkers

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.

Creating a Request

notifyWorkers

Arguments

:: Text

nwSubject

-> Text

nwMessageText

-> NotifyWorkers

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

See: notifyWorkers smart constructor.

Instances

Eq NotifyWorkers

Methods

(==) :: NotifyWorkers -> NotifyWorkers -> Bool

(/=) :: NotifyWorkers -> NotifyWorkers -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS NotifyWorkers

readList :: ReadS [NotifyWorkers]

readPrec :: ReadPrec NotifyWorkers

readListPrec :: ReadPrec [NotifyWorkers]

Show NotifyWorkers

Methods

showsPrec :: Int -> NotifyWorkers -> ShowS

show :: NotifyWorkers -> String

showList :: [NotifyWorkers] -> ShowS

Generic NotifyWorkers

Associated Types

type Rep NotifyWorkers :: * -> *

Methods

from :: NotifyWorkers -> Rep NotifyWorkers x

to :: Rep NotifyWorkers x -> NotifyWorkers

Hashable NotifyWorkers

Methods

hashWithSalt :: Int -> NotifyWorkers -> Int

hash :: NotifyWorkers -> Int

ToJSON NotifyWorkers

Methods

toJSON :: NotifyWorkers -> Value

toEncoding :: NotifyWorkers -> Encoding

toJSONList :: [NotifyWorkers] -> Value

toEncodingList :: [NotifyWorkers] -> Encoding

NFData NotifyWorkers

Methods

rnf :: NotifyWorkers -> ()

AWSRequest NotifyWorkers

Associated Types

type Rs NotifyWorkers :: *

Methods

request :: NotifyWorkers -> Request NotifyWorkers

response :: MonadResource m => Logger -> Service -> Proxy * NotifyWorkers -> ClientResponse -> m (Response NotifyWorkers)

ToQuery NotifyWorkers

Methods

toQuery :: NotifyWorkers -> QueryString

ToPath NotifyWorkers

Methods

toPath :: NotifyWorkers -> ByteString

ToHeaders NotifyWorkers

Methods

toHeaders :: NotifyWorkers -> [Header]

type Rep NotifyWorkers

type Rep NotifyWorkers = D1 (MetaData "NotifyWorkers" "Network.AWS.MechanicalTurk.NotifyWorkers" "amazonka-mechanicalturk-1.5.0-FaPkjSp7Fzg9knquA94uxS" False) (C1 (MetaCons "NotifyWorkers'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_nwSubject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_nwMessageText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_nwWorkerIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])))))

type Rs NotifyWorkers

type Rs NotifyWorkers = NotifyWorkersResponse

Request Lenses

nwSubject :: Lens' NotifyWorkers Text

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

nwMessageText :: Lens' NotifyWorkers Text

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

nwWorkerIds :: Lens' NotifyWorkers [Text]

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

Destructuring the Response

notifyWorkersResponse

Arguments

:: Int

nwrsResponseStatus

-> NotifyWorkersResponse

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:

• nwrsNotifyWorkersFailureStatuses - When MTurk sends notifications to the list of Workers, it returns back any failures it encounters in this list of NotifyWorkersFailureStatus objects.
• nwrsResponseStatus - -- | The response status code.

data NotifyWorkersResponse

See: notifyWorkersResponse smart constructor.

Instances

Eq NotifyWorkersResponse

Methods

(==) :: NotifyWorkersResponse -> NotifyWorkersResponse -> Bool

(/=) :: NotifyWorkersResponse -> NotifyWorkersResponse -> Bool

Data NotifyWorkersResponse

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

Methods

readsPrec :: Int -> ReadS NotifyWorkersResponse

readList :: ReadS [NotifyWorkersResponse]

readPrec :: ReadPrec NotifyWorkersResponse

readListPrec :: ReadPrec [NotifyWorkersResponse]

Show NotifyWorkersResponse

Methods

showsPrec :: Int -> NotifyWorkersResponse -> ShowS

show :: NotifyWorkersResponse -> String

showList :: [NotifyWorkersResponse] -> ShowS

Generic NotifyWorkersResponse

Associated Types

type Rep NotifyWorkersResponse :: * -> *

Methods

from :: NotifyWorkersResponse -> Rep NotifyWorkersResponse x

to :: Rep NotifyWorkersResponse x -> NotifyWorkersResponse

NFData NotifyWorkersResponse

Methods

rnf :: NotifyWorkersResponse -> ()

type Rep NotifyWorkersResponse

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

Response Lenses

nwrsNotifyWorkersFailureStatuses :: Lens' NotifyWorkersResponse [NotifyWorkersFailureStatus]

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

• - | The response status code.