File Coverage

blib/lib/Paws/MTurk/SendBonus.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::MTurk::SendBonus;
3 1     1   633 use Moose;
  1         5  
  1         12  
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 1     1   11173 use MooseX::ClassAttribute;
  1         7  
  1         13  
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 Paws::MTurk
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method SendBonus on the
26             Amazon Mechanical Turk 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             As an example:
32              
33             $service_obj->SendBonus(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 B<REQUIRED> AssignmentId => Str
41              
42             The ID of the assignment for which this bonus is paid.
43              
44              
45              
46             =head2 B<REQUIRED> BonusAmount => Str
47              
48             The Bonus amount is a US Dollar amount specified using a string (for
49             example, "5" represents $5.00 USD and "101.42" represents $101.42 USD).
50             Do not include currency symbols or currency codes.
51              
52              
53              
54             =head2 B<REQUIRED> Reason => Str
55              
56             A message that explains the reason for the bonus payment. The Worker
57             receiving the bonus can see this message.
58              
59              
60              
61             =head2 UniqueRequestToken => Str
62              
63             A unique identifier for this request, which allows you to retry the
64             call on error without granting multiple bonuses. This is useful in
65             cases such as network timeouts where it is unclear whether or not the
66             call succeeded on the server. If the bonus already exists in the system
67             from a previous call using the same UniqueRequestToken, subsequent
68             calls will return an error with a message containing the request ID.
69              
70              
71              
72             =head2 B<REQUIRED> WorkerId => Str
73              
74             The ID of the Worker being paid the bonus.
75              
76              
77              
78              
79             =head1 SEE ALSO
80              
81             This class forms part of L<Paws>, documenting arguments for method SendBonus in L<Paws::MTurk>
82              
83             =head1 BUGS and CONTRIBUTIONS
84              
85             The source code is located here: https://github.com/pplu/aws-sdk-perl
86              
87             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
88              
89             =cut
90