MTurk / Client / notify_workers

notify_workers#

MTurk.Client.notify_workers(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.notify_workers(
    Subject='string',
    MessageText='string',
    WorkerIds=[
        'string',
    ]
)
Parameters:

  • Subject (string) –

    [REQUIRED]

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

  • MessageText (string) –

    [REQUIRED]

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

  • WorkerIds (list) –

    [REQUIRED]

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

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NotifyWorkersFailureStatuses': [
        {
            'NotifyWorkersFailureCode': 'SoftFailure'|'HardFailure',
            'NotifyWorkersFailureMessage': 'string',
            'WorkerId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NotifyWorkersFailureStatuses (list) –

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

      • (dict) –

        When MTurk encounters an issue with notifying the Workers you specified, it returns back this object with failure details.

        • NotifyWorkersFailureCode (string) –

          Encoded value for the failure type.

        • NotifyWorkersFailureMessage (string) –

          A message detailing the reason the Worker could not be notified.

        • WorkerId (string) –

          The ID of the Worker.

Exceptions