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