aws-sdk-mturk 1.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
File without changes
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::MTurk
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::MTurk
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,3107 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::MTurk
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass AcceptQualificationRequestRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # qualification_request_id: "String", # required
16
+ # integer_value: 1,
17
+ # }
18
+ #
19
+ # @!attribute [rw] qualification_request_id
20
+ # The ID of the Qualification request, as returned by the
21
+ # `GetQualificationRequests` operation.
22
+ # @return [String]
23
+ #
24
+ # @!attribute [rw] integer_value
25
+ # The value of the Qualification. You can omit this value if you are
26
+ # using the presence or absence of the Qualification as the basis for
27
+ # a HIT requirement.
28
+ # @return [Integer]
29
+ #
30
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/AcceptQualificationRequestRequest AWS API Documentation
31
+ #
32
+ class AcceptQualificationRequestRequest < Struct.new(
33
+ :qualification_request_id,
34
+ :integer_value)
35
+ include Aws::Structure
36
+ end
37
+
38
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/AcceptQualificationRequestResponse AWS API Documentation
39
+ #
40
+ class AcceptQualificationRequestResponse < Aws::EmptyStructure; end
41
+
42
+ # @note When making an API call, you may pass ApproveAssignmentRequest
43
+ # data as a hash:
44
+ #
45
+ # {
46
+ # assignment_id: "EntityId", # required
47
+ # requester_feedback: "String",
48
+ # override_rejection: false,
49
+ # }
50
+ #
51
+ # @!attribute [rw] assignment_id
52
+ # The ID of the assignment. The assignment must correspond to a HIT
53
+ # created by the Requester.
54
+ # @return [String]
55
+ #
56
+ # @!attribute [rw] requester_feedback
57
+ # A message for the Worker, which the Worker can see in the Status
58
+ # section of the web site.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] override_rejection
62
+ # A flag indicating that an assignment should be approved even if it
63
+ # was previously rejected. Defaults to `False`.
64
+ # @return [Boolean]
65
+ #
66
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ApproveAssignmentRequest AWS API Documentation
67
+ #
68
+ class ApproveAssignmentRequest < Struct.new(
69
+ :assignment_id,
70
+ :requester_feedback,
71
+ :override_rejection)
72
+ include Aws::Structure
73
+ end
74
+
75
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ApproveAssignmentResponse AWS API Documentation
76
+ #
77
+ class ApproveAssignmentResponse < Aws::EmptyStructure; end
78
+
79
+ # The Assignment data structure represents a single assignment of a HIT
80
+ # to a Worker. The assignment tracks the Worker's efforts to complete
81
+ # the HIT, and contains the results for later retrieval.
82
+ #
83
+ # @!attribute [rw] assignment_id
84
+ # A unique identifier for the assignment.
85
+ # @return [String]
86
+ #
87
+ # @!attribute [rw] worker_id
88
+ # The ID of the Worker who accepted the HIT.
89
+ # @return [String]
90
+ #
91
+ # @!attribute [rw] hit_id
92
+ # The ID of the HIT.
93
+ # @return [String]
94
+ #
95
+ # @!attribute [rw] assignment_status
96
+ # The status of the assignment.
97
+ # @return [String]
98
+ #
99
+ # @!attribute [rw] auto_approval_time
100
+ # If results have been submitted, AutoApprovalTime is the date and
101
+ # time the results of the assignment results are considered Approved
102
+ # automatically if they have not already been explicitly approved or
103
+ # rejected by the Requester. This value is derived from the
104
+ # auto-approval delay specified by the Requester in the HIT. This
105
+ # value is omitted from the assignment if the Worker has not yet
106
+ # submitted results.
107
+ # @return [Time]
108
+ #
109
+ # @!attribute [rw] accept_time
110
+ # The date and time the Worker accepted the assignment.
111
+ # @return [Time]
112
+ #
113
+ # @!attribute [rw] submit_time
114
+ # If the Worker has submitted results, SubmitTime is the date and time
115
+ # the assignment was submitted. This value is omitted from the
116
+ # assignment if the Worker has not yet submitted results.
117
+ # @return [Time]
118
+ #
119
+ # @!attribute [rw] approval_time
120
+ # If the Worker has submitted results and the Requester has approved
121
+ # the results, ApprovalTime is the date and time the Requester
122
+ # approved the results. This value is omitted from the assignment if
123
+ # the Requester has not yet approved the results.
124
+ # @return [Time]
125
+ #
126
+ # @!attribute [rw] rejection_time
127
+ # If the Worker has submitted results and the Requester has rejected
128
+ # the results, RejectionTime is the date and time the Requester
129
+ # rejected the results.
130
+ # @return [Time]
131
+ #
132
+ # @!attribute [rw] deadline
133
+ # The date and time of the deadline for the assignment. This value is
134
+ # derived from the deadline specification for the HIT and the date and
135
+ # time the Worker accepted the HIT.
136
+ # @return [Time]
137
+ #
138
+ # @!attribute [rw] answer
139
+ # The Worker's answers submitted for the HIT contained in a
140
+ # QuestionFormAnswers document, if the Worker provides an answer. If
141
+ # the Worker does not provide any answers, Answer may contain a
142
+ # QuestionFormAnswers document, or Answer may be empty.
143
+ # @return [String]
144
+ #
145
+ # @!attribute [rw] requester_feedback
146
+ # The feedback string included with the call to the ApproveAssignment
147
+ # operation or the RejectAssignment operation, if the Requester
148
+ # approved or rejected the assignment and specified feedback.
149
+ # @return [String]
150
+ #
151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/Assignment AWS API Documentation
152
+ #
153
+ class Assignment < Struct.new(
154
+ :assignment_id,
155
+ :worker_id,
156
+ :hit_id,
157
+ :assignment_status,
158
+ :auto_approval_time,
159
+ :accept_time,
160
+ :submit_time,
161
+ :approval_time,
162
+ :rejection_time,
163
+ :deadline,
164
+ :answer,
165
+ :requester_feedback)
166
+ include Aws::Structure
167
+ end
168
+
169
+ # @note When making an API call, you may pass AssociateQualificationWithWorkerRequest
170
+ # data as a hash:
171
+ #
172
+ # {
173
+ # qualification_type_id: "EntityId", # required
174
+ # worker_id: "CustomerId", # required
175
+ # integer_value: 1,
176
+ # send_notification: false,
177
+ # }
178
+ #
179
+ # @!attribute [rw] qualification_type_id
180
+ # The ID of the Qualification type to use for the assigned
181
+ # Qualification.
182
+ # @return [String]
183
+ #
184
+ # @!attribute [rw] worker_id
185
+ # The ID of the Worker to whom the Qualification is being assigned.
186
+ # Worker IDs are included with submitted HIT assignments and
187
+ # Qualification requests.
188
+ # @return [String]
189
+ #
190
+ # @!attribute [rw] integer_value
191
+ # The value of the Qualification to assign.
192
+ # @return [Integer]
193
+ #
194
+ # @!attribute [rw] send_notification
195
+ # Specifies whether to send a notification email message to the Worker
196
+ # saying that the qualification was assigned to the Worker. Note: this
197
+ # is true by default.
198
+ # @return [Boolean]
199
+ #
200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/AssociateQualificationWithWorkerRequest AWS API Documentation
201
+ #
202
+ class AssociateQualificationWithWorkerRequest < Struct.new(
203
+ :qualification_type_id,
204
+ :worker_id,
205
+ :integer_value,
206
+ :send_notification)
207
+ include Aws::Structure
208
+ end
209
+
210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/AssociateQualificationWithWorkerResponse AWS API Documentation
211
+ #
212
+ class AssociateQualificationWithWorkerResponse < Aws::EmptyStructure; end
213
+
214
+ # An object representing a Bonus payment paid to a Worker.
215
+ #
216
+ # @!attribute [rw] worker_id
217
+ # The ID of the Worker to whom the bonus was paid.
218
+ # @return [String]
219
+ #
220
+ # @!attribute [rw] bonus_amount
221
+ # A string representing a numeric value.
222
+ # @return [String]
223
+ #
224
+ # @!attribute [rw] assignment_id
225
+ # The ID of the assignment associated with this bonus payment.
226
+ # @return [String]
227
+ #
228
+ # @!attribute [rw] reason
229
+ # The Reason text given when the bonus was granted, if any.
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] grant_time
233
+ # The date and time of when the bonus was granted.
234
+ # @return [Time]
235
+ #
236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/BonusPayment AWS API Documentation
237
+ #
238
+ class BonusPayment < Struct.new(
239
+ :worker_id,
240
+ :bonus_amount,
241
+ :assignment_id,
242
+ :reason,
243
+ :grant_time)
244
+ include Aws::Structure
245
+ end
246
+
247
+ # @note When making an API call, you may pass CreateAdditionalAssignmentsForHITRequest
248
+ # data as a hash:
249
+ #
250
+ # {
251
+ # hit_id: "EntityId", # required
252
+ # number_of_additional_assignments: 1,
253
+ # unique_request_token: "IdempotencyToken",
254
+ # }
255
+ #
256
+ # @!attribute [rw] hit_id
257
+ # The ID of the HIT to extend.
258
+ # @return [String]
259
+ #
260
+ # @!attribute [rw] number_of_additional_assignments
261
+ # The number of additional assignments to request for this HIT.
262
+ # @return [Integer]
263
+ #
264
+ # @!attribute [rw] unique_request_token
265
+ # A unique identifier for this request, which allows you to retry the
266
+ # call on error without extending the HIT multiple times. This is
267
+ # useful in cases such as network timeouts where it is unclear whether
268
+ # or not the call succeeded on the server. If the extend HIT already
269
+ # exists in the system from a previous call using the same
270
+ # `UniqueRequestToken`, subsequent calls will return an error with a
271
+ # message containing the request ID.
272
+ # @return [String]
273
+ #
274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateAdditionalAssignmentsForHITRequest AWS API Documentation
275
+ #
276
+ class CreateAdditionalAssignmentsForHITRequest < Struct.new(
277
+ :hit_id,
278
+ :number_of_additional_assignments,
279
+ :unique_request_token)
280
+ include Aws::Structure
281
+ end
282
+
283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateAdditionalAssignmentsForHITResponse AWS API Documentation
284
+ #
285
+ class CreateAdditionalAssignmentsForHITResponse < Aws::EmptyStructure; end
286
+
287
+ # @note When making an API call, you may pass CreateHITRequest
288
+ # data as a hash:
289
+ #
290
+ # {
291
+ # max_assignments: 1,
292
+ # auto_approval_delay_in_seconds: 1,
293
+ # lifetime_in_seconds: 1, # required
294
+ # assignment_duration_in_seconds: 1, # required
295
+ # reward: "NumericValue", # required
296
+ # title: "String", # required
297
+ # keywords: "String",
298
+ # description: "String", # required
299
+ # question: "String",
300
+ # requester_annotation: "String",
301
+ # qualification_requirements: [
302
+ # {
303
+ # qualification_type_id: "String", # required
304
+ # comparator: "LessThan", # required, accepts LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, NotEqualTo, Exists, DoesNotExist, In, NotIn
305
+ # integer_values: [1],
306
+ # locale_values: [
307
+ # {
308
+ # country: "CountryParameters", # required
309
+ # subdivision: "CountryParameters",
310
+ # },
311
+ # ],
312
+ # required_to_preview: false,
313
+ # },
314
+ # ],
315
+ # unique_request_token: "IdempotencyToken",
316
+ # assignment_review_policy: {
317
+ # policy_name: "String",
318
+ # parameters: [
319
+ # {
320
+ # key: "String",
321
+ # values: ["String"],
322
+ # map_entries: [
323
+ # {
324
+ # key: "String",
325
+ # values: ["String"],
326
+ # },
327
+ # ],
328
+ # },
329
+ # ],
330
+ # },
331
+ # hit_review_policy: {
332
+ # policy_name: "String",
333
+ # parameters: [
334
+ # {
335
+ # key: "String",
336
+ # values: ["String"],
337
+ # map_entries: [
338
+ # {
339
+ # key: "String",
340
+ # values: ["String"],
341
+ # },
342
+ # ],
343
+ # },
344
+ # ],
345
+ # },
346
+ # hit_layout_id: "EntityId",
347
+ # hit_layout_parameters: [
348
+ # {
349
+ # name: "String",
350
+ # value: "String",
351
+ # },
352
+ # ],
353
+ # }
354
+ #
355
+ # @!attribute [rw] max_assignments
356
+ # The number of times the HIT can be accepted and completed before the
357
+ # HIT becomes unavailable.
358
+ # @return [Integer]
359
+ #
360
+ # @!attribute [rw] auto_approval_delay_in_seconds
361
+ # The number of seconds after an assignment for the HIT has been
362
+ # submitted, after which the assignment is considered Approved
363
+ # automatically unless the Requester explicitly rejects it.
364
+ # @return [Integer]
365
+ #
366
+ # @!attribute [rw] lifetime_in_seconds
367
+ # An amount of time, in seconds, after which the HIT is no longer
368
+ # available for users to accept. After the lifetime of the HIT
369
+ # elapses, the HIT no longer appears in HIT searches, even if not all
370
+ # of the assignments for the HIT have been accepted.
371
+ # @return [Integer]
372
+ #
373
+ # @!attribute [rw] assignment_duration_in_seconds
374
+ # The amount of time, in seconds, that a Worker has to complete the
375
+ # HIT after accepting it. If a Worker does not complete the assignment
376
+ # within the specified duration, the assignment is considered
377
+ # abandoned. If the HIT is still active (that is, its lifetime has not
378
+ # elapsed), the assignment becomes available for other users to find
379
+ # and accept.
380
+ # @return [Integer]
381
+ #
382
+ # @!attribute [rw] reward
383
+ # The amount of money the Requester will pay a Worker for successfully
384
+ # completing the HIT.
385
+ # @return [String]
386
+ #
387
+ # @!attribute [rw] title
388
+ # The title of the HIT. A title should be short and descriptive about
389
+ # the kind of task the HIT contains. On the Amazon Mechanical Turk web
390
+ # site, the HIT title appears in search results, and everywhere the
391
+ # HIT is mentioned.
392
+ # @return [String]
393
+ #
394
+ # @!attribute [rw] keywords
395
+ # One or more words or phrases that describe the HIT, separated by
396
+ # commas. These words are used in searches to find HITs.
397
+ # @return [String]
398
+ #
399
+ # @!attribute [rw] description
400
+ # A general description of the HIT. A description includes detailed
401
+ # information about the kind of task the HIT contains. On the Amazon
402
+ # Mechanical Turk web site, the HIT description appears in the
403
+ # expanded view of search results, and in the HIT and assignment
404
+ # screens. A good description gives the user enough information to
405
+ # evaluate the HIT before accepting it.
406
+ # @return [String]
407
+ #
408
+ # @!attribute [rw] question
409
+ # The data the person completing the HIT uses to produce the results.
410
+ #
411
+ # Constraints: Must be a QuestionForm data structure, an
412
+ # ExternalQuestion data structure, or an HTMLQuestion data structure.
413
+ # The XML question data must not be larger than 64 kilobytes (65,535
414
+ # bytes) in size, including whitespace.
415
+ #
416
+ # Either a Question parameter or a HITLayoutId parameter must be
417
+ # provided.
418
+ # @return [String]
419
+ #
420
+ # @!attribute [rw] requester_annotation
421
+ # An arbitrary data field. The RequesterAnnotation parameter lets your
422
+ # application attach arbitrary data to the HIT for tracking purposes.
423
+ # For example, this parameter could be an identifier internal to the
424
+ # Requester's application that corresponds with the HIT.
425
+ #
426
+ # The RequesterAnnotation parameter for a HIT is only visible to the
427
+ # Requester who created the HIT. It is not shown to the Worker, or any
428
+ # other Requester.
429
+ #
430
+ # The RequesterAnnotation parameter may be different for each HIT you
431
+ # submit. It does not affect how your HITs are grouped.
432
+ # @return [String]
433
+ #
434
+ # @!attribute [rw] qualification_requirements
435
+ # A condition that a Worker's Qualifications must meet before the
436
+ # Worker is allowed to accept and complete the HIT.
437
+ # @return [Array<Types::QualificationRequirement>]
438
+ #
439
+ # @!attribute [rw] unique_request_token
440
+ # A unique identifier for this request which allows you to retry the
441
+ # call on error without creating duplicate HITs. This is useful in
442
+ # cases such as network timeouts where it is unclear whether or not
443
+ # the call succeeded on the server. If the HIT already exists in the
444
+ # system from a previous call using the same UniqueRequestToken,
445
+ # subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists
446
+ # error with a message containing the HITId.
447
+ #
448
+ # <note markdown="1"> Note: It is your responsibility to ensure uniqueness of the token.
449
+ # The unique token expires after 24 hours. Subsequent calls using the
450
+ # same UniqueRequestToken made after the 24 hour limit could create
451
+ # duplicate HITs.
452
+ #
453
+ # </note>
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] assignment_review_policy
457
+ # The Assignment-level Review Policy applies to the assignments under
458
+ # the HIT. You can specify for Mechanical Turk to take various actions
459
+ # based on the policy.
460
+ # @return [Types::ReviewPolicy]
461
+ #
462
+ # @!attribute [rw] hit_review_policy
463
+ # The HIT-level Review Policy applies to the HIT. You can specify for
464
+ # Mechanical Turk to take various actions based on the policy.
465
+ # @return [Types::ReviewPolicy]
466
+ #
467
+ # @!attribute [rw] hit_layout_id
468
+ # The HITLayoutId allows you to use a pre-existing HIT design with
469
+ # placeholder values and create an additional HIT by providing those
470
+ # values as HITLayoutParameters.
471
+ #
472
+ # Constraints: Either a Question parameter or a HITLayoutId parameter
473
+ # must be provided.
474
+ # @return [String]
475
+ #
476
+ # @!attribute [rw] hit_layout_parameters
477
+ # If the HITLayoutId is provided, any placeholder values must be
478
+ # filled in with values using the HITLayoutParameter structure. For
479
+ # more information, see HITLayout.
480
+ # @return [Array<Types::HITLayoutParameter>]
481
+ #
482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateHITRequest AWS API Documentation
483
+ #
484
+ class CreateHITRequest < Struct.new(
485
+ :max_assignments,
486
+ :auto_approval_delay_in_seconds,
487
+ :lifetime_in_seconds,
488
+ :assignment_duration_in_seconds,
489
+ :reward,
490
+ :title,
491
+ :keywords,
492
+ :description,
493
+ :question,
494
+ :requester_annotation,
495
+ :qualification_requirements,
496
+ :unique_request_token,
497
+ :assignment_review_policy,
498
+ :hit_review_policy,
499
+ :hit_layout_id,
500
+ :hit_layout_parameters)
501
+ include Aws::Structure
502
+ end
503
+
504
+ # @!attribute [rw] hit
505
+ # Contains the newly created HIT data. For a description of the HIT
506
+ # data structure as it appears in responses, see the HIT Data
507
+ # Structure documentation.
508
+ # @return [Types::HIT]
509
+ #
510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateHITResponse AWS API Documentation
511
+ #
512
+ class CreateHITResponse < Struct.new(
513
+ :hit)
514
+ include Aws::Structure
515
+ end
516
+
517
+ # @note When making an API call, you may pass CreateHITTypeRequest
518
+ # data as a hash:
519
+ #
520
+ # {
521
+ # auto_approval_delay_in_seconds: 1,
522
+ # assignment_duration_in_seconds: 1, # required
523
+ # reward: "NumericValue", # required
524
+ # title: "String", # required
525
+ # keywords: "String",
526
+ # description: "String", # required
527
+ # qualification_requirements: [
528
+ # {
529
+ # qualification_type_id: "String", # required
530
+ # comparator: "LessThan", # required, accepts LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, NotEqualTo, Exists, DoesNotExist, In, NotIn
531
+ # integer_values: [1],
532
+ # locale_values: [
533
+ # {
534
+ # country: "CountryParameters", # required
535
+ # subdivision: "CountryParameters",
536
+ # },
537
+ # ],
538
+ # required_to_preview: false,
539
+ # },
540
+ # ],
541
+ # }
542
+ #
543
+ # @!attribute [rw] auto_approval_delay_in_seconds
544
+ # The number of seconds after an assignment for the HIT has been
545
+ # submitted, after which the assignment is considered Approved
546
+ # automatically unless the Requester explicitly rejects it.
547
+ # @return [Integer]
548
+ #
549
+ # @!attribute [rw] assignment_duration_in_seconds
550
+ # The amount of time, in seconds, that a Worker has to complete the
551
+ # HIT after accepting it. If a Worker does not complete the assignment
552
+ # within the specified duration, the assignment is considered
553
+ # abandoned. If the HIT is still active (that is, its lifetime has not
554
+ # elapsed), the assignment becomes available for other users to find
555
+ # and accept.
556
+ # @return [Integer]
557
+ #
558
+ # @!attribute [rw] reward
559
+ # The amount of money the Requester will pay a Worker for successfully
560
+ # completing the HIT.
561
+ # @return [String]
562
+ #
563
+ # @!attribute [rw] title
564
+ # The title of the HIT. A title should be short and descriptive about
565
+ # the kind of task the HIT contains. On the Amazon Mechanical Turk web
566
+ # site, the HIT title appears in search results, and everywhere the
567
+ # HIT is mentioned.
568
+ # @return [String]
569
+ #
570
+ # @!attribute [rw] keywords
571
+ # One or more words or phrases that describe the HIT, separated by
572
+ # commas. These words are used in searches to find HITs.
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] description
576
+ # A general description of the HIT. A description includes detailed
577
+ # information about the kind of task the HIT contains. On the Amazon
578
+ # Mechanical Turk web site, the HIT description appears in the
579
+ # expanded view of search results, and in the HIT and assignment
580
+ # screens. A good description gives the user enough information to
581
+ # evaluate the HIT before accepting it.
582
+ # @return [String]
583
+ #
584
+ # @!attribute [rw] qualification_requirements
585
+ # A condition that a Worker's Qualifications must meet before the
586
+ # Worker is allowed to accept and complete the HIT.
587
+ # @return [Array<Types::QualificationRequirement>]
588
+ #
589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateHITTypeRequest AWS API Documentation
590
+ #
591
+ class CreateHITTypeRequest < Struct.new(
592
+ :auto_approval_delay_in_seconds,
593
+ :assignment_duration_in_seconds,
594
+ :reward,
595
+ :title,
596
+ :keywords,
597
+ :description,
598
+ :qualification_requirements)
599
+ include Aws::Structure
600
+ end
601
+
602
+ # @!attribute [rw] hit_type_id
603
+ # The ID of the newly registered HIT type.
604
+ # @return [String]
605
+ #
606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateHITTypeResponse AWS API Documentation
607
+ #
608
+ class CreateHITTypeResponse < Struct.new(
609
+ :hit_type_id)
610
+ include Aws::Structure
611
+ end
612
+
613
+ # @note When making an API call, you may pass CreateHITWithHITTypeRequest
614
+ # data as a hash:
615
+ #
616
+ # {
617
+ # hit_type_id: "EntityId", # required
618
+ # max_assignments: 1,
619
+ # lifetime_in_seconds: 1, # required
620
+ # question: "String",
621
+ # requester_annotation: "String",
622
+ # unique_request_token: "IdempotencyToken",
623
+ # assignment_review_policy: {
624
+ # policy_name: "String",
625
+ # parameters: [
626
+ # {
627
+ # key: "String",
628
+ # values: ["String"],
629
+ # map_entries: [
630
+ # {
631
+ # key: "String",
632
+ # values: ["String"],
633
+ # },
634
+ # ],
635
+ # },
636
+ # ],
637
+ # },
638
+ # hit_review_policy: {
639
+ # policy_name: "String",
640
+ # parameters: [
641
+ # {
642
+ # key: "String",
643
+ # values: ["String"],
644
+ # map_entries: [
645
+ # {
646
+ # key: "String",
647
+ # values: ["String"],
648
+ # },
649
+ # ],
650
+ # },
651
+ # ],
652
+ # },
653
+ # hit_layout_id: "EntityId",
654
+ # hit_layout_parameters: [
655
+ # {
656
+ # name: "String",
657
+ # value: "String",
658
+ # },
659
+ # ],
660
+ # }
661
+ #
662
+ # @!attribute [rw] hit_type_id
663
+ # The HIT type ID you want to create this HIT with.
664
+ # @return [String]
665
+ #
666
+ # @!attribute [rw] max_assignments
667
+ # The number of times the HIT can be accepted and completed before the
668
+ # HIT becomes unavailable.
669
+ # @return [Integer]
670
+ #
671
+ # @!attribute [rw] lifetime_in_seconds
672
+ # An amount of time, in seconds, after which the HIT is no longer
673
+ # available for users to accept. After the lifetime of the HIT
674
+ # elapses, the HIT no longer appears in HIT searches, even if not all
675
+ # of the assignments for the HIT have been accepted.
676
+ # @return [Integer]
677
+ #
678
+ # @!attribute [rw] question
679
+ # The data the person completing the HIT uses to produce the results.
680
+ #
681
+ # Constraints: Must be a QuestionForm data structure, an
682
+ # ExternalQuestion data structure, or an HTMLQuestion data structure.
683
+ # The XML question data must not be larger than 64 kilobytes (65,535
684
+ # bytes) in size, including whitespace.
685
+ #
686
+ # Either a Question parameter or a HITLayoutId parameter must be
687
+ # provided.
688
+ # @return [String]
689
+ #
690
+ # @!attribute [rw] requester_annotation
691
+ # An arbitrary data field. The RequesterAnnotation parameter lets your
692
+ # application attach arbitrary data to the HIT for tracking purposes.
693
+ # For example, this parameter could be an identifier internal to the
694
+ # Requester's application that corresponds with the HIT.
695
+ #
696
+ # The RequesterAnnotation parameter for a HIT is only visible to the
697
+ # Requester who created the HIT. It is not shown to the Worker, or any
698
+ # other Requester.
699
+ #
700
+ # The RequesterAnnotation parameter may be different for each HIT you
701
+ # submit. It does not affect how your HITs are grouped.
702
+ # @return [String]
703
+ #
704
+ # @!attribute [rw] unique_request_token
705
+ # A unique identifier for this request which allows you to retry the
706
+ # call on error without creating duplicate HITs. This is useful in
707
+ # cases such as network timeouts where it is unclear whether or not
708
+ # the call succeeded on the server. If the HIT already exists in the
709
+ # system from a previous call using the same UniqueRequestToken,
710
+ # subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists
711
+ # error with a message containing the HITId.
712
+ #
713
+ # <note markdown="1"> Note: It is your responsibility to ensure uniqueness of the token.
714
+ # The unique token expires after 24 hours. Subsequent calls using the
715
+ # same UniqueRequestToken made after the 24 hour limit could create
716
+ # duplicate HITs.
717
+ #
718
+ # </note>
719
+ # @return [String]
720
+ #
721
+ # @!attribute [rw] assignment_review_policy
722
+ # The Assignment-level Review Policy applies to the assignments under
723
+ # the HIT. You can specify for Mechanical Turk to take various actions
724
+ # based on the policy.
725
+ # @return [Types::ReviewPolicy]
726
+ #
727
+ # @!attribute [rw] hit_review_policy
728
+ # The HIT-level Review Policy applies to the HIT. You can specify for
729
+ # Mechanical Turk to take various actions based on the policy.
730
+ # @return [Types::ReviewPolicy]
731
+ #
732
+ # @!attribute [rw] hit_layout_id
733
+ # The HITLayoutId allows you to use a pre-existing HIT design with
734
+ # placeholder values and create an additional HIT by providing those
735
+ # values as HITLayoutParameters.
736
+ #
737
+ # Constraints: Either a Question parameter or a HITLayoutId parameter
738
+ # must be provided.
739
+ # @return [String]
740
+ #
741
+ # @!attribute [rw] hit_layout_parameters
742
+ # If the HITLayoutId is provided, any placeholder values must be
743
+ # filled in with values using the HITLayoutParameter structure. For
744
+ # more information, see HITLayout.
745
+ # @return [Array<Types::HITLayoutParameter>]
746
+ #
747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateHITWithHITTypeRequest AWS API Documentation
748
+ #
749
+ class CreateHITWithHITTypeRequest < Struct.new(
750
+ :hit_type_id,
751
+ :max_assignments,
752
+ :lifetime_in_seconds,
753
+ :question,
754
+ :requester_annotation,
755
+ :unique_request_token,
756
+ :assignment_review_policy,
757
+ :hit_review_policy,
758
+ :hit_layout_id,
759
+ :hit_layout_parameters)
760
+ include Aws::Structure
761
+ end
762
+
763
+ # @!attribute [rw] hit
764
+ # Contains the newly created HIT data. For a description of the HIT
765
+ # data structure as it appears in responses, see the HIT Data
766
+ # Structure documentation.
767
+ # @return [Types::HIT]
768
+ #
769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateHITWithHITTypeResponse AWS API Documentation
770
+ #
771
+ class CreateHITWithHITTypeResponse < Struct.new(
772
+ :hit)
773
+ include Aws::Structure
774
+ end
775
+
776
+ # @note When making an API call, you may pass CreateQualificationTypeRequest
777
+ # data as a hash:
778
+ #
779
+ # {
780
+ # name: "String", # required
781
+ # keywords: "String",
782
+ # description: "String", # required
783
+ # qualification_type_status: "Active", # required, accepts Active, Inactive
784
+ # retry_delay_in_seconds: 1,
785
+ # test: "String",
786
+ # answer_key: "String",
787
+ # test_duration_in_seconds: 1,
788
+ # auto_granted: false,
789
+ # auto_granted_value: 1,
790
+ # }
791
+ #
792
+ # @!attribute [rw] name
793
+ # The name you give to the Qualification type. The type name is used
794
+ # to represent the Qualification to Workers, and to find the type
795
+ # using a Qualification type search. It must be unique across all of
796
+ # your Qualification types.
797
+ # @return [String]
798
+ #
799
+ # @!attribute [rw] keywords
800
+ # One or more words or phrases that describe the Qualification type,
801
+ # separated by commas. The keywords of a type make the type easier to
802
+ # find during a search.
803
+ # @return [String]
804
+ #
805
+ # @!attribute [rw] description
806
+ # A long description for the Qualification type. On the Amazon
807
+ # Mechanical Turk website, the long description is displayed when a
808
+ # Worker examines a Qualification type.
809
+ # @return [String]
810
+ #
811
+ # @!attribute [rw] qualification_type_status
812
+ # The initial status of the Qualification type.
813
+ #
814
+ # Constraints: Valid values are: Active \| Inactive
815
+ # @return [String]
816
+ #
817
+ # @!attribute [rw] retry_delay_in_seconds
818
+ # The number of seconds that a Worker must wait after requesting a
819
+ # Qualification of the Qualification type before the worker can retry
820
+ # the Qualification request.
821
+ #
822
+ # Constraints: None. If not specified, retries are disabled and
823
+ # Workers can request a Qualification of this type only once, even if
824
+ # the Worker has not been granted the Qualification. It is not
825
+ # possible to disable retries for a Qualification type after it has
826
+ # been created with retries enabled. If you want to disable retries,
827
+ # you must delete existing retry-enabled Qualification type and then
828
+ # create a new Qualification type with retries disabled.
829
+ # @return [Integer]
830
+ #
831
+ # @!attribute [rw] test
832
+ # The questions for the Qualification test a Worker must answer
833
+ # correctly to obtain a Qualification of this type. If this parameter
834
+ # is specified, `TestDurationInSeconds` must also be specified.
835
+ #
836
+ # Constraints: Must not be longer than 65535 bytes. Must be a
837
+ # QuestionForm data structure. This parameter cannot be specified if
838
+ # AutoGranted is true.
839
+ #
840
+ # Constraints: None. If not specified, the Worker may request the
841
+ # Qualification without answering any questions.
842
+ # @return [String]
843
+ #
844
+ # @!attribute [rw] answer_key
845
+ # The answers to the Qualification test specified in the Test
846
+ # parameter, in the form of an AnswerKey data structure.
847
+ #
848
+ # Constraints: Must not be longer than 65535 bytes.
849
+ #
850
+ # Constraints: None. If not specified, you must process Qualification
851
+ # requests manually.
852
+ # @return [String]
853
+ #
854
+ # @!attribute [rw] test_duration_in_seconds
855
+ # The number of seconds the Worker has to complete the Qualification
856
+ # test, starting from the time the Worker requests the Qualification.
857
+ # @return [Integer]
858
+ #
859
+ # @!attribute [rw] auto_granted
860
+ # Specifies whether requests for the Qualification type are granted
861
+ # immediately, without prompting the Worker with a Qualification test.
862
+ #
863
+ # Constraints: If the Test parameter is specified, this parameter
864
+ # cannot be true.
865
+ # @return [Boolean]
866
+ #
867
+ # @!attribute [rw] auto_granted_value
868
+ # The Qualification value to use for automatically granted
869
+ # Qualifications. This parameter is used only if the AutoGranted
870
+ # parameter is true.
871
+ # @return [Integer]
872
+ #
873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateQualificationTypeRequest AWS API Documentation
874
+ #
875
+ class CreateQualificationTypeRequest < Struct.new(
876
+ :name,
877
+ :keywords,
878
+ :description,
879
+ :qualification_type_status,
880
+ :retry_delay_in_seconds,
881
+ :test,
882
+ :answer_key,
883
+ :test_duration_in_seconds,
884
+ :auto_granted,
885
+ :auto_granted_value)
886
+ include Aws::Structure
887
+ end
888
+
889
+ # @!attribute [rw] qualification_type
890
+ # The created Qualification type, returned as a QualificationType data
891
+ # structure.
892
+ # @return [Types::QualificationType]
893
+ #
894
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateQualificationTypeResponse AWS API Documentation
895
+ #
896
+ class CreateQualificationTypeResponse < Struct.new(
897
+ :qualification_type)
898
+ include Aws::Structure
899
+ end
900
+
901
+ # @note When making an API call, you may pass CreateWorkerBlockRequest
902
+ # data as a hash:
903
+ #
904
+ # {
905
+ # worker_id: "CustomerId", # required
906
+ # reason: "String", # required
907
+ # }
908
+ #
909
+ # @!attribute [rw] worker_id
910
+ # The ID of the Worker to block.
911
+ # @return [String]
912
+ #
913
+ # @!attribute [rw] reason
914
+ # A message explaining the reason for blocking the Worker. This
915
+ # parameter enables you to keep track of your Workers. The Worker does
916
+ # not see this message.
917
+ # @return [String]
918
+ #
919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateWorkerBlockRequest AWS API Documentation
920
+ #
921
+ class CreateWorkerBlockRequest < Struct.new(
922
+ :worker_id,
923
+ :reason)
924
+ include Aws::Structure
925
+ end
926
+
927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateWorkerBlockResponse AWS API Documentation
928
+ #
929
+ class CreateWorkerBlockResponse < Aws::EmptyStructure; end
930
+
931
+ # @note When making an API call, you may pass DeleteHITRequest
932
+ # data as a hash:
933
+ #
934
+ # {
935
+ # hit_id: "EntityId", # required
936
+ # }
937
+ #
938
+ # @!attribute [rw] hit_id
939
+ # The ID of the HIT to be deleted.
940
+ # @return [String]
941
+ #
942
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DeleteHITRequest AWS API Documentation
943
+ #
944
+ class DeleteHITRequest < Struct.new(
945
+ :hit_id)
946
+ include Aws::Structure
947
+ end
948
+
949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DeleteHITResponse AWS API Documentation
950
+ #
951
+ class DeleteHITResponse < Aws::EmptyStructure; end
952
+
953
+ # @note When making an API call, you may pass DeleteQualificationTypeRequest
954
+ # data as a hash:
955
+ #
956
+ # {
957
+ # qualification_type_id: "EntityId", # required
958
+ # }
959
+ #
960
+ # @!attribute [rw] qualification_type_id
961
+ # The ID of the QualificationType to dispose.
962
+ # @return [String]
963
+ #
964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DeleteQualificationTypeRequest AWS API Documentation
965
+ #
966
+ class DeleteQualificationTypeRequest < Struct.new(
967
+ :qualification_type_id)
968
+ include Aws::Structure
969
+ end
970
+
971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DeleteQualificationTypeResponse AWS API Documentation
972
+ #
973
+ class DeleteQualificationTypeResponse < Aws::EmptyStructure; end
974
+
975
+ # @note When making an API call, you may pass DeleteWorkerBlockRequest
976
+ # data as a hash:
977
+ #
978
+ # {
979
+ # worker_id: "CustomerId", # required
980
+ # reason: "String",
981
+ # }
982
+ #
983
+ # @!attribute [rw] worker_id
984
+ # The ID of the Worker to unblock.
985
+ # @return [String]
986
+ #
987
+ # @!attribute [rw] reason
988
+ # A message that explains the reason for unblocking the Worker. The
989
+ # Worker does not see this message.
990
+ # @return [String]
991
+ #
992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DeleteWorkerBlockRequest AWS API Documentation
993
+ #
994
+ class DeleteWorkerBlockRequest < Struct.new(
995
+ :worker_id,
996
+ :reason)
997
+ include Aws::Structure
998
+ end
999
+
1000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DeleteWorkerBlockResponse AWS API Documentation
1001
+ #
1002
+ class DeleteWorkerBlockResponse < Aws::EmptyStructure; end
1003
+
1004
+ # @note When making an API call, you may pass DisassociateQualificationFromWorkerRequest
1005
+ # data as a hash:
1006
+ #
1007
+ # {
1008
+ # worker_id: "CustomerId", # required
1009
+ # qualification_type_id: "EntityId", # required
1010
+ # reason: "String",
1011
+ # }
1012
+ #
1013
+ # @!attribute [rw] worker_id
1014
+ # The ID of the Worker who possesses the Qualification to be revoked.
1015
+ # @return [String]
1016
+ #
1017
+ # @!attribute [rw] qualification_type_id
1018
+ # The ID of the Qualification type of the Qualification to be revoked.
1019
+ # @return [String]
1020
+ #
1021
+ # @!attribute [rw] reason
1022
+ # A text message that explains why the Qualification was revoked. The
1023
+ # user who had the Qualification sees this message.
1024
+ # @return [String]
1025
+ #
1026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DisassociateQualificationFromWorkerRequest AWS API Documentation
1027
+ #
1028
+ class DisassociateQualificationFromWorkerRequest < Struct.new(
1029
+ :worker_id,
1030
+ :qualification_type_id,
1031
+ :reason)
1032
+ include Aws::Structure
1033
+ end
1034
+
1035
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DisassociateQualificationFromWorkerResponse AWS API Documentation
1036
+ #
1037
+ class DisassociateQualificationFromWorkerResponse < Aws::EmptyStructure; end
1038
+
1039
+ # @api private
1040
+ #
1041
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetAccountBalanceRequest AWS API Documentation
1042
+ #
1043
+ class GetAccountBalanceRequest < Aws::EmptyStructure; end
1044
+
1045
+ # @!attribute [rw] available_balance
1046
+ # A string representing a numeric value.
1047
+ # @return [String]
1048
+ #
1049
+ # @!attribute [rw] on_hold_balance
1050
+ # A string representing a numeric value.
1051
+ # @return [String]
1052
+ #
1053
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetAccountBalanceResponse AWS API Documentation
1054
+ #
1055
+ class GetAccountBalanceResponse < Struct.new(
1056
+ :available_balance,
1057
+ :on_hold_balance)
1058
+ include Aws::Structure
1059
+ end
1060
+
1061
+ # @note When making an API call, you may pass GetAssignmentRequest
1062
+ # data as a hash:
1063
+ #
1064
+ # {
1065
+ # assignment_id: "EntityId", # required
1066
+ # }
1067
+ #
1068
+ # @!attribute [rw] assignment_id
1069
+ # The ID of the Assignment to be retrieved.
1070
+ # @return [String]
1071
+ #
1072
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetAssignmentRequest AWS API Documentation
1073
+ #
1074
+ class GetAssignmentRequest < Struct.new(
1075
+ :assignment_id)
1076
+ include Aws::Structure
1077
+ end
1078
+
1079
+ # @!attribute [rw] assignment
1080
+ # The assignment. The response includes one Assignment element.
1081
+ # @return [Types::Assignment]
1082
+ #
1083
+ # @!attribute [rw] hit
1084
+ # The HIT associated with this assignment. The response includes one
1085
+ # HIT element.
1086
+ # @return [Types::HIT]
1087
+ #
1088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetAssignmentResponse AWS API Documentation
1089
+ #
1090
+ class GetAssignmentResponse < Struct.new(
1091
+ :assignment,
1092
+ :hit)
1093
+ include Aws::Structure
1094
+ end
1095
+
1096
+ # @note When making an API call, you may pass GetFileUploadURLRequest
1097
+ # data as a hash:
1098
+ #
1099
+ # {
1100
+ # assignment_id: "EntityId", # required
1101
+ # question_identifier: "String", # required
1102
+ # }
1103
+ #
1104
+ # @!attribute [rw] assignment_id
1105
+ # The ID of the assignment that contains the question with a
1106
+ # FileUploadAnswer.
1107
+ # @return [String]
1108
+ #
1109
+ # @!attribute [rw] question_identifier
1110
+ # The identifier of the question with a FileUploadAnswer, as specified
1111
+ # in the QuestionForm of the HIT.
1112
+ # @return [String]
1113
+ #
1114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetFileUploadURLRequest AWS API Documentation
1115
+ #
1116
+ class GetFileUploadURLRequest < Struct.new(
1117
+ :assignment_id,
1118
+ :question_identifier)
1119
+ include Aws::Structure
1120
+ end
1121
+
1122
+ # @!attribute [rw] file_upload_url
1123
+ # A temporary URL for the file that the Worker uploaded for the
1124
+ # answer.
1125
+ # @return [String]
1126
+ #
1127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetFileUploadURLResponse AWS API Documentation
1128
+ #
1129
+ class GetFileUploadURLResponse < Struct.new(
1130
+ :file_upload_url)
1131
+ include Aws::Structure
1132
+ end
1133
+
1134
+ # @note When making an API call, you may pass GetHITRequest
1135
+ # data as a hash:
1136
+ #
1137
+ # {
1138
+ # hit_id: "EntityId", # required
1139
+ # }
1140
+ #
1141
+ # @!attribute [rw] hit_id
1142
+ # The ID of the HIT to be retrieved.
1143
+ # @return [String]
1144
+ #
1145
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetHITRequest AWS API Documentation
1146
+ #
1147
+ class GetHITRequest < Struct.new(
1148
+ :hit_id)
1149
+ include Aws::Structure
1150
+ end
1151
+
1152
+ # @!attribute [rw] hit
1153
+ # Contains the requested HIT data.
1154
+ # @return [Types::HIT]
1155
+ #
1156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetHITResponse AWS API Documentation
1157
+ #
1158
+ class GetHITResponse < Struct.new(
1159
+ :hit)
1160
+ include Aws::Structure
1161
+ end
1162
+
1163
+ # @note When making an API call, you may pass GetQualificationScoreRequest
1164
+ # data as a hash:
1165
+ #
1166
+ # {
1167
+ # qualification_type_id: "EntityId", # required
1168
+ # worker_id: "CustomerId", # required
1169
+ # }
1170
+ #
1171
+ # @!attribute [rw] qualification_type_id
1172
+ # The ID of the QualificationType.
1173
+ # @return [String]
1174
+ #
1175
+ # @!attribute [rw] worker_id
1176
+ # The ID of the Worker whose Qualification is being updated.
1177
+ # @return [String]
1178
+ #
1179
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetQualificationScoreRequest AWS API Documentation
1180
+ #
1181
+ class GetQualificationScoreRequest < Struct.new(
1182
+ :qualification_type_id,
1183
+ :worker_id)
1184
+ include Aws::Structure
1185
+ end
1186
+
1187
+ # @!attribute [rw] qualification
1188
+ # The Qualification data structure of the Qualification assigned to a
1189
+ # user, including the Qualification type and the value (score).
1190
+ # @return [Types::Qualification]
1191
+ #
1192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetQualificationScoreResponse AWS API Documentation
1193
+ #
1194
+ class GetQualificationScoreResponse < Struct.new(
1195
+ :qualification)
1196
+ include Aws::Structure
1197
+ end
1198
+
1199
+ # @note When making an API call, you may pass GetQualificationTypeRequest
1200
+ # data as a hash:
1201
+ #
1202
+ # {
1203
+ # qualification_type_id: "EntityId", # required
1204
+ # }
1205
+ #
1206
+ # @!attribute [rw] qualification_type_id
1207
+ # The ID of the QualificationType.
1208
+ # @return [String]
1209
+ #
1210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetQualificationTypeRequest AWS API Documentation
1211
+ #
1212
+ class GetQualificationTypeRequest < Struct.new(
1213
+ :qualification_type_id)
1214
+ include Aws::Structure
1215
+ end
1216
+
1217
+ # @!attribute [rw] qualification_type
1218
+ # The returned Qualification Type
1219
+ # @return [Types::QualificationType]
1220
+ #
1221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetQualificationTypeResponse AWS API Documentation
1222
+ #
1223
+ class GetQualificationTypeResponse < Struct.new(
1224
+ :qualification_type)
1225
+ include Aws::Structure
1226
+ end
1227
+
1228
+ # The HIT data structure represents a single HIT, including all the
1229
+ # information necessary for a Worker to accept and complete the HIT.
1230
+ #
1231
+ # @!attribute [rw] hit_id
1232
+ # A unique identifier for the HIT.
1233
+ # @return [String]
1234
+ #
1235
+ # @!attribute [rw] hit_type_id
1236
+ # The ID of the HIT type of this HIT
1237
+ # @return [String]
1238
+ #
1239
+ # @!attribute [rw] hit_group_id
1240
+ # The ID of the HIT Group of this HIT.
1241
+ # @return [String]
1242
+ #
1243
+ # @!attribute [rw] hit_layout_id
1244
+ # The ID of the HIT Layout of this HIT.
1245
+ # @return [String]
1246
+ #
1247
+ # @!attribute [rw] creation_time
1248
+ # The date and time the HIT was created.
1249
+ # @return [Time]
1250
+ #
1251
+ # @!attribute [rw] title
1252
+ # The title of the HIT.
1253
+ # @return [String]
1254
+ #
1255
+ # @!attribute [rw] description
1256
+ # A general description of the HIT.
1257
+ # @return [String]
1258
+ #
1259
+ # @!attribute [rw] question
1260
+ # The data the Worker completing the HIT uses produce the results.
1261
+ # This is either either a QuestionForm, HTMLQuestion or an
1262
+ # ExternalQuestion data structure.
1263
+ # @return [String]
1264
+ #
1265
+ # @!attribute [rw] keywords
1266
+ # One or more words or phrases that describe the HIT, separated by
1267
+ # commas. Search terms similar to the keywords of a HIT are more
1268
+ # likely to have the HIT in the search results.
1269
+ # @return [String]
1270
+ #
1271
+ # @!attribute [rw] hit_status
1272
+ # The status of the HIT and its assignments. Valid Values are
1273
+ # Assignable \| Unassignable \| Reviewable \| Reviewing \| Disposed.
1274
+ # @return [String]
1275
+ #
1276
+ # @!attribute [rw] max_assignments
1277
+ # The number of times the HIT can be accepted and completed before the
1278
+ # HIT becomes unavailable.
1279
+ # @return [Integer]
1280
+ #
1281
+ # @!attribute [rw] reward
1282
+ # A string representing a numeric value.
1283
+ # @return [String]
1284
+ #
1285
+ # @!attribute [rw] auto_approval_delay_in_seconds
1286
+ # The amount of time, in seconds, after the Worker submits an
1287
+ # assignment for the HIT that the results are automatically approved
1288
+ # by Amazon Mechanical Turk. This is the amount of time the Requester
1289
+ # has to reject an assignment submitted by a Worker before the
1290
+ # assignment is auto-approved and the Worker is paid.
1291
+ # @return [Integer]
1292
+ #
1293
+ # @!attribute [rw] expiration
1294
+ # The date and time the HIT expires.
1295
+ # @return [Time]
1296
+ #
1297
+ # @!attribute [rw] assignment_duration_in_seconds
1298
+ # The length of time, in seconds, that a Worker has to complete the
1299
+ # HIT after accepting it.
1300
+ # @return [Integer]
1301
+ #
1302
+ # @!attribute [rw] requester_annotation
1303
+ # An arbitrary data field the Requester who created the HIT can use.
1304
+ # This field is visible only to the creator of the HIT.
1305
+ # @return [String]
1306
+ #
1307
+ # @!attribute [rw] qualification_requirements
1308
+ # A condition that a Worker's Qualifications must meet in order to
1309
+ # accept the HIT. A HIT can have between zero and ten Qualification
1310
+ # requirements. All requirements must be met by a Worker's
1311
+ # Qualifications for the Worker to accept the HIT.
1312
+ # @return [Array<Types::QualificationRequirement>]
1313
+ #
1314
+ # @!attribute [rw] hit_review_status
1315
+ # Indicates the review status of the HIT. Valid Values are NotReviewed
1316
+ # \| MarkedForReview \| ReviewedAppropriate \| ReviewedInappropriate.
1317
+ # @return [String]
1318
+ #
1319
+ # @!attribute [rw] number_of_assignments_pending
1320
+ # The number of assignments for this HIT that are being previewed or
1321
+ # have been accepted by Workers, but have not yet been submitted,
1322
+ # returned, or abandoned.
1323
+ # @return [Integer]
1324
+ #
1325
+ # @!attribute [rw] number_of_assignments_available
1326
+ # The number of assignments for this HIT that are available for
1327
+ # Workers to accept.
1328
+ # @return [Integer]
1329
+ #
1330
+ # @!attribute [rw] number_of_assignments_completed
1331
+ # The number of assignments for this HIT that have been approved or
1332
+ # rejected.
1333
+ # @return [Integer]
1334
+ #
1335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/HIT AWS API Documentation
1336
+ #
1337
+ class HIT < Struct.new(
1338
+ :hit_id,
1339
+ :hit_type_id,
1340
+ :hit_group_id,
1341
+ :hit_layout_id,
1342
+ :creation_time,
1343
+ :title,
1344
+ :description,
1345
+ :question,
1346
+ :keywords,
1347
+ :hit_status,
1348
+ :max_assignments,
1349
+ :reward,
1350
+ :auto_approval_delay_in_seconds,
1351
+ :expiration,
1352
+ :assignment_duration_in_seconds,
1353
+ :requester_annotation,
1354
+ :qualification_requirements,
1355
+ :hit_review_status,
1356
+ :number_of_assignments_pending,
1357
+ :number_of_assignments_available,
1358
+ :number_of_assignments_completed)
1359
+ include Aws::Structure
1360
+ end
1361
+
1362
+ # The HITLayoutParameter data structure defines parameter values used
1363
+ # with a HITLayout. A HITLayout is a reusable Amazon Mechanical Turk
1364
+ # project template used to provide Human Intelligence Task (HIT)
1365
+ # question data for CreateHIT.
1366
+ #
1367
+ # @note When making an API call, you may pass HITLayoutParameter
1368
+ # data as a hash:
1369
+ #
1370
+ # {
1371
+ # name: "String",
1372
+ # value: "String",
1373
+ # }
1374
+ #
1375
+ # @!attribute [rw] name
1376
+ # The name of the parameter in the HITLayout.
1377
+ # @return [String]
1378
+ #
1379
+ # @!attribute [rw] value
1380
+ # The value substituted for the parameter referenced in the HITLayout.
1381
+ # @return [String]
1382
+ #
1383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/HITLayoutParameter AWS API Documentation
1384
+ #
1385
+ class HITLayoutParameter < Struct.new(
1386
+ :name,
1387
+ :value)
1388
+ include Aws::Structure
1389
+ end
1390
+
1391
+ # @note When making an API call, you may pass ListAssignmentsForHITRequest
1392
+ # data as a hash:
1393
+ #
1394
+ # {
1395
+ # hit_id: "EntityId", # required
1396
+ # next_token: "PaginationToken",
1397
+ # max_results: 1,
1398
+ # assignment_statuses: ["Submitted"], # accepts Submitted, Approved, Rejected
1399
+ # }
1400
+ #
1401
+ # @!attribute [rw] hit_id
1402
+ # The ID of the HIT.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] next_token
1406
+ # Pagination token
1407
+ # @return [String]
1408
+ #
1409
+ # @!attribute [rw] max_results
1410
+ # @return [Integer]
1411
+ #
1412
+ # @!attribute [rw] assignment_statuses
1413
+ # The status of the assignments to return: Submitted \| Approved \|
1414
+ # Rejected
1415
+ # @return [Array<String>]
1416
+ #
1417
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListAssignmentsForHITRequest AWS API Documentation
1418
+ #
1419
+ class ListAssignmentsForHITRequest < Struct.new(
1420
+ :hit_id,
1421
+ :next_token,
1422
+ :max_results,
1423
+ :assignment_statuses)
1424
+ include Aws::Structure
1425
+ end
1426
+
1427
+ # @!attribute [rw] next_token
1428
+ # If the previous response was incomplete (because there is more data
1429
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1430
+ # the response. You can use this pagination token to retrieve the next
1431
+ # set of results.
1432
+ # @return [String]
1433
+ #
1434
+ # @!attribute [rw] num_results
1435
+ # The number of assignments on the page in the filtered results list,
1436
+ # equivalent to the number of assignments returned by this call.
1437
+ # @return [Integer]
1438
+ #
1439
+ # @!attribute [rw] assignments
1440
+ # The collection of Assignment data structures returned by this call.
1441
+ # @return [Array<Types::Assignment>]
1442
+ #
1443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListAssignmentsForHITResponse AWS API Documentation
1444
+ #
1445
+ class ListAssignmentsForHITResponse < Struct.new(
1446
+ :next_token,
1447
+ :num_results,
1448
+ :assignments)
1449
+ include Aws::Structure
1450
+ end
1451
+
1452
+ # @note When making an API call, you may pass ListBonusPaymentsRequest
1453
+ # data as a hash:
1454
+ #
1455
+ # {
1456
+ # hit_id: "EntityId",
1457
+ # assignment_id: "EntityId",
1458
+ # next_token: "PaginationToken",
1459
+ # max_results: 1,
1460
+ # }
1461
+ #
1462
+ # @!attribute [rw] hit_id
1463
+ # The ID of the HIT associated with the bonus payments to retrieve. If
1464
+ # not specified, all bonus payments for all assignments for the given
1465
+ # HIT are returned. Either the HITId parameter or the AssignmentId
1466
+ # parameter must be specified
1467
+ # @return [String]
1468
+ #
1469
+ # @!attribute [rw] assignment_id
1470
+ # The ID of the assignment associated with the bonus payments to
1471
+ # retrieve. If specified, only bonus payments for the given assignment
1472
+ # are returned. Either the HITId parameter or the AssignmentId
1473
+ # parameter must be specified
1474
+ # @return [String]
1475
+ #
1476
+ # @!attribute [rw] next_token
1477
+ # Pagination token
1478
+ # @return [String]
1479
+ #
1480
+ # @!attribute [rw] max_results
1481
+ # @return [Integer]
1482
+ #
1483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListBonusPaymentsRequest AWS API Documentation
1484
+ #
1485
+ class ListBonusPaymentsRequest < Struct.new(
1486
+ :hit_id,
1487
+ :assignment_id,
1488
+ :next_token,
1489
+ :max_results)
1490
+ include Aws::Structure
1491
+ end
1492
+
1493
+ # @!attribute [rw] num_results
1494
+ # The number of bonus payments on this page in the filtered results
1495
+ # list, equivalent to the number of bonus payments being returned by
1496
+ # this call.
1497
+ # @return [Integer]
1498
+ #
1499
+ # @!attribute [rw] next_token
1500
+ # If the previous response was incomplete (because there is more data
1501
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1502
+ # the response. You can use this pagination token to retrieve the next
1503
+ # set of results.
1504
+ # @return [String]
1505
+ #
1506
+ # @!attribute [rw] bonus_payments
1507
+ # A successful request to the ListBonusPayments operation returns a
1508
+ # list of BonusPayment objects.
1509
+ # @return [Array<Types::BonusPayment>]
1510
+ #
1511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListBonusPaymentsResponse AWS API Documentation
1512
+ #
1513
+ class ListBonusPaymentsResponse < Struct.new(
1514
+ :num_results,
1515
+ :next_token,
1516
+ :bonus_payments)
1517
+ include Aws::Structure
1518
+ end
1519
+
1520
+ # @note When making an API call, you may pass ListHITsForQualificationTypeRequest
1521
+ # data as a hash:
1522
+ #
1523
+ # {
1524
+ # qualification_type_id: "EntityId", # required
1525
+ # next_token: "PaginationToken",
1526
+ # max_results: 1,
1527
+ # }
1528
+ #
1529
+ # @!attribute [rw] qualification_type_id
1530
+ # The ID of the Qualification type to use when querying HITs.
1531
+ # @return [String]
1532
+ #
1533
+ # @!attribute [rw] next_token
1534
+ # Pagination Token
1535
+ # @return [String]
1536
+ #
1537
+ # @!attribute [rw] max_results
1538
+ # Limit the number of results returned.
1539
+ # @return [Integer]
1540
+ #
1541
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListHITsForQualificationTypeRequest AWS API Documentation
1542
+ #
1543
+ class ListHITsForQualificationTypeRequest < Struct.new(
1544
+ :qualification_type_id,
1545
+ :next_token,
1546
+ :max_results)
1547
+ include Aws::Structure
1548
+ end
1549
+
1550
+ # @!attribute [rw] next_token
1551
+ # If the previous response was incomplete (because there is more data
1552
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1553
+ # the response. You can use this pagination token to retrieve the next
1554
+ # set of results.
1555
+ # @return [String]
1556
+ #
1557
+ # @!attribute [rw] num_results
1558
+ # The number of HITs on this page in the filtered results list,
1559
+ # equivalent to the number of HITs being returned by this call.
1560
+ # @return [Integer]
1561
+ #
1562
+ # @!attribute [rw] hi_ts
1563
+ # The list of HIT elements returned by the query.
1564
+ # @return [Array<Types::HIT>]
1565
+ #
1566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListHITsForQualificationTypeResponse AWS API Documentation
1567
+ #
1568
+ class ListHITsForQualificationTypeResponse < Struct.new(
1569
+ :next_token,
1570
+ :num_results,
1571
+ :hi_ts)
1572
+ include Aws::Structure
1573
+ end
1574
+
1575
+ # @note When making an API call, you may pass ListHITsRequest
1576
+ # data as a hash:
1577
+ #
1578
+ # {
1579
+ # next_token: "PaginationToken",
1580
+ # max_results: 1,
1581
+ # }
1582
+ #
1583
+ # @!attribute [rw] next_token
1584
+ # Pagination token
1585
+ # @return [String]
1586
+ #
1587
+ # @!attribute [rw] max_results
1588
+ # @return [Integer]
1589
+ #
1590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListHITsRequest AWS API Documentation
1591
+ #
1592
+ class ListHITsRequest < Struct.new(
1593
+ :next_token,
1594
+ :max_results)
1595
+ include Aws::Structure
1596
+ end
1597
+
1598
+ # @!attribute [rw] next_token
1599
+ # If the previous response was incomplete (because there is more data
1600
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1601
+ # the response. You can use this pagination token to retrieve the next
1602
+ # set of results.
1603
+ # @return [String]
1604
+ #
1605
+ # @!attribute [rw] num_results
1606
+ # The number of HITs on this page in the filtered results list,
1607
+ # equivalent to the number of HITs being returned by this call.
1608
+ # @return [Integer]
1609
+ #
1610
+ # @!attribute [rw] hi_ts
1611
+ # The list of HIT elements returned by the query.
1612
+ # @return [Array<Types::HIT>]
1613
+ #
1614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListHITsResponse AWS API Documentation
1615
+ #
1616
+ class ListHITsResponse < Struct.new(
1617
+ :next_token,
1618
+ :num_results,
1619
+ :hi_ts)
1620
+ include Aws::Structure
1621
+ end
1622
+
1623
+ # @note When making an API call, you may pass ListQualificationRequestsRequest
1624
+ # data as a hash:
1625
+ #
1626
+ # {
1627
+ # qualification_type_id: "EntityId",
1628
+ # next_token: "PaginationToken",
1629
+ # max_results: 1,
1630
+ # }
1631
+ #
1632
+ # @!attribute [rw] qualification_type_id
1633
+ # The ID of the QualificationType.
1634
+ # @return [String]
1635
+ #
1636
+ # @!attribute [rw] next_token
1637
+ # If the previous response was incomplete (because there is more data
1638
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1639
+ # the response. You can use this pagination token to retrieve the next
1640
+ # set of results.
1641
+ # @return [String]
1642
+ #
1643
+ # @!attribute [rw] max_results
1644
+ # The maximum number of results to return in a single call.
1645
+ # @return [Integer]
1646
+ #
1647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListQualificationRequestsRequest AWS API Documentation
1648
+ #
1649
+ class ListQualificationRequestsRequest < Struct.new(
1650
+ :qualification_type_id,
1651
+ :next_token,
1652
+ :max_results)
1653
+ include Aws::Structure
1654
+ end
1655
+
1656
+ # @!attribute [rw] num_results
1657
+ # The number of Qualification requests on this page in the filtered
1658
+ # results list, equivalent to the number of Qualification requests
1659
+ # being returned by this call.
1660
+ # @return [Integer]
1661
+ #
1662
+ # @!attribute [rw] next_token
1663
+ # If the previous response was incomplete (because there is more data
1664
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1665
+ # the response. You can use this pagination token to retrieve the next
1666
+ # set of results.
1667
+ # @return [String]
1668
+ #
1669
+ # @!attribute [rw] qualification_requests
1670
+ # The Qualification request. The response includes one
1671
+ # QualificationRequest element for each Qualification request returned
1672
+ # by the query.
1673
+ # @return [Array<Types::QualificationRequest>]
1674
+ #
1675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListQualificationRequestsResponse AWS API Documentation
1676
+ #
1677
+ class ListQualificationRequestsResponse < Struct.new(
1678
+ :num_results,
1679
+ :next_token,
1680
+ :qualification_requests)
1681
+ include Aws::Structure
1682
+ end
1683
+
1684
+ # @note When making an API call, you may pass ListQualificationTypesRequest
1685
+ # data as a hash:
1686
+ #
1687
+ # {
1688
+ # query: "String",
1689
+ # must_be_requestable: false, # required
1690
+ # must_be_owned_by_caller: false,
1691
+ # next_token: "PaginationToken",
1692
+ # max_results: 1,
1693
+ # }
1694
+ #
1695
+ # @!attribute [rw] query
1696
+ # A text query against all of the searchable attributes of
1697
+ # Qualification types.
1698
+ # @return [String]
1699
+ #
1700
+ # @!attribute [rw] must_be_requestable
1701
+ # Specifies that only Qualification types that a user can request
1702
+ # through the Amazon Mechanical Turk web site, such as by taking a
1703
+ # Qualification test, are returned as results of the search. Some
1704
+ # Qualification types, such as those assigned automatically by the
1705
+ # system, cannot be requested directly by users. If false, all
1706
+ # Qualification types, including those managed by the system, are
1707
+ # considered. Valid values are True \| False.
1708
+ # @return [Boolean]
1709
+ #
1710
+ # @!attribute [rw] must_be_owned_by_caller
1711
+ # Specifies that only Qualification types that the Requester created
1712
+ # are returned. If false, the operation returns all Qualification
1713
+ # types.
1714
+ # @return [Boolean]
1715
+ #
1716
+ # @!attribute [rw] next_token
1717
+ # If the previous response was incomplete (because there is more data
1718
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1719
+ # the response. You can use this pagination token to retrieve the next
1720
+ # set of results.
1721
+ # @return [String]
1722
+ #
1723
+ # @!attribute [rw] max_results
1724
+ # The maximum number of results to return in a single call.
1725
+ # @return [Integer]
1726
+ #
1727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListQualificationTypesRequest AWS API Documentation
1728
+ #
1729
+ class ListQualificationTypesRequest < Struct.new(
1730
+ :query,
1731
+ :must_be_requestable,
1732
+ :must_be_owned_by_caller,
1733
+ :next_token,
1734
+ :max_results)
1735
+ include Aws::Structure
1736
+ end
1737
+
1738
+ # @!attribute [rw] num_results
1739
+ # The number of Qualification types on this page in the filtered
1740
+ # results list, equivalent to the number of types this operation
1741
+ # returns.
1742
+ # @return [Integer]
1743
+ #
1744
+ # @!attribute [rw] next_token
1745
+ # If the previous response was incomplete (because there is more data
1746
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1747
+ # the response. You can use this pagination token to retrieve the next
1748
+ # set of results.
1749
+ # @return [String]
1750
+ #
1751
+ # @!attribute [rw] qualification_types
1752
+ # The list of QualificationType elements returned by the query.
1753
+ # @return [Array<Types::QualificationType>]
1754
+ #
1755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListQualificationTypesResponse AWS API Documentation
1756
+ #
1757
+ class ListQualificationTypesResponse < Struct.new(
1758
+ :num_results,
1759
+ :next_token,
1760
+ :qualification_types)
1761
+ include Aws::Structure
1762
+ end
1763
+
1764
+ # @note When making an API call, you may pass ListReviewPolicyResultsForHITRequest
1765
+ # data as a hash:
1766
+ #
1767
+ # {
1768
+ # hit_id: "EntityId", # required
1769
+ # policy_levels: ["Assignment"], # accepts Assignment, HIT
1770
+ # retrieve_actions: false,
1771
+ # retrieve_results: false,
1772
+ # next_token: "PaginationToken",
1773
+ # max_results: 1,
1774
+ # }
1775
+ #
1776
+ # @!attribute [rw] hit_id
1777
+ # The unique identifier of the HIT to retrieve review results for.
1778
+ # @return [String]
1779
+ #
1780
+ # @!attribute [rw] policy_levels
1781
+ # The Policy Level(s) to retrieve review results for - HIT or
1782
+ # Assignment. If omitted, the default behavior is to retrieve all data
1783
+ # for both policy levels. For a list of all the described policies,
1784
+ # see Review Policies.
1785
+ # @return [Array<String>]
1786
+ #
1787
+ # @!attribute [rw] retrieve_actions
1788
+ # Specify if the operation should retrieve a list of the actions taken
1789
+ # executing the Review Policies and their outcomes.
1790
+ # @return [Boolean]
1791
+ #
1792
+ # @!attribute [rw] retrieve_results
1793
+ # Specify if the operation should retrieve a list of the results
1794
+ # computed by the Review Policies.
1795
+ # @return [Boolean]
1796
+ #
1797
+ # @!attribute [rw] next_token
1798
+ # Pagination token
1799
+ # @return [String]
1800
+ #
1801
+ # @!attribute [rw] max_results
1802
+ # Limit the number of results returned.
1803
+ # @return [Integer]
1804
+ #
1805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListReviewPolicyResultsForHITRequest AWS API Documentation
1806
+ #
1807
+ class ListReviewPolicyResultsForHITRequest < Struct.new(
1808
+ :hit_id,
1809
+ :policy_levels,
1810
+ :retrieve_actions,
1811
+ :retrieve_results,
1812
+ :next_token,
1813
+ :max_results)
1814
+ include Aws::Structure
1815
+ end
1816
+
1817
+ # @!attribute [rw] hit_id
1818
+ # The HITId of the HIT for which results have been returned.
1819
+ # @return [String]
1820
+ #
1821
+ # @!attribute [rw] assignment_review_policy
1822
+ # The name of the Assignment-level Review Policy. This contains only
1823
+ # the PolicyName element.
1824
+ # @return [Types::ReviewPolicy]
1825
+ #
1826
+ # @!attribute [rw] hit_review_policy
1827
+ # The name of the HIT-level Review Policy. This contains only the
1828
+ # PolicyName element.
1829
+ # @return [Types::ReviewPolicy]
1830
+ #
1831
+ # @!attribute [rw] assignment_review_report
1832
+ # Contains both ReviewResult and ReviewAction elements for an
1833
+ # Assignment.
1834
+ # @return [Types::ReviewReport]
1835
+ #
1836
+ # @!attribute [rw] hit_review_report
1837
+ # Contains both ReviewResult and ReviewAction elements for a
1838
+ # particular HIT.
1839
+ # @return [Types::ReviewReport]
1840
+ #
1841
+ # @!attribute [rw] next_token
1842
+ # If the previous response was incomplete (because there is more data
1843
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1844
+ # the response. You can use this pagination token to retrieve the next
1845
+ # set of results.
1846
+ # @return [String]
1847
+ #
1848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListReviewPolicyResultsForHITResponse AWS API Documentation
1849
+ #
1850
+ class ListReviewPolicyResultsForHITResponse < Struct.new(
1851
+ :hit_id,
1852
+ :assignment_review_policy,
1853
+ :hit_review_policy,
1854
+ :assignment_review_report,
1855
+ :hit_review_report,
1856
+ :next_token)
1857
+ include Aws::Structure
1858
+ end
1859
+
1860
+ # @note When making an API call, you may pass ListReviewableHITsRequest
1861
+ # data as a hash:
1862
+ #
1863
+ # {
1864
+ # hit_type_id: "EntityId",
1865
+ # status: "Reviewable", # accepts Reviewable, Reviewing
1866
+ # next_token: "PaginationToken",
1867
+ # max_results: 1,
1868
+ # }
1869
+ #
1870
+ # @!attribute [rw] hit_type_id
1871
+ # The ID of the HIT type of the HITs to consider for the query. If not
1872
+ # specified, all HITs for the Reviewer are considered
1873
+ # @return [String]
1874
+ #
1875
+ # @!attribute [rw] status
1876
+ # Can be either `Reviewable` or `Reviewing`. Reviewable is the default
1877
+ # value.
1878
+ # @return [String]
1879
+ #
1880
+ # @!attribute [rw] next_token
1881
+ # Pagination Token
1882
+ # @return [String]
1883
+ #
1884
+ # @!attribute [rw] max_results
1885
+ # Limit the number of results returned.
1886
+ # @return [Integer]
1887
+ #
1888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListReviewableHITsRequest AWS API Documentation
1889
+ #
1890
+ class ListReviewableHITsRequest < Struct.new(
1891
+ :hit_type_id,
1892
+ :status,
1893
+ :next_token,
1894
+ :max_results)
1895
+ include Aws::Structure
1896
+ end
1897
+
1898
+ # @!attribute [rw] next_token
1899
+ # If the previous response was incomplete (because there is more data
1900
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1901
+ # the response. You can use this pagination token to retrieve the next
1902
+ # set of results.
1903
+ # @return [String]
1904
+ #
1905
+ # @!attribute [rw] num_results
1906
+ # The number of HITs on this page in the filtered results list,
1907
+ # equivalent to the number of HITs being returned by this call.
1908
+ # @return [Integer]
1909
+ #
1910
+ # @!attribute [rw] hi_ts
1911
+ # The list of HIT elements returned by the query.
1912
+ # @return [Array<Types::HIT>]
1913
+ #
1914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListReviewableHITsResponse AWS API Documentation
1915
+ #
1916
+ class ListReviewableHITsResponse < Struct.new(
1917
+ :next_token,
1918
+ :num_results,
1919
+ :hi_ts)
1920
+ include Aws::Structure
1921
+ end
1922
+
1923
+ # @note When making an API call, you may pass ListWorkerBlocksRequest
1924
+ # data as a hash:
1925
+ #
1926
+ # {
1927
+ # next_token: "PaginationToken",
1928
+ # max_results: 1,
1929
+ # }
1930
+ #
1931
+ # @!attribute [rw] next_token
1932
+ # Pagination token
1933
+ # @return [String]
1934
+ #
1935
+ # @!attribute [rw] max_results
1936
+ # @return [Integer]
1937
+ #
1938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListWorkerBlocksRequest AWS API Documentation
1939
+ #
1940
+ class ListWorkerBlocksRequest < Struct.new(
1941
+ :next_token,
1942
+ :max_results)
1943
+ include Aws::Structure
1944
+ end
1945
+
1946
+ # @!attribute [rw] next_token
1947
+ # If the previous response was incomplete (because there is more data
1948
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
1949
+ # the response. You can use this pagination token to retrieve the next
1950
+ # set of results.
1951
+ # @return [String]
1952
+ #
1953
+ # @!attribute [rw] num_results
1954
+ # The number of assignments on the page in the filtered results list,
1955
+ # equivalent to the number of assignments returned by this call.
1956
+ # @return [Integer]
1957
+ #
1958
+ # @!attribute [rw] worker_blocks
1959
+ # The list of WorkerBlocks, containing the collection of Worker IDs
1960
+ # and reasons for blocking.
1961
+ # @return [Array<Types::WorkerBlock>]
1962
+ #
1963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListWorkerBlocksResponse AWS API Documentation
1964
+ #
1965
+ class ListWorkerBlocksResponse < Struct.new(
1966
+ :next_token,
1967
+ :num_results,
1968
+ :worker_blocks)
1969
+ include Aws::Structure
1970
+ end
1971
+
1972
+ # @note When making an API call, you may pass ListWorkersWithQualificationTypeRequest
1973
+ # data as a hash:
1974
+ #
1975
+ # {
1976
+ # qualification_type_id: "EntityId", # required
1977
+ # status: "Granted", # accepts Granted, Revoked
1978
+ # next_token: "PaginationToken",
1979
+ # max_results: 1,
1980
+ # }
1981
+ #
1982
+ # @!attribute [rw] qualification_type_id
1983
+ # The ID of the Qualification type of the Qualifications to return.
1984
+ # @return [String]
1985
+ #
1986
+ # @!attribute [rw] status
1987
+ # The status of the Qualifications to return. Can be `Granted |
1988
+ # Revoked`.
1989
+ # @return [String]
1990
+ #
1991
+ # @!attribute [rw] next_token
1992
+ # Pagination Token
1993
+ # @return [String]
1994
+ #
1995
+ # @!attribute [rw] max_results
1996
+ # Limit the number of results returned.
1997
+ # @return [Integer]
1998
+ #
1999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListWorkersWithQualificationTypeRequest AWS API Documentation
2000
+ #
2001
+ class ListWorkersWithQualificationTypeRequest < Struct.new(
2002
+ :qualification_type_id,
2003
+ :status,
2004
+ :next_token,
2005
+ :max_results)
2006
+ include Aws::Structure
2007
+ end
2008
+
2009
+ # @!attribute [rw] next_token
2010
+ # If the previous response was incomplete (because there is more data
2011
+ # to retrieve), Amazon Mechanical Turk returns a pagination token in
2012
+ # the response. You can use this pagination token to retrieve the next
2013
+ # set of results.
2014
+ # @return [String]
2015
+ #
2016
+ # @!attribute [rw] num_results
2017
+ # The number of Qualifications on this page in the filtered results
2018
+ # list, equivalent to the number of Qualifications being returned by
2019
+ # this call.
2020
+ # @return [Integer]
2021
+ #
2022
+ # @!attribute [rw] qualifications
2023
+ # The list of Qualification elements returned by this call.
2024
+ # @return [Array<Types::Qualification>]
2025
+ #
2026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListWorkersWithQualificationTypeResponse AWS API Documentation
2027
+ #
2028
+ class ListWorkersWithQualificationTypeResponse < Struct.new(
2029
+ :next_token,
2030
+ :num_results,
2031
+ :qualifications)
2032
+ include Aws::Structure
2033
+ end
2034
+
2035
+ # The Locale data structure represents a geographical region or
2036
+ # location.
2037
+ #
2038
+ # @note When making an API call, you may pass Locale
2039
+ # data as a hash:
2040
+ #
2041
+ # {
2042
+ # country: "CountryParameters", # required
2043
+ # subdivision: "CountryParameters",
2044
+ # }
2045
+ #
2046
+ # @!attribute [rw] country
2047
+ # The country of the locale. Must be a valid ISO 3166 country code.
2048
+ # For example, the code US refers to the United States of America.
2049
+ # @return [String]
2050
+ #
2051
+ # @!attribute [rw] subdivision
2052
+ # The state or subdivision of the locale. A valid ISO 3166-2
2053
+ # subdivision code. For example, the code WA refers to the state of
2054
+ # Washington.
2055
+ # @return [String]
2056
+ #
2057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/Locale AWS API Documentation
2058
+ #
2059
+ class Locale < Struct.new(
2060
+ :country,
2061
+ :subdivision)
2062
+ include Aws::Structure
2063
+ end
2064
+
2065
+ # The NotificationSpecification data structure describes a HIT event
2066
+ # notification for a HIT type.
2067
+ #
2068
+ # @note When making an API call, you may pass NotificationSpecification
2069
+ # data as a hash:
2070
+ #
2071
+ # {
2072
+ # destination: "String", # required
2073
+ # transport: "Email", # required, accepts Email, SQS
2074
+ # version: "String",
2075
+ # event_types: ["AssignmentAccepted"], # accepts AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping
2076
+ # }
2077
+ #
2078
+ # @!attribute [rw] destination
2079
+ # The destination for notification messages. or email notifications
2080
+ # (if Transport is Email), this is an email address. For Amazon Simple
2081
+ # Queue Service (Amazon SQS) notifications (if Transport is SQS), this
2082
+ # is the URL for your Amazon SQS queue.
2083
+ # @return [String]
2084
+ #
2085
+ # @!attribute [rw] transport
2086
+ # The method Amazon Mechanical Turk uses to send the notification.
2087
+ # Valid Values: Email \| SQS.
2088
+ # @return [String]
2089
+ #
2090
+ # @!attribute [rw] version
2091
+ # The version of the Notification API to use. Valid value is
2092
+ # 2006-05-05.
2093
+ # @return [String]
2094
+ #
2095
+ # @!attribute [rw] event_types
2096
+ # The list of events that should cause notifications to be sent. Valid
2097
+ # Values: AssignmentAccepted \| AssignmentAbandoned \|
2098
+ # AssignmentReturned \| AssignmentSubmitted \| AssignmentRejected \|
2099
+ # AssignmentApproved \| HITCreated \| HITExtended \| HITDisposed \|
2100
+ # HITReviewable \| HITExpired \| Ping. The Ping event is only valid
2101
+ # for the SendTestEventNotification operation.
2102
+ # @return [Array<String>]
2103
+ #
2104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/NotificationSpecification AWS API Documentation
2105
+ #
2106
+ class NotificationSpecification < Struct.new(
2107
+ :destination,
2108
+ :transport,
2109
+ :version,
2110
+ :event_types)
2111
+ include Aws::Structure
2112
+ end
2113
+
2114
+ # When MTurk encounters an issue with notifying the Workers you
2115
+ # specified, it returns back this object with failure details.
2116
+ #
2117
+ # @!attribute [rw] notify_workers_failure_code
2118
+ # Encoded value for the failure type.
2119
+ # @return [String]
2120
+ #
2121
+ # @!attribute [rw] notify_workers_failure_message
2122
+ # A message detailing the reason the Worker could not be notified.
2123
+ # @return [String]
2124
+ #
2125
+ # @!attribute [rw] worker_id
2126
+ # The ID of the Worker.
2127
+ # @return [String]
2128
+ #
2129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/NotifyWorkersFailureStatus AWS API Documentation
2130
+ #
2131
+ class NotifyWorkersFailureStatus < Struct.new(
2132
+ :notify_workers_failure_code,
2133
+ :notify_workers_failure_message,
2134
+ :worker_id)
2135
+ include Aws::Structure
2136
+ end
2137
+
2138
+ # @note When making an API call, you may pass NotifyWorkersRequest
2139
+ # data as a hash:
2140
+ #
2141
+ # {
2142
+ # subject: "String", # required
2143
+ # message_text: "String", # required
2144
+ # worker_ids: ["CustomerId"], # required
2145
+ # }
2146
+ #
2147
+ # @!attribute [rw] subject
2148
+ # The subject line of the email message to send. Can include up to 200
2149
+ # characters.
2150
+ # @return [String]
2151
+ #
2152
+ # @!attribute [rw] message_text
2153
+ # The text of the email message to send. Can include up to 4,096
2154
+ # characters
2155
+ # @return [String]
2156
+ #
2157
+ # @!attribute [rw] worker_ids
2158
+ # A list of Worker IDs you wish to notify. You can notify upto 100
2159
+ # Workers at a time.
2160
+ # @return [Array<String>]
2161
+ #
2162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/NotifyWorkersRequest AWS API Documentation
2163
+ #
2164
+ class NotifyWorkersRequest < Struct.new(
2165
+ :subject,
2166
+ :message_text,
2167
+ :worker_ids)
2168
+ include Aws::Structure
2169
+ end
2170
+
2171
+ # @!attribute [rw] notify_workers_failure_statuses
2172
+ # When MTurk sends notifications to the list of Workers, it returns
2173
+ # back any failures it encounters in this list of
2174
+ # NotifyWorkersFailureStatus objects.
2175
+ # @return [Array<Types::NotifyWorkersFailureStatus>]
2176
+ #
2177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/NotifyWorkersResponse AWS API Documentation
2178
+ #
2179
+ class NotifyWorkersResponse < Struct.new(
2180
+ :notify_workers_failure_statuses)
2181
+ include Aws::Structure
2182
+ end
2183
+
2184
+ # This data structure is the data type for the AnswerKey parameter of
2185
+ # the ScoreMyKnownAnswers/2011-09-01 Review Policy.
2186
+ #
2187
+ # @note When making an API call, you may pass ParameterMapEntry
2188
+ # data as a hash:
2189
+ #
2190
+ # {
2191
+ # key: "String",
2192
+ # values: ["String"],
2193
+ # }
2194
+ #
2195
+ # @!attribute [rw] key
2196
+ # The QuestionID from the HIT that is used to identify which question
2197
+ # requires Mechanical Turk to score as part of the
2198
+ # ScoreMyKnownAnswers/2011-09-01 Review Policy.
2199
+ # @return [String]
2200
+ #
2201
+ # @!attribute [rw] values
2202
+ # The list of answers to the question specified in the MapEntry Key
2203
+ # element. The Worker must match all values in order for the answer to
2204
+ # be scored correctly.
2205
+ # @return [Array<String>]
2206
+ #
2207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ParameterMapEntry AWS API Documentation
2208
+ #
2209
+ class ParameterMapEntry < Struct.new(
2210
+ :key,
2211
+ :values)
2212
+ include Aws::Structure
2213
+ end
2214
+
2215
+ # Name of the parameter from the Review policy.
2216
+ #
2217
+ # @note When making an API call, you may pass PolicyParameter
2218
+ # data as a hash:
2219
+ #
2220
+ # {
2221
+ # key: "String",
2222
+ # values: ["String"],
2223
+ # map_entries: [
2224
+ # {
2225
+ # key: "String",
2226
+ # values: ["String"],
2227
+ # },
2228
+ # ],
2229
+ # }
2230
+ #
2231
+ # @!attribute [rw] key
2232
+ # Name of the parameter from the list of Review Polices.
2233
+ # @return [String]
2234
+ #
2235
+ # @!attribute [rw] values
2236
+ # The list of values of the Parameter
2237
+ # @return [Array<String>]
2238
+ #
2239
+ # @!attribute [rw] map_entries
2240
+ # List of ParameterMapEntry objects.
2241
+ # @return [Array<Types::ParameterMapEntry>]
2242
+ #
2243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/PolicyParameter AWS API Documentation
2244
+ #
2245
+ class PolicyParameter < Struct.new(
2246
+ :key,
2247
+ :values,
2248
+ :map_entries)
2249
+ include Aws::Structure
2250
+ end
2251
+
2252
+ # The Qualification data structure represents a Qualification assigned
2253
+ # to a user, including the Qualification type and the value (score).
2254
+ #
2255
+ # @!attribute [rw] qualification_type_id
2256
+ # The ID of the Qualification type for the Qualification.
2257
+ # @return [String]
2258
+ #
2259
+ # @!attribute [rw] worker_id
2260
+ # The ID of the Worker who possesses the Qualification.
2261
+ # @return [String]
2262
+ #
2263
+ # @!attribute [rw] grant_time
2264
+ # The date and time the Qualification was granted to the Worker. If
2265
+ # the Worker's Qualification was revoked, and then re-granted based
2266
+ # on a new Qualification request, GrantTime is the date and time of
2267
+ # the last call to the AcceptQualificationRequest operation.
2268
+ # @return [Time]
2269
+ #
2270
+ # @!attribute [rw] integer_value
2271
+ # The value (score) of the Qualification, if the Qualification has an
2272
+ # integer value.
2273
+ # @return [Integer]
2274
+ #
2275
+ # @!attribute [rw] locale_value
2276
+ # The Locale data structure represents a geographical region or
2277
+ # location.
2278
+ # @return [Types::Locale]
2279
+ #
2280
+ # @!attribute [rw] status
2281
+ # The status of the Qualification. Valid values are Granted \|
2282
+ # Revoked.
2283
+ # @return [String]
2284
+ #
2285
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/Qualification AWS API Documentation
2286
+ #
2287
+ class Qualification < Struct.new(
2288
+ :qualification_type_id,
2289
+ :worker_id,
2290
+ :grant_time,
2291
+ :integer_value,
2292
+ :locale_value,
2293
+ :status)
2294
+ include Aws::Structure
2295
+ end
2296
+
2297
+ # The QualificationRequest data structure represents a request a Worker
2298
+ # has made for a Qualification.
2299
+ #
2300
+ # @!attribute [rw] qualification_request_id
2301
+ # The ID of the Qualification request, a unique identifier generated
2302
+ # when the request was submitted.
2303
+ # @return [String]
2304
+ #
2305
+ # @!attribute [rw] qualification_type_id
2306
+ # The ID of the Qualification type the Worker is requesting, as
2307
+ # returned by the CreateQualificationType operation.
2308
+ # @return [String]
2309
+ #
2310
+ # @!attribute [rw] worker_id
2311
+ # The ID of the Worker requesting the Qualification.
2312
+ # @return [String]
2313
+ #
2314
+ # @!attribute [rw] test
2315
+ # The contents of the Qualification test that was presented to the
2316
+ # Worker, if the type has a test and the Worker has submitted answers.
2317
+ # This value is identical to the QuestionForm associated with the
2318
+ # Qualification type at the time the Worker requests the
2319
+ # Qualification.
2320
+ # @return [String]
2321
+ #
2322
+ # @!attribute [rw] answer
2323
+ # The Worker's answers for the Qualification type's test contained
2324
+ # in a QuestionFormAnswers document, if the type has a test and the
2325
+ # Worker has submitted answers. If the Worker does not provide any
2326
+ # answers, Answer may be empty.
2327
+ # @return [String]
2328
+ #
2329
+ # @!attribute [rw] submit_time
2330
+ # The date and time the Qualification request had a status of
2331
+ # Submitted. This is either the time the Worker submitted answers for
2332
+ # a Qualification test, or the time the Worker requested the
2333
+ # Qualification if the Qualification type does not have a test.
2334
+ # @return [Time]
2335
+ #
2336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/QualificationRequest AWS API Documentation
2337
+ #
2338
+ class QualificationRequest < Struct.new(
2339
+ :qualification_request_id,
2340
+ :qualification_type_id,
2341
+ :worker_id,
2342
+ :test,
2343
+ :answer,
2344
+ :submit_time)
2345
+ include Aws::Structure
2346
+ end
2347
+
2348
+ # The QualificationRequirement data structure describes a Qualification
2349
+ # that a Worker must have before the Worker is allowed to accept a HIT.
2350
+ # A requirement may optionally state that a Worker must have the
2351
+ # Qualification in order to preview the HIT.
2352
+ #
2353
+ # @note When making an API call, you may pass QualificationRequirement
2354
+ # data as a hash:
2355
+ #
2356
+ # {
2357
+ # qualification_type_id: "String", # required
2358
+ # comparator: "LessThan", # required, accepts LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, NotEqualTo, Exists, DoesNotExist, In, NotIn
2359
+ # integer_values: [1],
2360
+ # locale_values: [
2361
+ # {
2362
+ # country: "CountryParameters", # required
2363
+ # subdivision: "CountryParameters",
2364
+ # },
2365
+ # ],
2366
+ # required_to_preview: false,
2367
+ # }
2368
+ #
2369
+ # @!attribute [rw] qualification_type_id
2370
+ # The ID of the Qualification type for the requirement.
2371
+ # @return [String]
2372
+ #
2373
+ # @!attribute [rw] comparator
2374
+ # The kind of comparison to make against a Qualification's value. You
2375
+ # can compare a Qualification's value to an IntegerValue to see if it
2376
+ # is LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo,
2377
+ # EqualTo, or NotEqualTo the IntegerValue. You can compare it to a
2378
+ # LocaleValue to see if it is EqualTo, or NotEqualTo the LocaleValue.
2379
+ # You can check to see if the value is In or NotIn a set of
2380
+ # IntegerValue or LocaleValue values. Lastly, a Qualification
2381
+ # requirement can also test if a Qualification Exists or DoesNotExist
2382
+ # in the user's profile, regardless of its value.
2383
+ # @return [String]
2384
+ #
2385
+ # @!attribute [rw] integer_values
2386
+ # The integer value to compare against the Qualification's value.
2387
+ # IntegerValue must not be present if Comparator is Exists or
2388
+ # DoesNotExist. IntegerValue can only be used if the Qualification
2389
+ # type has an integer value; it cannot be used with the Worker\_Locale
2390
+ # QualificationType ID. When performing a set comparison by using the
2391
+ # In or the NotIn comparator, you can use up to 15 IntegerValue
2392
+ # elements in a QualificationRequirement data structure.
2393
+ # @return [Array<Integer>]
2394
+ #
2395
+ # @!attribute [rw] locale_values
2396
+ # The locale value to compare against the Qualification's value. The
2397
+ # local value must be a valid ISO 3166 country code or supports ISO
2398
+ # 3166-2 subdivisions. LocaleValue can only be used with a
2399
+ # Worker\_Locale QualificationType ID. LocaleValue can only be used
2400
+ # with the EqualTo, NotEqualTo, In, and NotIn comparators. You must
2401
+ # only use a single LocaleValue element when using the EqualTo or
2402
+ # NotEqualTo comparators. When performing a set comparison by using
2403
+ # the In or the NotIn comparator, you can use up to 30 LocaleValue
2404
+ # elements in a QualificationRequirement data structure.
2405
+ # @return [Array<Types::Locale>]
2406
+ #
2407
+ # @!attribute [rw] required_to_preview
2408
+ # If true, the question data for the HIT will not be shown when a
2409
+ # Worker whose Qualifications do not meet this requirement tries to
2410
+ # preview the HIT. That is, a Worker's Qualifications must meet all
2411
+ # of the requirements for which RequiredToPreview is true in order to
2412
+ # preview the HIT. If a Worker meets all of the requirements where
2413
+ # RequiredToPreview is true (or if there are no such requirements),
2414
+ # but does not meet all of the requirements for the HIT, the Worker
2415
+ # will be allowed to preview the HIT's question data, but will not be
2416
+ # allowed to accept and complete the HIT. The default is false.
2417
+ # @return [Boolean]
2418
+ #
2419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/QualificationRequirement AWS API Documentation
2420
+ #
2421
+ class QualificationRequirement < Struct.new(
2422
+ :qualification_type_id,
2423
+ :comparator,
2424
+ :integer_values,
2425
+ :locale_values,
2426
+ :required_to_preview)
2427
+ include Aws::Structure
2428
+ end
2429
+
2430
+ # The QualificationType data structure represents a Qualification type,
2431
+ # a description of a property of a Worker that must match the
2432
+ # requirements of a HIT for the Worker to be able to accept the HIT. The
2433
+ # type also describes how a Worker can obtain a Qualification of that
2434
+ # type, such as through a Qualification test.
2435
+ #
2436
+ # @!attribute [rw] qualification_type_id
2437
+ # A unique identifier for the Qualification type. A Qualification type
2438
+ # is given a Qualification type ID when you call the
2439
+ # CreateQualificationType operation.
2440
+ # @return [String]
2441
+ #
2442
+ # @!attribute [rw] creation_time
2443
+ # The date and time the Qualification type was created.
2444
+ # @return [Time]
2445
+ #
2446
+ # @!attribute [rw] name
2447
+ # The name of the Qualification type. The type name is used to
2448
+ # identify the type, and to find the type using a Qualification type
2449
+ # search.
2450
+ # @return [String]
2451
+ #
2452
+ # @!attribute [rw] description
2453
+ # A long description for the Qualification type.
2454
+ # @return [String]
2455
+ #
2456
+ # @!attribute [rw] keywords
2457
+ # One or more words or phrases that describe theQualification type,
2458
+ # separated by commas. The Keywords make the type easier to find using
2459
+ # a search.
2460
+ # @return [String]
2461
+ #
2462
+ # @!attribute [rw] qualification_type_status
2463
+ # The status of the Qualification type. A Qualification type's status
2464
+ # determines if users can apply to receive a Qualification of this
2465
+ # type, and if HITs can be created with requirements based on this
2466
+ # type. Valid values are Active \| Inactive.
2467
+ # @return [String]
2468
+ #
2469
+ # @!attribute [rw] test
2470
+ # The questions for a Qualification test associated with this
2471
+ # Qualification type that a user can take to obtain a Qualification of
2472
+ # this type. This parameter must be specified if AnswerKey is present.
2473
+ # A Qualification type cannot have both a specified Test parameter and
2474
+ # an AutoGranted value of true.
2475
+ # @return [String]
2476
+ #
2477
+ # @!attribute [rw] test_duration_in_seconds
2478
+ # The amount of time, in seconds, given to a Worker to complete the
2479
+ # Qualification test, beginning from the time the Worker requests the
2480
+ # Qualification.
2481
+ # @return [Integer]
2482
+ #
2483
+ # @!attribute [rw] answer_key
2484
+ # The answers to the Qualification test specified in the Test
2485
+ # parameter.
2486
+ # @return [String]
2487
+ #
2488
+ # @!attribute [rw] retry_delay_in_seconds
2489
+ # The amount of time, in seconds, Workers must wait after taking the
2490
+ # Qualification test before they can take it again. Workers can take a
2491
+ # Qualification test multiple times if they were not granted the
2492
+ # Qualification from a previous attempt, or if the test offers a
2493
+ # gradient score and they want a better score. If not specified,
2494
+ # retries are disabled and Workers can request a Qualification only
2495
+ # once.
2496
+ # @return [Integer]
2497
+ #
2498
+ # @!attribute [rw] is_requestable
2499
+ # Specifies whether the Qualification type is one that a user can
2500
+ # request through the Amazon Mechanical Turk web site, such as by
2501
+ # taking a Qualification test. This value is False for Qualifications
2502
+ # assigned automatically by the system. Valid values are True \|
2503
+ # False.
2504
+ # @return [Boolean]
2505
+ #
2506
+ # @!attribute [rw] auto_granted
2507
+ # Specifies that requests for the Qualification type are granted
2508
+ # immediately, without prompting the Worker with a Qualification test.
2509
+ # Valid values are True \| False.
2510
+ # @return [Boolean]
2511
+ #
2512
+ # @!attribute [rw] auto_granted_value
2513
+ # The Qualification integer value to use for automatically granted
2514
+ # Qualifications, if AutoGranted is true. This is 1 by default.
2515
+ # @return [Integer]
2516
+ #
2517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/QualificationType AWS API Documentation
2518
+ #
2519
+ class QualificationType < Struct.new(
2520
+ :qualification_type_id,
2521
+ :creation_time,
2522
+ :name,
2523
+ :description,
2524
+ :keywords,
2525
+ :qualification_type_status,
2526
+ :test,
2527
+ :test_duration_in_seconds,
2528
+ :answer_key,
2529
+ :retry_delay_in_seconds,
2530
+ :is_requestable,
2531
+ :auto_granted,
2532
+ :auto_granted_value)
2533
+ include Aws::Structure
2534
+ end
2535
+
2536
+ # @note When making an API call, you may pass RejectAssignmentRequest
2537
+ # data as a hash:
2538
+ #
2539
+ # {
2540
+ # assignment_id: "EntityId", # required
2541
+ # requester_feedback: "String",
2542
+ # }
2543
+ #
2544
+ # @!attribute [rw] assignment_id
2545
+ # The ID of the assignment. The assignment must correspond to a HIT
2546
+ # created by the Requester.
2547
+ # @return [String]
2548
+ #
2549
+ # @!attribute [rw] requester_feedback
2550
+ # A message for the Worker, which the Worker can see in the Status
2551
+ # section of the web site.
2552
+ # @return [String]
2553
+ #
2554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/RejectAssignmentRequest AWS API Documentation
2555
+ #
2556
+ class RejectAssignmentRequest < Struct.new(
2557
+ :assignment_id,
2558
+ :requester_feedback)
2559
+ include Aws::Structure
2560
+ end
2561
+
2562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/RejectAssignmentResponse AWS API Documentation
2563
+ #
2564
+ class RejectAssignmentResponse < Aws::EmptyStructure; end
2565
+
2566
+ # @note When making an API call, you may pass RejectQualificationRequestRequest
2567
+ # data as a hash:
2568
+ #
2569
+ # {
2570
+ # qualification_request_id: "String", # required
2571
+ # reason: "String",
2572
+ # }
2573
+ #
2574
+ # @!attribute [rw] qualification_request_id
2575
+ # The ID of the Qualification request, as returned by the
2576
+ # `ListQualificationRequests` operation.
2577
+ # @return [String]
2578
+ #
2579
+ # @!attribute [rw] reason
2580
+ # A text message explaining why the request was rejected, to be shown
2581
+ # to the Worker who made the request.
2582
+ # @return [String]
2583
+ #
2584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/RejectQualificationRequestRequest AWS API Documentation
2585
+ #
2586
+ class RejectQualificationRequestRequest < Struct.new(
2587
+ :qualification_request_id,
2588
+ :reason)
2589
+ include Aws::Structure
2590
+ end
2591
+
2592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/RejectQualificationRequestResponse AWS API Documentation
2593
+ #
2594
+ class RejectQualificationRequestResponse < Aws::EmptyStructure; end
2595
+
2596
+ # Both the AssignmentReviewReport and the HITReviewReport elements
2597
+ # contains the ReviewActionDetail data structure. This structure is
2598
+ # returned multiple times for each action specified in the Review
2599
+ # Policy.
2600
+ #
2601
+ # @!attribute [rw] action_id
2602
+ # The unique identifier for the action.
2603
+ # @return [String]
2604
+ #
2605
+ # @!attribute [rw] action_name
2606
+ # The nature of the action itself. The Review Policy is responsible
2607
+ # for examining the HIT and Assignments, emitting results, and
2608
+ # deciding which other actions will be necessary.
2609
+ # @return [String]
2610
+ #
2611
+ # @!attribute [rw] target_id
2612
+ # The specific HITId or AssignmentID targeted by the action.
2613
+ # @return [String]
2614
+ #
2615
+ # @!attribute [rw] target_type
2616
+ # The type of object in TargetId.
2617
+ # @return [String]
2618
+ #
2619
+ # @!attribute [rw] status
2620
+ # The current disposition of the action: INTENDED, SUCCEEDED, FAILED,
2621
+ # or CANCELLED.
2622
+ # @return [String]
2623
+ #
2624
+ # @!attribute [rw] complete_time
2625
+ # The date when the action was completed.
2626
+ # @return [Time]
2627
+ #
2628
+ # @!attribute [rw] result
2629
+ # A description of the outcome of the review.
2630
+ # @return [String]
2631
+ #
2632
+ # @!attribute [rw] error_code
2633
+ # Present only when the Results have a FAILED Status.
2634
+ # @return [String]
2635
+ #
2636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ReviewActionDetail AWS API Documentation
2637
+ #
2638
+ class ReviewActionDetail < Struct.new(
2639
+ :action_id,
2640
+ :action_name,
2641
+ :target_id,
2642
+ :target_type,
2643
+ :status,
2644
+ :complete_time,
2645
+ :result,
2646
+ :error_code)
2647
+ include Aws::Structure
2648
+ end
2649
+
2650
+ # HIT Review Policy data structures represent HIT review policies, which
2651
+ # you specify when you create a HIT.
2652
+ #
2653
+ # @note When making an API call, you may pass ReviewPolicy
2654
+ # data as a hash:
2655
+ #
2656
+ # {
2657
+ # policy_name: "String",
2658
+ # parameters: [
2659
+ # {
2660
+ # key: "String",
2661
+ # values: ["String"],
2662
+ # map_entries: [
2663
+ # {
2664
+ # key: "String",
2665
+ # values: ["String"],
2666
+ # },
2667
+ # ],
2668
+ # },
2669
+ # ],
2670
+ # }
2671
+ #
2672
+ # @!attribute [rw] policy_name
2673
+ # Name of a Review Policy: SimplePlurality/2011-09-01 or
2674
+ # ScoreMyKnownAnswers/2011-09-01
2675
+ # @return [String]
2676
+ #
2677
+ # @!attribute [rw] parameters
2678
+ # Name of the parameter from the Review policy.
2679
+ # @return [Array<Types::PolicyParameter>]
2680
+ #
2681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ReviewPolicy AWS API Documentation
2682
+ #
2683
+ class ReviewPolicy < Struct.new(
2684
+ :policy_name,
2685
+ :parameters)
2686
+ include Aws::Structure
2687
+ end
2688
+
2689
+ # Contains both ReviewResult and ReviewAction elements for a particular
2690
+ # HIT.
2691
+ #
2692
+ # @!attribute [rw] review_results
2693
+ # A list of ReviewResults objects for each action specified in the
2694
+ # Review Policy.
2695
+ # @return [Array<Types::ReviewResultDetail>]
2696
+ #
2697
+ # @!attribute [rw] review_actions
2698
+ # A list of ReviewAction objects for each action specified in the
2699
+ # Review Policy.
2700
+ # @return [Array<Types::ReviewActionDetail>]
2701
+ #
2702
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ReviewReport AWS API Documentation
2703
+ #
2704
+ class ReviewReport < Struct.new(
2705
+ :review_results,
2706
+ :review_actions)
2707
+ include Aws::Structure
2708
+ end
2709
+
2710
+ # This data structure is returned multiple times for each result
2711
+ # specified in the Review Policy.
2712
+ #
2713
+ # @!attribute [rw] action_id
2714
+ # A unique identifier of the Review action result.
2715
+ # @return [String]
2716
+ #
2717
+ # @!attribute [rw] subject_id
2718
+ # The HITID or AssignmentId about which this result was taken. Note
2719
+ # that HIT-level Review Policies will often emit results about both
2720
+ # the HIT itself and its Assignments, while Assignment-level review
2721
+ # policies generally only emit results about the Assignment itself.
2722
+ # @return [String]
2723
+ #
2724
+ # @!attribute [rw] subject_type
2725
+ # The type of the object from the SubjectId field.
2726
+ # @return [String]
2727
+ #
2728
+ # @!attribute [rw] question_id
2729
+ # Specifies the QuestionId the result is describing. Depending on
2730
+ # whether the TargetType is a HIT or Assignment this results could
2731
+ # specify multiple values. If TargetType is HIT and QuestionId is
2732
+ # absent, then the result describes results of the HIT, including the
2733
+ # HIT agreement score. If ObjectType is Assignment and QuestionId is
2734
+ # absent, then the result describes the Worker's performance on the
2735
+ # HIT.
2736
+ # @return [String]
2737
+ #
2738
+ # @!attribute [rw] key
2739
+ # Key identifies the particular piece of reviewed information.
2740
+ # @return [String]
2741
+ #
2742
+ # @!attribute [rw] value
2743
+ # The values of Key provided by the review policies you have selected.
2744
+ # @return [String]
2745
+ #
2746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ReviewResultDetail AWS API Documentation
2747
+ #
2748
+ class ReviewResultDetail < Struct.new(
2749
+ :action_id,
2750
+ :subject_id,
2751
+ :subject_type,
2752
+ :question_id,
2753
+ :key,
2754
+ :value)
2755
+ include Aws::Structure
2756
+ end
2757
+
2758
+ # @note When making an API call, you may pass SendBonusRequest
2759
+ # data as a hash:
2760
+ #
2761
+ # {
2762
+ # worker_id: "CustomerId", # required
2763
+ # bonus_amount: "NumericValue", # required
2764
+ # assignment_id: "EntityId", # required
2765
+ # reason: "String",
2766
+ # unique_request_token: "IdempotencyToken",
2767
+ # }
2768
+ #
2769
+ # @!attribute [rw] worker_id
2770
+ # The ID of the Worker being paid the bonus.
2771
+ # @return [String]
2772
+ #
2773
+ # @!attribute [rw] bonus_amount
2774
+ # The Bonus amount is a US Dollar amount specified using a string (for
2775
+ # example, "5" represents $5.00 USD and "101.42" represents
2776
+ # $101.42 USD). Do not include currency symbols or currency codes.
2777
+ # @return [String]
2778
+ #
2779
+ # @!attribute [rw] assignment_id
2780
+ # The ID of the assignment for which this bonus is paid.
2781
+ # @return [String]
2782
+ #
2783
+ # @!attribute [rw] reason
2784
+ # A message that explains the reason for the bonus payment. The Worker
2785
+ # receiving the bonus can see this message.
2786
+ # @return [String]
2787
+ #
2788
+ # @!attribute [rw] unique_request_token
2789
+ # A unique identifier for this request, which allows you to retry the
2790
+ # call on error without granting multiple bonuses. This is useful in
2791
+ # cases such as network timeouts where it is unclear whether or not
2792
+ # the call succeeded on the server. If the bonus already exists in the
2793
+ # system from a previous call using the same UniqueRequestToken,
2794
+ # subsequent calls will return an error with a message containing the
2795
+ # request ID.
2796
+ # @return [String]
2797
+ #
2798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/SendBonusRequest AWS API Documentation
2799
+ #
2800
+ class SendBonusRequest < Struct.new(
2801
+ :worker_id,
2802
+ :bonus_amount,
2803
+ :assignment_id,
2804
+ :reason,
2805
+ :unique_request_token)
2806
+ include Aws::Structure
2807
+ end
2808
+
2809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/SendBonusResponse AWS API Documentation
2810
+ #
2811
+ class SendBonusResponse < Aws::EmptyStructure; end
2812
+
2813
+ # @note When making an API call, you may pass SendTestEventNotificationRequest
2814
+ # data as a hash:
2815
+ #
2816
+ # {
2817
+ # notification: { # required
2818
+ # destination: "String", # required
2819
+ # transport: "Email", # required, accepts Email, SQS
2820
+ # version: "String",
2821
+ # event_types: ["AssignmentAccepted"], # accepts AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping
2822
+ # },
2823
+ # test_event_type: "AssignmentAccepted", # required, accepts AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping
2824
+ # }
2825
+ #
2826
+ # @!attribute [rw] notification
2827
+ # The notification specification to test. This value is identical to
2828
+ # the value you would provide to the UpdateNotificationSettings
2829
+ # operation when you establish the notification specification for a
2830
+ # HIT type.
2831
+ # @return [Types::NotificationSpecification]
2832
+ #
2833
+ # @!attribute [rw] test_event_type
2834
+ # The event to simulate to test the notification specification. This
2835
+ # event is included in the test message even if the notification
2836
+ # specification does not include the event type. The notification
2837
+ # specification does not filter out the test event.
2838
+ # @return [String]
2839
+ #
2840
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/SendTestEventNotificationRequest AWS API Documentation
2841
+ #
2842
+ class SendTestEventNotificationRequest < Struct.new(
2843
+ :notification,
2844
+ :test_event_type)
2845
+ include Aws::Structure
2846
+ end
2847
+
2848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/SendTestEventNotificationResponse AWS API Documentation
2849
+ #
2850
+ class SendTestEventNotificationResponse < Aws::EmptyStructure; end
2851
+
2852
+ # @note When making an API call, you may pass UpdateExpirationForHITRequest
2853
+ # data as a hash:
2854
+ #
2855
+ # {
2856
+ # hit_id: "EntityId", # required
2857
+ # expire_at: Time.now,
2858
+ # }
2859
+ #
2860
+ # @!attribute [rw] hit_id
2861
+ # The HIT to update.
2862
+ # @return [String]
2863
+ #
2864
+ # @!attribute [rw] expire_at
2865
+ # The date and time at which you want the HIT to expire
2866
+ # @return [Time]
2867
+ #
2868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateExpirationForHITRequest AWS API Documentation
2869
+ #
2870
+ class UpdateExpirationForHITRequest < Struct.new(
2871
+ :hit_id,
2872
+ :expire_at)
2873
+ include Aws::Structure
2874
+ end
2875
+
2876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateExpirationForHITResponse AWS API Documentation
2877
+ #
2878
+ class UpdateExpirationForHITResponse < Aws::EmptyStructure; end
2879
+
2880
+ # @note When making an API call, you may pass UpdateHITReviewStatusRequest
2881
+ # data as a hash:
2882
+ #
2883
+ # {
2884
+ # hit_id: "EntityId", # required
2885
+ # revert: false,
2886
+ # }
2887
+ #
2888
+ # @!attribute [rw] hit_id
2889
+ # The ID of the HIT to update.
2890
+ # @return [String]
2891
+ #
2892
+ # @!attribute [rw] revert
2893
+ # Specifies how to update the HIT status. Default is `False`.
2894
+ #
2895
+ # * Setting this to false will only transition a HIT from `Reviewable`
2896
+ # to `Reviewing`
2897
+ #
2898
+ # * Setting this to true will only transition a HIT from `Reviewing`
2899
+ # to `Reviewable`
2900
+ # @return [Boolean]
2901
+ #
2902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateHITReviewStatusRequest AWS API Documentation
2903
+ #
2904
+ class UpdateHITReviewStatusRequest < Struct.new(
2905
+ :hit_id,
2906
+ :revert)
2907
+ include Aws::Structure
2908
+ end
2909
+
2910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateHITReviewStatusResponse AWS API Documentation
2911
+ #
2912
+ class UpdateHITReviewStatusResponse < Aws::EmptyStructure; end
2913
+
2914
+ # @note When making an API call, you may pass UpdateHITTypeOfHITRequest
2915
+ # data as a hash:
2916
+ #
2917
+ # {
2918
+ # hit_id: "EntityId", # required
2919
+ # hit_type_id: "EntityId", # required
2920
+ # }
2921
+ #
2922
+ # @!attribute [rw] hit_id
2923
+ # The HIT to update.
2924
+ # @return [String]
2925
+ #
2926
+ # @!attribute [rw] hit_type_id
2927
+ # The ID of the new HIT type.
2928
+ # @return [String]
2929
+ #
2930
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateHITTypeOfHITRequest AWS API Documentation
2931
+ #
2932
+ class UpdateHITTypeOfHITRequest < Struct.new(
2933
+ :hit_id,
2934
+ :hit_type_id)
2935
+ include Aws::Structure
2936
+ end
2937
+
2938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateHITTypeOfHITResponse AWS API Documentation
2939
+ #
2940
+ class UpdateHITTypeOfHITResponse < Aws::EmptyStructure; end
2941
+
2942
+ # @note When making an API call, you may pass UpdateNotificationSettingsRequest
2943
+ # data as a hash:
2944
+ #
2945
+ # {
2946
+ # hit_type_id: "EntityId", # required
2947
+ # notification: {
2948
+ # destination: "String", # required
2949
+ # transport: "Email", # required, accepts Email, SQS
2950
+ # version: "String",
2951
+ # event_types: ["AssignmentAccepted"], # accepts AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping
2952
+ # },
2953
+ # active: false,
2954
+ # }
2955
+ #
2956
+ # @!attribute [rw] hit_type_id
2957
+ # The ID of the HIT type whose notification specification is being
2958
+ # updated.
2959
+ # @return [String]
2960
+ #
2961
+ # @!attribute [rw] notification
2962
+ # The notification specification for the HIT type.
2963
+ # @return [Types::NotificationSpecification]
2964
+ #
2965
+ # @!attribute [rw] active
2966
+ # Specifies whether notifications are sent for HITs of this HIT type,
2967
+ # according to the notification specification. You must specify either
2968
+ # the Notification parameter or the Active parameter for the call to
2969
+ # UpdateNotificationSettings to succeed.
2970
+ # @return [Boolean]
2971
+ #
2972
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateNotificationSettingsRequest AWS API Documentation
2973
+ #
2974
+ class UpdateNotificationSettingsRequest < Struct.new(
2975
+ :hit_type_id,
2976
+ :notification,
2977
+ :active)
2978
+ include Aws::Structure
2979
+ end
2980
+
2981
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateNotificationSettingsResponse AWS API Documentation
2982
+ #
2983
+ class UpdateNotificationSettingsResponse < Aws::EmptyStructure; end
2984
+
2985
+ # @note When making an API call, you may pass UpdateQualificationTypeRequest
2986
+ # data as a hash:
2987
+ #
2988
+ # {
2989
+ # qualification_type_id: "EntityId", # required
2990
+ # description: "String",
2991
+ # qualification_type_status: "Active", # accepts Active, Inactive
2992
+ # test: "String",
2993
+ # answer_key: "String",
2994
+ # test_duration_in_seconds: 1,
2995
+ # retry_delay_in_seconds: 1,
2996
+ # auto_granted: false,
2997
+ # auto_granted_value: 1,
2998
+ # }
2999
+ #
3000
+ # @!attribute [rw] qualification_type_id
3001
+ # The ID of the Qualification type to update.
3002
+ # @return [String]
3003
+ #
3004
+ # @!attribute [rw] description
3005
+ # The new description of the Qualification type.
3006
+ # @return [String]
3007
+ #
3008
+ # @!attribute [rw] qualification_type_status
3009
+ # The new status of the Qualification type - Active \| Inactive
3010
+ # @return [String]
3011
+ #
3012
+ # @!attribute [rw] test
3013
+ # The questions for the Qualification test a Worker must answer
3014
+ # correctly to obtain a Qualification of this type. If this parameter
3015
+ # is specified, `TestDurationInSeconds` must also be specified.
3016
+ #
3017
+ # Constraints: Must not be longer than 65535 bytes. Must be a
3018
+ # QuestionForm data structure. This parameter cannot be specified if
3019
+ # AutoGranted is true.
3020
+ #
3021
+ # Constraints: None. If not specified, the Worker may request the
3022
+ # Qualification without answering any questions.
3023
+ # @return [String]
3024
+ #
3025
+ # @!attribute [rw] answer_key
3026
+ # The answers to the Qualification test specified in the Test
3027
+ # parameter, in the form of an AnswerKey data structure.
3028
+ # @return [String]
3029
+ #
3030
+ # @!attribute [rw] test_duration_in_seconds
3031
+ # The number of seconds the Worker has to complete the Qualification
3032
+ # test, starting from the time the Worker requests the Qualification.
3033
+ # @return [Integer]
3034
+ #
3035
+ # @!attribute [rw] retry_delay_in_seconds
3036
+ # The amount of time, in seconds, that Workers must wait after
3037
+ # requesting a Qualification of the specified Qualification type
3038
+ # before they can retry the Qualification request. It is not possible
3039
+ # to disable retries for a Qualification type after it has been
3040
+ # created with retries enabled. If you want to disable retries, you
3041
+ # must dispose of the existing retry-enabled Qualification type using
3042
+ # DisposeQualificationType and then create a new Qualification type
3043
+ # with retries disabled using CreateQualificationType.
3044
+ # @return [Integer]
3045
+ #
3046
+ # @!attribute [rw] auto_granted
3047
+ # Specifies whether requests for the Qualification type are granted
3048
+ # immediately, without prompting the Worker with a Qualification test.
3049
+ #
3050
+ # Constraints: If the Test parameter is specified, this parameter
3051
+ # cannot be true.
3052
+ # @return [Boolean]
3053
+ #
3054
+ # @!attribute [rw] auto_granted_value
3055
+ # The Qualification value to use for automatically granted
3056
+ # Qualifications. This parameter is used only if the AutoGranted
3057
+ # parameter is true.
3058
+ # @return [Integer]
3059
+ #
3060
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateQualificationTypeRequest AWS API Documentation
3061
+ #
3062
+ class UpdateQualificationTypeRequest < Struct.new(
3063
+ :qualification_type_id,
3064
+ :description,
3065
+ :qualification_type_status,
3066
+ :test,
3067
+ :answer_key,
3068
+ :test_duration_in_seconds,
3069
+ :retry_delay_in_seconds,
3070
+ :auto_granted,
3071
+ :auto_granted_value)
3072
+ include Aws::Structure
3073
+ end
3074
+
3075
+ # @!attribute [rw] qualification_type
3076
+ # Contains a QualificationType data structure.
3077
+ # @return [Types::QualificationType]
3078
+ #
3079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateQualificationTypeResponse AWS API Documentation
3080
+ #
3081
+ class UpdateQualificationTypeResponse < Struct.new(
3082
+ :qualification_type)
3083
+ include Aws::Structure
3084
+ end
3085
+
3086
+ # The WorkerBlock data structure represents a Worker who has been
3087
+ # blocked. It has two elements: the WorkerId and the Reason for the
3088
+ # block.
3089
+ #
3090
+ # @!attribute [rw] worker_id
3091
+ # The ID of the Worker who accepted the HIT.
3092
+ # @return [String]
3093
+ #
3094
+ # @!attribute [rw] reason
3095
+ # A message explaining the reason the Worker was blocked.
3096
+ # @return [String]
3097
+ #
3098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/WorkerBlock AWS API Documentation
3099
+ #
3100
+ class WorkerBlock < Struct.new(
3101
+ :worker_id,
3102
+ :reason)
3103
+ include Aws::Structure
3104
+ end
3105
+
3106
+ end
3107
+ end