« blib/lib/Paws/MTurk/CreateHITWithHITTypeResponse.pm
↑ Summary
blib/lib/Paws/MTurk/CreateQualificationTypeResponse.pm »
| 1 | |||
| 2 | package Paws::MTurk::CreateQualificationType; | ||
| 3 | use Moose; | ||
| 4 | has AnswerKey => (is => 'ro', isa => 'Str'); | ||
| 5 | has AutoGranted => (is => 'ro', isa => 'Bool'); | ||
| 6 | has AutoGrantedValue => (is => 'ro', isa => 'Int'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Keywords => (is => 'ro', isa => 'Str'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has QualificationTypeStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has RetryDelayInSeconds => (is => 'ro', isa => 'Int'); | ||
| 12 | has Test => (is => 'ro', isa => 'Str'); | ||
| 13 | has TestDurationInSeconds => (is => 'ro', isa => 'Int'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateQualificationType'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MTurk::CreateQualificationTypeResponse'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::MTurk::CreateQualificationType - Arguments for method CreateQualificationType on L<Paws::MTurk> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateQualificationType on the | ||
| 31 | L<Amazon Mechanical Turk|Paws::MTurk> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateQualificationType. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateQualificationType. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $mturk-requester = Paws->service('MTurk'); | ||
| 39 | my $CreateQualificationTypeResponse = | ||
| 40 | $mturk -requester->CreateQualificationType( | ||
| 41 | Description => 'MyString', | ||
| 42 | Name => 'MyString', | ||
| 43 | QualificationTypeStatus => 'Active', | ||
| 44 | AnswerKey => 'MyString', # OPTIONAL | ||
| 45 | AutoGranted => 1, # OPTIONAL | ||
| 46 | AutoGrantedValue => 1, # OPTIONAL | ||
| 47 | Keywords => 'MyString', # OPTIONAL | ||
| 48 | RetryDelayInSeconds => 1, # OPTIONAL | ||
| 49 | Test => 'MyString', # OPTIONAL | ||
| 50 | TestDurationInSeconds => 1, # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $QualificationType = $CreateQualificationTypeResponse->QualificationType; | ||
| 55 | |||
| 56 | # Returns a L<Paws::MTurk::CreateQualificationTypeResponse> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mturk-requester/CreateQualificationType> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 AnswerKey => Str | ||
| 65 | |||
| 66 | The answers to the Qualification test specified in the Test parameter, | ||
| 67 | in the form of an AnswerKey data structure. | ||
| 68 | |||
| 69 | Constraints: Must not be longer than 65535 bytes. | ||
| 70 | |||
| 71 | Constraints: None. If not specified, you must process Qualification | ||
| 72 | requests manually. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 AutoGranted => Bool | ||
| 77 | |||
| 78 | Specifies whether requests for the Qualification type are granted | ||
| 79 | immediately, without prompting the Worker with a Qualification test. | ||
| 80 | |||
| 81 | Constraints: If the Test parameter is specified, this parameter cannot | ||
| 82 | be true. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 AutoGrantedValue => Int | ||
| 87 | |||
| 88 | The Qualification value to use for automatically granted | ||
| 89 | Qualifications. This parameter is used only if the AutoGranted | ||
| 90 | parameter is true. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> Description => Str | ||
| 95 | |||
| 96 | A long description for the Qualification type. On the Amazon Mechanical | ||
| 97 | Turk website, the long description is displayed when a Worker examines | ||
| 98 | a Qualification type. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 Keywords => Str | ||
| 103 | |||
| 104 | One or more words or phrases that describe the Qualification type, | ||
| 105 | separated by commas. The keywords of a type make the type easier to | ||
| 106 | find during a search. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> Name => Str | ||
| 111 | |||
| 112 | The name you give to the Qualification type. The type name is used to | ||
| 113 | represent the Qualification to Workers, and to find the type using a | ||
| 114 | Qualification type search. It must be unique across all of your | ||
| 115 | Qualification types. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 B<REQUIRED> QualificationTypeStatus => Str | ||
| 120 | |||
| 121 | The initial status of the Qualification type. | ||
| 122 | |||
| 123 | Constraints: Valid values are: Active | Inactive | ||
| 124 | |||
| 125 | Valid values are: C<"Active">, C<"Inactive"> | ||
| 126 | |||
| 127 | =head2 RetryDelayInSeconds => Int | ||
| 128 | |||
| 129 | The number of seconds that a Worker must wait after requesting a | ||
| 130 | Qualification of the Qualification type before the worker can retry the | ||
| 131 | Qualification request. | ||
| 132 | |||
| 133 | Constraints: None. If not specified, retries are disabled and Workers | ||
| 134 | can request a Qualification of this type only once, even if the Worker | ||
| 135 | has not been granted the Qualification. It is not possible to disable | ||
| 136 | retries for a Qualification type after it has been created with retries | ||
| 137 | enabled. If you want to disable retries, you must delete existing | ||
| 138 | retry-enabled Qualification type and then create a new Qualification | ||
| 139 | type with retries disabled. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 Test => Str | ||
| 144 | |||
| 145 | The questions for the Qualification test a Worker must answer correctly | ||
| 146 | to obtain a Qualification of this type. If this parameter is specified, | ||
| 147 | C<TestDurationInSeconds> must also be specified. | ||
| 148 | |||
| 149 | Constraints: Must not be longer than 65535 bytes. Must be a | ||
| 150 | QuestionForm data structure. This parameter cannot be specified if | ||
| 151 | AutoGranted is true. | ||
| 152 | |||
| 153 | Constraints: None. If not specified, the Worker may request the | ||
| 154 | Qualification without answering any questions. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 TestDurationInSeconds => Int | ||
| 159 | |||
| 160 | The number of seconds the Worker has to complete the Qualification | ||
| 161 | test, starting from the time the Worker requests the Qualification. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | =head1 SEE ALSO | ||
| 167 | |||
| 168 | This class forms part of L<Paws>, documenting arguments for method CreateQualificationType in L<Paws::MTurk> | ||
| 169 | |||
| 170 | =head1 BUGS and CONTRIBUTIONS | ||
| 171 | |||
| 172 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 173 | |||
| 174 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 175 | |||
| 176 | =cut | ||
| 177 |