@aws-sdk/client-mturk 3.315.0 → 3.316.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.
@@ -39,673 +39,245 @@ import { UpdateHITTypeOfHITCommandInput, UpdateHITTypeOfHITCommandOutput } from
39
39
  import { UpdateNotificationSettingsCommandInput, UpdateNotificationSettingsCommandOutput } from "./commands/UpdateNotificationSettingsCommand";
40
40
  import { UpdateQualificationTypeCommandInput, UpdateQualificationTypeCommandOutput } from "./commands/UpdateQualificationTypeCommand";
41
41
  import { MTurkClient } from "./MTurkClient";
42
- /**
43
- * @public
44
- * <fullname>Amazon Mechanical Turk API Reference</fullname>
45
- */
46
- export declare class MTurk extends MTurkClient {
47
- /**
48
- * @public
49
- * <p>
50
- * The <code>AcceptQualificationRequest</code> operation approves a Worker's request for a Qualification.
51
- * </p>
52
- * <p>
53
- * Only the owner of the Qualification type can grant a Qualification request for that type.
54
- * </p>
55
- * <p>
56
- * A successful request for the <code>AcceptQualificationRequest</code> operation
57
- * returns with no errors and an empty body.
58
- * </p>
42
+ export interface MTurk {
43
+ /**
44
+ * @see {@link AcceptQualificationRequestCommand}
59
45
  */
60
46
  acceptQualificationRequest(args: AcceptQualificationRequestCommandInput, options?: __HttpHandlerOptions): Promise<AcceptQualificationRequestCommandOutput>;
61
47
  acceptQualificationRequest(args: AcceptQualificationRequestCommandInput, cb: (err: any, data?: AcceptQualificationRequestCommandOutput) => void): void;
62
48
  acceptQualificationRequest(args: AcceptQualificationRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptQualificationRequestCommandOutput) => void): void;
63
49
  /**
64
- * @public
65
- * <p>
66
- * The <code>ApproveAssignment</code> operation approves the results of a completed assignment.
67
- * </p>
68
- * <p>
69
- * Approving an assignment initiates two payments from the Requester's Amazon.com account
70
- * </p>
71
- * <ul>
72
- * <li>
73
- * <p>
74
- * The Worker who submitted the results is paid the reward specified in the HIT.
75
- * </p>
76
- * </li>
77
- * <li>
78
- * <p>
79
- * Amazon Mechanical Turk fees are debited.
80
- * </p>
81
- * </li>
82
- * </ul>
83
- * <p>
84
- * If the Requester's account does not have adequate funds for these payments,
85
- * the call to ApproveAssignment returns an exception, and the approval is not processed.
86
- * You can include an optional feedback message with the approval,
87
- * which the Worker can see in the Status section of the web site.
88
- * </p>
89
- * <p>
90
- * You can also call this operation for assignments that were previous rejected
91
- * and approve them by explicitly overriding the previous rejection.
92
- * This only works on rejected assignments that were submitted within the previous 30 days
93
- * and only if the assignment's related HIT has not been deleted.
94
- * </p>
50
+ * @see {@link ApproveAssignmentCommand}
95
51
  */
96
52
  approveAssignment(args: ApproveAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<ApproveAssignmentCommandOutput>;
97
53
  approveAssignment(args: ApproveAssignmentCommandInput, cb: (err: any, data?: ApproveAssignmentCommandOutput) => void): void;
98
54
  approveAssignment(args: ApproveAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApproveAssignmentCommandOutput) => void): void;
99
55
  /**
100
- * @public
101
- * <p>
102
- * The <code>AssociateQualificationWithWorker</code> operation gives a Worker a
103
- * Qualification. <code>AssociateQualificationWithWorker</code> does not require that the Worker
104
- * submit a Qualification request. It gives the Qualification directly to the Worker.
105
- * </p>
106
- *
107
- * <p>
108
- * You can only assign a Qualification of a Qualification type that you created (using
109
- * the <code>CreateQualificationType</code> operation).
110
- * </p>
111
- *
112
- * <note>
113
- * <p>
114
- * Note: <code>AssociateQualificationWithWorker</code> does not affect any pending Qualification
115
- * requests for the Qualification by the Worker. If you assign a Qualification to a
116
- * Worker, then later grant a Qualification request made by the Worker, the granting of
117
- * the request may modify the Qualification score. To resolve a pending Qualification
118
- * request without affecting the Qualification the Worker already has, reject the
119
- * request with the <code>RejectQualificationRequest</code> operation.
120
- * </p>
121
- * </note>
56
+ * @see {@link AssociateQualificationWithWorkerCommand}
122
57
  */
123
58
  associateQualificationWithWorker(args: AssociateQualificationWithWorkerCommandInput, options?: __HttpHandlerOptions): Promise<AssociateQualificationWithWorkerCommandOutput>;
124
59
  associateQualificationWithWorker(args: AssociateQualificationWithWorkerCommandInput, cb: (err: any, data?: AssociateQualificationWithWorkerCommandOutput) => void): void;
125
60
  associateQualificationWithWorker(args: AssociateQualificationWithWorkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateQualificationWithWorkerCommandOutput) => void): void;
126
61
  /**
127
- * @public
128
- * <p>
129
- * The
130
- * <code>CreateAdditionalAssignmentsForHIT</code>
131
- * operation increases the maximum number of assignments of an existing HIT.
132
- * </p>
133
- * <p>
134
- * To extend the maximum number of assignments, specify the number of additional assignments.</p>
135
- * <note>
136
- * <ul>
137
- * <li>
138
- * <p>HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more
139
- * assignments will result in an
140
- * <code>AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease</code>
141
- * exception.</p>
142
- * </li>
143
- * <li>
144
- * <p>HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an
145
- * <code>AWS.MechanicalTurk.HITTooOldForExtension</code>
146
- * exception.
147
- * </p>
148
- * </li>
149
- * </ul>
150
- * </note>
62
+ * @see {@link CreateAdditionalAssignmentsForHITCommand}
151
63
  */
152
64
  createAdditionalAssignmentsForHIT(args: CreateAdditionalAssignmentsForHITCommandInput, options?: __HttpHandlerOptions): Promise<CreateAdditionalAssignmentsForHITCommandOutput>;
153
65
  createAdditionalAssignmentsForHIT(args: CreateAdditionalAssignmentsForHITCommandInput, cb: (err: any, data?: CreateAdditionalAssignmentsForHITCommandOutput) => void): void;
154
66
  createAdditionalAssignmentsForHIT(args: CreateAdditionalAssignmentsForHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAdditionalAssignmentsForHITCommandOutput) => void): void;
155
67
  /**
156
- * @public
157
- * <p>The <code>CreateHIT</code> operation creates a new Human Intelligence Task (HIT).
158
- * The new HIT is made available for Workers to find and accept on the Amazon Mechanical
159
- * Turk website. </p>
160
- * <p>
161
- * This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to <code>CreateHIT</code>, a new HIT is created for you, with a new <code>HITTypeID</code>. The HITTypeID can be used to create additional HITs in the future without needing to specify common parameters such as the title, description and reward amount each time.</p>
162
- * <p> An alternative way to create HITs is to first generate a HITTypeID using the <code>CreateHITType</code> operation and then call the <code>CreateHITWithHITType</code> operation. This is the recommended best practice for Requesters who are creating large numbers of HITs.
163
- * </p>
164
- *
165
- * <p>CreateHIT also supports several ways to provide question data: by providing a value
166
- * for the <code>Question</code> parameter that fully specifies the contents of the HIT, or by providing
167
- * a <code>HitLayoutId</code> and associated <code>HitLayoutParameters</code>.
168
- * </p>
169
- *
170
- * <note>
171
- * <p> If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see
172
- * <a href="https://requester.mturk.com/pricing">Amazon Mechanical Turk Pricing</a>.</p>
173
- * </note>
68
+ * @see {@link CreateHITCommand}
174
69
  */
175
70
  createHIT(args: CreateHITCommandInput, options?: __HttpHandlerOptions): Promise<CreateHITCommandOutput>;
176
71
  createHIT(args: CreateHITCommandInput, cb: (err: any, data?: CreateHITCommandOutput) => void): void;
177
72
  createHIT(args: CreateHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHITCommandOutput) => void): void;
178
73
  /**
179
- * @public
180
- * <p>
181
- * The <code>CreateHITType</code> operation creates a new HIT type. This operation
182
- * allows you to define a standard set of HIT properties to use when creating HITs.
183
- * If you register a HIT type with values that match an existing HIT type, the HIT type
184
- * ID of the existing type will be returned.
185
- * </p>
74
+ * @see {@link CreateHITTypeCommand}
186
75
  */
187
76
  createHITType(args: CreateHITTypeCommandInput, options?: __HttpHandlerOptions): Promise<CreateHITTypeCommandOutput>;
188
77
  createHITType(args: CreateHITTypeCommandInput, cb: (err: any, data?: CreateHITTypeCommandOutput) => void): void;
189
78
  createHITType(args: CreateHITTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHITTypeCommandOutput) => void): void;
190
79
  /**
191
- * @public
192
- * <p>
193
- * The <code>CreateHITWithHITType</code> operation creates a new Human Intelligence Task (HIT)
194
- * using an existing HITTypeID generated by the <code>CreateHITType</code> operation.
195
- * </p>
196
- * <p>
197
- * This is an alternative way to create HITs from the <code>CreateHIT</code> operation.
198
- * This is the recommended best practice for Requesters who are creating large numbers of HITs.
199
- * </p>
200
- * <p>CreateHITWithHITType also supports several ways to provide question data:
201
- * by providing a value for the <code>Question</code> parameter that fully specifies the contents of the HIT,
202
- * or by providing a <code>HitLayoutId</code> and associated <code>HitLayoutParameters</code>.
203
- * </p>
204
- * <note>
205
- * <p>
206
- * If a HIT is created with 10 or more maximum assignments, there is an additional fee.
207
- * For more information, see <a href="https://requester.mturk.com/pricing">Amazon Mechanical Turk Pricing</a>.
208
- * </p>
209
- * </note>
80
+ * @see {@link CreateHITWithHITTypeCommand}
210
81
  */
211
82
  createHITWithHITType(args: CreateHITWithHITTypeCommandInput, options?: __HttpHandlerOptions): Promise<CreateHITWithHITTypeCommandOutput>;
212
83
  createHITWithHITType(args: CreateHITWithHITTypeCommandInput, cb: (err: any, data?: CreateHITWithHITTypeCommandOutput) => void): void;
213
84
  createHITWithHITType(args: CreateHITWithHITTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHITWithHITTypeCommandOutput) => void): void;
214
85
  /**
215
- * @public
216
- * <p>
217
- * The
218
- * <code>CreateQualificationType</code>
219
- * operation creates a new Qualification type, which is represented by a
220
- * <code>QualificationType</code>
221
- * data structure.
222
- * </p>
86
+ * @see {@link CreateQualificationTypeCommand}
223
87
  */
224
88
  createQualificationType(args: CreateQualificationTypeCommandInput, options?: __HttpHandlerOptions): Promise<CreateQualificationTypeCommandOutput>;
225
89
  createQualificationType(args: CreateQualificationTypeCommandInput, cb: (err: any, data?: CreateQualificationTypeCommandOutput) => void): void;
226
90
  createQualificationType(args: CreateQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQualificationTypeCommandOutput) => void): void;
227
91
  /**
228
- * @public
229
- * <p>The <code>CreateWorkerBlock</code> operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.</p>
92
+ * @see {@link CreateWorkerBlockCommand}
230
93
  */
231
94
  createWorkerBlock(args: CreateWorkerBlockCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkerBlockCommandOutput>;
232
95
  createWorkerBlock(args: CreateWorkerBlockCommandInput, cb: (err: any, data?: CreateWorkerBlockCommandOutput) => void): void;
233
96
  createWorkerBlock(args: CreateWorkerBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkerBlockCommandOutput) => void): void;
234
97
  /**
235
- * @public
236
- * <p>
237
- * The <code>DeleteHIT</code> operation is used to delete HIT that is no longer needed.
238
- * Only the Requester who created the HIT can delete it.
239
- * </p>
240
- * <p>
241
- * You can only dispose of HITs that are in the <code>Reviewable</code> state,
242
- * with all of their submitted assignments already either approved or rejected.
243
- * If you call the DeleteHIT operation on a HIT that is not in the <code>Reviewable</code> state
244
- * (for example, that has not expired, or still has active assignments),
245
- * or on a HIT that is Reviewable but without all of its submitted assignments
246
- * already approved or rejected, the service will return an error.
247
- * </p>
248
- * <note>
249
- * <ul>
250
- * <li>
251
- * <p>
252
- * HITs are automatically disposed of after 120 days.
253
- * </p>
254
- * </li>
255
- * <li>
256
- * <p>
257
- * After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.
258
- * </p>
259
- * </li>
260
- * <li>
261
- * <p>
262
- * Disposed HITs are not returned in results for the ListHITs operation.
263
- * </p>
264
- * </li>
265
- * <li>
266
- * <p>
267
- * Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs.
268
- * </p>
269
- * </li>
270
- * </ul>
271
- * </note>
98
+ * @see {@link DeleteHITCommand}
272
99
  */
273
100
  deleteHIT(args: DeleteHITCommandInput, options?: __HttpHandlerOptions): Promise<DeleteHITCommandOutput>;
274
101
  deleteHIT(args: DeleteHITCommandInput, cb: (err: any, data?: DeleteHITCommandOutput) => void): void;
275
102
  deleteHIT(args: DeleteHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHITCommandOutput) => void): void;
276
103
  /**
277
- * @public
278
- * <p>
279
- * The
280
- * <code>DeleteQualificationType</code>
281
- * deletes a Qualification type and deletes any HIT types that are
282
- * associated with the Qualification type.
283
- * </p>
284
- * <p>This operation does not revoke Qualifications already assigned
285
- * to Workers because the Qualifications might be needed for active HITs.
286
- * If there are any pending requests for the Qualification type, Amazon
287
- * Mechanical Turk rejects those requests. After you delete a
288
- * Qualification type, you can no longer use it to create HITs or HIT
289
- * types.</p>
290
- * <note>
291
- * <p>DeleteQualificationType must wait for all the HITs that use
292
- * the deleted Qualification type to be deleted before completing. It
293
- * may take up to 48 hours before DeleteQualificationType completes and
294
- * the unique name of the Qualification type is available for reuse with
295
- * CreateQualificationType.</p>
296
- * </note>
104
+ * @see {@link DeleteQualificationTypeCommand}
297
105
  */
298
106
  deleteQualificationType(args: DeleteQualificationTypeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteQualificationTypeCommandOutput>;
299
107
  deleteQualificationType(args: DeleteQualificationTypeCommandInput, cb: (err: any, data?: DeleteQualificationTypeCommandOutput) => void): void;
300
108
  deleteQualificationType(args: DeleteQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQualificationTypeCommandOutput) => void): void;
301
109
  /**
302
- * @public
303
- * <p>The <code>DeleteWorkerBlock</code> operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully.</p>
110
+ * @see {@link DeleteWorkerBlockCommand}
304
111
  */
305
112
  deleteWorkerBlock(args: DeleteWorkerBlockCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWorkerBlockCommandOutput>;
306
113
  deleteWorkerBlock(args: DeleteWorkerBlockCommandInput, cb: (err: any, data?: DeleteWorkerBlockCommandOutput) => void): void;
307
114
  deleteWorkerBlock(args: DeleteWorkerBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkerBlockCommandOutput) => void): void;
308
115
  /**
309
- * @public
310
- * <p>
311
- * The <code>DisassociateQualificationFromWorker</code>
312
- * revokes a previously granted Qualification from a user.
313
- * </p>
314
- * <p>
315
- * You can provide a text message explaining why the Qualification was
316
- * revoked. The user who had the Qualification can see this message.
317
- * </p>
116
+ * @see {@link DisassociateQualificationFromWorkerCommand}
318
117
  */
319
118
  disassociateQualificationFromWorker(args: DisassociateQualificationFromWorkerCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateQualificationFromWorkerCommandOutput>;
320
119
  disassociateQualificationFromWorker(args: DisassociateQualificationFromWorkerCommandInput, cb: (err: any, data?: DisassociateQualificationFromWorkerCommandOutput) => void): void;
321
120
  disassociateQualificationFromWorker(args: DisassociateQualificationFromWorkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateQualificationFromWorkerCommandOutput) => void): void;
322
121
  /**
323
- * @public
324
- * <p>The <code>GetAccountBalance</code> operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester.
325
- * Alternatively, this operation will retrieve the remaining available AWS Billing usage if you have enabled AWS Billing.
326
- * Note: If you have enabled AWS Billing and still have a remaining Prepaid HITs balance, this balance can be viewed on the My Account page in the Requester console.</p>
122
+ * @see {@link GetAccountBalanceCommand}
327
123
  */
328
124
  getAccountBalance(args: GetAccountBalanceCommandInput, options?: __HttpHandlerOptions): Promise<GetAccountBalanceCommandOutput>;
329
125
  getAccountBalance(args: GetAccountBalanceCommandInput, cb: (err: any, data?: GetAccountBalanceCommandOutput) => void): void;
330
126
  getAccountBalance(args: GetAccountBalanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountBalanceCommandOutput) => void): void;
331
127
  /**
332
- * @public
333
- * <p>
334
- * The <code>GetAssignment</code> operation retrieves the details of the specified Assignment.
335
- * </p>
128
+ * @see {@link GetAssignmentCommand}
336
129
  */
337
130
  getAssignment(args: GetAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<GetAssignmentCommandOutput>;
338
131
  getAssignment(args: GetAssignmentCommandInput, cb: (err: any, data?: GetAssignmentCommandOutput) => void): void;
339
132
  getAssignment(args: GetAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssignmentCommandOutput) => void): void;
340
133
  /**
341
- * @public
342
- * <p>
343
- * The
344
- * <code>GetFileUploadURL</code>
345
- * operation generates and returns a temporary URL. You use the
346
- * temporary URL to retrieve a file uploaded by a Worker as an answer to
347
- * a FileUploadAnswer question for a HIT. The temporary URL is generated
348
- * the instant the GetFileUploadURL operation is called, and is valid
349
- * for 60 seconds. You can get a temporary file upload URL any time
350
- * until the HIT is disposed. After the HIT is disposed, any uploaded
351
- * files are deleted, and cannot be retrieved.
352
- *
353
- * Pending Deprecation on December 12, 2017. The Answer Specification
354
- * structure will no longer support the <code>FileUploadAnswer</code>
355
- * element to be used for the QuestionForm data structure.
356
- * Instead, we recommend that Requesters who want to create HITs asking
357
- * Workers to upload files to use Amazon S3.
358
- *
359
- * </p>
134
+ * @see {@link GetFileUploadURLCommand}
360
135
  */
361
136
  getFileUploadURL(args: GetFileUploadURLCommandInput, options?: __HttpHandlerOptions): Promise<GetFileUploadURLCommandOutput>;
362
137
  getFileUploadURL(args: GetFileUploadURLCommandInput, cb: (err: any, data?: GetFileUploadURLCommandOutput) => void): void;
363
138
  getFileUploadURL(args: GetFileUploadURLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFileUploadURLCommandOutput) => void): void;
364
139
  /**
365
- * @public
366
- * <p>
367
- * The <code>GetHIT</code> operation retrieves the details of the specified HIT.
368
- * </p>
140
+ * @see {@link GetHITCommand}
369
141
  */
370
142
  getHIT(args: GetHITCommandInput, options?: __HttpHandlerOptions): Promise<GetHITCommandOutput>;
371
143
  getHIT(args: GetHITCommandInput, cb: (err: any, data?: GetHITCommandOutput) => void): void;
372
144
  getHIT(args: GetHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHITCommandOutput) => void): void;
373
145
  /**
374
- * @public
375
- * <p>
376
- * The
377
- * <code>GetQualificationScore</code>
378
- * operation returns the value of a Worker's Qualification for a given
379
- * Qualification type.
380
- * </p>
381
- * <p>
382
- * To get a Worker's Qualification, you must know the Worker's ID. The
383
- * Worker's ID is included in the assignment data returned by the
384
- * <code>ListAssignmentsForHIT</code>
385
- * operation.
386
- * </p>
387
- * <p>Only the owner of a Qualification type can query the value of
388
- * a Worker's Qualification of that type.</p>
146
+ * @see {@link GetQualificationScoreCommand}
389
147
  */
390
148
  getQualificationScore(args: GetQualificationScoreCommandInput, options?: __HttpHandlerOptions): Promise<GetQualificationScoreCommandOutput>;
391
149
  getQualificationScore(args: GetQualificationScoreCommandInput, cb: (err: any, data?: GetQualificationScoreCommandOutput) => void): void;
392
150
  getQualificationScore(args: GetQualificationScoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQualificationScoreCommandOutput) => void): void;
393
151
  /**
394
- * @public
395
- * <p>
396
- * The <code>GetQualificationType</code>operation retrieves information about a Qualification type using its ID.
397
- * </p>
152
+ * @see {@link GetQualificationTypeCommand}
398
153
  */
399
154
  getQualificationType(args: GetQualificationTypeCommandInput, options?: __HttpHandlerOptions): Promise<GetQualificationTypeCommandOutput>;
400
155
  getQualificationType(args: GetQualificationTypeCommandInput, cb: (err: any, data?: GetQualificationTypeCommandOutput) => void): void;
401
156
  getQualificationType(args: GetQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQualificationTypeCommandOutput) => void): void;
402
157
  /**
403
- * @public
404
- * <p>
405
- * The
406
- * <code>ListAssignmentsForHIT</code>
407
- * operation retrieves completed assignments for a HIT. You can use this
408
- * operation to retrieve the results for a HIT.
409
- * </p>
410
- * <p> You can get assignments for a HIT at any time, even if the
411
- * HIT is not yet Reviewable. If a HIT requested multiple assignments,
412
- * and has received some results but has not yet become Reviewable, you
413
- * can still retrieve the partial results with this operation.
414
- * </p>
415
- * <p> Use the AssignmentStatus parameter to control which set of
416
- * assignments for a HIT are returned. The ListAssignmentsForHIT
417
- * operation
418
- * can return submitted assignments awaiting approval, or it can return
419
- * assignments that have already been approved or rejected. You can set
420
- * AssignmentStatus=Approved,Rejected to get assignments that have
421
- * already been approved and rejected together in one result set.
422
- * </p>
423
- * <p> Only the Requester who created the HIT can retrieve the
424
- * assignments for that HIT.
425
- * </p>
426
- * <p> Results are sorted and divided into numbered pages and the
427
- * operation returns a single page of results. You can use the
428
- * parameters
429
- * of the operation to control sorting and pagination.
430
- * </p>
158
+ * @see {@link ListAssignmentsForHITCommand}
431
159
  */
432
160
  listAssignmentsForHIT(args: ListAssignmentsForHITCommandInput, options?: __HttpHandlerOptions): Promise<ListAssignmentsForHITCommandOutput>;
433
161
  listAssignmentsForHIT(args: ListAssignmentsForHITCommandInput, cb: (err: any, data?: ListAssignmentsForHITCommandOutput) => void): void;
434
162
  listAssignmentsForHIT(args: ListAssignmentsForHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssignmentsForHITCommandOutput) => void): void;
435
163
  /**
436
- * @public
437
- * <p>
438
- * The
439
- * <code>ListBonusPayments</code>
440
- * operation retrieves the amounts of bonuses you have paid to Workers
441
- * for a given HIT or assignment.
442
- * </p>
164
+ * @see {@link ListBonusPaymentsCommand}
443
165
  */
444
166
  listBonusPayments(args: ListBonusPaymentsCommandInput, options?: __HttpHandlerOptions): Promise<ListBonusPaymentsCommandOutput>;
445
167
  listBonusPayments(args: ListBonusPaymentsCommandInput, cb: (err: any, data?: ListBonusPaymentsCommandOutput) => void): void;
446
168
  listBonusPayments(args: ListBonusPaymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBonusPaymentsCommandOutput) => void): void;
447
169
  /**
448
- * @public
449
- * <p>
450
- * The
451
- * <code>ListHITs</code>
452
- * operation returns all of a Requester's HITs. The operation returns
453
- * HITs of any status, except for HITs that have been deleted of with
454
- * the DeleteHIT operation or that have been auto-deleted.
455
- * </p>
170
+ * @see {@link ListHITsCommand}
456
171
  */
457
172
  listHITs(args: ListHITsCommandInput, options?: __HttpHandlerOptions): Promise<ListHITsCommandOutput>;
458
173
  listHITs(args: ListHITsCommandInput, cb: (err: any, data?: ListHITsCommandOutput) => void): void;
459
174
  listHITs(args: ListHITsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHITsCommandOutput) => void): void;
460
175
  /**
461
- * @public
462
- * <p>
463
- * The <code>ListHITsForQualificationType</code> operation returns the HITs that use
464
- * the given Qualification type for a Qualification requirement.
465
- * The operation returns HITs of any status, except for HITs that have been deleted
466
- * with the <code>DeleteHIT</code> operation or that have been auto-deleted.
467
- * </p>
176
+ * @see {@link ListHITsForQualificationTypeCommand}
468
177
  */
469
178
  listHITsForQualificationType(args: ListHITsForQualificationTypeCommandInput, options?: __HttpHandlerOptions): Promise<ListHITsForQualificationTypeCommandOutput>;
470
179
  listHITsForQualificationType(args: ListHITsForQualificationTypeCommandInput, cb: (err: any, data?: ListHITsForQualificationTypeCommandOutput) => void): void;
471
180
  listHITsForQualificationType(args: ListHITsForQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHITsForQualificationTypeCommandOutput) => void): void;
472
181
  /**
473
- * @public
474
- * <p>
475
- * The
476
- * <code>ListQualificationRequests</code>
477
- * operation retrieves requests for Qualifications of a particular
478
- * Qualification type. The owner of the Qualification type calls this
479
- * operation to poll for pending requests, and accepts them using the
480
- * AcceptQualification operation.
481
- * </p>
182
+ * @see {@link ListQualificationRequestsCommand}
482
183
  */
483
184
  listQualificationRequests(args: ListQualificationRequestsCommandInput, options?: __HttpHandlerOptions): Promise<ListQualificationRequestsCommandOutput>;
484
185
  listQualificationRequests(args: ListQualificationRequestsCommandInput, cb: (err: any, data?: ListQualificationRequestsCommandOutput) => void): void;
485
186
  listQualificationRequests(args: ListQualificationRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQualificationRequestsCommandOutput) => void): void;
486
187
  /**
487
- * @public
488
- * <p>
489
- * The
490
- * <code>ListQualificationTypes</code>
491
- * operation returns a list of Qualification types, filtered by
492
- * an optional search term.
493
- * </p>
188
+ * @see {@link ListQualificationTypesCommand}
494
189
  */
495
190
  listQualificationTypes(args: ListQualificationTypesCommandInput, options?: __HttpHandlerOptions): Promise<ListQualificationTypesCommandOutput>;
496
191
  listQualificationTypes(args: ListQualificationTypesCommandInput, cb: (err: any, data?: ListQualificationTypesCommandOutput) => void): void;
497
192
  listQualificationTypes(args: ListQualificationTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQualificationTypesCommandOutput) => void): void;
498
193
  /**
499
- * @public
500
- * <p>
501
- * The <code>ListReviewableHITs</code> operation retrieves the HITs with Status equal to
502
- * Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.
503
- * </p>
194
+ * @see {@link ListReviewableHITsCommand}
504
195
  */
505
196
  listReviewableHITs(args: ListReviewableHITsCommandInput, options?: __HttpHandlerOptions): Promise<ListReviewableHITsCommandOutput>;
506
197
  listReviewableHITs(args: ListReviewableHITsCommandInput, cb: (err: any, data?: ListReviewableHITsCommandOutput) => void): void;
507
198
  listReviewableHITs(args: ListReviewableHITsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReviewableHITsCommandOutput) => void): void;
508
199
  /**
509
- * @public
510
- * <p>
511
- * The <code>ListReviewPolicyResultsForHIT</code> operation retrieves the computed results
512
- * and the actions taken in the course of executing your Review Policies for a given HIT.
513
- * For information about how to specify Review Policies when you call CreateHIT,
514
- * see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both
515
- * Assignment-level and HIT-level review results.
516
- * </p>
200
+ * @see {@link ListReviewPolicyResultsForHITCommand}
517
201
  */
518
202
  listReviewPolicyResultsForHIT(args: ListReviewPolicyResultsForHITCommandInput, options?: __HttpHandlerOptions): Promise<ListReviewPolicyResultsForHITCommandOutput>;
519
203
  listReviewPolicyResultsForHIT(args: ListReviewPolicyResultsForHITCommandInput, cb: (err: any, data?: ListReviewPolicyResultsForHITCommandOutput) => void): void;
520
204
  listReviewPolicyResultsForHIT(args: ListReviewPolicyResultsForHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReviewPolicyResultsForHITCommandOutput) => void): void;
521
205
  /**
522
- * @public
523
- * <p>The <code>ListWorkersBlocks</code> operation retrieves a list of Workers who are blocked from working on your HITs.</p>
206
+ * @see {@link ListWorkerBlocksCommand}
524
207
  */
525
208
  listWorkerBlocks(args: ListWorkerBlocksCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkerBlocksCommandOutput>;
526
209
  listWorkerBlocks(args: ListWorkerBlocksCommandInput, cb: (err: any, data?: ListWorkerBlocksCommandOutput) => void): void;
527
210
  listWorkerBlocks(args: ListWorkerBlocksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkerBlocksCommandOutput) => void): void;
528
211
  /**
529
- * @public
530
- * <p>
531
- * The <code>ListWorkersWithQualificationType</code> operation returns all of the Workers
532
- * that have been associated with a given Qualification type.
533
- * </p>
212
+ * @see {@link ListWorkersWithQualificationTypeCommand}
534
213
  */
535
214
  listWorkersWithQualificationType(args: ListWorkersWithQualificationTypeCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkersWithQualificationTypeCommandOutput>;
536
215
  listWorkersWithQualificationType(args: ListWorkersWithQualificationTypeCommandInput, cb: (err: any, data?: ListWorkersWithQualificationTypeCommandOutput) => void): void;
537
216
  listWorkersWithQualificationType(args: ListWorkersWithQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkersWithQualificationTypeCommandOutput) => void): void;
538
217
  /**
539
- * @public
540
- * <p>
541
- * The
542
- * <code>NotifyWorkers</code>
543
- * operation sends an email to one or more Workers that you specify with
544
- * the Worker ID. You can specify up to 100 Worker IDs to send the same
545
- * message with a single call to the NotifyWorkers operation. The
546
- * NotifyWorkers operation will send a notification email to a Worker
547
- * only if you have previously approved or rejected work from the
548
- * Worker.
549
- * </p>
218
+ * @see {@link NotifyWorkersCommand}
550
219
  */
551
220
  notifyWorkers(args: NotifyWorkersCommandInput, options?: __HttpHandlerOptions): Promise<NotifyWorkersCommandOutput>;
552
221
  notifyWorkers(args: NotifyWorkersCommandInput, cb: (err: any, data?: NotifyWorkersCommandOutput) => void): void;
553
222
  notifyWorkers(args: NotifyWorkersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyWorkersCommandOutput) => void): void;
554
223
  /**
555
- * @public
556
- * <p>
557
- * The <code>RejectAssignment</code> operation rejects the results of a completed assignment.
558
- * </p>
559
- * <p>
560
- * You can include an optional feedback message with the rejection,
561
- * which the Worker can see in the Status section of the web site.
562
- * When you include a feedback message with the rejection,
563
- * it helps the Worker understand why the assignment was rejected,
564
- * and can improve the quality of the results the Worker submits in the future.
565
- * </p>
566
- * <p>
567
- * Only the Requester who created the HIT can reject an assignment for the HIT.
568
- * </p>
224
+ * @see {@link RejectAssignmentCommand}
569
225
  */
570
226
  rejectAssignment(args: RejectAssignmentCommandInput, options?: __HttpHandlerOptions): Promise<RejectAssignmentCommandOutput>;
571
227
  rejectAssignment(args: RejectAssignmentCommandInput, cb: (err: any, data?: RejectAssignmentCommandOutput) => void): void;
572
228
  rejectAssignment(args: RejectAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectAssignmentCommandOutput) => void): void;
573
229
  /**
574
- * @public
575
- * <p>
576
- * The
577
- * <code>RejectQualificationRequest</code>
578
- * operation rejects a user's request for a Qualification.
579
- * </p>
580
- * <p> You can provide a text message explaining why the request was
581
- * rejected. The Worker who made the request can see this message.</p>
230
+ * @see {@link RejectQualificationRequestCommand}
582
231
  */
583
232
  rejectQualificationRequest(args: RejectQualificationRequestCommandInput, options?: __HttpHandlerOptions): Promise<RejectQualificationRequestCommandOutput>;
584
233
  rejectQualificationRequest(args: RejectQualificationRequestCommandInput, cb: (err: any, data?: RejectQualificationRequestCommandOutput) => void): void;
585
234
  rejectQualificationRequest(args: RejectQualificationRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectQualificationRequestCommandOutput) => void): void;
586
235
  /**
587
- * @public
588
- * <p>
589
- * The
590
- * <code>SendBonus</code>
591
- * operation issues a payment of money from your account to a Worker.
592
- * This payment happens separately from the reward you pay to the Worker
593
- * when you approve the Worker's assignment. The SendBonus operation
594
- * requires the Worker's ID and the assignment ID as parameters to
595
- * initiate payment of the bonus. You must include a message that
596
- * explains the reason for the bonus payment, as the Worker may not be
597
- * expecting the payment. Amazon Mechanical Turk collects a fee for
598
- * bonus payments, similar to the HIT listing fee. This operation fails
599
- * if your account does not have enough funds to pay for both the bonus
600
- * and the fees.
601
- * </p>
236
+ * @see {@link SendBonusCommand}
602
237
  */
603
238
  sendBonus(args: SendBonusCommandInput, options?: __HttpHandlerOptions): Promise<SendBonusCommandOutput>;
604
239
  sendBonus(args: SendBonusCommandInput, cb: (err: any, data?: SendBonusCommandOutput) => void): void;
605
240
  sendBonus(args: SendBonusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendBonusCommandOutput) => void): void;
606
241
  /**
607
- * @public
608
- * <p>
609
- * The <code>SendTestEventNotification</code> operation causes Amazon Mechanical Turk to send
610
- * a notification message as if a HIT event occurred, according to the provided
611
- * notification specification. This allows you to test notifications without
612
- * setting up notifications for a real HIT type and trying to trigger them using the website.
613
- * When you call this operation, the service attempts to send the test notification immediately.
614
- * </p>
242
+ * @see {@link SendTestEventNotificationCommand}
615
243
  */
616
244
  sendTestEventNotification(args: SendTestEventNotificationCommandInput, options?: __HttpHandlerOptions): Promise<SendTestEventNotificationCommandOutput>;
617
245
  sendTestEventNotification(args: SendTestEventNotificationCommandInput, cb: (err: any, data?: SendTestEventNotificationCommandOutput) => void): void;
618
246
  sendTestEventNotification(args: SendTestEventNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTestEventNotificationCommandOutput) => void): void;
619
247
  /**
620
- * @public
621
- * <p>
622
- * The <code>UpdateExpirationForHIT</code> operation allows you update the expiration time of a HIT.
623
- * If you update it to a time in the past, the HIT will be immediately expired.
624
- * </p>
248
+ * @see {@link UpdateExpirationForHITCommand}
625
249
  */
626
250
  updateExpirationForHIT(args: UpdateExpirationForHITCommandInput, options?: __HttpHandlerOptions): Promise<UpdateExpirationForHITCommandOutput>;
627
251
  updateExpirationForHIT(args: UpdateExpirationForHITCommandInput, cb: (err: any, data?: UpdateExpirationForHITCommandOutput) => void): void;
628
252
  updateExpirationForHIT(args: UpdateExpirationForHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExpirationForHITCommandOutput) => void): void;
629
253
  /**
630
- * @public
631
- * <p>
632
- * The <code>UpdateHITReviewStatus</code> operation updates the status of a HIT.
633
- * If the status is Reviewable, this operation can update the status to Reviewing,
634
- * or it can revert a Reviewing HIT back to the Reviewable status.
635
- * </p>
254
+ * @see {@link UpdateHITReviewStatusCommand}
636
255
  */
637
256
  updateHITReviewStatus(args: UpdateHITReviewStatusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateHITReviewStatusCommandOutput>;
638
257
  updateHITReviewStatus(args: UpdateHITReviewStatusCommandInput, cb: (err: any, data?: UpdateHITReviewStatusCommandOutput) => void): void;
639
258
  updateHITReviewStatus(args: UpdateHITReviewStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHITReviewStatusCommandOutput) => void): void;
640
259
  /**
641
- * @public
642
- * <p>
643
- * The
644
- * <code>UpdateHITTypeOfHIT</code>
645
- * operation allows you to change the HITType properties of a HIT. This
646
- * operation disassociates the HIT from its old HITType properties and
647
- * associates it with the new HITType properties. The HIT takes on the
648
- * properties of the new HITType in place of the old ones.
649
- * </p>
260
+ * @see {@link UpdateHITTypeOfHITCommand}
650
261
  */
651
262
  updateHITTypeOfHIT(args: UpdateHITTypeOfHITCommandInput, options?: __HttpHandlerOptions): Promise<UpdateHITTypeOfHITCommandOutput>;
652
263
  updateHITTypeOfHIT(args: UpdateHITTypeOfHITCommandInput, cb: (err: any, data?: UpdateHITTypeOfHITCommandOutput) => void): void;
653
264
  updateHITTypeOfHIT(args: UpdateHITTypeOfHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHITTypeOfHITCommandOutput) => void): void;
654
265
  /**
655
- * @public
656
- * <p>
657
- * The <code>UpdateNotificationSettings</code> operation creates, updates,
658
- * disables or re-enables notifications for a HIT type.
659
- * If you call the UpdateNotificationSettings operation for a HIT type that already has a
660
- * notification specification, the operation replaces the old specification with a new one.
661
- * You can call the UpdateNotificationSettings operation to enable or disable notifications
662
- * for the HIT type, without having to modify the notification specification itself by providing
663
- * updates to the Active status without specifying a new notification specification.
664
- * To change the Active status of a HIT type's notifications,
665
- * the HIT type must already have a notification specification,
666
- * or one must be provided in the same call to <code>UpdateNotificationSettings</code>.
667
- * </p>
266
+ * @see {@link UpdateNotificationSettingsCommand}
668
267
  */
669
268
  updateNotificationSettings(args: UpdateNotificationSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateNotificationSettingsCommandOutput>;
670
269
  updateNotificationSettings(args: UpdateNotificationSettingsCommandInput, cb: (err: any, data?: UpdateNotificationSettingsCommandOutput) => void): void;
671
270
  updateNotificationSettings(args: UpdateNotificationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotificationSettingsCommandOutput) => void): void;
672
271
  /**
673
- * @public
674
- * <p>
675
- * The
676
- * <code>UpdateQualificationType</code>
677
- * operation modifies the attributes of an existing Qualification type,
678
- * which is represented by a QualificationType data structure. Only the
679
- * owner of a Qualification type can modify its attributes.
680
- * </p>
681
- * <p> Most attributes of a Qualification type can be changed after
682
- * the type has been created. However, the Name and Keywords fields
683
- * cannot be modified. The RetryDelayInSeconds parameter can be modified
684
- * or added to change the delay or to enable retries, but
685
- * RetryDelayInSeconds cannot be used to disable retries. </p>
686
- * <p> You can use this operation to update the test for a
687
- * Qualification type. The test is updated based on the values specified
688
- * for the Test, TestDurationInSeconds and AnswerKey parameters. All
689
- * three parameters specify the updated test. If you are updating the
690
- * test for a type, you must specify the Test and TestDurationInSeconds
691
- * parameters. The AnswerKey parameter is optional; omitting it specifies
692
- * that the updated test does not have an answer key. </p>
693
- * <p> If you omit the Test parameter, the test for the
694
- * Qualification type is unchanged. There is no way to remove a test from
695
- * a Qualification type that has one. If the type already has a test, you
696
- * cannot update it to be AutoGranted. If the Qualification type does not
697
- * have a test and one is provided by an update, the type will henceforth
698
- * have a test. </p>
699
- * <p> If you want to update the test duration or answer key for an
700
- * existing test without changing the questions, you must specify a Test
701
- * parameter with the original questions, along with the updated values. </p>
702
- * <p> If you provide an updated Test but no AnswerKey, the new test
703
- * will not have an answer key. Requests for such Qualifications must be
704
- * granted manually. </p>
705
- * <p> You can also update the AutoGranted and AutoGrantedValue
706
- * attributes of the Qualification type.</p>
272
+ * @see {@link UpdateQualificationTypeCommand}
707
273
  */
708
274
  updateQualificationType(args: UpdateQualificationTypeCommandInput, options?: __HttpHandlerOptions): Promise<UpdateQualificationTypeCommandOutput>;
709
275
  updateQualificationType(args: UpdateQualificationTypeCommandInput, cb: (err: any, data?: UpdateQualificationTypeCommandOutput) => void): void;
710
276
  updateQualificationType(args: UpdateQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQualificationTypeCommandOutput) => void): void;
711
277
  }
278
+ /**
279
+ * @public
280
+ * <fullname>Amazon Mechanical Turk API Reference</fullname>
281
+ */
282
+ export declare class MTurk extends MTurkClient implements MTurk {
283
+ }