« blib/lib/Paws/MTurk/NotificationSpecification.pm
↑ Summary
blib/lib/Paws/MTurk/NotifyWorkersFailureStatus.pm »
| 1 | |||
| 2 | package Paws::MTurk::NotifyWorkers; | ||
| 3 | use Moose; | ||
| 4 | has MessageText => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Subject => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has WorkerIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'NotifyWorkers'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MTurk::NotifyWorkersResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::MTurk::NotifyWorkers - Arguments for method NotifyWorkers on L<Paws::MTurk> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method NotifyWorkers on the | ||
| 24 | L<Amazon Mechanical Turk|Paws::MTurk> service. Use the attributes of this class | ||
| 25 | as arguments to method NotifyWorkers. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to NotifyWorkers. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $mturk-requester = Paws->service('MTurk'); | ||
| 32 | my $NotifyWorkersResponse = $mturk -requester->NotifyWorkers( | ||
| 33 | MessageText => 'MyString', | ||
| 34 | Subject => 'MyString', | ||
| 35 | WorkerIds => [ | ||
| 36 | 'MyCustomerId', ... # min: 1, max: 64 | ||
| 37 | ], | ||
| 38 | |||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $NotifyWorkersFailureStatuses = | ||
| 43 | $NotifyWorkersResponse->NotifyWorkersFailureStatuses; | ||
| 44 | |||
| 45 | # Returns a L<Paws::MTurk::NotifyWorkersResponse> object. | ||
| 46 | |||
| 47 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mturk-requester/NotifyWorkers> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> MessageText => Str | ||
| 54 | |||
| 55 | The text of the email message to send. Can include up to 4,096 | ||
| 56 | characters | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> Subject => Str | ||
| 61 | |||
| 62 | The subject line of the email message to send. Can include up to 200 | ||
| 63 | characters. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> WorkerIds => ArrayRef[Str|Undef] | ||
| 68 | |||
| 69 | A list of Worker IDs you wish to notify. You can notify upto 100 | ||
| 70 | Workers at a time. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method NotifyWorkers in L<Paws::MTurk> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |