« blib/lib/Paws/MTurk/ListQualificationTypesResponse.pm
↑ Summary
blib/lib/Paws/MTurk/ListReviewPolicyResultsForHITResponse.pm »
| 1 | |||
| 2 | package Paws::MTurk::ListReviewPolicyResultsForHIT; | ||
| 3 | use Moose; | ||
| 4 | has HITId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has PolicyLevels => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has RetrieveActions => (is => 'ro', isa => 'Bool'); | ||
| 9 | has RetrieveResults => (is => 'ro', isa => 'Bool'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListReviewPolicyResultsForHIT'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MTurk::ListReviewPolicyResultsForHITResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::MTurk::ListReviewPolicyResultsForHIT - Arguments for method ListReviewPolicyResultsForHIT on L<Paws::MTurk> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListReviewPolicyResultsForHIT on the | ||
| 27 | L<Amazon Mechanical Turk|Paws::MTurk> service. Use the attributes of this class | ||
| 28 | as arguments to method ListReviewPolicyResultsForHIT. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListReviewPolicyResultsForHIT. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $mturk-requester = Paws->service('MTurk'); | ||
| 35 | my $ListReviewPolicyResultsForHITResponse = | ||
| 36 | $mturk -requester->ListReviewPolicyResultsForHIT( | ||
| 37 | HITId => 'MyEntityId', | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 40 | PolicyLevels => [ | ||
| 41 | 'Assignment', ... # values: Assignment, HIT | ||
| 42 | ], # OPTIONAL | ||
| 43 | RetrieveActions => 1, # OPTIONAL | ||
| 44 | RetrieveResults => 1, # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $AssignmentReviewPolicy = | ||
| 49 | $ListReviewPolicyResultsForHITResponse->AssignmentReviewPolicy; | ||
| 50 | my $AssignmentReviewReport = | ||
| 51 | $ListReviewPolicyResultsForHITResponse->AssignmentReviewReport; | ||
| 52 | my $HITId = $ListReviewPolicyResultsForHITResponse->HITId; | ||
| 53 | my $HITReviewPolicy = | ||
| 54 | $ListReviewPolicyResultsForHITResponse->HITReviewPolicy; | ||
| 55 | my $HITReviewReport = | ||
| 56 | $ListReviewPolicyResultsForHITResponse->HITReviewReport; | ||
| 57 | my $NextToken = $ListReviewPolicyResultsForHITResponse->NextToken; | ||
| 58 | |||
| 59 | # Returns a L<Paws::MTurk::ListReviewPolicyResultsForHITResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mturk-requester/ListReviewPolicyResultsForHIT> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> HITId => Str | ||
| 68 | |||
| 69 | The unique identifier of the HIT to retrieve review results for. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 MaxResults => Int | ||
| 74 | |||
| 75 | Limit the number of results returned. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 NextToken => Str | ||
| 80 | |||
| 81 | Pagination token | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 PolicyLevels => ArrayRef[Str|Undef] | ||
| 86 | |||
| 87 | The Policy Level(s) to retrieve review results for - HIT or Assignment. | ||
| 88 | If omitted, the default behavior is to retrieve all data for both | ||
| 89 | policy levels. For a list of all the described policies, see Review | ||
| 90 | Policies. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 RetrieveActions => Bool | ||
| 95 | |||
| 96 | Specify if the operation should retrieve a list of the actions taken | ||
| 97 | executing the Review Policies and their outcomes. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 RetrieveResults => Bool | ||
| 102 | |||
| 103 | Specify if the operation should retrieve a list of the results computed | ||
| 104 | by the Review Policies. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, documenting arguments for method ListReviewPolicyResultsForHIT in L<Paws::MTurk> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |