@aws-sdk/client-mturk 3.296.0 → 3.297.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.
Files changed (55) hide show
  1. package/dist-types/MTurk.d.ts +40 -0
  2. package/dist-types/MTurkClient.d.ts +24 -4
  3. package/dist-types/commands/AcceptQualificationRequestCommand.d.ts +16 -0
  4. package/dist-types/commands/ApproveAssignmentCommand.d.ts +16 -0
  5. package/dist-types/commands/AssociateQualificationWithWorkerCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateAdditionalAssignmentsForHITCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateHITCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateHITTypeCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateHITWithHITTypeCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateQualificationTypeCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateWorkerBlockCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteHITCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteQualificationTypeCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteWorkerBlockCommand.d.ts +16 -0
  15. package/dist-types/commands/DisassociateQualificationFromWorkerCommand.d.ts +16 -0
  16. package/dist-types/commands/GetAccountBalanceCommand.d.ts +16 -0
  17. package/dist-types/commands/GetAssignmentCommand.d.ts +16 -0
  18. package/dist-types/commands/GetFileUploadURLCommand.d.ts +16 -0
  19. package/dist-types/commands/GetHITCommand.d.ts +16 -0
  20. package/dist-types/commands/GetQualificationScoreCommand.d.ts +16 -0
  21. package/dist-types/commands/GetQualificationTypeCommand.d.ts +16 -0
  22. package/dist-types/commands/ListAssignmentsForHITCommand.d.ts +16 -0
  23. package/dist-types/commands/ListBonusPaymentsCommand.d.ts +16 -0
  24. package/dist-types/commands/ListHITsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListHITsForQualificationTypeCommand.d.ts +16 -0
  26. package/dist-types/commands/ListQualificationRequestsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListQualificationTypesCommand.d.ts +16 -0
  28. package/dist-types/commands/ListReviewPolicyResultsForHITCommand.d.ts +16 -0
  29. package/dist-types/commands/ListReviewableHITsCommand.d.ts +16 -0
  30. package/dist-types/commands/ListWorkerBlocksCommand.d.ts +16 -0
  31. package/dist-types/commands/ListWorkersWithQualificationTypeCommand.d.ts +16 -0
  32. package/dist-types/commands/NotifyWorkersCommand.d.ts +16 -0
  33. package/dist-types/commands/RejectAssignmentCommand.d.ts +16 -0
  34. package/dist-types/commands/RejectQualificationRequestCommand.d.ts +16 -0
  35. package/dist-types/commands/SendBonusCommand.d.ts +16 -0
  36. package/dist-types/commands/SendTestEventNotificationCommand.d.ts +16 -0
  37. package/dist-types/commands/UpdateExpirationForHITCommand.d.ts +16 -0
  38. package/dist-types/commands/UpdateHITReviewStatusCommand.d.ts +16 -0
  39. package/dist-types/commands/UpdateHITTypeOfHITCommand.d.ts +16 -0
  40. package/dist-types/commands/UpdateNotificationSettingsCommand.d.ts +16 -0
  41. package/dist-types/commands/UpdateQualificationTypeCommand.d.ts +16 -0
  42. package/dist-types/models/MTurkServiceException.d.ts +2 -0
  43. package/dist-types/models/models_0.d.ts +293 -0
  44. package/dist-types/pagination/Interfaces.d.ts +3 -0
  45. package/dist-types/pagination/ListAssignmentsForHITPaginator.d.ts +3 -0
  46. package/dist-types/pagination/ListBonusPaymentsPaginator.d.ts +3 -0
  47. package/dist-types/pagination/ListHITsForQualificationTypePaginator.d.ts +3 -0
  48. package/dist-types/pagination/ListHITsPaginator.d.ts +3 -0
  49. package/dist-types/pagination/ListQualificationRequestsPaginator.d.ts +3 -0
  50. package/dist-types/pagination/ListQualificationTypesPaginator.d.ts +3 -0
  51. package/dist-types/pagination/ListReviewPolicyResultsForHITPaginator.d.ts +3 -0
  52. package/dist-types/pagination/ListReviewableHITsPaginator.d.ts +3 -0
  53. package/dist-types/pagination/ListWorkerBlocksPaginator.d.ts +3 -0
  54. package/dist-types/pagination/ListWorkersWithQualificationTypePaginator.d.ts +3 -0
  55. package/package.json +3 -3
@@ -1,5 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { MTurkServiceException as __BaseException } from "./MTurkServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface AcceptQualificationRequestRequest {
4
7
  /**
5
8
  * <p>The ID of the Qualification request, as returned by the <code>GetQualificationRequests</code> operation.</p>
@@ -13,9 +16,13 @@ export interface AcceptQualificationRequestRequest {
13
16
  */
14
17
  IntegerValue?: number;
15
18
  }
19
+ /**
20
+ * @public
21
+ */
16
22
  export interface AcceptQualificationRequestResponse {
17
23
  }
18
24
  /**
25
+ * @public
19
26
  * <p>Your request is invalid.</p>
20
27
  */
21
28
  export declare class RequestError extends __BaseException {
@@ -29,6 +36,7 @@ export declare class RequestError extends __BaseException {
29
36
  constructor(opts: __ExceptionOptionType<RequestError, __BaseException>);
30
37
  }
31
38
  /**
39
+ * @public
32
40
  * <p>Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.</p>
33
41
  */
34
42
  export declare class ServiceFault extends __BaseException {
@@ -41,6 +49,9 @@ export declare class ServiceFault extends __BaseException {
41
49
  */
42
50
  constructor(opts: __ExceptionOptionType<ServiceFault, __BaseException>);
43
51
  }
52
+ /**
53
+ * @public
54
+ */
44
55
  export interface ApproveAssignmentRequest {
45
56
  /**
46
57
  * <p>
@@ -61,14 +72,21 @@ export interface ApproveAssignmentRequest {
61
72
  */
62
73
  OverrideRejection?: boolean;
63
74
  }
75
+ /**
76
+ * @public
77
+ */
64
78
  export interface ApproveAssignmentResponse {
65
79
  }
80
+ /**
81
+ * @public
82
+ */
66
83
  export declare enum AssignmentStatus {
67
84
  Approved = "Approved",
68
85
  Rejected = "Rejected",
69
86
  Submitted = "Submitted"
70
87
  }
71
88
  /**
89
+ * @public
72
90
  * <p> The Assignment data structure represents a single assignment
73
91
  * of a HIT to a Worker. The assignment tracks the Worker's efforts to
74
92
  * complete the HIT, and contains the results for later retrieval.
@@ -144,6 +162,9 @@ export interface Assignment {
144
162
  */
145
163
  RequesterFeedback?: string;
146
164
  }
165
+ /**
166
+ * @public
167
+ */
147
168
  export interface AssociateQualificationWithWorkerRequest {
148
169
  /**
149
170
  * <p>The ID of the Qualification type to use for the assigned Qualification.</p>
@@ -169,9 +190,13 @@ export interface AssociateQualificationWithWorkerRequest {
169
190
  */
170
191
  SendNotification?: boolean;
171
192
  }
193
+ /**
194
+ * @public
195
+ */
172
196
  export interface AssociateQualificationWithWorkerResponse {
173
197
  }
174
198
  /**
199
+ * @public
175
200
  * <p>An object representing a Bonus payment paid to a Worker.</p>
176
201
  */
177
202
  export interface BonusPayment {
@@ -196,6 +221,9 @@ export interface BonusPayment {
196
221
  */
197
222
  GrantTime?: Date;
198
223
  }
224
+ /**
225
+ * @public
226
+ */
199
227
  export declare enum Comparator {
200
228
  DoesNotExist = "DoesNotExist",
201
229
  EqualTo = "EqualTo",
@@ -208,6 +236,9 @@ export declare enum Comparator {
208
236
  NotEqualTo = "NotEqualTo",
209
237
  NotIn = "NotIn"
210
238
  }
239
+ /**
240
+ * @public
241
+ */
211
242
  export interface CreateAdditionalAssignmentsForHITRequest {
212
243
  /**
213
244
  * <p>The ID of the HIT to extend.</p>
@@ -229,9 +260,13 @@ export interface CreateAdditionalAssignmentsForHITRequest {
229
260
  */
230
261
  UniqueRequestToken?: string;
231
262
  }
263
+ /**
264
+ * @public
265
+ */
232
266
  export interface CreateAdditionalAssignmentsForHITResponse {
233
267
  }
234
268
  /**
269
+ * @public
235
270
  * <p> This data structure is the data type for the AnswerKey
236
271
  * parameter of the ScoreMyKnownAnswers/2011-09-01 Review Policy.
237
272
  * </p>
@@ -253,6 +288,7 @@ export interface ParameterMapEntry {
253
288
  Values?: string[];
254
289
  }
255
290
  /**
291
+ * @public
256
292
  * <p> Name of the parameter from the Review policy.
257
293
  * </p>
258
294
  */
@@ -273,6 +309,7 @@ export interface PolicyParameter {
273
309
  MapEntries?: ParameterMapEntry[];
274
310
  }
275
311
  /**
312
+ * @public
276
313
  * <p> HIT Review Policy data structures represent HIT review
277
314
  * policies, which you specify when you create a HIT.
278
315
  * </p>
@@ -290,6 +327,7 @@ export interface ReviewPolicy {
290
327
  Parameters?: PolicyParameter[];
291
328
  }
292
329
  /**
330
+ * @public
293
331
  * <p> The HITLayoutParameter data structure defines parameter
294
332
  * values used with a HITLayout. A HITLayout is a reusable Amazon
295
333
  * Mechanical Turk project template used to provide Human Intelligence
@@ -309,12 +347,16 @@ export interface HITLayoutParameter {
309
347
  */
310
348
  Value: string | undefined;
311
349
  }
350
+ /**
351
+ * @public
352
+ */
312
353
  export declare enum HITAccessActions {
313
354
  Accept = "Accept",
314
355
  DiscoverPreviewAndAccept = "DiscoverPreviewAndAccept",
315
356
  PreviewAndAccept = "PreviewAndAccept"
316
357
  }
317
358
  /**
359
+ * @public
318
360
  * <p>The Locale data structure represents a geographical region or location.</p>
319
361
  */
320
362
  export interface Locale {
@@ -333,6 +375,7 @@ export interface Locale {
333
375
  Subdivision?: string;
334
376
  }
335
377
  /**
378
+ * @public
336
379
  * <p>
337
380
  * The QualificationRequirement data structure describes a Qualification that a Worker must have
338
381
  * before the Worker is allowed to accept a HIT.
@@ -419,6 +462,9 @@ export interface QualificationRequirement {
419
462
  */
420
463
  ActionsGuarded?: HITAccessActions | string;
421
464
  }
465
+ /**
466
+ * @public
467
+ */
422
468
  export interface CreateHITRequest {
423
469
  /**
424
470
  * <p>
@@ -574,12 +620,18 @@ export interface CreateHITRequest {
574
620
  */
575
621
  HITLayoutParameters?: HITLayoutParameter[];
576
622
  }
623
+ /**
624
+ * @public
625
+ */
577
626
  export declare enum HITReviewStatus {
578
627
  MarkedForReview = "MarkedForReview",
579
628
  NotReviewed = "NotReviewed",
580
629
  ReviewedAppropriate = "ReviewedAppropriate",
581
630
  ReviewedInappropriate = "ReviewedInappropriate"
582
631
  }
632
+ /**
633
+ * @public
634
+ */
583
635
  export declare enum HITStatus {
584
636
  Assignable = "Assignable",
585
637
  Disposed = "Disposed",
@@ -588,6 +640,7 @@ export declare enum HITStatus {
588
640
  Unassignable = "Unassignable"
589
641
  }
590
642
  /**
643
+ * @public
591
644
  * <p> The HIT data structure represents a single HIT, including
592
645
  * all the information necessary for a Worker to accept and complete the
593
646
  * HIT.</p>
@@ -706,6 +759,9 @@ export interface HIT {
706
759
  */
707
760
  NumberOfAssignmentsCompleted?: number;
708
761
  }
762
+ /**
763
+ * @public
764
+ */
709
765
  export interface CreateHITResponse {
710
766
  /**
711
767
  * <p> Contains the newly created HIT data. For a description of
@@ -715,6 +771,9 @@ export interface CreateHITResponse {
715
771
  */
716
772
  HIT?: HIT;
717
773
  }
774
+ /**
775
+ * @public
776
+ */
718
777
  export interface CreateHITTypeRequest {
719
778
  /**
720
779
  * <p>
@@ -776,12 +835,18 @@ export interface CreateHITTypeRequest {
776
835
  */
777
836
  QualificationRequirements?: QualificationRequirement[];
778
837
  }
838
+ /**
839
+ * @public
840
+ */
779
841
  export interface CreateHITTypeResponse {
780
842
  /**
781
843
  * <p> The ID of the newly registered HIT type.</p>
782
844
  */
783
845
  HITTypeId?: string;
784
846
  }
847
+ /**
848
+ * @public
849
+ */
785
850
  export interface CreateHITWithHITTypeRequest {
786
851
  /**
787
852
  * <p>The HIT type ID you want to create this HIT with.</p>
@@ -882,6 +947,9 @@ export interface CreateHITWithHITTypeRequest {
882
947
  */
883
948
  HITLayoutParameters?: HITLayoutParameter[];
884
949
  }
950
+ /**
951
+ * @public
952
+ */
885
953
  export interface CreateHITWithHITTypeResponse {
886
954
  /**
887
955
  * <p> Contains the newly created HIT data. For a description of
@@ -891,10 +959,16 @@ export interface CreateHITWithHITTypeResponse {
891
959
  */
892
960
  HIT?: HIT;
893
961
  }
962
+ /**
963
+ * @public
964
+ */
894
965
  export declare enum QualificationTypeStatus {
895
966
  Active = "Active",
896
967
  Inactive = "Inactive"
897
968
  }
969
+ /**
970
+ * @public
971
+ */
898
972
  export interface CreateQualificationTypeRequest {
899
973
  /**
900
974
  * <p> The name you give to the Qualification type. The type name
@@ -978,6 +1052,7 @@ export interface CreateQualificationTypeRequest {
978
1052
  AutoGrantedValue?: number;
979
1053
  }
980
1054
  /**
1055
+ * @public
981
1056
  * <p> The QualificationType data structure represents a
982
1057
  * Qualification type, a description of a property of a Worker that must
983
1058
  * match the requirements of a HIT for the Worker to be able to accept
@@ -1078,6 +1153,9 @@ export interface QualificationType {
1078
1153
  */
1079
1154
  AutoGrantedValue?: number;
1080
1155
  }
1156
+ /**
1157
+ * @public
1158
+ */
1081
1159
  export interface CreateQualificationTypeResponse {
1082
1160
  /**
1083
1161
  * <p>The created Qualification type, returned as a
@@ -1085,6 +1163,9 @@ export interface CreateQualificationTypeResponse {
1085
1163
  */
1086
1164
  QualificationType?: QualificationType;
1087
1165
  }
1166
+ /**
1167
+ * @public
1168
+ */
1088
1169
  export interface CreateWorkerBlockRequest {
1089
1170
  /**
1090
1171
  * <p>The ID of the Worker to block.</p>
@@ -1095,24 +1176,42 @@ export interface CreateWorkerBlockRequest {
1095
1176
  */
1096
1177
  Reason: string | undefined;
1097
1178
  }
1179
+ /**
1180
+ * @public
1181
+ */
1098
1182
  export interface CreateWorkerBlockResponse {
1099
1183
  }
1184
+ /**
1185
+ * @public
1186
+ */
1100
1187
  export interface DeleteHITRequest {
1101
1188
  /**
1102
1189
  * <p>The ID of the HIT to be deleted.</p>
1103
1190
  */
1104
1191
  HITId: string | undefined;
1105
1192
  }
1193
+ /**
1194
+ * @public
1195
+ */
1106
1196
  export interface DeleteHITResponse {
1107
1197
  }
1198
+ /**
1199
+ * @public
1200
+ */
1108
1201
  export interface DeleteQualificationTypeRequest {
1109
1202
  /**
1110
1203
  * <p>The ID of the QualificationType to dispose.</p>
1111
1204
  */
1112
1205
  QualificationTypeId: string | undefined;
1113
1206
  }
1207
+ /**
1208
+ * @public
1209
+ */
1114
1210
  export interface DeleteQualificationTypeResponse {
1115
1211
  }
1212
+ /**
1213
+ * @public
1214
+ */
1116
1215
  export interface DeleteWorkerBlockRequest {
1117
1216
  /**
1118
1217
  * <p>The ID of the Worker to unblock.</p>
@@ -1123,8 +1222,14 @@ export interface DeleteWorkerBlockRequest {
1123
1222
  */
1124
1223
  Reason?: string;
1125
1224
  }
1225
+ /**
1226
+ * @public
1227
+ */
1126
1228
  export interface DeleteWorkerBlockResponse {
1127
1229
  }
1230
+ /**
1231
+ * @public
1232
+ */
1128
1233
  export interface DisassociateQualificationFromWorkerRequest {
1129
1234
  /**
1130
1235
  * <p>The ID of the Worker who possesses the Qualification to be revoked.</p>
@@ -1139,8 +1244,14 @@ export interface DisassociateQualificationFromWorkerRequest {
1139
1244
  */
1140
1245
  Reason?: string;
1141
1246
  }
1247
+ /**
1248
+ * @public
1249
+ */
1142
1250
  export interface DisassociateQualificationFromWorkerResponse {
1143
1251
  }
1252
+ /**
1253
+ * @public
1254
+ */
1144
1255
  export declare enum EventType {
1145
1256
  AssignmentAbandoned = "AssignmentAbandoned",
1146
1257
  AssignmentAccepted = "AssignmentAccepted",
@@ -1155,8 +1266,14 @@ export declare enum EventType {
1155
1266
  HITReviewable = "HITReviewable",
1156
1267
  Ping = "Ping"
1157
1268
  }
1269
+ /**
1270
+ * @public
1271
+ */
1158
1272
  export interface GetAccountBalanceRequest {
1159
1273
  }
1274
+ /**
1275
+ * @public
1276
+ */
1160
1277
  export interface GetAccountBalanceResponse {
1161
1278
  /**
1162
1279
  * <p>A string representing a currency amount.</p>
@@ -1167,12 +1284,18 @@ export interface GetAccountBalanceResponse {
1167
1284
  */
1168
1285
  OnHoldBalance?: string;
1169
1286
  }
1287
+ /**
1288
+ * @public
1289
+ */
1170
1290
  export interface GetAssignmentRequest {
1171
1291
  /**
1172
1292
  * <p>The ID of the Assignment to be retrieved.</p>
1173
1293
  */
1174
1294
  AssignmentId: string | undefined;
1175
1295
  }
1296
+ /**
1297
+ * @public
1298
+ */
1176
1299
  export interface GetAssignmentResponse {
1177
1300
  /**
1178
1301
  * <p> The assignment. The response includes one Assignment
@@ -1186,6 +1309,9 @@ export interface GetAssignmentResponse {
1186
1309
  */
1187
1310
  HIT?: HIT;
1188
1311
  }
1312
+ /**
1313
+ * @public
1314
+ */
1189
1315
  export interface GetFileUploadURLRequest {
1190
1316
  /**
1191
1317
  * <p>The ID of the assignment that contains the question with a
@@ -1198,6 +1324,9 @@ export interface GetFileUploadURLRequest {
1198
1324
  */
1199
1325
  QuestionIdentifier: string | undefined;
1200
1326
  }
1327
+ /**
1328
+ * @public
1329
+ */
1201
1330
  export interface GetFileUploadURLResponse {
1202
1331
  /**
1203
1332
  * <p> A temporary URL for the file that the Worker uploaded for
@@ -1206,18 +1335,27 @@ export interface GetFileUploadURLResponse {
1206
1335
  */
1207
1336
  FileUploadURL?: string;
1208
1337
  }
1338
+ /**
1339
+ * @public
1340
+ */
1209
1341
  export interface GetHITRequest {
1210
1342
  /**
1211
1343
  * <p>The ID of the HIT to be retrieved.</p>
1212
1344
  */
1213
1345
  HITId: string | undefined;
1214
1346
  }
1347
+ /**
1348
+ * @public
1349
+ */
1215
1350
  export interface GetHITResponse {
1216
1351
  /**
1217
1352
  * <p> Contains the requested HIT data.</p>
1218
1353
  */
1219
1354
  HIT?: HIT;
1220
1355
  }
1356
+ /**
1357
+ * @public
1358
+ */
1221
1359
  export interface GetQualificationScoreRequest {
1222
1360
  /**
1223
1361
  * <p>The ID of the QualificationType.</p>
@@ -1228,11 +1366,15 @@ export interface GetQualificationScoreRequest {
1228
1366
  */
1229
1367
  WorkerId: string | undefined;
1230
1368
  }
1369
+ /**
1370
+ * @public
1371
+ */
1231
1372
  export declare enum QualificationStatus {
1232
1373
  Granted = "Granted",
1233
1374
  Revoked = "Revoked"
1234
1375
  }
1235
1376
  /**
1377
+ * @public
1236
1378
  * <p>The Qualification data structure represents a Qualification
1237
1379
  * assigned to a user, including the Qualification type and the value
1238
1380
  * (score).</p>
@@ -1270,6 +1412,9 @@ export interface Qualification {
1270
1412
  */
1271
1413
  Status?: QualificationStatus | string;
1272
1414
  }
1415
+ /**
1416
+ * @public
1417
+ */
1273
1418
  export interface GetQualificationScoreResponse {
1274
1419
  /**
1275
1420
  * <p> The Qualification data structure of the Qualification
@@ -1279,18 +1424,27 @@ export interface GetQualificationScoreResponse {
1279
1424
  */
1280
1425
  Qualification?: Qualification;
1281
1426
  }
1427
+ /**
1428
+ * @public
1429
+ */
1282
1430
  export interface GetQualificationTypeRequest {
1283
1431
  /**
1284
1432
  * <p>The ID of the QualificationType.</p>
1285
1433
  */
1286
1434
  QualificationTypeId: string | undefined;
1287
1435
  }
1436
+ /**
1437
+ * @public
1438
+ */
1288
1439
  export interface GetQualificationTypeResponse {
1289
1440
  /**
1290
1441
  * <p> The returned Qualification Type</p>
1291
1442
  */
1292
1443
  QualificationType?: QualificationType;
1293
1444
  }
1445
+ /**
1446
+ * @public
1447
+ */
1294
1448
  export interface ListAssignmentsForHITRequest {
1295
1449
  /**
1296
1450
  * <p>The ID of the HIT.</p>
@@ -1307,6 +1461,9 @@ export interface ListAssignmentsForHITRequest {
1307
1461
  */
1308
1462
  AssignmentStatuses?: (AssignmentStatus | string)[];
1309
1463
  }
1464
+ /**
1465
+ * @public
1466
+ */
1310
1467
  export interface ListAssignmentsForHITResponse {
1311
1468
  /**
1312
1469
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
@@ -1327,6 +1484,9 @@ export interface ListAssignmentsForHITResponse {
1327
1484
  */
1328
1485
  Assignments?: Assignment[];
1329
1486
  }
1487
+ /**
1488
+ * @public
1489
+ */
1330
1490
  export interface ListBonusPaymentsRequest {
1331
1491
  /**
1332
1492
  * <p>The ID of the HIT associated with the bonus payments to
@@ -1348,6 +1508,9 @@ export interface ListBonusPaymentsRequest {
1348
1508
  NextToken?: string;
1349
1509
  MaxResults?: number;
1350
1510
  }
1511
+ /**
1512
+ * @public
1513
+ */
1351
1514
  export interface ListBonusPaymentsResponse {
1352
1515
  /**
1353
1516
  * <p>The number of bonus payments on this page in the filtered
@@ -1370,6 +1533,9 @@ export interface ListBonusPaymentsResponse {
1370
1533
  */
1371
1534
  BonusPayments?: BonusPayment[];
1372
1535
  }
1536
+ /**
1537
+ * @public
1538
+ */
1373
1539
  export interface ListHITsRequest {
1374
1540
  /**
1375
1541
  * <p>Pagination token</p>
@@ -1377,6 +1543,9 @@ export interface ListHITsRequest {
1377
1543
  NextToken?: string;
1378
1544
  MaxResults?: number;
1379
1545
  }
1546
+ /**
1547
+ * @public
1548
+ */
1380
1549
  export interface ListHITsResponse {
1381
1550
  /**
1382
1551
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
@@ -1395,6 +1564,9 @@ export interface ListHITsResponse {
1395
1564
  */
1396
1565
  HITs?: HIT[];
1397
1566
  }
1567
+ /**
1568
+ * @public
1569
+ */
1398
1570
  export interface ListHITsForQualificationTypeRequest {
1399
1571
  /**
1400
1572
  * <p>
@@ -1413,6 +1585,9 @@ export interface ListHITsForQualificationTypeRequest {
1413
1585
  */
1414
1586
  MaxResults?: number;
1415
1587
  }
1588
+ /**
1589
+ * @public
1590
+ */
1416
1591
  export interface ListHITsForQualificationTypeResponse {
1417
1592
  /**
1418
1593
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
@@ -1431,6 +1606,9 @@ export interface ListHITsForQualificationTypeResponse {
1431
1606
  */
1432
1607
  HITs?: HIT[];
1433
1608
  }
1609
+ /**
1610
+ * @public
1611
+ */
1434
1612
  export interface ListQualificationRequestsRequest {
1435
1613
  /**
1436
1614
  * <p>The ID of the QualificationType.</p>
@@ -1450,6 +1628,7 @@ export interface ListQualificationRequestsRequest {
1450
1628
  MaxResults?: number;
1451
1629
  }
1452
1630
  /**
1631
+ * @public
1453
1632
  * <p> The QualificationRequest data structure represents a request
1454
1633
  * a Worker has made for a Qualification.
1455
1634
  * </p>
@@ -1497,6 +1676,9 @@ export interface QualificationRequest {
1497
1676
  */
1498
1677
  SubmitTime?: Date;
1499
1678
  }
1679
+ /**
1680
+ * @public
1681
+ */
1500
1682
  export interface ListQualificationRequestsResponse {
1501
1683
  /**
1502
1684
  * <p>The number of Qualification requests on this page in the filtered results list,
@@ -1518,6 +1700,9 @@ export interface ListQualificationRequestsResponse {
1518
1700
  */
1519
1701
  QualificationRequests?: QualificationRequest[];
1520
1702
  }
1703
+ /**
1704
+ * @public
1705
+ */
1521
1706
  export interface ListQualificationTypesRequest {
1522
1707
  /**
1523
1708
  * <p> A text query against all of the searchable attributes of
@@ -1556,6 +1741,9 @@ export interface ListQualificationTypesRequest {
1556
1741
  */
1557
1742
  MaxResults?: number;
1558
1743
  }
1744
+ /**
1745
+ * @public
1746
+ */
1559
1747
  export interface ListQualificationTypesResponse {
1560
1748
  /**
1561
1749
  * <p> The number of Qualification types on this page in the
@@ -1578,10 +1766,16 @@ export interface ListQualificationTypesResponse {
1578
1766
  */
1579
1767
  QualificationTypes?: QualificationType[];
1580
1768
  }
1769
+ /**
1770
+ * @public
1771
+ */
1581
1772
  export declare enum ReviewableHITStatus {
1582
1773
  Reviewable = "Reviewable",
1583
1774
  Reviewing = "Reviewing"
1584
1775
  }
1776
+ /**
1777
+ * @public
1778
+ */
1585
1779
  export interface ListReviewableHITsRequest {
1586
1780
  /**
1587
1781
  * <p>
@@ -1608,6 +1802,9 @@ export interface ListReviewableHITsRequest {
1608
1802
  */
1609
1803
  MaxResults?: number;
1610
1804
  }
1805
+ /**
1806
+ * @public
1807
+ */
1611
1808
  export interface ListReviewableHITsResponse {
1612
1809
  /**
1613
1810
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
@@ -1627,10 +1824,16 @@ export interface ListReviewableHITsResponse {
1627
1824
  */
1628
1825
  HITs?: HIT[];
1629
1826
  }
1827
+ /**
1828
+ * @public
1829
+ */
1630
1830
  export declare enum ReviewPolicyLevel {
1631
1831
  Assignment = "Assignment",
1632
1832
  HIT = "HIT"
1633
1833
  }
1834
+ /**
1835
+ * @public
1836
+ */
1634
1837
  export interface ListReviewPolicyResultsForHITRequest {
1635
1838
  /**
1636
1839
  * <p>The unique identifier of the HIT to retrieve review results for.</p>
@@ -1666,6 +1869,9 @@ export interface ListReviewPolicyResultsForHITRequest {
1666
1869
  */
1667
1870
  MaxResults?: number;
1668
1871
  }
1872
+ /**
1873
+ * @public
1874
+ */
1669
1875
  export declare enum ReviewActionStatus {
1670
1876
  Cancelled = "Cancelled",
1671
1877
  Failed = "Failed",
@@ -1673,6 +1879,7 @@ export declare enum ReviewActionStatus {
1673
1879
  Succeeded = "Succeeded"
1674
1880
  }
1675
1881
  /**
1882
+ * @public
1676
1883
  * <p> Both the AssignmentReviewReport and the HITReviewReport
1677
1884
  * elements contains the ReviewActionDetail data structure. This
1678
1885
  * structure is returned multiple times for each action specified in the
@@ -1718,6 +1925,7 @@ export interface ReviewActionDetail {
1718
1925
  ErrorCode?: string;
1719
1926
  }
1720
1927
  /**
1928
+ * @public
1721
1929
  * <p> This data structure is returned multiple times for each
1722
1930
  * result specified in the Review Policy.
1723
1931
  * </p>
@@ -1765,6 +1973,7 @@ export interface ReviewResultDetail {
1765
1973
  Value?: string;
1766
1974
  }
1767
1975
  /**
1976
+ * @public
1768
1977
  * <p> Contains both ReviewResult and ReviewAction elements for a
1769
1978
  * particular HIT.
1770
1979
  * </p>
@@ -1783,6 +1992,9 @@ export interface ReviewReport {
1783
1992
  */
1784
1993
  ReviewActions?: ReviewActionDetail[];
1785
1994
  }
1995
+ /**
1996
+ * @public
1997
+ */
1786
1998
  export interface ListReviewPolicyResultsForHITResponse {
1787
1999
  /**
1788
2000
  * <p>The HITId of the HIT for which results have been returned.</p>
@@ -1818,6 +2030,9 @@ export interface ListReviewPolicyResultsForHITResponse {
1818
2030
  */
1819
2031
  NextToken?: string;
1820
2032
  }
2033
+ /**
2034
+ * @public
2035
+ */
1821
2036
  export interface ListWorkerBlocksRequest {
1822
2037
  /**
1823
2038
  * <p>Pagination token</p>
@@ -1826,6 +2041,7 @@ export interface ListWorkerBlocksRequest {
1826
2041
  MaxResults?: number;
1827
2042
  }
1828
2043
  /**
2044
+ * @public
1829
2045
  * <p> The WorkerBlock data structure represents a Worker who has
1830
2046
  * been blocked. It has two elements: the WorkerId and the Reason for
1831
2047
  * the block.
@@ -1842,6 +2058,9 @@ export interface WorkerBlock {
1842
2058
  */
1843
2059
  Reason?: string;
1844
2060
  }
2061
+ /**
2062
+ * @public
2063
+ */
1845
2064
  export interface ListWorkerBlocksResponse {
1846
2065
  /**
1847
2066
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
@@ -1862,6 +2081,9 @@ export interface ListWorkerBlocksResponse {
1862
2081
  */
1863
2082
  WorkerBlocks?: WorkerBlock[];
1864
2083
  }
2084
+ /**
2085
+ * @public
2086
+ */
1865
2087
  export interface ListWorkersWithQualificationTypeRequest {
1866
2088
  /**
1867
2089
  * <p>The ID of the Qualification type of the Qualifications to
@@ -1886,6 +2108,9 @@ export interface ListWorkersWithQualificationTypeRequest {
1886
2108
  */
1887
2109
  MaxResults?: number;
1888
2110
  }
2111
+ /**
2112
+ * @public
2113
+ */
1889
2114
  export interface ListWorkersWithQualificationTypeResponse {
1890
2115
  /**
1891
2116
  * <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk
@@ -1906,6 +2131,9 @@ export interface ListWorkersWithQualificationTypeResponse {
1906
2131
  */
1907
2132
  Qualifications?: Qualification[];
1908
2133
  }
2134
+ /**
2135
+ * @public
2136
+ */
1909
2137
  export interface NotifyWorkersRequest {
1910
2138
  /**
1911
2139
  * <p>The subject line of the email message to send. Can include up
@@ -1924,11 +2152,15 @@ export interface NotifyWorkersRequest {
1924
2152
  */
1925
2153
  WorkerIds: string[] | undefined;
1926
2154
  }
2155
+ /**
2156
+ * @public
2157
+ */
1927
2158
  export declare enum NotifyWorkersFailureCode {
1928
2159
  HardFailure = "HardFailure",
1929
2160
  SoftFailure = "SoftFailure"
1930
2161
  }
1931
2162
  /**
2163
+ * @public
1932
2164
  * <p> When MTurk encounters an issue with notifying the Workers
1933
2165
  * you specified, it returns back this object with failure details.
1934
2166
  * </p>
@@ -1950,6 +2182,9 @@ export interface NotifyWorkersFailureStatus {
1950
2182
  */
1951
2183
  WorkerId?: string;
1952
2184
  }
2185
+ /**
2186
+ * @public
2187
+ */
1953
2188
  export interface NotifyWorkersResponse {
1954
2189
  /**
1955
2190
  * <p> When MTurk sends notifications to the list of Workers, it
@@ -1959,6 +2194,9 @@ export interface NotifyWorkersResponse {
1959
2194
  */
1960
2195
  NotifyWorkersFailureStatuses?: NotifyWorkersFailureStatus[];
1961
2196
  }
2197
+ /**
2198
+ * @public
2199
+ */
1962
2200
  export interface RejectAssignmentRequest {
1963
2201
  /**
1964
2202
  * <p>
@@ -1973,8 +2211,14 @@ export interface RejectAssignmentRequest {
1973
2211
  */
1974
2212
  RequesterFeedback: string | undefined;
1975
2213
  }
2214
+ /**
2215
+ * @public
2216
+ */
1976
2217
  export interface RejectAssignmentResponse {
1977
2218
  }
2219
+ /**
2220
+ * @public
2221
+ */
1978
2222
  export interface RejectQualificationRequestRequest {
1979
2223
  /**
1980
2224
  * <p>
@@ -1990,8 +2234,14 @@ export interface RejectQualificationRequestRequest {
1990
2234
  */
1991
2235
  Reason?: string;
1992
2236
  }
2237
+ /**
2238
+ * @public
2239
+ */
1993
2240
  export interface RejectQualificationRequestResponse {
1994
2241
  }
2242
+ /**
2243
+ * @public
2244
+ */
1995
2245
  export interface SendBonusRequest {
1996
2246
  /**
1997
2247
  * <p>The ID of the Worker being paid the bonus.</p>
@@ -2024,14 +2274,21 @@ export interface SendBonusRequest {
2024
2274
  */
2025
2275
  UniqueRequestToken?: string;
2026
2276
  }
2277
+ /**
2278
+ * @public
2279
+ */
2027
2280
  export interface SendBonusResponse {
2028
2281
  }
2282
+ /**
2283
+ * @public
2284
+ */
2029
2285
  export declare enum NotificationTransport {
2030
2286
  Email = "Email",
2031
2287
  SNS = "SNS",
2032
2288
  SQS = "SQS"
2033
2289
  }
2034
2290
  /**
2291
+ * @public
2035
2292
  * <p>The NotificationSpecification data structure describes a HIT
2036
2293
  * event notification for a HIT type.</p>
2037
2294
  */
@@ -2075,6 +2332,9 @@ export interface NotificationSpecification {
2075
2332
  */
2076
2333
  EventTypes: (EventType | string)[] | undefined;
2077
2334
  }
2335
+ /**
2336
+ * @public
2337
+ */
2078
2338
  export interface SendTestEventNotificationRequest {
2079
2339
  /**
2080
2340
  * <p>
@@ -2094,8 +2354,14 @@ export interface SendTestEventNotificationRequest {
2094
2354
  */
2095
2355
  TestEventType: EventType | string | undefined;
2096
2356
  }
2357
+ /**
2358
+ * @public
2359
+ */
2097
2360
  export interface SendTestEventNotificationResponse {
2098
2361
  }
2362
+ /**
2363
+ * @public
2364
+ */
2099
2365
  export interface UpdateExpirationForHITRequest {
2100
2366
  /**
2101
2367
  * <p>
@@ -2110,8 +2376,14 @@ export interface UpdateExpirationForHITRequest {
2110
2376
  */
2111
2377
  ExpireAt: Date | undefined;
2112
2378
  }
2379
+ /**
2380
+ * @public
2381
+ */
2113
2382
  export interface UpdateExpirationForHITResponse {
2114
2383
  }
2384
+ /**
2385
+ * @public
2386
+ */
2115
2387
  export interface UpdateHITReviewStatusRequest {
2116
2388
  /**
2117
2389
  * <p>
@@ -2138,8 +2410,14 @@ export interface UpdateHITReviewStatusRequest {
2138
2410
  */
2139
2411
  Revert?: boolean;
2140
2412
  }
2413
+ /**
2414
+ * @public
2415
+ */
2141
2416
  export interface UpdateHITReviewStatusResponse {
2142
2417
  }
2418
+ /**
2419
+ * @public
2420
+ */
2143
2421
  export interface UpdateHITTypeOfHITRequest {
2144
2422
  /**
2145
2423
  * <p>The HIT to update.</p>
@@ -2150,8 +2428,14 @@ export interface UpdateHITTypeOfHITRequest {
2150
2428
  */
2151
2429
  HITTypeId: string | undefined;
2152
2430
  }
2431
+ /**
2432
+ * @public
2433
+ */
2153
2434
  export interface UpdateHITTypeOfHITResponse {
2154
2435
  }
2436
+ /**
2437
+ * @public
2438
+ */
2155
2439
  export interface UpdateNotificationSettingsRequest {
2156
2440
  /**
2157
2441
  * <p>
@@ -2175,8 +2459,14 @@ export interface UpdateNotificationSettingsRequest {
2175
2459
  */
2176
2460
  Active?: boolean;
2177
2461
  }
2462
+ /**
2463
+ * @public
2464
+ */
2178
2465
  export interface UpdateNotificationSettingsResponse {
2179
2466
  }
2467
+ /**
2468
+ * @public
2469
+ */
2180
2470
  export interface UpdateQualificationTypeRequest {
2181
2471
  /**
2182
2472
  * <p>The ID of the Qualification type to update.</p>
@@ -2225,6 +2515,9 @@ export interface UpdateQualificationTypeRequest {
2225
2515
  */
2226
2516
  AutoGrantedValue?: number;
2227
2517
  }
2518
+ /**
2519
+ * @public
2520
+ */
2228
2521
  export interface UpdateQualificationTypeResponse {
2229
2522
  /**
2230
2523
  * <p> Contains a QualificationType data structure.</p>