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