| 1 | |||
| 2 | package Paws::MTurk::SendBonus; | ||
| 3 | use Moose; | ||
| 4 | has AssignmentId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has BonusAmount => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Reason => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has UniqueRequestToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has WorkerId => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendBonus'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MTurk::SendBonusResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::MTurk::SendBonus - Arguments for method SendBonus on L<Paws::MTurk> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method SendBonus on the | ||
| 26 | L<Amazon Mechanical Turk|Paws::MTurk> service. Use the attributes of this class | ||
| 27 | as arguments to method SendBonus. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendBonus. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $mturk-requester = Paws->service('MTurk'); | ||
| 34 | my $SendBonusResponse = $mturk -requester->SendBonus( | ||
| 35 | AssignmentId => 'MyEntityId', | ||
| 36 | BonusAmount => 'MyCurrencyAmount', | ||
| 37 | Reason => 'MyString', | ||
| 38 | WorkerId => 'MyCustomerId', | ||
| 39 | UniqueRequestToken => 'MyIdempotencyToken', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mturk-requester/SendBonus> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> AssignmentId => Str | ||
| 49 | |||
| 50 | The ID of the assignment for which this bonus is paid. | ||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> BonusAmount => Str | ||
| 55 | |||
| 56 | The Bonus amount is a US Dollar amount specified using a string (for | ||
| 57 | example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). | ||
| 58 | Do not include currency symbols or currency codes. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Reason => Str | ||
| 63 | |||
| 64 | A message that explains the reason for the bonus payment. The Worker | ||
| 65 | receiving the bonus can see this message. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 UniqueRequestToken => Str | ||
| 70 | |||
| 71 | A unique identifier for this request, which allows you to retry the | ||
| 72 | call on error without granting multiple bonuses. This is useful in | ||
| 73 | cases such as network timeouts where it is unclear whether or not the | ||
| 74 | call succeeded on the server. If the bonus already exists in the system | ||
| 75 | from a previous call using the same UniqueRequestToken, subsequent | ||
| 76 | calls will return an error with a message containing the request ID. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> WorkerId => Str | ||
| 81 | |||
| 82 | The ID of the Worker being paid the bonus. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head1 SEE ALSO | ||
| 88 | |||
| 89 | This class forms part of L<Paws>, documenting arguments for method SendBonus in L<Paws::MTurk> | ||
| 90 | |||
| 91 | =head1 BUGS and CONTRIBUTIONS | ||
| 92 | |||
| 93 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 94 | |||
| 95 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 96 | |||
| 97 | =cut | ||
| 98 |