« blib/lib/Paws/MTurk/ListAssignmentsForHITResponse.pm
↑ Summary
blib/lib/Paws/MTurk/ListBonusPaymentsResponse.pm »
| 1 | |||
| 2 | package Paws::MTurk::ListBonusPayments; | ||
| 3 | use Moose; | ||
| 4 | has AssignmentId => (is => 'ro', isa => 'Str'); | ||
| 5 | has HITId => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListBonusPayments'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MTurk::ListBonusPaymentsResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::MTurk::ListBonusPayments - Arguments for method ListBonusPayments on L<Paws::MTurk> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListBonusPayments on the | ||
| 25 | L<Amazon Mechanical Turk|Paws::MTurk> service. Use the attributes of this class | ||
| 26 | as arguments to method ListBonusPayments. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListBonusPayments. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $mturk-requester = Paws->service('MTurk'); | ||
| 33 | my $ListBonusPaymentsResponse = $mturk -requester->ListBonusPayments( | ||
| 34 | AssignmentId => 'MyEntityId', # OPTIONAL | ||
| 35 | HITId => 'MyEntityId', # OPTIONAL | ||
| 36 | MaxResults => 1, # OPTIONAL | ||
| 37 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $BonusPayments = $ListBonusPaymentsResponse->BonusPayments; | ||
| 42 | my $NextToken = $ListBonusPaymentsResponse->NextToken; | ||
| 43 | my $NumResults = $ListBonusPaymentsResponse->NumResults; | ||
| 44 | |||
| 45 | # Returns a L<Paws::MTurk::ListBonusPaymentsResponse> 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/ListBonusPayments> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 AssignmentId => Str | ||
| 54 | |||
| 55 | The ID of the assignment associated with the bonus payments to | ||
| 56 | retrieve. If specified, only bonus payments for the given assignment | ||
| 57 | are returned. Either the HITId parameter or the AssignmentId parameter | ||
| 58 | must be specified | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 HITId => Str | ||
| 63 | |||
| 64 | The ID of the HIT associated with the bonus payments to retrieve. If | ||
| 65 | not specified, all bonus payments for all assignments for the given HIT | ||
| 66 | are returned. Either the HITId parameter or the AssignmentId parameter | ||
| 67 | must be specified | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 MaxResults => Int | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 NextToken => Str | ||
| 78 | |||
| 79 | Pagination token | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method ListBonusPayments in L<Paws::MTurk> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |