Amazonka.MechanicalTurk.Lens

Operations

AcceptQualificationRequest

acceptQualificationRequest_integerValue :: Lens' AcceptQualificationRequest (Maybe Int)

The value of the Qualification. You can omit this value if you are using the presence or absence of the Qualification as the basis for a HIT requirement.

acceptQualificationRequest_qualificationRequestId :: Lens' AcceptQualificationRequest Text

The ID of the Qualification request, as returned by the GetQualificationRequests operation.

acceptQualificationRequestResponse_httpStatus :: Lens' AcceptQualificationRequestResponse Int

The response's http status code.

ApproveAssignment

approveAssignment_overrideRejection :: Lens' ApproveAssignment (Maybe Bool)

A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to False.

approveAssignment_requesterFeedback :: Lens' ApproveAssignment (Maybe Text)

A message for the Worker, which the Worker can see in the Status section of the web site.

approveAssignment_assignmentId :: Lens' ApproveAssignment Text

The ID of the assignment. The assignment must correspond to a HIT created by the Requester.

approveAssignmentResponse_httpStatus :: Lens' ApproveAssignmentResponse Int

The response's http status code.

AssociateQualificationWithWorker

associateQualificationWithWorker_integerValue :: Lens' AssociateQualificationWithWorker (Maybe Int)

The value of the Qualification to assign.

associateQualificationWithWorker_sendNotification :: Lens' AssociateQualificationWithWorker (Maybe Bool)

Specifies whether to send a notification email message to the Worker saying that the qualification was assigned to the Worker. Note: this is true by default.

associateQualificationWithWorker_qualificationTypeId :: Lens' AssociateQualificationWithWorker Text

The ID of the Qualification type to use for the assigned Qualification.

associateQualificationWithWorker_workerId :: Lens' AssociateQualificationWithWorker Text

The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT assignments and Qualification requests.

associateQualificationWithWorkerResponse_httpStatus :: Lens' AssociateQualificationWithWorkerResponse Int

The response's http status code.

CreateAdditionalAssignmentsForHIT

createAdditionalAssignmentsForHIT_uniqueRequestToken :: Lens' CreateAdditionalAssignmentsForHIT (Maybe Text)

A unique identifier for this request, which allows you to retry the call on error without extending the HIT multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the extend HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.

createAdditionalAssignmentsForHIT_hITId :: Lens' CreateAdditionalAssignmentsForHIT Text

The ID of the HIT to extend.

createAdditionalAssignmentsForHIT_numberOfAdditionalAssignments :: Lens' CreateAdditionalAssignmentsForHIT Int

The number of additional assignments to request for this HIT.

createAdditionalAssignmentsForHITResponse_httpStatus :: Lens' CreateAdditionalAssignmentsForHITResponse Int

The response's http status code.

CreateHIT

createHIT_assignmentReviewPolicy :: Lens' CreateHIT (Maybe ReviewPolicy)

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

createHIT_autoApprovalDelayInSeconds :: Lens' CreateHIT (Maybe Integer)

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

createHIT_hITLayoutId :: Lens' CreateHIT (Maybe Text)

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

createHIT_hITLayoutParameters :: Lens' CreateHIT (Maybe [HITLayoutParameter])

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

createHIT_hITReviewPolicy :: Lens' CreateHIT (Maybe ReviewPolicy)

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

createHIT_keywords :: Lens' CreateHIT (Maybe Text)

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

createHIT_maxAssignments :: Lens' CreateHIT (Maybe Int)

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

createHIT_qualificationRequirements :: Lens' CreateHIT (Maybe [QualificationRequirement])

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

createHIT_question :: Lens' CreateHIT (Maybe Text)

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

createHIT_requesterAnnotation :: Lens' CreateHIT (Maybe Text)

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

createHIT_uniqueRequestToken :: Lens' CreateHIT (Maybe Text)

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

createHIT_lifetimeInSeconds :: Lens' CreateHIT Integer

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

createHIT_assignmentDurationInSeconds :: Lens' CreateHIT Integer

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

createHIT_reward :: Lens' CreateHIT Text

The amount of money the Requester will pay a Worker for successfully completing the HIT.

createHIT_title :: Lens' CreateHIT Text

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

createHIT_description :: Lens' CreateHIT Text

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

createHITResponse_hit :: Lens' CreateHITResponse (Maybe HIT)

Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation.

createHITResponse_httpStatus :: Lens' CreateHITResponse Int

The response's http status code.

CreateHITType

createHITType_autoApprovalDelayInSeconds :: Lens' CreateHITType (Maybe Integer)

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

createHITType_keywords :: Lens' CreateHITType (Maybe Text)

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

createHITType_qualificationRequirements :: Lens' CreateHITType (Maybe [QualificationRequirement])

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

createHITType_assignmentDurationInSeconds :: Lens' CreateHITType Integer

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

createHITType_reward :: Lens' CreateHITType Text

The amount of money the Requester will pay a Worker for successfully completing the HIT.

createHITType_title :: Lens' CreateHITType Text

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

createHITType_description :: Lens' CreateHITType Text

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

createHITTypeResponse_hITTypeId :: Lens' CreateHITTypeResponse (Maybe Text)

The ID of the newly registered HIT type.

createHITTypeResponse_httpStatus :: Lens' CreateHITTypeResponse Int

The response's http status code.

CreateHITWithHITType

createHITWithHITType_assignmentReviewPolicy :: Lens' CreateHITWithHITType (Maybe ReviewPolicy)

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

createHITWithHITType_hITLayoutId :: Lens' CreateHITWithHITType (Maybe Text)

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

createHITWithHITType_hITLayoutParameters :: Lens' CreateHITWithHITType (Maybe [HITLayoutParameter])

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

createHITWithHITType_hITReviewPolicy :: Lens' CreateHITWithHITType (Maybe ReviewPolicy)

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

createHITWithHITType_maxAssignments :: Lens' CreateHITWithHITType (Maybe Int)

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

createHITWithHITType_question :: Lens' CreateHITWithHITType (Maybe Text)

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

createHITWithHITType_requesterAnnotation :: Lens' CreateHITWithHITType (Maybe Text)

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

createHITWithHITType_uniqueRequestToken :: Lens' CreateHITWithHITType (Maybe Text)

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

createHITWithHITType_hITTypeId :: Lens' CreateHITWithHITType Text

The HIT type ID you want to create this HIT with.

createHITWithHITType_lifetimeInSeconds :: Lens' CreateHITWithHITType Integer

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

createHITWithHITTypeResponse_hit :: Lens' CreateHITWithHITTypeResponse (Maybe HIT)

Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation.

createHITWithHITTypeResponse_httpStatus :: Lens' CreateHITWithHITTypeResponse Int

The response's http status code.

CreateQualificationType

createQualificationType_answerKey :: Lens' CreateQualificationType (Maybe Text)

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

Constraints: Must not be longer than 65535 bytes.

Constraints: None. If not specified, you must process Qualification requests manually.

createQualificationType_autoGranted :: Lens' CreateQualificationType (Maybe Bool)

Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Constraints: If the Test parameter is specified, this parameter cannot be true.

createQualificationType_autoGrantedValue :: Lens' CreateQualificationType (Maybe Int)

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

createQualificationType_keywords :: Lens' CreateQualificationType (Maybe Text)

One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search.

createQualificationType_retryDelayInSeconds :: Lens' CreateQualificationType (Maybe Integer)

The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request.

Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled.

createQualificationType_test :: Lens' CreateQualificationType (Maybe Text)

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

createQualificationType_testDurationInSeconds :: Lens' CreateQualificationType (Maybe Integer)

The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

createQualificationType_name :: Lens' CreateQualificationType Text

The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types.

createQualificationType_description :: Lens' CreateQualificationType Text

A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type.

createQualificationType_qualificationTypeStatus :: Lens' CreateQualificationType QualificationTypeStatus

The initial status of the Qualification type.

Constraints: Valid values are: Active | Inactive

createQualificationTypeResponse_qualificationType :: Lens' CreateQualificationTypeResponse (Maybe QualificationType)

The created Qualification type, returned as a QualificationType data structure.

createQualificationTypeResponse_httpStatus :: Lens' CreateQualificationTypeResponse Int

The response's http status code.

CreateWorkerBlock

createWorkerBlock_workerId :: Lens' CreateWorkerBlock Text

The ID of the Worker to block.

createWorkerBlock_reason :: Lens' CreateWorkerBlock Text

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.

createWorkerBlockResponse_httpStatus :: Lens' CreateWorkerBlockResponse Int

The response's http status code.

DeleteHIT

deleteHIT_hITId :: Lens' DeleteHIT Text

The ID of the HIT to be deleted.

deleteHITResponse_httpStatus :: Lens' DeleteHITResponse Int

The response's http status code.

DeleteQualificationType

deleteQualificationType_qualificationTypeId :: Lens' DeleteQualificationType Text

The ID of the QualificationType to dispose.

deleteQualificationTypeResponse_httpStatus :: Lens' DeleteQualificationTypeResponse Int

The response's http status code.

DeleteWorkerBlock

deleteWorkerBlock_reason :: Lens' DeleteWorkerBlock (Maybe Text)

A message that explains the reason for unblocking the Worker. The Worker does not see this message.

deleteWorkerBlock_workerId :: Lens' DeleteWorkerBlock Text

The ID of the Worker to unblock.

deleteWorkerBlockResponse_httpStatus :: Lens' DeleteWorkerBlockResponse Int

The response's http status code.

DisassociateQualificationFromWorker

disassociateQualificationFromWorker_reason :: Lens' DisassociateQualificationFromWorker (Maybe Text)

A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message.

disassociateQualificationFromWorker_workerId :: Lens' DisassociateQualificationFromWorker Text

The ID of the Worker who possesses the Qualification to be revoked.

disassociateQualificationFromWorker_qualificationTypeId :: Lens' DisassociateQualificationFromWorker Text

The ID of the Qualification type of the Qualification to be revoked.

disassociateQualificationFromWorkerResponse_httpStatus :: Lens' DisassociateQualificationFromWorkerResponse Int

The response's http status code.

GetAccountBalance

getAccountBalanceResponse_availableBalance :: Lens' GetAccountBalanceResponse (Maybe Text)

Undocumented member.

getAccountBalanceResponse_onHoldBalance :: Lens' GetAccountBalanceResponse (Maybe Text)

Undocumented member.

getAccountBalanceResponse_httpStatus :: Lens' GetAccountBalanceResponse Int

The response's http status code.

GetAssignment

getAssignment_assignmentId :: Lens' GetAssignment Text

The ID of the Assignment to be retrieved.

getAssignmentResponse_assignment :: Lens' GetAssignmentResponse (Maybe Assignment)

The assignment. The response includes one Assignment element.

getAssignmentResponse_hit :: Lens' GetAssignmentResponse (Maybe HIT)

The HIT associated with this assignment. The response includes one HIT element.

getAssignmentResponse_httpStatus :: Lens' GetAssignmentResponse Int

The response's http status code.

GetFileUploadURL

getFileUploadURL_assignmentId :: Lens' GetFileUploadURL Text

The ID of the assignment that contains the question with a FileUploadAnswer.

getFileUploadURL_questionIdentifier :: Lens' GetFileUploadURL Text

The identifier of the question with a FileUploadAnswer, as specified in the QuestionForm of the HIT.

getFileUploadURLResponse_fileUploadURL :: Lens' GetFileUploadURLResponse (Maybe Text)

A temporary URL for the file that the Worker uploaded for the answer.

getFileUploadURLResponse_httpStatus :: Lens' GetFileUploadURLResponse Int

The response's http status code.

GetHIT

getHIT_hITId :: Lens' GetHIT Text

The ID of the HIT to be retrieved.

getHITResponse_hit :: Lens' GetHITResponse (Maybe HIT)

Contains the requested HIT data.

getHITResponse_httpStatus :: Lens' GetHITResponse Int

The response's http status code.

GetQualificationScore

getQualificationScore_qualificationTypeId :: Lens' GetQualificationScore Text

The ID of the QualificationType.

getQualificationScore_workerId :: Lens' GetQualificationScore Text

The ID of the Worker whose Qualification is being updated.

getQualificationScoreResponse_qualification :: Lens' GetQualificationScoreResponse (Maybe Qualification)

The Qualification data structure of the Qualification assigned to a user, including the Qualification type and the value (score).

getQualificationScoreResponse_httpStatus :: Lens' GetQualificationScoreResponse Int

The response's http status code.

GetQualificationType

getQualificationType_qualificationTypeId :: Lens' GetQualificationType Text

The ID of the QualificationType.

getQualificationTypeResponse_qualificationType :: Lens' GetQualificationTypeResponse (Maybe QualificationType)

The returned Qualification Type

getQualificationTypeResponse_httpStatus :: Lens' GetQualificationTypeResponse Int

The response's http status code.

ListAssignmentsForHIT

listAssignmentsForHIT_assignmentStatuses :: Lens' ListAssignmentsForHIT (Maybe [AssignmentStatus])

The status of the assignments to return: Submitted | Approved | Rejected

listAssignmentsForHIT_maxResults :: Lens' ListAssignmentsForHIT (Maybe Natural)

Undocumented member.

listAssignmentsForHIT_nextToken :: Lens' ListAssignmentsForHIT (Maybe Text)

Pagination token

listAssignmentsForHIT_hITId :: Lens' ListAssignmentsForHIT Text

The ID of the HIT.

listAssignmentsForHITResponse_assignments :: Lens' ListAssignmentsForHITResponse (Maybe [Assignment])

The collection of Assignment data structures returned by this call.

listAssignmentsForHITResponse_nextToken :: Lens' ListAssignmentsForHITResponse (Maybe Text)

Undocumented member.

listAssignmentsForHITResponse_numResults :: Lens' ListAssignmentsForHITResponse (Maybe Int)

The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.

listAssignmentsForHITResponse_httpStatus :: Lens' ListAssignmentsForHITResponse Int

The response's http status code.

ListBonusPayments

listBonusPayments_assignmentId :: Lens' ListBonusPayments (Maybe Text)

The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified

listBonusPayments_hITId :: Lens' ListBonusPayments (Maybe Text)

The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified

listBonusPayments_maxResults :: Lens' ListBonusPayments (Maybe Natural)

Undocumented member.

listBonusPayments_nextToken :: Lens' ListBonusPayments (Maybe Text)

Pagination token

listBonusPaymentsResponse_bonusPayments :: Lens' ListBonusPaymentsResponse (Maybe [BonusPayment])

A successful request to the ListBonusPayments operation returns a list of BonusPayment objects.

listBonusPaymentsResponse_nextToken :: Lens' ListBonusPaymentsResponse (Maybe Text)

Undocumented member.

listBonusPaymentsResponse_numResults :: Lens' ListBonusPaymentsResponse (Maybe Int)

The number of bonus payments on this page in the filtered results list, equivalent to the number of bonus payments being returned by this call.

listBonusPaymentsResponse_httpStatus :: Lens' ListBonusPaymentsResponse Int

The response's http status code.

ListHITs

listHITs_maxResults :: Lens' ListHITs (Maybe Natural)

Undocumented member.

listHITs_nextToken :: Lens' ListHITs (Maybe Text)

Pagination token

listHITsResponse_hITs :: Lens' ListHITsResponse (Maybe [HIT])

The list of HIT elements returned by the query.

listHITsResponse_nextToken :: Lens' ListHITsResponse (Maybe Text)

Undocumented member.

listHITsResponse_numResults :: Lens' ListHITsResponse (Maybe Int)

The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

listHITsResponse_httpStatus :: Lens' ListHITsResponse Int

The response's http status code.

ListHITsForQualificationType

listHITsForQualificationType_maxResults :: Lens' ListHITsForQualificationType (Maybe Natural)

Limit the number of results returned.

listHITsForQualificationType_nextToken :: Lens' ListHITsForQualificationType (Maybe Text)

Pagination Token

listHITsForQualificationType_qualificationTypeId :: Lens' ListHITsForQualificationType Text

The ID of the Qualification type to use when querying HITs.

listHITsForQualificationTypeResponse_hITs :: Lens' ListHITsForQualificationTypeResponse (Maybe [HIT])

The list of HIT elements returned by the query.

listHITsForQualificationTypeResponse_nextToken :: Lens' ListHITsForQualificationTypeResponse (Maybe Text)

Undocumented member.

listHITsForQualificationTypeResponse_numResults :: Lens' ListHITsForQualificationTypeResponse (Maybe Int)

The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

listHITsForQualificationTypeResponse_httpStatus :: Lens' ListHITsForQualificationTypeResponse Int

The response's http status code.

ListQualificationRequests

listQualificationRequests_maxResults :: Lens' ListQualificationRequests (Maybe Natural)

The maximum number of results to return in a single call.

listQualificationRequests_nextToken :: Lens' ListQualificationRequests (Maybe Text)

Undocumented member.

listQualificationRequests_qualificationTypeId :: Lens' ListQualificationRequests (Maybe Text)

The ID of the QualificationType.

listQualificationRequestsResponse_nextToken :: Lens' ListQualificationRequestsResponse (Maybe Text)

Undocumented member.

listQualificationRequestsResponse_numResults :: Lens' ListQualificationRequestsResponse (Maybe Int)

The number of Qualification requests on this page in the filtered results list, equivalent to the number of Qualification requests being returned by this call.

listQualificationRequestsResponse_qualificationRequests :: Lens' ListQualificationRequestsResponse (Maybe [QualificationRequest])

The Qualification request. The response includes one QualificationRequest element for each Qualification request returned by the query.

listQualificationRequestsResponse_httpStatus :: Lens' ListQualificationRequestsResponse Int

The response's http status code.

ListQualificationTypes

listQualificationTypes_maxResults :: Lens' ListQualificationTypes (Maybe Natural)

The maximum number of results to return in a single call.

listQualificationTypes_mustBeOwnedByCaller :: Lens' ListQualificationTypes (Maybe Bool)

Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.

listQualificationTypes_nextToken :: Lens' ListQualificationTypes (Maybe Text)

Undocumented member.

listQualificationTypes_query :: Lens' ListQualificationTypes (Maybe Text)

A text query against all of the searchable attributes of Qualification types.

listQualificationTypes_mustBeRequestable :: Lens' ListQualificationTypes Bool

Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False.

listQualificationTypesResponse_nextToken :: Lens' ListQualificationTypesResponse (Maybe Text)

Undocumented member.

listQualificationTypesResponse_numResults :: Lens' ListQualificationTypesResponse (Maybe Int)

The number of Qualification types on this page in the filtered results list, equivalent to the number of types this operation returns.

listQualificationTypesResponse_qualificationTypes :: Lens' ListQualificationTypesResponse (Maybe [QualificationType])

The list of QualificationType elements returned by the query.

listQualificationTypesResponse_httpStatus :: Lens' ListQualificationTypesResponse Int

The response's http status code.

ListReviewPolicyResultsForHIT

listReviewPolicyResultsForHIT_maxResults :: Lens' ListReviewPolicyResultsForHIT (Maybe Natural)

Limit the number of results returned.

listReviewPolicyResultsForHIT_nextToken :: Lens' ListReviewPolicyResultsForHIT (Maybe Text)

Pagination token

listReviewPolicyResultsForHIT_policyLevels :: Lens' ListReviewPolicyResultsForHIT (Maybe [ReviewPolicyLevel])

The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

listReviewPolicyResultsForHIT_retrieveActions :: Lens' ListReviewPolicyResultsForHIT (Maybe Bool)

Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.

listReviewPolicyResultsForHIT_retrieveResults :: Lens' ListReviewPolicyResultsForHIT (Maybe Bool)

Specify if the operation should retrieve a list of the results computed by the Review Policies.

listReviewPolicyResultsForHIT_hITId :: Lens' ListReviewPolicyResultsForHIT Text

The unique identifier of the HIT to retrieve review results for.

listReviewPolicyResultsForHITResponse_assignmentReviewPolicy :: Lens' ListReviewPolicyResultsForHITResponse (Maybe ReviewPolicy)

The name of the Assignment-level Review Policy. This contains only the PolicyName element.

listReviewPolicyResultsForHITResponse_assignmentReviewReport :: Lens' ListReviewPolicyResultsForHITResponse (Maybe ReviewReport)

Contains both ReviewResult and ReviewAction elements for an Assignment.

listReviewPolicyResultsForHITResponse_hITId :: Lens' ListReviewPolicyResultsForHITResponse (Maybe Text)

The HITId of the HIT for which results have been returned.

listReviewPolicyResultsForHITResponse_hITReviewPolicy :: Lens' ListReviewPolicyResultsForHITResponse (Maybe ReviewPolicy)

The name of the HIT-level Review Policy. This contains only the PolicyName element.

listReviewPolicyResultsForHITResponse_hITReviewReport :: Lens' ListReviewPolicyResultsForHITResponse (Maybe ReviewReport)

Contains both ReviewResult and ReviewAction elements for a particular HIT.

listReviewPolicyResultsForHITResponse_nextToken :: Lens' ListReviewPolicyResultsForHITResponse (Maybe Text)

Undocumented member.

listReviewPolicyResultsForHITResponse_httpStatus :: Lens' ListReviewPolicyResultsForHITResponse Int

The response's http status code.

ListReviewableHITs

listReviewableHITs_hITTypeId :: Lens' ListReviewableHITs (Maybe Text)

The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered

listReviewableHITs_maxResults :: Lens' ListReviewableHITs (Maybe Natural)

Limit the number of results returned.

listReviewableHITs_nextToken :: Lens' ListReviewableHITs (Maybe Text)

Pagination Token

listReviewableHITs_status :: Lens' ListReviewableHITs (Maybe ReviewableHITStatus)

Can be either Reviewable or Reviewing. Reviewable is the default value.

listReviewableHITsResponse_hITs :: Lens' ListReviewableHITsResponse (Maybe [HIT])

The list of HIT elements returned by the query.

listReviewableHITsResponse_nextToken :: Lens' ListReviewableHITsResponse (Maybe Text)

Undocumented member.

listReviewableHITsResponse_numResults :: Lens' ListReviewableHITsResponse (Maybe Int)

The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

listReviewableHITsResponse_httpStatus :: Lens' ListReviewableHITsResponse Int

The response's http status code.

ListWorkerBlocks

listWorkerBlocks_maxResults :: Lens' ListWorkerBlocks (Maybe Natural)

Undocumented member.

listWorkerBlocks_nextToken :: Lens' ListWorkerBlocks (Maybe Text)

Pagination token

listWorkerBlocksResponse_nextToken :: Lens' ListWorkerBlocksResponse (Maybe Text)

Undocumented member.

listWorkerBlocksResponse_numResults :: Lens' ListWorkerBlocksResponse (Maybe Int)

The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.

listWorkerBlocksResponse_workerBlocks :: Lens' ListWorkerBlocksResponse (Maybe [WorkerBlock])

The list of WorkerBlocks, containing the collection of Worker IDs and reasons for blocking.

listWorkerBlocksResponse_httpStatus :: Lens' ListWorkerBlocksResponse Int

The response's http status code.

ListWorkersWithQualificationType

listWorkersWithQualificationType_maxResults :: Lens' ListWorkersWithQualificationType (Maybe Natural)

Limit the number of results returned.

listWorkersWithQualificationType_nextToken :: Lens' ListWorkersWithQualificationType (Maybe Text)

Pagination Token

listWorkersWithQualificationType_status :: Lens' ListWorkersWithQualificationType (Maybe QualificationStatus)

The status of the Qualifications to return. Can be Granted | Revoked.

listWorkersWithQualificationType_qualificationTypeId :: Lens' ListWorkersWithQualificationType Text

The ID of the Qualification type of the Qualifications to return.

listWorkersWithQualificationTypeResponse_nextToken :: Lens' ListWorkersWithQualificationTypeResponse (Maybe Text)

Undocumented member.

listWorkersWithQualificationTypeResponse_numResults :: Lens' ListWorkersWithQualificationTypeResponse (Maybe Int)

The number of Qualifications on this page in the filtered results list, equivalent to the number of Qualifications being returned by this call.

listWorkersWithQualificationTypeResponse_qualifications :: Lens' ListWorkersWithQualificationTypeResponse (Maybe [Qualification])

The list of Qualification elements returned by this call.

listWorkersWithQualificationTypeResponse_httpStatus :: Lens' ListWorkersWithQualificationTypeResponse Int

The response's http status code.

NotifyWorkers

notifyWorkers_subject :: Lens' NotifyWorkers Text

The subject line of the email message to send. Can include up to 200 characters.

notifyWorkers_messageText :: Lens' NotifyWorkers Text

The text of the email message to send. Can include up to 4,096 characters

notifyWorkers_workerIds :: Lens' NotifyWorkers [Text]

A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.

notifyWorkersResponse_notifyWorkersFailureStatuses :: Lens' NotifyWorkersResponse (Maybe [NotifyWorkersFailureStatus])

When MTurk sends notifications to the list of Workers, it returns back any failures it encounters in this list of NotifyWorkersFailureStatus objects.

notifyWorkersResponse_httpStatus :: Lens' NotifyWorkersResponse Int

The response's http status code.

RejectAssignment

rejectAssignment_assignmentId :: Lens' RejectAssignment Text

The ID of the assignment. The assignment must correspond to a HIT created by the Requester.

rejectAssignment_requesterFeedback :: Lens' RejectAssignment Text

A message for the Worker, which the Worker can see in the Status section of the web site.

rejectAssignmentResponse_httpStatus :: Lens' RejectAssignmentResponse Int

The response's http status code.

RejectQualificationRequest

rejectQualificationRequest_reason :: Lens' RejectQualificationRequest (Maybe Text)

A text message explaining why the request was rejected, to be shown to the Worker who made the request.

rejectQualificationRequest_qualificationRequestId :: Lens' RejectQualificationRequest Text

The ID of the Qualification request, as returned by the ListQualificationRequests operation.

rejectQualificationRequestResponse_httpStatus :: Lens' RejectQualificationRequestResponse Int

The response's http status code.

SendBonus

sendBonus_uniqueRequestToken :: Lens' SendBonus (Maybe Text)

A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.

sendBonus_workerId :: Lens' SendBonus Text

The ID of the Worker being paid the bonus.

sendBonus_bonusAmount :: Lens' SendBonus Text

The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes.

sendBonus_assignmentId :: Lens' SendBonus Text

The ID of the assignment for which this bonus is paid.

sendBonus_reason :: Lens' SendBonus Text

A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.

sendBonusResponse_httpStatus :: Lens' SendBonusResponse Int

The response's http status code.

SendTestEventNotification

sendTestEventNotification_notification :: Lens' SendTestEventNotification NotificationSpecification

The notification specification to test. This value is identical to the value you would provide to the UpdateNotificationSettings operation when you establish the notification specification for a HIT type.

sendTestEventNotification_testEventType :: Lens' SendTestEventNotification EventType

The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event.

sendTestEventNotificationResponse_httpStatus :: Lens' SendTestEventNotificationResponse Int

The response's http status code.

UpdateExpirationForHIT

updateExpirationForHIT_hITId :: Lens' UpdateExpirationForHIT Text

The HIT to update.

updateExpirationForHIT_expireAt :: Lens' UpdateExpirationForHIT UTCTime

The date and time at which you want the HIT to expire

updateExpirationForHITResponse_httpStatus :: Lens' UpdateExpirationForHITResponse Int

The response's http status code.

UpdateHITReviewStatus

updateHITReviewStatus_revert :: Lens' UpdateHITReviewStatus (Maybe Bool)

Specifies how to update the HIT status. Default is False.

• Setting this to false will only transition a HIT from Reviewable to Reviewing
• Setting this to true will only transition a HIT from Reviewing to Reviewable

updateHITReviewStatus_hITId :: Lens' UpdateHITReviewStatus Text

The ID of the HIT to update.

updateHITReviewStatusResponse_httpStatus :: Lens' UpdateHITReviewStatusResponse Int

The response's http status code.

UpdateHITTypeOfHIT

updateHITTypeOfHIT_hITId :: Lens' UpdateHITTypeOfHIT Text

The HIT to update.

updateHITTypeOfHIT_hITTypeId :: Lens' UpdateHITTypeOfHIT Text

The ID of the new HIT type.

updateHITTypeOfHITResponse_httpStatus :: Lens' UpdateHITTypeOfHITResponse Int

The response's http status code.

UpdateNotificationSettings

updateNotificationSettings_active :: Lens' UpdateNotificationSettings (Maybe Bool)

Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification. You must specify either the Notification parameter or the Active parameter for the call to UpdateNotificationSettings to succeed.

updateNotificationSettings_notification :: Lens' UpdateNotificationSettings (Maybe NotificationSpecification)

The notification specification for the HIT type.

updateNotificationSettings_hITTypeId :: Lens' UpdateNotificationSettings Text

The ID of the HIT type whose notification specification is being updated.

updateNotificationSettingsResponse_httpStatus :: Lens' UpdateNotificationSettingsResponse Int

The response's http status code.

UpdateQualificationType

updateQualificationType_answerKey :: Lens' UpdateQualificationType (Maybe Text)

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

updateQualificationType_autoGranted :: Lens' UpdateQualificationType (Maybe Bool)

Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Constraints: If the Test parameter is specified, this parameter cannot be true.

updateQualificationType_autoGrantedValue :: Lens' UpdateQualificationType (Maybe Int)

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

updateQualificationType_description :: Lens' UpdateQualificationType (Maybe Text)

The new description of the Qualification type.

updateQualificationType_qualificationTypeStatus :: Lens' UpdateQualificationType (Maybe QualificationTypeStatus)

The new status of the Qualification type - Active | Inactive

updateQualificationType_retryDelayInSeconds :: Lens' UpdateQualificationType (Maybe Integer)

The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.

updateQualificationType_test :: Lens' UpdateQualificationType (Maybe Text)

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

updateQualificationType_testDurationInSeconds :: Lens' UpdateQualificationType (Maybe Integer)

The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

updateQualificationType_qualificationTypeId :: Lens' UpdateQualificationType Text

The ID of the Qualification type to update.

updateQualificationTypeResponse_qualificationType :: Lens' UpdateQualificationTypeResponse (Maybe QualificationType)

Contains a QualificationType data structure.

updateQualificationTypeResponse_httpStatus :: Lens' UpdateQualificationTypeResponse Int

The response's http status code.

Types

Assignment

assignment_acceptTime :: Lens' Assignment (Maybe UTCTime)

The date and time the Worker accepted the assignment.

assignment_answer :: Lens' Assignment (Maybe Text)

The Worker's answers submitted for the HIT contained in a QuestionFormAnswers document, if the Worker provides an answer. If the Worker does not provide any answers, Answer may contain a QuestionFormAnswers document, or Answer may be empty.

assignment_approvalTime :: Lens' Assignment (Maybe UTCTime)

If the Worker has submitted results and the Requester has approved the results, ApprovalTime is the date and time the Requester approved the results. This value is omitted from the assignment if the Requester has not yet approved the results.

assignment_assignmentId :: Lens' Assignment (Maybe Text)

A unique identifier for the assignment.

assignment_assignmentStatus :: Lens' Assignment (Maybe AssignmentStatus)

The status of the assignment.

assignment_autoApprovalTime :: Lens' Assignment (Maybe UTCTime)

If results have been submitted, AutoApprovalTime is the date and time the results of the assignment results are considered Approved automatically if they have not already been explicitly approved or rejected by the Requester. This value is derived from the auto-approval delay specified by the Requester in the HIT. This value is omitted from the assignment if the Worker has not yet submitted results.

assignment_deadline :: Lens' Assignment (Maybe UTCTime)

The date and time of the deadline for the assignment. This value is derived from the deadline specification for the HIT and the date and time the Worker accepted the HIT.

assignment_hITId :: Lens' Assignment (Maybe Text)

The ID of the HIT.

assignment_rejectionTime :: Lens' Assignment (Maybe UTCTime)

If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.

assignment_requesterFeedback :: Lens' Assignment (Maybe Text)

The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation, if the Requester approved or rejected the assignment and specified feedback.

assignment_submitTime :: Lens' Assignment (Maybe UTCTime)

If the Worker has submitted results, SubmitTime is the date and time the assignment was submitted. This value is omitted from the assignment if the Worker has not yet submitted results.

assignment_workerId :: Lens' Assignment (Maybe Text)

The ID of the Worker who accepted the HIT.

BonusPayment

bonusPayment_assignmentId :: Lens' BonusPayment (Maybe Text)

The ID of the assignment associated with this bonus payment.

bonusPayment_bonusAmount :: Lens' BonusPayment (Maybe Text)

Undocumented member.

bonusPayment_grantTime :: Lens' BonusPayment (Maybe UTCTime)

The date and time of when the bonus was granted.

bonusPayment_reason :: Lens' BonusPayment (Maybe Text)

The Reason text given when the bonus was granted, if any.

bonusPayment_workerId :: Lens' BonusPayment (Maybe Text)

The ID of the Worker to whom the bonus was paid.

HIT

hit_assignmentDurationInSeconds :: Lens' HIT (Maybe Integer)

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

hit_autoApprovalDelayInSeconds :: Lens' HIT (Maybe Integer)

The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.

hit_creationTime :: Lens' HIT (Maybe UTCTime)

The date and time the HIT was created.

hit_description :: Lens' HIT (Maybe Text)

A general description of the HIT.

hit_expiration :: Lens' HIT (Maybe UTCTime)

The date and time the HIT expires.

hit_hITGroupId :: Lens' HIT (Maybe Text)

The ID of the HIT Group of this HIT.

hit_hITId :: Lens' HIT (Maybe Text)

A unique identifier for the HIT.

hit_hITLayoutId :: Lens' HIT (Maybe Text)

The ID of the HIT Layout of this HIT.

hit_hITReviewStatus :: Lens' HIT (Maybe HITReviewStatus)

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

hit_hITStatus :: Lens' HIT (Maybe HITStatus)

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

hit_hITTypeId :: Lens' HIT (Maybe Text)

The ID of the HIT type of this HIT

hit_keywords :: Lens' HIT (Maybe Text)

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

hit_maxAssignments :: Lens' HIT (Maybe Int)

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

hit_numberOfAssignmentsAvailable :: Lens' HIT (Maybe Int)

The number of assignments for this HIT that are available for Workers to accept.

hit_numberOfAssignmentsCompleted :: Lens' HIT (Maybe Int)

The number of assignments for this HIT that have been approved or rejected.

hit_numberOfAssignmentsPending :: Lens' HIT (Maybe Int)

The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.

hit_qualificationRequirements :: Lens' HIT (Maybe [QualificationRequirement])

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

hit_question :: Lens' HIT (Maybe Text)

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

hit_requesterAnnotation :: Lens' HIT (Maybe Text)

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

hit_reward :: Lens' HIT (Maybe Text)

Undocumented member.

hit_title :: Lens' HIT (Maybe Text)

The title of the HIT.

HITLayoutParameter

hITLayoutParameter_name :: Lens' HITLayoutParameter Text

The name of the parameter in the HITLayout.

hITLayoutParameter_value :: Lens' HITLayoutParameter Text

The value substituted for the parameter referenced in the HITLayout.

Locale

locale_subdivision :: Lens' Locale (Maybe Text)

The state or subdivision of the locale. A valid ISO 3166-2 subdivision code. For example, the code WA refers to the state of Washington.

locale_country :: Lens' Locale Text

The country of the locale. Must be a valid ISO 3166 country code. For example, the code US refers to the United States of America.

NotificationSpecification

notificationSpecification_destination :: Lens' NotificationSpecification Text

The target for notification messages. The Destination’s format is determined by the specified Transport:

• When Transport is Email, the Destination is your email address.
• When Transport is SQS, the Destination is your queue URL.
• When Transport is SNS, the Destination is the ARN of your topic.

notificationSpecification_transport :: Lens' NotificationSpecification NotificationTransport

The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.

notificationSpecification_version :: Lens' NotificationSpecification Text

The version of the Notification API to use. Valid value is 2006-05-05.

notificationSpecification_eventTypes :: Lens' NotificationSpecification [EventType]

The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation.

NotifyWorkersFailureStatus

notifyWorkersFailureStatus_notifyWorkersFailureCode :: Lens' NotifyWorkersFailureStatus (Maybe NotifyWorkersFailureCode)

Encoded value for the failure type.

notifyWorkersFailureStatus_notifyWorkersFailureMessage :: Lens' NotifyWorkersFailureStatus (Maybe Text)

A message detailing the reason the Worker could not be notified.

notifyWorkersFailureStatus_workerId :: Lens' NotifyWorkersFailureStatus (Maybe Text)

The ID of the Worker.

ParameterMapEntry

parameterMapEntry_key :: Lens' ParameterMapEntry (Maybe Text)

The QuestionID from the HIT that is used to identify which question requires Mechanical Turk to score as part of the ScoreMyKnownAnswers/2011-09-01 Review Policy.

parameterMapEntry_values :: Lens' ParameterMapEntry (Maybe [Text])

The list of answers to the question specified in the MapEntry Key element. The Worker must match all values in order for the answer to be scored correctly.

PolicyParameter

policyParameter_key :: Lens' PolicyParameter (Maybe Text)

Name of the parameter from the list of Review Polices.

policyParameter_mapEntries :: Lens' PolicyParameter (Maybe [ParameterMapEntry])

List of ParameterMapEntry objects.

policyParameter_values :: Lens' PolicyParameter (Maybe [Text])

The list of values of the Parameter

Qualification

qualification_grantTime :: Lens' Qualification (Maybe UTCTime)

The date and time the Qualification was granted to the Worker. If the Worker's Qualification was revoked, and then re-granted based on a new Qualification request, GrantTime is the date and time of the last call to the AcceptQualificationRequest operation.

qualification_integerValue :: Lens' Qualification (Maybe Int)

The value (score) of the Qualification, if the Qualification has an integer value.

qualification_localeValue :: Lens' Qualification (Maybe Locale)

Undocumented member.

qualification_qualificationTypeId :: Lens' Qualification (Maybe Text)

The ID of the Qualification type for the Qualification.

qualification_status :: Lens' Qualification (Maybe QualificationStatus)

The status of the Qualification. Valid values are Granted | Revoked.

qualification_workerId :: Lens' Qualification (Maybe Text)

The ID of the Worker who possesses the Qualification.

QualificationRequest

qualificationRequest_answer :: Lens' QualificationRequest (Maybe Text)

The Worker's answers for the Qualification type's test contained in a QuestionFormAnswers document, if the type has a test and the Worker has submitted answers. If the Worker does not provide any answers, Answer may be empty.

qualificationRequest_qualificationRequestId :: Lens' QualificationRequest (Maybe Text)

The ID of the Qualification request, a unique identifier generated when the request was submitted.

qualificationRequest_qualificationTypeId :: Lens' QualificationRequest (Maybe Text)

The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation.

qualificationRequest_submitTime :: Lens' QualificationRequest (Maybe UTCTime)

The date and time the Qualification request had a status of Submitted. This is either the time the Worker submitted answers for a Qualification test, or the time the Worker requested the Qualification if the Qualification type does not have a test.

qualificationRequest_test :: Lens' QualificationRequest (Maybe Text)

The contents of the Qualification test that was presented to the Worker, if the type has a test and the Worker has submitted answers. This value is identical to the QuestionForm associated with the Qualification type at the time the Worker requests the Qualification.

qualificationRequest_workerId :: Lens' QualificationRequest (Maybe Text)

The ID of the Worker requesting the Qualification.

QualificationRequirement

qualificationRequirement_actionsGuarded :: Lens' QualificationRequirement (Maybe HITAccessActions)

Setting this attribute prevents Workers whose Qualifications do not meet this QualificationRequirement from taking the specified action. Valid arguments include "Accept" (Worker cannot accept the HIT, but can preview the HIT and see it in their search results), "PreviewAndAccept" (Worker cannot accept or preview the HIT, but can see the HIT in their search results), 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 QualificationRequirements (which can have different values for the ActionGuarded attribute). In this case, the Worker is only permitted to perform an action when they have met all QualificationRequirements guarding the action. The actions in the order of least restrictive to most restrictive are Discover, Preview and Accept. For example, if a Worker meets all QualificationRequirements that are set to DiscoverPreviewAndAccept, but do not meet all requirements that are set with PreviewAndAccept, then the Worker will be able to Discover, i.e. see the 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 RequiredToPreview field.

qualificationRequirement_integerValues :: Lens' QualificationRequirement (Maybe [Int])

The integer value to compare against the Qualification's value. IntegerValue must not be present if Comparator is Exists or DoesNotExist. IntegerValue can only be used if the Qualification type has an integer value; it cannot be used with the Worker_Locale QualificationType ID. When performing a set comparison by using the In or the NotIn comparator, you can use up to 15 IntegerValue elements in a QualificationRequirement data structure.

qualificationRequirement_localeValues :: Lens' QualificationRequirement (Maybe [Locale])

The locale value to compare against the Qualification's value. The local value must be a valid ISO 3166 country code or supports ISO 3166-2 subdivisions. LocaleValue can only be used with a Worker_Locale QualificationType ID. LocaleValue can only be used with the EqualTo, NotEqualTo, In, and NotIn comparators. You must only use a single LocaleValue element when using the EqualTo or NotEqualTo comparators. When performing a set comparison by using the In or the NotIn comparator, you can use up to 30 LocaleValue elements in a QualificationRequirement data structure.

qualificationRequirement_requiredToPreview :: Lens' QualificationRequirement (Maybe Bool)

DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is true, the question data for the HIT will not be shown when a Worker whose Qualifications do not meet this requirement tries to preview the HIT. That is, a Worker's Qualifications must meet all of the requirements for which RequiredToPreview is true in order to preview the HIT. If a Worker meets all of the requirements where RequiredToPreview is true (or if there are no such requirements), but does not meet all of the requirements for the HIT, the Worker will be allowed to preview the HIT's question data, but will not be allowed to accept and complete the HIT. The default is false. This should not be used in combination with the ActionsGuarded field.

qualificationRequirement_qualificationTypeId :: Lens' QualificationRequirement Text

The ID of the Qualification type for the requirement.

qualificationRequirement_comparator :: Lens' QualificationRequirement Comparator

The kind of comparison to make against a Qualification's value. You can compare a Qualification's value to an IntegerValue to see if it is LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, or NotEqualTo the IntegerValue. You can compare it to a LocaleValue to see if it is EqualTo, or NotEqualTo the LocaleValue. You can check to see if the value is In or NotIn a set of IntegerValue or LocaleValue values. Lastly, a Qualification requirement can also test if a Qualification Exists or DoesNotExist in the user's profile, regardless of its value.

QualificationType

qualificationType_answerKey :: Lens' QualificationType (Maybe Text)

The answers to the Qualification test specified in the Test parameter.

qualificationType_autoGranted :: Lens' QualificationType (Maybe Bool)

Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.

qualificationType_autoGrantedValue :: Lens' QualificationType (Maybe Int)

The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.

qualificationType_creationTime :: Lens' QualificationType (Maybe UTCTime)

The date and time the Qualification type was created.

qualificationType_description :: Lens' QualificationType (Maybe Text)

A long description for the Qualification type.

qualificationType_isRequestable :: Lens' QualificationType (Maybe Bool)

Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False.

qualificationType_keywords :: Lens' QualificationType (Maybe Text)

One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

qualificationType_name :: Lens' QualificationType (Maybe Text)

The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.

qualificationType_qualificationTypeId :: Lens' QualificationType (Maybe Text)

A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.

qualificationType_qualificationTypeStatus :: Lens' QualificationType (Maybe QualificationTypeStatus)

The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.

qualificationType_retryDelayInSeconds :: Lens' QualificationType (Maybe Integer)

The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once.

qualificationType_test :: Lens' QualificationType (Maybe Text)

The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.

qualificationType_testDurationInSeconds :: Lens' QualificationType (Maybe Integer)

The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

ReviewActionDetail

reviewActionDetail_actionId :: Lens' ReviewActionDetail (Maybe Text)

The unique identifier for the action.

reviewActionDetail_actionName :: Lens' ReviewActionDetail (Maybe Text)

The nature of the action itself. The Review Policy is responsible for examining the HIT and Assignments, emitting results, and deciding which other actions will be necessary.

reviewActionDetail_completeTime :: Lens' ReviewActionDetail (Maybe UTCTime)

The date when the action was completed.

reviewActionDetail_errorCode :: Lens' ReviewActionDetail (Maybe Text)

Present only when the Results have a FAILED Status.

reviewActionDetail_result :: Lens' ReviewActionDetail (Maybe Text)

A description of the outcome of the review.

reviewActionDetail_status :: Lens' ReviewActionDetail (Maybe ReviewActionStatus)

The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.

reviewActionDetail_targetId :: Lens' ReviewActionDetail (Maybe Text)

The specific HITId or AssignmentID targeted by the action.

reviewActionDetail_targetType :: Lens' ReviewActionDetail (Maybe Text)

The type of object in TargetId.

ReviewPolicy

reviewPolicy_parameters :: Lens' ReviewPolicy (Maybe [PolicyParameter])

Name of the parameter from the Review policy.

reviewPolicy_policyName :: Lens' ReviewPolicy Text

Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01

ReviewReport

reviewReport_reviewActions :: Lens' ReviewReport (Maybe [ReviewActionDetail])

A list of ReviewAction objects for each action specified in the Review Policy.

reviewReport_reviewResults :: Lens' ReviewReport (Maybe [ReviewResultDetail])

A list of ReviewResults objects for each action specified in the Review Policy.

ReviewResultDetail

reviewResultDetail_actionId :: Lens' ReviewResultDetail (Maybe Text)

A unique identifier of the Review action result.

reviewResultDetail_key :: Lens' ReviewResultDetail (Maybe Text)

Key identifies the particular piece of reviewed information.

reviewResultDetail_questionId :: Lens' ReviewResultDetail (Maybe Text)

Specifies the QuestionId the result is describing. Depending on whether the TargetType is a HIT or Assignment this results could specify multiple values. If TargetType is HIT and QuestionId is absent, then the result describes results of the HIT, including the HIT agreement score. If ObjectType is Assignment and QuestionId is absent, then the result describes the Worker's performance on the HIT.

reviewResultDetail_subjectId :: Lens' ReviewResultDetail (Maybe Text)

The HITID or AssignmentId about which this result was taken. Note that HIT-level Review Policies will often emit results about both the HIT itself and its Assignments, while Assignment-level review policies generally only emit results about the Assignment itself.

reviewResultDetail_subjectType :: Lens' ReviewResultDetail (Maybe Text)

The type of the object from the SubjectId field.

reviewResultDetail_value :: Lens' ReviewResultDetail (Maybe Text)

The values of Key provided by the review policies you have selected.

WorkerBlock

workerBlock_reason :: Lens' WorkerBlock (Maybe Text)

A message explaining the reason the Worker was blocked.

workerBlock_workerId :: Lens' WorkerBlock (Maybe Text)

The ID of the Worker who accepted the HIT.