@aws-sdk/client-mturk 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,10 +5,12 @@ import { MTurkServiceException as __BaseException } from "./MTurkServiceExceptio
5
5
  */
6
6
  export interface AcceptQualificationRequestRequest {
7
7
  /**
8
+ * @public
8
9
  * <p>The ID of the Qualification request, as returned by the <code>GetQualificationRequests</code> operation.</p>
9
10
  */
10
11
  QualificationRequestId: string | undefined;
11
12
  /**
13
+ * @public
12
14
  * <p>
13
15
  * The value of the Qualification. You can omit this value if you are using the
14
16
  * presence or absence of the Qualification as the basis for a HIT requirement.
@@ -54,18 +56,21 @@ export declare class ServiceFault extends __BaseException {
54
56
  */
55
57
  export interface ApproveAssignmentRequest {
56
58
  /**
59
+ * @public
57
60
  * <p>
58
61
  * The ID of the assignment. The assignment must correspond to a HIT created by the Requester.
59
62
  * </p>
60
63
  */
61
64
  AssignmentId: string | undefined;
62
65
  /**
66
+ * @public
63
67
  * <p>
64
68
  * A message for the Worker, which the Worker can see in the Status section of the web site.
65
69
  * </p>
66
70
  */
67
71
  RequesterFeedback?: string;
68
72
  /**
73
+ * @public
69
74
  * <p>
70
75
  * A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to <code>False</code>.
71
76
  * </p>
@@ -99,22 +104,27 @@ export type AssignmentStatus = (typeof AssignmentStatus)[keyof typeof Assignment
99
104
  */
100
105
  export interface Assignment {
101
106
  /**
107
+ * @public
102
108
  * <p> A unique identifier for the assignment.</p>
103
109
  */
104
110
  AssignmentId?: string;
105
111
  /**
112
+ * @public
106
113
  * <p> The ID of the Worker who accepted the HIT.</p>
107
114
  */
108
115
  WorkerId?: string;
109
116
  /**
117
+ * @public
110
118
  * <p> The ID of the HIT.</p>
111
119
  */
112
120
  HITId?: string;
113
121
  /**
122
+ * @public
114
123
  * <p> The status of the assignment.</p>
115
124
  */
116
125
  AssignmentStatus?: AssignmentStatus | string;
117
126
  /**
127
+ * @public
118
128
  * <p> If results have been submitted, AutoApprovalTime is the date
119
129
  * and time the results of the assignment results are considered
120
130
  * Approved automatically if they have not already been explicitly
@@ -125,16 +135,19 @@ export interface Assignment {
125
135
  */
126
136
  AutoApprovalTime?: Date;
127
137
  /**
138
+ * @public
128
139
  * <p> The date and time the Worker accepted the assignment.</p>
129
140
  */
130
141
  AcceptTime?: Date;
131
142
  /**
143
+ * @public
132
144
  * <p> If the Worker has submitted results, SubmitTime is the date
133
145
  * and time the assignment was submitted. This value is omitted from the
134
146
  * assignment if the Worker has not yet submitted results.</p>
135
147
  */
136
148
  SubmitTime?: Date;
137
149
  /**
150
+ * @public
138
151
  * <p> If the Worker has submitted results and the Requester has
139
152
  * approved the results, ApprovalTime is the date and time the Requester
140
153
  * approved the results. This value is omitted from the assignment if
@@ -142,18 +155,21 @@ export interface Assignment {
142
155
  */
143
156
  ApprovalTime?: Date;
144
157
  /**
158
+ * @public
145
159
  * <p> If the Worker has submitted results and the Requester has
146
160
  * rejected the results, RejectionTime is the date and time the
147
161
  * Requester rejected the results.</p>
148
162
  */
149
163
  RejectionTime?: Date;
150
164
  /**
165
+ * @public
151
166
  * <p> The date and time of the deadline for the assignment. This
152
167
  * value is derived from the deadline specification for the HIT and the
153
168
  * date and time the Worker accepted the HIT.</p>
154
169
  */
155
170
  Deadline?: Date;
156
171
  /**
172
+ * @public
157
173
  * <p> The Worker's answers submitted for the HIT contained in a
158
174
  * QuestionFormAnswers document, if the Worker provides an answer. If
159
175
  * the Worker does not provide any answers, Answer may contain a
@@ -161,6 +177,7 @@ export interface Assignment {
161
177
  */
162
178
  Answer?: string;
163
179
  /**
180
+ * @public
164
181
  * <p> The feedback string included with the call to the
165
182
  * ApproveAssignment operation or the RejectAssignment operation, if the
166
183
  * Requester approved or rejected the assignment and specified feedback.</p>
@@ -172,10 +189,12 @@ export interface Assignment {
172
189
  */
173
190
  export interface AssociateQualificationWithWorkerRequest {
174
191
  /**
192
+ * @public
175
193
  * <p>The ID of the Qualification type to use for the assigned Qualification.</p>
176
194
  */
177
195
  QualificationTypeId: string | undefined;
178
196
  /**
197
+ * @public
179
198
  * <p>
180
199
  * The ID of the Worker to whom the Qualification is being assigned.
181
200
  * Worker IDs are included with submitted HIT assignments and Qualification requests.
@@ -183,10 +202,12 @@ export interface AssociateQualificationWithWorkerRequest {
183
202
  */
184
203
  WorkerId: string | undefined;
185
204
  /**
205
+ * @public
186
206
  * <p>The value of the Qualification to assign.</p>
187
207
  */
188
208
  IntegerValue?: number;
189
209
  /**
210
+ * @public
190
211
  * <p>
191
212
  * Specifies whether to send a notification email message to the Worker
192
213
  * saying that the qualification was assigned to the Worker.
@@ -206,22 +227,27 @@ export interface AssociateQualificationWithWorkerResponse {
206
227
  */
207
228
  export interface BonusPayment {
208
229
  /**
230
+ * @public
209
231
  * <p>The ID of the Worker to whom the bonus was paid.</p>
210
232
  */
211
233
  WorkerId?: string;
212
234
  /**
235
+ * @public
213
236
  * <p>A string representing a currency amount.</p>
214
237
  */
215
238
  BonusAmount?: string;
216
239
  /**
240
+ * @public
217
241
  * <p>The ID of the assignment associated with this bonus payment.</p>
218
242
  */
219
243
  AssignmentId?: string;
220
244
  /**
245
+ * @public
221
246
  * <p>The Reason text given when the bonus was granted, if any.</p>
222
247
  */
223
248
  Reason?: string;
224
249
  /**
250
+ * @public
225
251
  * <p>The date and time of when the bonus was granted.</p>
226
252
  */
227
253
  GrantTime?: Date;
@@ -251,14 +277,17 @@ export type Comparator = (typeof Comparator)[keyof typeof Comparator];
251
277
  */
252
278
  export interface CreateAdditionalAssignmentsForHITRequest {
253
279
  /**
280
+ * @public
254
281
  * <p>The ID of the HIT to extend.</p>
255
282
  */
256
283
  HITId: string | undefined;
257
284
  /**
285
+ * @public
258
286
  * <p>The number of additional assignments to request for this HIT.</p>
259
287
  */
260
288
  NumberOfAdditionalAssignments: number | undefined;
261
289
  /**
290
+ * @public
262
291
  * <p>
263
292
  * A unique identifier for this request, which allows you to retry the call on error
264
293
  * without extending the HIT multiple times.
@@ -283,6 +312,7 @@ export interface CreateAdditionalAssignmentsForHITResponse {
283
312
  */
284
313
  export interface ParameterMapEntry {
285
314
  /**
315
+ * @public
286
316
  * <p> The QuestionID from the HIT that is used to identify which
287
317
  * question requires Mechanical Turk to score as part of the
288
318
  * ScoreMyKnownAnswers/2011-09-01 Review Policy.
@@ -290,6 +320,7 @@ export interface ParameterMapEntry {
290
320
  */
291
321
  Key?: string;
292
322
  /**
323
+ * @public
293
324
  * <p> The list of answers to the question specified in the
294
325
  * MapEntry Key element. The Worker must match all values in order for
295
326
  * the answer to be scored correctly.
@@ -304,15 +335,18 @@ export interface ParameterMapEntry {
304
335
  */
305
336
  export interface PolicyParameter {
306
337
  /**
338
+ * @public
307
339
  * <p> Name of the parameter from the list of Review Polices.
308
340
  * </p>
309
341
  */
310
342
  Key?: string;
311
343
  /**
344
+ * @public
312
345
  * <p> The list of values of the Parameter</p>
313
346
  */
314
347
  Values?: string[];
315
348
  /**
349
+ * @public
316
350
  * <p> List of ParameterMapEntry objects.
317
351
  * </p>
318
352
  */
@@ -326,12 +360,14 @@ export interface PolicyParameter {
326
360
  */
327
361
  export interface ReviewPolicy {
328
362
  /**
363
+ * @public
329
364
  * <p> Name of a Review Policy: SimplePlurality/2011-09-01 or
330
365
  * ScoreMyKnownAnswers/2011-09-01
331
366
  * </p>
332
367
  */
333
368
  PolicyName: string | undefined;
334
369
  /**
370
+ * @public
335
371
  * <p>Name of the parameter from the Review policy.</p>
336
372
  */
337
373
  Parameters?: PolicyParameter[];
@@ -346,11 +382,13 @@ export interface ReviewPolicy {
346
382
  */
347
383
  export interface HITLayoutParameter {
348
384
  /**
385
+ * @public
349
386
  * <p> The name of the parameter in the HITLayout.
350
387
  * </p>
351
388
  */
352
389
  Name: string | undefined;
353
390
  /**
391
+ * @public
354
392
  * <p>The value substituted for the parameter referenced in the
355
393
  * HITLayout.
356
394
  * </p>
@@ -376,6 +414,7 @@ export type HITAccessActions = (typeof HITAccessActions)[keyof typeof HITAccessA
376
414
  */
377
415
  export interface Locale {
378
416
  /**
417
+ * @public
379
418
  * <p> The country of the locale. Must be a valid ISO 3166 country
380
419
  * code. For example, the code US refers to the United States of
381
420
  * America.
@@ -383,6 +422,7 @@ export interface Locale {
383
422
  */
384
423
  Country: string | undefined;
385
424
  /**
425
+ * @public
386
426
  * <p>The state or subdivision of the locale. A valid ISO 3166-2
387
427
  * subdivision code. For example, the code WA refers to the state of
388
428
  * Washington.</p>
@@ -400,10 +440,12 @@ export interface Locale {
400
440
  */
401
441
  export interface QualificationRequirement {
402
442
  /**
443
+ * @public
403
444
  * <p> The ID of the Qualification type for the requirement.</p>
404
445
  */
405
446
  QualificationTypeId: string | undefined;
406
447
  /**
448
+ * @public
407
449
  * <p>The kind of comparison to make against a Qualification's
408
450
  * value. You can compare a Qualification's value to an IntegerValue to
409
451
  * see if it is LessThan, LessThanOrEqualTo, GreaterThan,
@@ -420,6 +462,7 @@ export interface QualificationRequirement {
420
462
  */
421
463
  Comparator: Comparator | string | undefined;
422
464
  /**
465
+ * @public
423
466
  * <p> The integer value to compare against the Qualification's
424
467
  * value. IntegerValue must not be present if Comparator is Exists or
425
468
  * DoesNotExist. IntegerValue can only be used if the Qualification type
@@ -431,6 +474,7 @@ export interface QualificationRequirement {
431
474
  */
432
475
  IntegerValues?: number[];
433
476
  /**
477
+ * @public
434
478
  * <p> The locale value to compare against the Qualification's
435
479
  * value. The local value must be a valid ISO 3166 country code or
436
480
  * supports ISO 3166-2 subdivisions. LocaleValue can only be used with a
@@ -444,6 +488,7 @@ export interface QualificationRequirement {
444
488
  */
445
489
  LocaleValues?: Locale[];
446
490
  /**
491
+ * @public
447
492
  * @deprecated
448
493
  *
449
494
  * <p> DEPRECATED: Use the <code>ActionsGuarded</code> field instead.
@@ -461,6 +506,7 @@ export interface QualificationRequirement {
461
506
  */
462
507
  RequiredToPreview?: boolean;
463
508
  /**
509
+ * @public
464
510
  * <p> Setting this attribute prevents Workers whose Qualifications do not meet
465
511
  * this QualificationRequirement from taking the specified action. Valid arguments include
466
512
  * "Accept" (Worker cannot accept the HIT, but can preview the HIT and see it in their search results),
@@ -482,12 +528,14 @@ export interface QualificationRequirement {
482
528
  */
483
529
  export interface CreateHITRequest {
484
530
  /**
531
+ * @public
485
532
  * <p>
486
533
  * The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
487
534
  * </p>
488
535
  */
489
536
  MaxAssignments?: number;
490
537
  /**
538
+ * @public
491
539
  * <p>
492
540
  * The number of seconds after an assignment for the HIT has been submitted,
493
541
  * after which the assignment is considered Approved automatically
@@ -496,6 +544,7 @@ export interface CreateHITRequest {
496
544
  */
497
545
  AutoApprovalDelayInSeconds?: number;
498
546
  /**
547
+ * @public
499
548
  * <p>
500
549
  * An amount of time, in seconds, after which the HIT is no longer available for users to accept.
501
550
  * After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches,
@@ -504,6 +553,7 @@ export interface CreateHITRequest {
504
553
  */
505
554
  LifetimeInSeconds: number | undefined;
506
555
  /**
556
+ * @public
507
557
  * <p>
508
558
  * The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.
509
559
  * If a Worker does not complete the assignment within the specified duration,
@@ -514,12 +564,14 @@ export interface CreateHITRequest {
514
564
  */
515
565
  AssignmentDurationInSeconds: number | undefined;
516
566
  /**
567
+ * @public
517
568
  * <p>
518
569
  * The amount of money the Requester will pay a Worker for successfully completing the HIT.
519
570
  * </p>
520
571
  */
521
572
  Reward: string | undefined;
522
573
  /**
574
+ * @public
523
575
  * <p>
524
576
  * The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains.
525
577
  * On the Amazon Mechanical Turk web site, the HIT title appears in search results,
@@ -528,6 +580,7 @@ export interface CreateHITRequest {
528
580
  */
529
581
  Title: string | undefined;
530
582
  /**
583
+ * @public
531
584
  * <p>
532
585
  * One or more words or phrases that describe the HIT, separated by commas.
533
586
  * These words are used in searches to find HITs.
@@ -535,6 +588,7 @@ export interface CreateHITRequest {
535
588
  */
536
589
  Keywords?: string;
537
590
  /**
591
+ * @public
538
592
  * <p>
539
593
  * A general description of the HIT. A description includes detailed information about the kind of task
540
594
  * the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded
@@ -544,6 +598,7 @@ export interface CreateHITRequest {
544
598
  */
545
599
  Description: string | undefined;
546
600
  /**
601
+ * @public
547
602
  * <p>
548
603
  * The data the person completing the HIT uses to produce the results.
549
604
  * </p>
@@ -556,6 +611,7 @@ export interface CreateHITRequest {
556
611
  */
557
612
  Question?: string;
558
613
  /**
614
+ * @public
559
615
  * <p>
560
616
  * An arbitrary data field.
561
617
  * The RequesterAnnotation parameter lets your application attach arbitrary data
@@ -574,6 +630,7 @@ export interface CreateHITRequest {
574
630
  */
575
631
  RequesterAnnotation?: string;
576
632
  /**
633
+ * @public
577
634
  * <p>
578
635
  * Conditions that a Worker's Qualifications must meet in order
579
636
  * to accept the HIT. A HIT can have between zero and ten
@@ -585,6 +642,7 @@ export interface CreateHITRequest {
585
642
  */
586
643
  QualificationRequirements?: QualificationRequirement[];
587
644
  /**
645
+ * @public
588
646
  * <p>
589
647
  * A unique identifier for this request which allows you to retry the call
590
648
  * on error without creating duplicate HITs.
@@ -604,6 +662,7 @@ export interface CreateHITRequest {
604
662
  */
605
663
  UniqueRequestToken?: string;
606
664
  /**
665
+ * @public
607
666
  * <p>
608
667
  * The Assignment-level Review Policy applies to the assignments under the HIT.
609
668
  * You can specify for Mechanical Turk to take various actions based on the policy.
@@ -611,6 +670,7 @@ export interface CreateHITRequest {
611
670
  */
612
671
  AssignmentReviewPolicy?: ReviewPolicy;
613
672
  /**
673
+ * @public
614
674
  * <p>
615
675
  * The HIT-level Review Policy applies to the HIT.
616
676
  * You can specify for Mechanical Turk to take various actions based on the policy.
@@ -618,6 +678,7 @@ export interface CreateHITRequest {
618
678
  */
619
679
  HITReviewPolicy?: ReviewPolicy;
620
680
  /**
681
+ * @public
621
682
  * <p>
622
683
  * The HITLayoutId allows you to use a pre-existing HIT design with placeholder values
623
684
  * and create an additional HIT by providing those values as HITLayoutParameters.
@@ -628,6 +689,7 @@ export interface CreateHITRequest {
628
689
  */
629
690
  HITLayoutId?: string;
630
691
  /**
692
+ * @public
631
693
  * <p>
632
694
  * If the HITLayoutId is provided, any placeholder values must be filled in with values
633
695
  * using the HITLayoutParameter structure. For more information, see HITLayout.
@@ -672,62 +734,75 @@ export type HITStatus = (typeof HITStatus)[keyof typeof HITStatus];
672
734
  */
673
735
  export interface HIT {
674
736
  /**
737
+ * @public
675
738
  * <p> A unique identifier for the HIT.</p>
676
739
  */
677
740
  HITId?: string;
678
741
  /**
742
+ * @public
679
743
  * <p>The ID of the HIT type of this HIT</p>
680
744
  */
681
745
  HITTypeId?: string;
682
746
  /**
747
+ * @public
683
748
  * <p> The ID of the HIT Group of this HIT.</p>
684
749
  */
685
750
  HITGroupId?: string;
686
751
  /**
752
+ * @public
687
753
  * <p> The ID of the HIT Layout of this HIT.</p>
688
754
  */
689
755
  HITLayoutId?: string;
690
756
  /**
757
+ * @public
691
758
  * <p> The date and time the HIT was created.</p>
692
759
  */
693
760
  CreationTime?: Date;
694
761
  /**
762
+ * @public
695
763
  * <p> The title of the HIT.</p>
696
764
  */
697
765
  Title?: string;
698
766
  /**
767
+ * @public
699
768
  * <p> A general description of the HIT.</p>
700
769
  */
701
770
  Description?: string;
702
771
  /**
772
+ * @public
703
773
  * <p> The data the Worker completing the HIT uses produce the
704
774
  * results. This is either either a QuestionForm, HTMLQuestion or an
705
775
  * ExternalQuestion data structure.</p>
706
776
  */
707
777
  Question?: string;
708
778
  /**
779
+ * @public
709
780
  * <p> One or more words or phrases that describe the HIT,
710
781
  * separated by commas. Search terms similar to the keywords of a HIT
711
782
  * are more likely to have the HIT in the search results.</p>
712
783
  */
713
784
  Keywords?: string;
714
785
  /**
786
+ * @public
715
787
  * <p>The status of the HIT and its assignments. Valid Values are
716
788
  * Assignable | Unassignable | Reviewable | Reviewing | Disposed.
717
789
  * </p>
718
790
  */
719
791
  HITStatus?: HITStatus | string;
720
792
  /**
793
+ * @public
721
794
  * <p>The number of times the HIT can be accepted and completed
722
795
  * before the HIT becomes unavailable.
723
796
  * </p>
724
797
  */
725
798
  MaxAssignments?: number;
726
799
  /**
800
+ * @public
727
801
  * <p>A string representing a currency amount.</p>
728
802
  */
729
803
  Reward?: string;
730
804
  /**
805
+ * @public
731
806
  * <p>The amount of time, in seconds, after the Worker submits an
732
807
  * assignment for the HIT that the results are automatically approved by
733
808
  * Amazon Mechanical Turk. This is the amount of time the Requester has
@@ -737,20 +812,24 @@ export interface HIT {
737
812
  */
738
813
  AutoApprovalDelayInSeconds?: number;
739
814
  /**
815
+ * @public
740
816
  * <p>The date and time the HIT expires.</p>
741
817
  */
742
818
  Expiration?: Date;
743
819
  /**
820
+ * @public
744
821
  * <p> The length of time, in seconds, that a Worker has to
745
822
  * complete the HIT after accepting it.</p>
746
823
  */
747
824
  AssignmentDurationInSeconds?: number;
748
825
  /**
826
+ * @public
749
827
  * <p> An arbitrary data field the Requester who created the HIT
750
828
  * can use. This field is visible only to the creator of the HIT.</p>
751
829
  */
752
830
  RequesterAnnotation?: string;
753
831
  /**
832
+ * @public
754
833
  * <p>
755
834
  * Conditions that a Worker's Qualifications must meet in order
756
835
  * to accept the HIT. A HIT can have between zero and ten
@@ -762,23 +841,27 @@ export interface HIT {
762
841
  */
763
842
  QualificationRequirements?: QualificationRequirement[];
764
843
  /**
844
+ * @public
765
845
  * <p> Indicates the review status of the HIT. Valid Values are
766
846
  * NotReviewed | MarkedForReview | ReviewedAppropriate |
767
847
  * ReviewedInappropriate.</p>
768
848
  */
769
849
  HITReviewStatus?: HITReviewStatus | string;
770
850
  /**
851
+ * @public
771
852
  * <p> The number of assignments for this HIT that are being
772
853
  * previewed or have been accepted by Workers, but have not yet been
773
854
  * submitted, returned, or abandoned.</p>
774
855
  */
775
856
  NumberOfAssignmentsPending?: number;
776
857
  /**
858
+ * @public
777
859
  * <p> The number of assignments for this HIT that are available
778
860
  * for Workers to accept.</p>
779
861
  */
780
862
  NumberOfAssignmentsAvailable?: number;
781
863
  /**
864
+ * @public
782
865
  * <p> The number of assignments for this HIT that have been
783
866
  * approved or rejected.</p>
784
867
  */
@@ -789,6 +872,7 @@ export interface HIT {
789
872
  */
790
873
  export interface CreateHITResponse {
791
874
  /**
875
+ * @public
792
876
  * <p> Contains the newly created HIT data. For a description of
793
877
  * the HIT data structure as it appears in responses, see the HIT Data
794
878
  * Structure documentation.
@@ -801,6 +885,7 @@ export interface CreateHITResponse {
801
885
  */
802
886
  export interface CreateHITTypeRequest {
803
887
  /**
888
+ * @public
804
889
  * <p>
805
890
  * The number of seconds after an assignment for the HIT has been submitted,
806
891
  * after which the assignment is considered Approved automatically
@@ -809,6 +894,7 @@ export interface CreateHITTypeRequest {
809
894
  */
810
895
  AutoApprovalDelayInSeconds?: number;
811
896
  /**
897
+ * @public
812
898
  * <p>
813
899
  * The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.
814
900
  * If a Worker does not complete the assignment within the specified duration,
@@ -819,12 +905,14 @@ export interface CreateHITTypeRequest {
819
905
  */
820
906
  AssignmentDurationInSeconds: number | undefined;
821
907
  /**
908
+ * @public
822
909
  * <p>
823
910
  * The amount of money the Requester will pay a Worker for successfully completing the HIT.
824
911
  * </p>
825
912
  */
826
913
  Reward: string | undefined;
827
914
  /**
915
+ * @public
828
916
  * <p>
829
917
  * The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains.
830
918
  * On the Amazon Mechanical Turk web site, the HIT title appears in search results,
@@ -833,6 +921,7 @@ export interface CreateHITTypeRequest {
833
921
  */
834
922
  Title: string | undefined;
835
923
  /**
924
+ * @public
836
925
  * <p>
837
926
  * One or more words or phrases that describe the HIT, separated by commas.
838
927
  * These words are used in searches to find HITs.
@@ -840,6 +929,7 @@ export interface CreateHITTypeRequest {
840
929
  */
841
930
  Keywords?: string;
842
931
  /**
932
+ * @public
843
933
  * <p>
844
934
  * A general description of the HIT. A description includes detailed information about the kind of task
845
935
  * the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded
@@ -849,6 +939,7 @@ export interface CreateHITTypeRequest {
849
939
  */
850
940
  Description: string | undefined;
851
941
  /**
942
+ * @public
852
943
  * <p>
853
944
  * Conditions that a Worker's Qualifications must meet in order
854
945
  * to accept the HIT. A HIT can have between zero and ten
@@ -865,6 +956,7 @@ export interface CreateHITTypeRequest {
865
956
  */
866
957
  export interface CreateHITTypeResponse {
867
958
  /**
959
+ * @public
868
960
  * <p> The ID of the newly registered HIT type.</p>
869
961
  */
870
962
  HITTypeId?: string;
@@ -874,16 +966,19 @@ export interface CreateHITTypeResponse {
874
966
  */
875
967
  export interface CreateHITWithHITTypeRequest {
876
968
  /**
969
+ * @public
877
970
  * <p>The HIT type ID you want to create this HIT with.</p>
878
971
  */
879
972
  HITTypeId: string | undefined;
880
973
  /**
974
+ * @public
881
975
  * <p>
882
976
  * The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
883
977
  * </p>
884
978
  */
885
979
  MaxAssignments?: number;
886
980
  /**
981
+ * @public
887
982
  * <p>
888
983
  * An amount of time, in seconds, after which the HIT is no longer available for users to accept.
889
984
  * After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches,
@@ -892,6 +987,7 @@ export interface CreateHITWithHITTypeRequest {
892
987
  */
893
988
  LifetimeInSeconds: number | undefined;
894
989
  /**
990
+ * @public
895
991
  * <p>
896
992
  * The data the person completing the HIT uses to produce the results.
897
993
  * </p>
@@ -904,6 +1000,7 @@ export interface CreateHITWithHITTypeRequest {
904
1000
  */
905
1001
  Question?: string;
906
1002
  /**
1003
+ * @public
907
1004
  * <p>
908
1005
  * An arbitrary data field.
909
1006
  * The RequesterAnnotation parameter lets your application attach arbitrary data
@@ -922,6 +1019,7 @@ export interface CreateHITWithHITTypeRequest {
922
1019
  */
923
1020
  RequesterAnnotation?: string;
924
1021
  /**
1022
+ * @public
925
1023
  * <p>
926
1024
  * A unique identifier for this request which allows you to retry the call
927
1025
  * on error without creating duplicate HITs.
@@ -941,6 +1039,7 @@ export interface CreateHITWithHITTypeRequest {
941
1039
  */
942
1040
  UniqueRequestToken?: string;
943
1041
  /**
1042
+ * @public
944
1043
  * <p>
945
1044
  * The Assignment-level Review Policy applies to the assignments under the HIT.
946
1045
  * You can specify for Mechanical Turk to take various actions based on the policy.
@@ -948,6 +1047,7 @@ export interface CreateHITWithHITTypeRequest {
948
1047
  */
949
1048
  AssignmentReviewPolicy?: ReviewPolicy;
950
1049
  /**
1050
+ * @public
951
1051
  * <p>
952
1052
  * The HIT-level Review Policy applies to the HIT.
953
1053
  * You can specify for Mechanical Turk to take various actions based on the policy.
@@ -955,6 +1055,7 @@ export interface CreateHITWithHITTypeRequest {
955
1055
  */
956
1056
  HITReviewPolicy?: ReviewPolicy;
957
1057
  /**
1058
+ * @public
958
1059
  * <p>
959
1060
  * The HITLayoutId allows you to use a pre-existing HIT design with placeholder values
960
1061
  * and create an additional HIT by providing those values as HITLayoutParameters.
@@ -965,6 +1066,7 @@ export interface CreateHITWithHITTypeRequest {
965
1066
  */
966
1067
  HITLayoutId?: string;
967
1068
  /**
1069
+ * @public
968
1070
  * <p>
969
1071
  * If the HITLayoutId is provided, any placeholder values must be filled in with values
970
1072
  * using the HITLayoutParameter structure. For more information, see HITLayout.
@@ -977,6 +1079,7 @@ export interface CreateHITWithHITTypeRequest {
977
1079
  */
978
1080
  export interface CreateHITWithHITTypeResponse {
979
1081
  /**
1082
+ * @public
980
1083
  * <p> Contains the newly created HIT data. For a description of
981
1084
  * the HIT data structure as it appears in responses, see the HIT Data
982
1085
  * Structure documentation.
@@ -1001,6 +1104,7 @@ export type QualificationTypeStatus = (typeof QualificationTypeStatus)[keyof typ
1001
1104
  */
1002
1105
  export interface CreateQualificationTypeRequest {
1003
1106
  /**
1107
+ * @public
1004
1108
  * <p> The name you give to the Qualification type. The type name
1005
1109
  * is used to represent the Qualification to Workers, and to find the
1006
1110
  * type using a Qualification type search. It must be unique across all
@@ -1008,23 +1112,27 @@ export interface CreateQualificationTypeRequest {
1008
1112
  */
1009
1113
  Name: string | undefined;
1010
1114
  /**
1115
+ * @public
1011
1116
  * <p>One or more words or phrases that describe the Qualification
1012
1117
  * type, separated by commas. The keywords of a type make the type
1013
1118
  * easier to find during a search.</p>
1014
1119
  */
1015
1120
  Keywords?: string;
1016
1121
  /**
1122
+ * @public
1017
1123
  * <p>A long description for the Qualification type. On the Amazon
1018
1124
  * Mechanical Turk website, the long description is displayed when a
1019
1125
  * Worker examines a Qualification type.</p>
1020
1126
  */
1021
1127
  Description: string | undefined;
1022
1128
  /**
1129
+ * @public
1023
1130
  * <p>The initial status of the Qualification type.</p>
1024
1131
  * <p>Constraints: Valid values are: Active | Inactive</p>
1025
1132
  */
1026
1133
  QualificationTypeStatus: QualificationTypeStatus | string | undefined;
1027
1134
  /**
1135
+ * @public
1028
1136
  * <p>The number of seconds that a Worker must wait after
1029
1137
  * requesting a Qualification of the Qualification type before the
1030
1138
  * worker can retry the Qualification request.</p>
@@ -1038,6 +1146,7 @@ export interface CreateQualificationTypeRequest {
1038
1146
  */
1039
1147
  RetryDelayInSeconds?: number;
1040
1148
  /**
1149
+ * @public
1041
1150
  * <p>
1042
1151
  * The questions for the Qualification test a Worker must answer
1043
1152
  * correctly to obtain a Qualification of this type. If this parameter
@@ -1053,6 +1162,7 @@ export interface CreateQualificationTypeRequest {
1053
1162
  */
1054
1163
  Test?: string;
1055
1164
  /**
1165
+ * @public
1056
1166
  * <p>The answers to the Qualification test specified in the Test
1057
1167
  * parameter, in the form of an AnswerKey data structure.</p>
1058
1168
  * <p>Constraints: Must not be longer than 65535 bytes.</p>
@@ -1061,12 +1171,14 @@ export interface CreateQualificationTypeRequest {
1061
1171
  */
1062
1172
  AnswerKey?: string;
1063
1173
  /**
1174
+ * @public
1064
1175
  * <p>The number of seconds the Worker has to complete the
1065
1176
  * Qualification test, starting from the time the Worker requests the
1066
1177
  * Qualification.</p>
1067
1178
  */
1068
1179
  TestDurationInSeconds?: number;
1069
1180
  /**
1181
+ * @public
1070
1182
  * <p>Specifies whether requests for the Qualification type are
1071
1183
  * granted immediately, without prompting the Worker with a
1072
1184
  * Qualification test.</p>
@@ -1075,6 +1187,7 @@ export interface CreateQualificationTypeRequest {
1075
1187
  */
1076
1188
  AutoGranted?: boolean;
1077
1189
  /**
1190
+ * @public
1078
1191
  * <p>The Qualification value to use for automatically granted
1079
1192
  * Qualifications. This parameter is used only if the AutoGranted
1080
1193
  * parameter is true.</p>
@@ -1092,6 +1205,7 @@ export interface CreateQualificationTypeRequest {
1092
1205
  */
1093
1206
  export interface QualificationType {
1094
1207
  /**
1208
+ * @public
1095
1209
  * <p> A unique identifier for the Qualification type. A
1096
1210
  * Qualification type is given a Qualification type ID when you call the
1097
1211
  * CreateQualificationType operation.
@@ -1099,11 +1213,13 @@ export interface QualificationType {
1099
1213
  */
1100
1214
  QualificationTypeId?: string;
1101
1215
  /**
1216
+ * @public
1102
1217
  * <p> The date and time the Qualification type was created.
1103
1218
  * </p>
1104
1219
  */
1105
1220
  CreationTime?: Date;
1106
1221
  /**
1222
+ * @public
1107
1223
  * <p> The name of the Qualification type. The type name is used to
1108
1224
  * identify the type, and to find the type using a Qualification type
1109
1225
  * search.
@@ -1111,11 +1227,13 @@ export interface QualificationType {
1111
1227
  */
1112
1228
  Name?: string;
1113
1229
  /**
1230
+ * @public
1114
1231
  * <p> A long description for the Qualification type.
1115
1232
  * </p>
1116
1233
  */
1117
1234
  Description?: string;
1118
1235
  /**
1236
+ * @public
1119
1237
  * <p> One or more words or phrases that describe theQualification
1120
1238
  * type, separated by commas. The Keywords make the type easier to find
1121
1239
  * using a search.
@@ -1123,6 +1241,7 @@ export interface QualificationType {
1123
1241
  */
1124
1242
  Keywords?: string;
1125
1243
  /**
1244
+ * @public
1126
1245
  * <p> The status of the Qualification type. A Qualification type's
1127
1246
  * status determines if users can apply to receive a Qualification of
1128
1247
  * this type, and if HITs can be created with requirements based on this
@@ -1131,6 +1250,7 @@ export interface QualificationType {
1131
1250
  */
1132
1251
  QualificationTypeStatus?: QualificationTypeStatus | string;
1133
1252
  /**
1253
+ * @public
1134
1254
  * <p> The questions for a Qualification test associated with this
1135
1255
  * Qualification type that a user can take to obtain a Qualification of
1136
1256
  * this type. This parameter must be specified if AnswerKey is present.
@@ -1140,6 +1260,7 @@ export interface QualificationType {
1140
1260
  */
1141
1261
  Test?: string;
1142
1262
  /**
1263
+ * @public
1143
1264
  * <p> The amount of time, in seconds, given to a Worker to
1144
1265
  * complete the Qualification test, beginning from the time the Worker
1145
1266
  * requests the Qualification.
@@ -1147,11 +1268,13 @@ export interface QualificationType {
1147
1268
  */
1148
1269
  TestDurationInSeconds?: number;
1149
1270
  /**
1271
+ * @public
1150
1272
  * <p>The answers to the Qualification test specified in the Test
1151
1273
  * parameter.</p>
1152
1274
  */
1153
1275
  AnswerKey?: string;
1154
1276
  /**
1277
+ * @public
1155
1278
  * <p> The amount of time, in seconds, Workers must wait after
1156
1279
  * taking the Qualification test before they can take it again. Workers
1157
1280
  * can take a Qualification test multiple times if they were not granted
@@ -1163,6 +1286,7 @@ export interface QualificationType {
1163
1286
  */
1164
1287
  RetryDelayInSeconds?: number;
1165
1288
  /**
1289
+ * @public
1166
1290
  * <p> Specifies whether the Qualification type is one that a user
1167
1291
  * can request through the Amazon Mechanical Turk web site, such as by
1168
1292
  * taking a Qualification test. This value is False for Qualifications
@@ -1171,12 +1295,14 @@ export interface QualificationType {
1171
1295
  */
1172
1296
  IsRequestable?: boolean;
1173
1297
  /**
1298
+ * @public
1174
1299
  * <p>Specifies that requests for the Qualification type are
1175
1300
  * granted immediately, without prompting the Worker with a
1176
1301
  * Qualification test. Valid values are True | False.</p>
1177
1302
  */
1178
1303
  AutoGranted?: boolean;
1179
1304
  /**
1305
+ * @public
1180
1306
  * <p> The Qualification integer value to use for automatically
1181
1307
  * granted Qualifications, if AutoGranted is true. This is 1 by default.
1182
1308
  * </p>
@@ -1188,6 +1314,7 @@ export interface QualificationType {
1188
1314
  */
1189
1315
  export interface CreateQualificationTypeResponse {
1190
1316
  /**
1317
+ * @public
1191
1318
  * <p>The created Qualification type, returned as a
1192
1319
  * QualificationType data structure.</p>
1193
1320
  */
@@ -1198,10 +1325,12 @@ export interface CreateQualificationTypeResponse {
1198
1325
  */
1199
1326
  export interface CreateWorkerBlockRequest {
1200
1327
  /**
1328
+ * @public
1201
1329
  * <p>The ID of the Worker to block.</p>
1202
1330
  */
1203
1331
  WorkerId: string | undefined;
1204
1332
  /**
1333
+ * @public
1205
1334
  * <p>A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message.</p>
1206
1335
  */
1207
1336
  Reason: string | undefined;
@@ -1216,6 +1345,7 @@ export interface CreateWorkerBlockResponse {
1216
1345
  */
1217
1346
  export interface DeleteHITRequest {
1218
1347
  /**
1348
+ * @public
1219
1349
  * <p>The ID of the HIT to be deleted.</p>
1220
1350
  */
1221
1351
  HITId: string | undefined;
@@ -1230,6 +1360,7 @@ export interface DeleteHITResponse {
1230
1360
  */
1231
1361
  export interface DeleteQualificationTypeRequest {
1232
1362
  /**
1363
+ * @public
1233
1364
  * <p>The ID of the QualificationType to dispose.</p>
1234
1365
  */
1235
1366
  QualificationTypeId: string | undefined;
@@ -1244,10 +1375,12 @@ export interface DeleteQualificationTypeResponse {
1244
1375
  */
1245
1376
  export interface DeleteWorkerBlockRequest {
1246
1377
  /**
1378
+ * @public
1247
1379
  * <p>The ID of the Worker to unblock.</p>
1248
1380
  */
1249
1381
  WorkerId: string | undefined;
1250
1382
  /**
1383
+ * @public
1251
1384
  * <p>A message that explains the reason for unblocking the Worker. The Worker does not see this message.</p>
1252
1385
  */
1253
1386
  Reason?: string;
@@ -1262,14 +1395,17 @@ export interface DeleteWorkerBlockResponse {
1262
1395
  */
1263
1396
  export interface DisassociateQualificationFromWorkerRequest {
1264
1397
  /**
1398
+ * @public
1265
1399
  * <p>The ID of the Worker who possesses the Qualification to be revoked.</p>
1266
1400
  */
1267
1401
  WorkerId: string | undefined;
1268
1402
  /**
1403
+ * @public
1269
1404
  * <p>The ID of the Qualification type of the Qualification to be revoked.</p>
1270
1405
  */
1271
1406
  QualificationTypeId: string | undefined;
1272
1407
  /**
1408
+ * @public
1273
1409
  * <p>A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message.</p>
1274
1410
  */
1275
1411
  Reason?: string;
@@ -1311,10 +1447,12 @@ export interface GetAccountBalanceRequest {
1311
1447
  */
1312
1448
  export interface GetAccountBalanceResponse {
1313
1449
  /**
1450
+ * @public
1314
1451
  * <p>A string representing a currency amount.</p>
1315
1452
  */
1316
1453
  AvailableBalance?: string;
1317
1454
  /**
1455
+ * @public
1318
1456
  * <p>A string representing a currency amount.</p>
1319
1457
  */
1320
1458
  OnHoldBalance?: string;
@@ -1324,6 +1462,7 @@ export interface GetAccountBalanceResponse {
1324
1462
  */
1325
1463
  export interface GetAssignmentRequest {
1326
1464
  /**
1465
+ * @public
1327
1466
  * <p>The ID of the Assignment to be retrieved.</p>
1328
1467
  */
1329
1468
  AssignmentId: string | undefined;
@@ -1333,12 +1472,14 @@ export interface GetAssignmentRequest {
1333
1472
  */
1334
1473
  export interface GetAssignmentResponse {
1335
1474
  /**
1475
+ * @public
1336
1476
  * <p> The assignment. The response includes one Assignment
1337
1477
  * element.
1338
1478
  * </p>
1339
1479
  */
1340
1480
  Assignment?: Assignment;
1341
1481
  /**
1482
+ * @public
1342
1483
  * <p> The HIT associated with this assignment. The response
1343
1484
  * includes one HIT element.</p>
1344
1485
  */
@@ -1349,11 +1490,13 @@ export interface GetAssignmentResponse {
1349
1490
  */
1350
1491
  export interface GetFileUploadURLRequest {
1351
1492
  /**
1493
+ * @public
1352
1494
  * <p>The ID of the assignment that contains the question with a
1353
1495
  * FileUploadAnswer.</p>
1354
1496
  */
1355
1497
  AssignmentId: string | undefined;
1356
1498
  /**
1499
+ * @public
1357
1500
  * <p>The identifier of the question with a FileUploadAnswer, as
1358
1501
  * specified in the QuestionForm of the HIT.</p>
1359
1502
  */
@@ -1364,6 +1507,7 @@ export interface GetFileUploadURLRequest {
1364
1507
  */
1365
1508
  export interface GetFileUploadURLResponse {
1366
1509
  /**
1510
+ * @public
1367
1511
  * <p> A temporary URL for the file that the Worker uploaded for
1368
1512
  * the answer.
1369
1513
  * </p>
@@ -1375,6 +1519,7 @@ export interface GetFileUploadURLResponse {
1375
1519
  */
1376
1520
  export interface GetHITRequest {
1377
1521
  /**
1522
+ * @public
1378
1523
  * <p>The ID of the HIT to be retrieved.</p>
1379
1524
  */
1380
1525
  HITId: string | undefined;
@@ -1384,6 +1529,7 @@ export interface GetHITRequest {
1384
1529
  */
1385
1530
  export interface GetHITResponse {
1386
1531
  /**
1532
+ * @public
1387
1533
  * <p> Contains the requested HIT data.</p>
1388
1534
  */
1389
1535
  HIT?: HIT;
@@ -1393,10 +1539,12 @@ export interface GetHITResponse {
1393
1539
  */
1394
1540
  export interface GetQualificationScoreRequest {
1395
1541
  /**
1542
+ * @public
1396
1543
  * <p>The ID of the QualificationType.</p>
1397
1544
  */
1398
1545
  QualificationTypeId: string | undefined;
1399
1546
  /**
1547
+ * @public
1400
1548
  * <p>The ID of the Worker whose Qualification is being updated.</p>
1401
1549
  */
1402
1550
  WorkerId: string | undefined;
@@ -1421,15 +1569,18 @@ export type QualificationStatus = (typeof QualificationStatus)[keyof typeof Qual
1421
1569
  */
1422
1570
  export interface Qualification {
1423
1571
  /**
1572
+ * @public
1424
1573
  * <p> The ID of the Qualification type for the Qualification.</p>
1425
1574
  */
1426
1575
  QualificationTypeId?: string;
1427
1576
  /**
1577
+ * @public
1428
1578
  * <p> The ID of the Worker who possesses the Qualification.
1429
1579
  * </p>
1430
1580
  */
1431
1581
  WorkerId?: string;
1432
1582
  /**
1583
+ * @public
1433
1584
  * <p> The date and time the Qualification was granted to the
1434
1585
  * Worker. If the Worker's Qualification was revoked, and then
1435
1586
  * re-granted based on a new Qualification request, GrantTime is the
@@ -1438,15 +1589,18 @@ export interface Qualification {
1438
1589
  */
1439
1590
  GrantTime?: Date;
1440
1591
  /**
1592
+ * @public
1441
1593
  * <p> The value (score) of the Qualification, if the Qualification
1442
1594
  * has an integer value.</p>
1443
1595
  */
1444
1596
  IntegerValue?: number;
1445
1597
  /**
1598
+ * @public
1446
1599
  * <p>The Locale data structure represents a geographical region or location.</p>
1447
1600
  */
1448
1601
  LocaleValue?: Locale;
1449
1602
  /**
1603
+ * @public
1450
1604
  * <p> The status of the Qualification. Valid values are Granted |
1451
1605
  * Revoked.</p>
1452
1606
  */
@@ -1457,6 +1611,7 @@ export interface Qualification {
1457
1611
  */
1458
1612
  export interface GetQualificationScoreResponse {
1459
1613
  /**
1614
+ * @public
1460
1615
  * <p> The Qualification data structure of the Qualification
1461
1616
  * assigned to a user, including the Qualification type and the value
1462
1617
  * (score).
@@ -1469,6 +1624,7 @@ export interface GetQualificationScoreResponse {
1469
1624
  */
1470
1625
  export interface GetQualificationTypeRequest {
1471
1626
  /**
1627
+ * @public
1472
1628
  * <p>The ID of the QualificationType.</p>
1473
1629
  */
1474
1630
  QualificationTypeId: string | undefined;
@@ -1478,6 +1634,7 @@ export interface GetQualificationTypeRequest {
1478
1634
  */
1479
1635
  export interface GetQualificationTypeResponse {
1480
1636
  /**
1637
+ * @public
1481
1638
  * <p> The returned Qualification Type</p>
1482
1639
  */
1483
1640
  QualificationType?: QualificationType;
@@ -1487,15 +1644,18 @@ export interface GetQualificationTypeResponse {
1487
1644
  */
1488
1645
  export interface ListAssignmentsForHITRequest {
1489
1646
  /**
1647
+ * @public
1490
1648
  * <p>The ID of the HIT.</p>
1491
1649
  */
1492
1650
  HITId: string | undefined;
1493
1651
  /**
1652
+ * @public
1494
1653
  * <p>Pagination token</p>
1495
1654
  */
1496
1655
  NextToken?: string;
1497
1656
  MaxResults?: number;
1498
1657
  /**
1658
+ * @public
1499
1659
  * <p>The status of the assignments to return: Submitted | Approved
1500
1660
  * | Rejected</p>
1501
1661
  */
@@ -1506,6 +1666,7 @@ export interface ListAssignmentsForHITRequest {
1506
1666
  */
1507
1667
  export interface ListAssignmentsForHITResponse {
1508
1668
  /**
1669
+ * @public
1509
1670
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
1510
1671
  * returns a pagination token in the response. You can use this pagination token
1511
1672
  * to retrieve the next set of results.
@@ -1513,12 +1674,14 @@ export interface ListAssignmentsForHITResponse {
1513
1674
  */
1514
1675
  NextToken?: string;
1515
1676
  /**
1677
+ * @public
1516
1678
  * <p> The number of assignments on the page in the filtered
1517
1679
  * results list, equivalent to the number of assignments returned by
1518
1680
  * this call.</p>
1519
1681
  */
1520
1682
  NumResults?: number;
1521
1683
  /**
1684
+ * @public
1522
1685
  * <p> The collection of Assignment data structures returned by
1523
1686
  * this call.</p>
1524
1687
  */
@@ -1529,6 +1692,7 @@ export interface ListAssignmentsForHITResponse {
1529
1692
  */
1530
1693
  export interface ListBonusPaymentsRequest {
1531
1694
  /**
1695
+ * @public
1532
1696
  * <p>The ID of the HIT associated with the bonus payments to
1533
1697
  * retrieve. If not specified, all bonus payments for all assignments
1534
1698
  * for the given HIT are returned. Either the HITId parameter or the
@@ -1536,6 +1700,7 @@ export interface ListBonusPaymentsRequest {
1536
1700
  */
1537
1701
  HITId?: string;
1538
1702
  /**
1703
+ * @public
1539
1704
  * <p>The ID of the assignment associated with the bonus payments
1540
1705
  * to retrieve. If specified, only bonus payments for the given
1541
1706
  * assignment are returned. Either the HITId parameter or the
@@ -1543,6 +1708,7 @@ export interface ListBonusPaymentsRequest {
1543
1708
  */
1544
1709
  AssignmentId?: string;
1545
1710
  /**
1711
+ * @public
1546
1712
  * <p>Pagination token</p>
1547
1713
  */
1548
1714
  NextToken?: string;
@@ -1553,6 +1719,7 @@ export interface ListBonusPaymentsRequest {
1553
1719
  */
1554
1720
  export interface ListBonusPaymentsResponse {
1555
1721
  /**
1722
+ * @public
1556
1723
  * <p>The number of bonus payments on this page in the filtered
1557
1724
  * results list, equivalent to the number of bonus payments being
1558
1725
  * returned by this call.
@@ -1560,6 +1727,7 @@ export interface ListBonusPaymentsResponse {
1560
1727
  */
1561
1728
  NumResults?: number;
1562
1729
  /**
1730
+ * @public
1563
1731
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
1564
1732
  * returns a pagination token in the response. You can use this pagination token
1565
1733
  * to retrieve the next set of results.
@@ -1567,6 +1735,7 @@ export interface ListBonusPaymentsResponse {
1567
1735
  */
1568
1736
  NextToken?: string;
1569
1737
  /**
1738
+ * @public
1570
1739
  * <p>A successful request to the ListBonusPayments operation
1571
1740
  * returns a list of BonusPayment objects.
1572
1741
  * </p>
@@ -1578,6 +1747,7 @@ export interface ListBonusPaymentsResponse {
1578
1747
  */
1579
1748
  export interface ListHITsRequest {
1580
1749
  /**
1750
+ * @public
1581
1751
  * <p>Pagination token</p>
1582
1752
  */
1583
1753
  NextToken?: string;
@@ -1588,6 +1758,7 @@ export interface ListHITsRequest {
1588
1758
  */
1589
1759
  export interface ListHITsResponse {
1590
1760
  /**
1761
+ * @public
1591
1762
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
1592
1763
  * returns a pagination token in the response. You can use this pagination token
1593
1764
  * to retrieve the next set of results.
@@ -1595,11 +1766,13 @@ export interface ListHITsResponse {
1595
1766
  */
1596
1767
  NextToken?: string;
1597
1768
  /**
1769
+ * @public
1598
1770
  * <p>The number of HITs on this page in the filtered results list,
1599
1771
  * equivalent to the number of HITs being returned by this call.</p>
1600
1772
  */
1601
1773
  NumResults?: number;
1602
1774
  /**
1775
+ * @public
1603
1776
  * <p> The list of HIT elements returned by the query.</p>
1604
1777
  */
1605
1778
  HITs?: HIT[];
@@ -1609,16 +1782,19 @@ export interface ListHITsResponse {
1609
1782
  */
1610
1783
  export interface ListHITsForQualificationTypeRequest {
1611
1784
  /**
1785
+ * @public
1612
1786
  * <p>
1613
1787
  * The ID of the Qualification type to use when querying HITs.
1614
1788
  * </p>
1615
1789
  */
1616
1790
  QualificationTypeId: string | undefined;
1617
1791
  /**
1792
+ * @public
1618
1793
  * <p>Pagination Token</p>
1619
1794
  */
1620
1795
  NextToken?: string;
1621
1796
  /**
1797
+ * @public
1622
1798
  * <p>
1623
1799
  * Limit the number of results returned.
1624
1800
  * </p>
@@ -1630,6 +1806,7 @@ export interface ListHITsForQualificationTypeRequest {
1630
1806
  */
1631
1807
  export interface ListHITsForQualificationTypeResponse {
1632
1808
  /**
1809
+ * @public
1633
1810
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
1634
1811
  * returns a pagination token in the response. You can use this pagination token
1635
1812
  * to retrieve the next set of results.
@@ -1637,11 +1814,13 @@ export interface ListHITsForQualificationTypeResponse {
1637
1814
  */
1638
1815
  NextToken?: string;
1639
1816
  /**
1817
+ * @public
1640
1818
  * <p> The number of HITs on this page in the filtered results
1641
1819
  * list, equivalent to the number of HITs being returned by this call. </p>
1642
1820
  */
1643
1821
  NumResults?: number;
1644
1822
  /**
1823
+ * @public
1645
1824
  * <p> The list of HIT elements returned by the query.</p>
1646
1825
  */
1647
1826
  HITs?: HIT[];
@@ -1651,10 +1830,12 @@ export interface ListHITsForQualificationTypeResponse {
1651
1830
  */
1652
1831
  export interface ListQualificationRequestsRequest {
1653
1832
  /**
1833
+ * @public
1654
1834
  * <p>The ID of the QualificationType.</p>
1655
1835
  */
1656
1836
  QualificationTypeId?: string;
1657
1837
  /**
1838
+ * @public
1658
1839
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
1659
1840
  * returns a pagination token in the response. You can use this pagination token
1660
1841
  * to retrieve the next set of results.
@@ -1662,6 +1843,7 @@ export interface ListQualificationRequestsRequest {
1662
1843
  */
1663
1844
  NextToken?: string;
1664
1845
  /**
1846
+ * @public
1665
1847
  * <p> The maximum number of results to return in a single call.
1666
1848
  * </p>
1667
1849
  */
@@ -1675,6 +1857,7 @@ export interface ListQualificationRequestsRequest {
1675
1857
  */
1676
1858
  export interface QualificationRequest {
1677
1859
  /**
1860
+ * @public
1678
1861
  * <p>The ID of the Qualification request, a unique identifier
1679
1862
  * generated when the request was submitted.
1680
1863
  *
@@ -1682,16 +1865,19 @@ export interface QualificationRequest {
1682
1865
  */
1683
1866
  QualificationRequestId?: string;
1684
1867
  /**
1868
+ * @public
1685
1869
  * <p> The ID of the Qualification type the Worker is requesting,
1686
1870
  * as returned by the CreateQualificationType operation.
1687
1871
  * </p>
1688
1872
  */
1689
1873
  QualificationTypeId?: string;
1690
1874
  /**
1875
+ * @public
1691
1876
  * <p> The ID of the Worker requesting the Qualification.</p>
1692
1877
  */
1693
1878
  WorkerId?: string;
1694
1879
  /**
1880
+ * @public
1695
1881
  * <p> The contents of the Qualification test that was presented to
1696
1882
  * the Worker, if the type has a test and the Worker has submitted
1697
1883
  * answers. This value is identical to the QuestionForm associated with
@@ -1700,6 +1886,7 @@ export interface QualificationRequest {
1700
1886
  */
1701
1887
  Test?: string;
1702
1888
  /**
1889
+ * @public
1703
1890
  * <p> The Worker's answers for the Qualification type's test
1704
1891
  * contained in a QuestionFormAnswers document, if the type has a test
1705
1892
  * and the Worker has submitted answers. If the Worker does not provide
@@ -1708,6 +1895,7 @@ export interface QualificationRequest {
1708
1895
  */
1709
1896
  Answer?: string;
1710
1897
  /**
1898
+ * @public
1711
1899
  * <p>The date and time the Qualification request had a status of
1712
1900
  * Submitted. This is either the time the Worker submitted answers for a
1713
1901
  * Qualification test, or the time the Worker requested the
@@ -1721,11 +1909,13 @@ export interface QualificationRequest {
1721
1909
  */
1722
1910
  export interface ListQualificationRequestsResponse {
1723
1911
  /**
1912
+ * @public
1724
1913
  * <p>The number of Qualification requests on this page in the filtered results list,
1725
1914
  * equivalent to the number of Qualification requests being returned by this call.</p>
1726
1915
  */
1727
1916
  NumResults?: number;
1728
1917
  /**
1918
+ * @public
1729
1919
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
1730
1920
  * returns a pagination token in the response. You can use this pagination token
1731
1921
  * to retrieve the next set of results.
@@ -1733,6 +1923,7 @@ export interface ListQualificationRequestsResponse {
1733
1923
  */
1734
1924
  NextToken?: string;
1735
1925
  /**
1926
+ * @public
1736
1927
  * <p>The Qualification request. The response includes one
1737
1928
  * QualificationRequest element
1738
1929
  * for each Qualification request returned
@@ -1745,12 +1936,14 @@ export interface ListQualificationRequestsResponse {
1745
1936
  */
1746
1937
  export interface ListQualificationTypesRequest {
1747
1938
  /**
1939
+ * @public
1748
1940
  * <p> A text query against all of the searchable attributes of
1749
1941
  * Qualification types.
1750
1942
  * </p>
1751
1943
  */
1752
1944
  Query?: string;
1753
1945
  /**
1946
+ * @public
1754
1947
  * <p>Specifies that only Qualification types that a user can
1755
1948
  * request through the Amazon Mechanical Turk web site, such as by
1756
1949
  * taking a Qualification test, are returned as results of the search.
@@ -1762,6 +1955,7 @@ export interface ListQualificationTypesRequest {
1762
1955
  */
1763
1956
  MustBeRequestable: boolean | undefined;
1764
1957
  /**
1958
+ * @public
1765
1959
  * <p> Specifies that only Qualification types that the Requester
1766
1960
  * created are returned. If false, the operation returns all
1767
1961
  * Qualification types.
@@ -1769,6 +1963,7 @@ export interface ListQualificationTypesRequest {
1769
1963
  */
1770
1964
  MustBeOwnedByCaller?: boolean;
1771
1965
  /**
1966
+ * @public
1772
1967
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
1773
1968
  * returns a pagination token in the response. You can use this pagination token
1774
1969
  * to retrieve the next set of results.
@@ -1776,6 +1971,7 @@ export interface ListQualificationTypesRequest {
1776
1971
  */
1777
1972
  NextToken?: string;
1778
1973
  /**
1974
+ * @public
1779
1975
  * <p> The maximum number of results to return in a single call.
1780
1976
  * </p>
1781
1977
  */
@@ -1786,6 +1982,7 @@ export interface ListQualificationTypesRequest {
1786
1982
  */
1787
1983
  export interface ListQualificationTypesResponse {
1788
1984
  /**
1985
+ * @public
1789
1986
  * <p> The number of Qualification types on this page in the
1790
1987
  * filtered results list, equivalent to the number of types this
1791
1988
  * operation returns.
@@ -1793,6 +1990,7 @@ export interface ListQualificationTypesResponse {
1793
1990
  */
1794
1991
  NumResults?: number;
1795
1992
  /**
1993
+ * @public
1796
1994
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
1797
1995
  * returns a pagination token in the response. You can use this pagination token
1798
1996
  * to retrieve the next set of results.
@@ -1800,6 +1998,7 @@ export interface ListQualificationTypesResponse {
1800
1998
  */
1801
1999
  NextToken?: string;
1802
2000
  /**
2001
+ * @public
1803
2002
  * <p> The list of QualificationType elements returned by the
1804
2003
  * query.
1805
2004
  * </p>
@@ -1823,6 +2022,7 @@ export type ReviewableHITStatus = (typeof ReviewableHITStatus)[keyof typeof Revi
1823
2022
  */
1824
2023
  export interface ListReviewableHITsRequest {
1825
2024
  /**
2025
+ * @public
1826
2026
  * <p>
1827
2027
  * The ID of the HIT type of the HITs to consider for the query.
1828
2028
  * If not specified, all HITs for the Reviewer are considered
@@ -1830,6 +2030,7 @@ export interface ListReviewableHITsRequest {
1830
2030
  */
1831
2031
  HITTypeId?: string;
1832
2032
  /**
2033
+ * @public
1833
2034
  * <p>
1834
2035
  * Can be either <code>Reviewable</code> or <code>Reviewing</code>.
1835
2036
  * Reviewable is the default value.
@@ -1837,10 +2038,12 @@ export interface ListReviewableHITsRequest {
1837
2038
  */
1838
2039
  Status?: ReviewableHITStatus | string;
1839
2040
  /**
2041
+ * @public
1840
2042
  * <p>Pagination Token</p>
1841
2043
  */
1842
2044
  NextToken?: string;
1843
2045
  /**
2046
+ * @public
1844
2047
  * <p>
1845
2048
  * Limit the number of results returned.
1846
2049
  * </p>
@@ -1852,6 +2055,7 @@ export interface ListReviewableHITsRequest {
1852
2055
  */
1853
2056
  export interface ListReviewableHITsResponse {
1854
2057
  /**
2058
+ * @public
1855
2059
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
1856
2060
  * returns a pagination token in the response. You can use this pagination token
1857
2061
  * to retrieve the next set of results.
@@ -1859,12 +2063,14 @@ export interface ListReviewableHITsResponse {
1859
2063
  */
1860
2064
  NextToken?: string;
1861
2065
  /**
2066
+ * @public
1862
2067
  * <p> The number of HITs on this page in the filtered results
1863
2068
  * list, equivalent to the number of HITs being returned by this call.
1864
2069
  * </p>
1865
2070
  */
1866
2071
  NumResults?: number;
1867
2072
  /**
2073
+ * @public
1868
2074
  * <p> The list of HIT elements returned by the query.</p>
1869
2075
  */
1870
2076
  HITs?: HIT[];
@@ -1886,10 +2092,12 @@ export type ReviewPolicyLevel = (typeof ReviewPolicyLevel)[keyof typeof ReviewPo
1886
2092
  */
1887
2093
  export interface ListReviewPolicyResultsForHITRequest {
1888
2094
  /**
2095
+ * @public
1889
2096
  * <p>The unique identifier of the HIT to retrieve review results for.</p>
1890
2097
  */
1891
2098
  HITId: string | undefined;
1892
2099
  /**
2100
+ * @public
1893
2101
  * <p>
1894
2102
  * The Policy Level(s) to retrieve review results for - HIT or Assignment.
1895
2103
  * If omitted, the default behavior is to retrieve all data for both policy levels.
@@ -1898,6 +2106,7 @@ export interface ListReviewPolicyResultsForHITRequest {
1898
2106
  */
1899
2107
  PolicyLevels?: (ReviewPolicyLevel | string)[];
1900
2108
  /**
2109
+ * @public
1901
2110
  * <p>
1902
2111
  * Specify if the operation should retrieve a list of the actions taken executing
1903
2112
  * the Review Policies and their outcomes.
@@ -1905,16 +2114,19 @@ export interface ListReviewPolicyResultsForHITRequest {
1905
2114
  */
1906
2115
  RetrieveActions?: boolean;
1907
2116
  /**
2117
+ * @public
1908
2118
  * <p>
1909
2119
  * Specify if the operation should retrieve a list of the results computed by the Review Policies.
1910
2120
  * </p>
1911
2121
  */
1912
2122
  RetrieveResults?: boolean;
1913
2123
  /**
2124
+ * @public
1914
2125
  * <p>Pagination token</p>
1915
2126
  */
1916
2127
  NextToken?: string;
1917
2128
  /**
2129
+ * @public
1918
2130
  * <p>Limit the number of results returned.</p>
1919
2131
  */
1920
2132
  MaxResults?: number;
@@ -1943,38 +2155,46 @@ export type ReviewActionStatus = (typeof ReviewActionStatus)[keyof typeof Review
1943
2155
  */
1944
2156
  export interface ReviewActionDetail {
1945
2157
  /**
2158
+ * @public
1946
2159
  * <p>The unique identifier for the action.</p>
1947
2160
  */
1948
2161
  ActionId?: string;
1949
2162
  /**
2163
+ * @public
1950
2164
  * <p> The nature of the action itself. The Review Policy is
1951
2165
  * responsible for examining the HIT and Assignments, emitting results,
1952
2166
  * and deciding which other actions will be necessary. </p>
1953
2167
  */
1954
2168
  ActionName?: string;
1955
2169
  /**
2170
+ * @public
1956
2171
  * <p> The specific HITId or AssignmentID targeted by the action.</p>
1957
2172
  */
1958
2173
  TargetId?: string;
1959
2174
  /**
2175
+ * @public
1960
2176
  * <p> The type of object in TargetId.</p>
1961
2177
  */
1962
2178
  TargetType?: string;
1963
2179
  /**
2180
+ * @public
1964
2181
  * <p> The current disposition of the action: INTENDED, SUCCEEDED,
1965
2182
  * FAILED, or CANCELLED.
1966
2183
  * </p>
1967
2184
  */
1968
2185
  Status?: ReviewActionStatus | string;
1969
2186
  /**
2187
+ * @public
1970
2188
  * <p> The date when the action was completed.</p>
1971
2189
  */
1972
2190
  CompleteTime?: Date;
1973
2191
  /**
2192
+ * @public
1974
2193
  * <p> A description of the outcome of the review.</p>
1975
2194
  */
1976
2195
  Result?: string;
1977
2196
  /**
2197
+ * @public
1978
2198
  * <p> Present only when the Results have a FAILED Status.</p>
1979
2199
  */
1980
2200
  ErrorCode?: string;
@@ -1987,11 +2207,13 @@ export interface ReviewActionDetail {
1987
2207
  */
1988
2208
  export interface ReviewResultDetail {
1989
2209
  /**
2210
+ * @public
1990
2211
  * <p> A unique identifier of the Review action result.
1991
2212
  * </p>
1992
2213
  */
1993
2214
  ActionId?: string;
1994
2215
  /**
2216
+ * @public
1995
2217
  * <p>The HITID or AssignmentId about which this result was taken.
1996
2218
  * Note that HIT-level Review Policies will often emit results about
1997
2219
  * both the HIT itself and its Assignments, while Assignment-level
@@ -2001,10 +2223,12 @@ export interface ReviewResultDetail {
2001
2223
  */
2002
2224
  SubjectId?: string;
2003
2225
  /**
2226
+ * @public
2004
2227
  * <p> The type of the object from the SubjectId field.</p>
2005
2228
  */
2006
2229
  SubjectType?: string;
2007
2230
  /**
2231
+ * @public
2008
2232
  * <p> Specifies the QuestionId the result is describing. Depending
2009
2233
  * on whether the TargetType is a HIT or Assignment this results could
2010
2234
  * specify multiple values. If TargetType is HIT and QuestionId is
@@ -2016,11 +2240,13 @@ export interface ReviewResultDetail {
2016
2240
  */
2017
2241
  QuestionId?: string;
2018
2242
  /**
2243
+ * @public
2019
2244
  * <p> Key identifies the particular piece of reviewed information.
2020
2245
  * </p>
2021
2246
  */
2022
2247
  Key?: string;
2023
2248
  /**
2249
+ * @public
2024
2250
  * <p> The values of Key provided by the review policies you have
2025
2251
  * selected.
2026
2252
  * </p>
@@ -2035,12 +2261,14 @@ export interface ReviewResultDetail {
2035
2261
  */
2036
2262
  export interface ReviewReport {
2037
2263
  /**
2264
+ * @public
2038
2265
  * <p> A list of ReviewResults objects for each action specified in
2039
2266
  * the Review Policy.
2040
2267
  * </p>
2041
2268
  */
2042
2269
  ReviewResults?: ReviewResultDetail[];
2043
2270
  /**
2271
+ * @public
2044
2272
  * <p> A list of ReviewAction objects for each action specified in
2045
2273
  * the Review Policy.
2046
2274
  * </p>
@@ -2052,32 +2280,38 @@ export interface ReviewReport {
2052
2280
  */
2053
2281
  export interface ListReviewPolicyResultsForHITResponse {
2054
2282
  /**
2283
+ * @public
2055
2284
  * <p>The HITId of the HIT for which results have been returned.</p>
2056
2285
  */
2057
2286
  HITId?: string;
2058
2287
  /**
2288
+ * @public
2059
2289
  * <p> The name of the Assignment-level Review Policy. This
2060
2290
  * contains only the PolicyName element.
2061
2291
  * </p>
2062
2292
  */
2063
2293
  AssignmentReviewPolicy?: ReviewPolicy;
2064
2294
  /**
2295
+ * @public
2065
2296
  * <p>The name of the HIT-level Review Policy. This contains only
2066
2297
  * the PolicyName element.</p>
2067
2298
  */
2068
2299
  HITReviewPolicy?: ReviewPolicy;
2069
2300
  /**
2301
+ * @public
2070
2302
  * <p> Contains both ReviewResult and ReviewAction elements for an
2071
2303
  * Assignment.
2072
2304
  * </p>
2073
2305
  */
2074
2306
  AssignmentReviewReport?: ReviewReport;
2075
2307
  /**
2308
+ * @public
2076
2309
  * <p>Contains both ReviewResult and ReviewAction elements for a particular HIT.
2077
2310
  * </p>
2078
2311
  */
2079
2312
  HITReviewReport?: ReviewReport;
2080
2313
  /**
2314
+ * @public
2081
2315
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
2082
2316
  * returns a pagination token in the response. You can use this pagination token
2083
2317
  * to retrieve the next set of results.
@@ -2090,6 +2324,7 @@ export interface ListReviewPolicyResultsForHITResponse {
2090
2324
  */
2091
2325
  export interface ListWorkerBlocksRequest {
2092
2326
  /**
2327
+ * @public
2093
2328
  * <p>Pagination token</p>
2094
2329
  */
2095
2330
  NextToken?: string;
@@ -2104,10 +2339,12 @@ export interface ListWorkerBlocksRequest {
2104
2339
  */
2105
2340
  export interface WorkerBlock {
2106
2341
  /**
2342
+ * @public
2107
2343
  * <p> The ID of the Worker who accepted the HIT.</p>
2108
2344
  */
2109
2345
  WorkerId?: string;
2110
2346
  /**
2347
+ * @public
2111
2348
  * <p> A message explaining the reason the Worker was blocked.
2112
2349
  * </p>
2113
2350
  */
@@ -2118,6 +2355,7 @@ export interface WorkerBlock {
2118
2355
  */
2119
2356
  export interface ListWorkerBlocksResponse {
2120
2357
  /**
2358
+ * @public
2121
2359
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
2122
2360
  * returns a pagination token in the response. You can use this pagination token
2123
2361
  * to retrieve the next set of results.
@@ -2125,12 +2363,14 @@ export interface ListWorkerBlocksResponse {
2125
2363
  */
2126
2364
  NextToken?: string;
2127
2365
  /**
2366
+ * @public
2128
2367
  * <p> The number of assignments on the page in the filtered
2129
2368
  * results list, equivalent to the number of assignments returned by
2130
2369
  * this call.</p>
2131
2370
  */
2132
2371
  NumResults?: number;
2133
2372
  /**
2373
+ * @public
2134
2374
  * <p> The list of WorkerBlocks, containing the collection of
2135
2375
  * Worker IDs and reasons for blocking.</p>
2136
2376
  */
@@ -2141,11 +2381,13 @@ export interface ListWorkerBlocksResponse {
2141
2381
  */
2142
2382
  export interface ListWorkersWithQualificationTypeRequest {
2143
2383
  /**
2384
+ * @public
2144
2385
  * <p>The ID of the Qualification type of the Qualifications to
2145
2386
  * return.</p>
2146
2387
  */
2147
2388
  QualificationTypeId: string | undefined;
2148
2389
  /**
2390
+ * @public
2149
2391
  * <p>
2150
2392
  * The status of the Qualifications to return.
2151
2393
  * Can be <code>Granted | Revoked</code>.
@@ -2153,10 +2395,12 @@ export interface ListWorkersWithQualificationTypeRequest {
2153
2395
  */
2154
2396
  Status?: QualificationStatus | string;
2155
2397
  /**
2398
+ * @public
2156
2399
  * <p>Pagination Token</p>
2157
2400
  */
2158
2401
  NextToken?: string;
2159
2402
  /**
2403
+ * @public
2160
2404
  * <p>
2161
2405
  * Limit the number of results returned.
2162
2406
  * </p>
@@ -2168,6 +2412,7 @@ export interface ListWorkersWithQualificationTypeRequest {
2168
2412
  */
2169
2413
  export interface ListWorkersWithQualificationTypeResponse {
2170
2414
  /**
2415
+ * @public
2171
2416
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
2172
2417
  * returns a pagination token in the response. You can use this pagination token
2173
2418
  * to retrieve the next set of results.
@@ -2175,12 +2420,14 @@ export interface ListWorkersWithQualificationTypeResponse {
2175
2420
  */
2176
2421
  NextToken?: string;
2177
2422
  /**
2423
+ * @public
2178
2424
  * <p> The number of Qualifications on this page in the filtered
2179
2425
  * results list, equivalent to the number of Qualifications being
2180
2426
  * returned by this call.</p>
2181
2427
  */
2182
2428
  NumResults?: number;
2183
2429
  /**
2430
+ * @public
2184
2431
  * <p> The list of Qualification elements returned by this call.
2185
2432
  * </p>
2186
2433
  */
@@ -2191,16 +2438,19 @@ export interface ListWorkersWithQualificationTypeResponse {
2191
2438
  */
2192
2439
  export interface NotifyWorkersRequest {
2193
2440
  /**
2441
+ * @public
2194
2442
  * <p>The subject line of the email message to send. Can include up
2195
2443
  * to 200 characters.</p>
2196
2444
  */
2197
2445
  Subject: string | undefined;
2198
2446
  /**
2447
+ * @public
2199
2448
  * <p>The text of the email message to send. Can include up to
2200
2449
  * 4,096 characters</p>
2201
2450
  */
2202
2451
  MessageText: string | undefined;
2203
2452
  /**
2453
+ * @public
2204
2454
  * <p>A list of Worker IDs you wish to notify. You
2205
2455
  * can notify upto
2206
2456
  * 100 Workers at a time.</p>
@@ -2227,17 +2477,20 @@ export type NotifyWorkersFailureCode = (typeof NotifyWorkersFailureCode)[keyof t
2227
2477
  */
2228
2478
  export interface NotifyWorkersFailureStatus {
2229
2479
  /**
2480
+ * @public
2230
2481
  * <p> Encoded value for the failure type.
2231
2482
  * </p>
2232
2483
  */
2233
2484
  NotifyWorkersFailureCode?: NotifyWorkersFailureCode | string;
2234
2485
  /**
2486
+ * @public
2235
2487
  * <p> A message detailing the reason the Worker could not be
2236
2488
  * notified.
2237
2489
  * </p>
2238
2490
  */
2239
2491
  NotifyWorkersFailureMessage?: string;
2240
2492
  /**
2493
+ * @public
2241
2494
  * <p> The ID of the Worker.</p>
2242
2495
  */
2243
2496
  WorkerId?: string;
@@ -2247,6 +2500,7 @@ export interface NotifyWorkersFailureStatus {
2247
2500
  */
2248
2501
  export interface NotifyWorkersResponse {
2249
2502
  /**
2503
+ * @public
2250
2504
  * <p> When MTurk sends notifications to the list of Workers, it
2251
2505
  * returns back any failures it encounters in this list of
2252
2506
  * NotifyWorkersFailureStatus objects.
@@ -2259,12 +2513,14 @@ export interface NotifyWorkersResponse {
2259
2513
  */
2260
2514
  export interface RejectAssignmentRequest {
2261
2515
  /**
2516
+ * @public
2262
2517
  * <p>
2263
2518
  * The ID of the assignment. The assignment must correspond to a HIT created by the Requester.
2264
2519
  * </p>
2265
2520
  */
2266
2521
  AssignmentId: string | undefined;
2267
2522
  /**
2523
+ * @public
2268
2524
  * <p>
2269
2525
  * A message for the Worker, which the Worker can see in the Status section of the web site.
2270
2526
  * </p>
@@ -2281,6 +2537,7 @@ export interface RejectAssignmentResponse {
2281
2537
  */
2282
2538
  export interface RejectQualificationRequestRequest {
2283
2539
  /**
2540
+ * @public
2284
2541
  * <p>
2285
2542
  * The ID of the Qualification request, as returned by the
2286
2543
  * <code>ListQualificationRequests</code>
@@ -2289,6 +2546,7 @@ export interface RejectQualificationRequestRequest {
2289
2546
  */
2290
2547
  QualificationRequestId: string | undefined;
2291
2548
  /**
2549
+ * @public
2292
2550
  * <p>A text message explaining why the request was rejected, to be
2293
2551
  * shown to the Worker who made the request.</p>
2294
2552
  */
@@ -2304,10 +2562,12 @@ export interface RejectQualificationRequestResponse {
2304
2562
  */
2305
2563
  export interface SendBonusRequest {
2306
2564
  /**
2565
+ * @public
2307
2566
  * <p>The ID of the Worker being paid the bonus.</p>
2308
2567
  */
2309
2568
  WorkerId: string | undefined;
2310
2569
  /**
2570
+ * @public
2311
2571
  * <p>
2312
2572
  * The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and
2313
2573
  * "101.42" represents $101.42 USD). Do not include currency symbols or currency codes.
@@ -2315,15 +2575,18 @@ export interface SendBonusRequest {
2315
2575
  */
2316
2576
  BonusAmount: string | undefined;
2317
2577
  /**
2578
+ * @public
2318
2579
  * <p>The ID of the assignment for which this bonus is paid.</p>
2319
2580
  */
2320
2581
  AssignmentId: string | undefined;
2321
2582
  /**
2583
+ * @public
2322
2584
  * <p>A message that explains the reason for the bonus payment. The
2323
2585
  * Worker receiving the bonus can see this message.</p>
2324
2586
  */
2325
2587
  Reason: string | undefined;
2326
2588
  /**
2589
+ * @public
2327
2590
  * <p>A unique identifier for this request, which allows you to
2328
2591
  * retry the call on error without granting multiple bonuses. This is
2329
2592
  * useful in cases such as network timeouts where it is unclear whether
@@ -2359,6 +2622,7 @@ export type NotificationTransport = (typeof NotificationTransport)[keyof typeof
2359
2622
  */
2360
2623
  export interface NotificationSpecification {
2361
2624
  /**
2625
+ * @public
2362
2626
  * <p>
2363
2627
  * The target for notification messages. The Destination’s format is determined by the specified Transport:
2364
2628
  * </p>
@@ -2376,17 +2640,20 @@ export interface NotificationSpecification {
2376
2640
  */
2377
2641
  Destination: string | undefined;
2378
2642
  /**
2643
+ * @public
2379
2644
  * <p> The method Amazon Mechanical Turk uses to send the
2380
2645
  * notification. Valid Values: Email | SQS | SNS.
2381
2646
  * </p>
2382
2647
  */
2383
2648
  Transport: NotificationTransport | string | undefined;
2384
2649
  /**
2650
+ * @public
2385
2651
  * <p>The version of the Notification API to use. Valid value is
2386
2652
  * 2006-05-05.</p>
2387
2653
  */
2388
2654
  Version: string | undefined;
2389
2655
  /**
2656
+ * @public
2390
2657
  * <p> The list of events that should cause notifications to be
2391
2658
  * sent. Valid Values: AssignmentAccepted | AssignmentAbandoned |
2392
2659
  * AssignmentReturned | AssignmentSubmitted | AssignmentRejected |
@@ -2402,6 +2669,7 @@ export interface NotificationSpecification {
2402
2669
  */
2403
2670
  export interface SendTestEventNotificationRequest {
2404
2671
  /**
2672
+ * @public
2405
2673
  * <p>
2406
2674
  * The notification specification to test. This value is identical to the value
2407
2675
  * you would provide to the UpdateNotificationSettings operation when you establish
@@ -2410,6 +2678,7 @@ export interface SendTestEventNotificationRequest {
2410
2678
  */
2411
2679
  Notification: NotificationSpecification | undefined;
2412
2680
  /**
2681
+ * @public
2413
2682
  * <p>
2414
2683
  * The event to simulate to test the notification specification.
2415
2684
  * This event is included in the test message even if the notification specification
@@ -2429,12 +2698,14 @@ export interface SendTestEventNotificationResponse {
2429
2698
  */
2430
2699
  export interface UpdateExpirationForHITRequest {
2431
2700
  /**
2701
+ * @public
2432
2702
  * <p>
2433
2703
  * The HIT to update.
2434
2704
  * </p>
2435
2705
  */
2436
2706
  HITId: string | undefined;
2437
2707
  /**
2708
+ * @public
2438
2709
  * <p>
2439
2710
  * The date and time at which you want the HIT to expire
2440
2711
  * </p>
@@ -2451,12 +2722,14 @@ export interface UpdateExpirationForHITResponse {
2451
2722
  */
2452
2723
  export interface UpdateHITReviewStatusRequest {
2453
2724
  /**
2725
+ * @public
2454
2726
  * <p>
2455
2727
  * The ID of the HIT to update.
2456
2728
  * </p>
2457
2729
  */
2458
2730
  HITId: string | undefined;
2459
2731
  /**
2732
+ * @public
2460
2733
  * <p>
2461
2734
  * Specifies how to update the HIT status. Default is <code>False</code>.
2462
2735
  * </p>
@@ -2485,10 +2758,12 @@ export interface UpdateHITReviewStatusResponse {
2485
2758
  */
2486
2759
  export interface UpdateHITTypeOfHITRequest {
2487
2760
  /**
2761
+ * @public
2488
2762
  * <p>The HIT to update.</p>
2489
2763
  */
2490
2764
  HITId: string | undefined;
2491
2765
  /**
2766
+ * @public
2492
2767
  * <p>The ID of the new HIT type.</p>
2493
2768
  */
2494
2769
  HITTypeId: string | undefined;
@@ -2503,18 +2778,21 @@ export interface UpdateHITTypeOfHITResponse {
2503
2778
  */
2504
2779
  export interface UpdateNotificationSettingsRequest {
2505
2780
  /**
2781
+ * @public
2506
2782
  * <p>
2507
2783
  * The ID of the HIT type whose notification specification is being updated.
2508
2784
  * </p>
2509
2785
  */
2510
2786
  HITTypeId: string | undefined;
2511
2787
  /**
2788
+ * @public
2512
2789
  * <p>
2513
2790
  * The notification specification for the HIT type.
2514
2791
  * </p>
2515
2792
  */
2516
2793
  Notification?: NotificationSpecification;
2517
2794
  /**
2795
+ * @public
2518
2796
  * <p>
2519
2797
  * Specifies whether notifications are sent for HITs of this HIT type,
2520
2798
  * according to the notification specification.
@@ -2534,32 +2812,39 @@ export interface UpdateNotificationSettingsResponse {
2534
2812
  */
2535
2813
  export interface UpdateQualificationTypeRequest {
2536
2814
  /**
2815
+ * @public
2537
2816
  * <p>The ID of the Qualification type to update.</p>
2538
2817
  */
2539
2818
  QualificationTypeId: string | undefined;
2540
2819
  /**
2820
+ * @public
2541
2821
  * <p>The new description of the Qualification type.</p>
2542
2822
  */
2543
2823
  Description?: string;
2544
2824
  /**
2825
+ * @public
2545
2826
  * <p>The new status of the Qualification type - Active | Inactive</p>
2546
2827
  */
2547
2828
  QualificationTypeStatus?: QualificationTypeStatus | string;
2548
2829
  /**
2830
+ * @public
2549
2831
  * <p>The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, <code>TestDurationInSeconds</code> must also be specified.</p>
2550
2832
  * <p>Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.</p>
2551
2833
  * <p>Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.</p>
2552
2834
  */
2553
2835
  Test?: string;
2554
2836
  /**
2837
+ * @public
2555
2838
  * <p>The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.</p>
2556
2839
  */
2557
2840
  AnswerKey?: string;
2558
2841
  /**
2842
+ * @public
2559
2843
  * <p>The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.</p>
2560
2844
  */
2561
2845
  TestDurationInSeconds?: number;
2562
2846
  /**
2847
+ * @public
2563
2848
  * <p>The amount of time, in seconds, that Workers must wait
2564
2849
  * after requesting a Qualification of the specified Qualification type
2565
2850
  * before they can retry the Qualification request. It is not possible to
@@ -2571,11 +2856,13 @@ export interface UpdateQualificationTypeRequest {
2571
2856
  */
2572
2857
  RetryDelayInSeconds?: number;
2573
2858
  /**
2859
+ * @public
2574
2860
  * <p>Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.</p>
2575
2861
  * <p>Constraints: If the Test parameter is specified, this parameter cannot be true.</p>
2576
2862
  */
2577
2863
  AutoGranted?: boolean;
2578
2864
  /**
2865
+ * @public
2579
2866
  * <p>The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.</p>
2580
2867
  */
2581
2868
  AutoGrantedValue?: number;
@@ -2585,6 +2872,7 @@ export interface UpdateQualificationTypeRequest {
2585
2872
  */
2586
2873
  export interface UpdateQualificationTypeResponse {
2587
2874
  /**
2875
+ * @public
2588
2876
  * <p> Contains a QualificationType data structure.</p>
2589
2877
  */
2590
2878
  QualificationType?: QualificationType;