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

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

data NotifyWorkers Source #

See: newNotifyWorkers smart constructor.

Constructors

NotifyWorkers' 

Fields

  • subject :: Text

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

  • messageText :: Text

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

  • workerIds :: [Text]

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

Instances

Instances details
Eq NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Read NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Show NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Generic NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Associated Types

type Rep NotifyWorkers :: Type -> Type #

NFData NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Methods

rnf :: NotifyWorkers -> () #

Hashable NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

ToJSON NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

AWSRequest NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Associated Types

type AWSResponse NotifyWorkers #

ToHeaders NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

ToPath NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

ToQuery NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

type Rep NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

type Rep NotifyWorkers = D1 ('MetaData "NotifyWorkers" "Amazonka.MechanicalTurk.NotifyWorkers" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "NotifyWorkers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "messageText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workerIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))
type AWSResponse NotifyWorkers Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

newNotifyWorkers Source #

Create a value of NotifyWorkers 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:subject:NotifyWorkers', notifyWorkers_subject - The subject line of the email message to send. Can include up to 200 characters.

$sel:messageText:NotifyWorkers', notifyWorkers_messageText - The text of the email message to send. Can include up to 4,096 characters

$sel:workerIds:NotifyWorkers', notifyWorkers_workerIds - A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.

Request Lenses

notifyWorkers_subject :: Lens' NotifyWorkers Text Source #

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

notifyWorkers_messageText :: Lens' NotifyWorkers Text Source #

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

notifyWorkers_workerIds :: 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

data NotifyWorkersResponse Source #

See: newNotifyWorkersResponse smart constructor.

Constructors

NotifyWorkersResponse' 

Fields

Instances

Instances details
Eq NotifyWorkersResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Read NotifyWorkersResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Show NotifyWorkersResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Generic NotifyWorkersResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Associated Types

type Rep NotifyWorkersResponse :: Type -> Type #

NFData NotifyWorkersResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

Methods

rnf :: NotifyWorkersResponse -> () #

type Rep NotifyWorkersResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.NotifyWorkers

type Rep NotifyWorkersResponse = D1 ('MetaData "NotifyWorkersResponse" "Amazonka.MechanicalTurk.NotifyWorkers" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "NotifyWorkersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notifyWorkersFailureStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NotifyWorkersFailureStatus])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newNotifyWorkersResponse Source #

Create a value of NotifyWorkersResponse 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:notifyWorkersFailureStatuses:NotifyWorkersResponse', notifyWorkersResponse_notifyWorkersFailureStatuses - When MTurk sends notifications to the list of Workers, it returns back any failures it encounters in this list of NotifyWorkersFailureStatus objects.

$sel:httpStatus:NotifyWorkersResponse', notifyWorkersResponse_httpStatus - The response's http status code.

Response Lenses

notifyWorkersResponse_notifyWorkersFailureStatuses :: Lens' NotifyWorkersResponse (Maybe [NotifyWorkersFailureStatus]) Source #

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