| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.MechanicalTurk.Types
Contents
- Service Configuration
- Errors
- AssignmentStatus
- Comparator
- EventType
- HITAccessActions
- HITReviewStatus
- HITStatus
- NotificationTransport
- NotifyWorkersFailureCode
- QualificationStatus
- QualificationTypeStatus
- ReviewActionStatus
- ReviewPolicyLevel
- ReviewableHITStatus
- Assignment
- BonusPayment
- HIT
- HITLayoutParameter
- Locale
- NotificationSpecification
- NotifyWorkersFailureStatus
- ParameterMapEntry
- PolicyParameter
- Qualification
- QualificationRequest
- QualificationRequirement
- QualificationType
- ReviewActionDetail
- ReviewPolicy
- ReviewReport
- ReviewResultDetail
- WorkerBlock
Description
Synopsis
- defaultService :: Service
- _RequestError :: AsError a => Fold a ServiceError
- _ServiceFault :: AsError a => Fold a ServiceError
- newtype AssignmentStatus where
- AssignmentStatus' { }
- pattern AssignmentStatus_Approved :: AssignmentStatus
- pattern AssignmentStatus_Rejected :: AssignmentStatus
- pattern AssignmentStatus_Submitted :: AssignmentStatus
- newtype Comparator where
- Comparator' { }
- pattern Comparator_DoesNotExist :: Comparator
- pattern Comparator_EqualTo :: Comparator
- pattern Comparator_Exists :: Comparator
- pattern Comparator_GreaterThan :: Comparator
- pattern Comparator_GreaterThanOrEqualTo :: Comparator
- pattern Comparator_In :: Comparator
- pattern Comparator_LessThan :: Comparator
- pattern Comparator_LessThanOrEqualTo :: Comparator
- pattern Comparator_NotEqualTo :: Comparator
- pattern Comparator_NotIn :: Comparator
- newtype EventType where
- EventType' { }
- pattern EventType_AssignmentAbandoned :: EventType
- pattern EventType_AssignmentAccepted :: EventType
- pattern EventType_AssignmentApproved :: EventType
- pattern EventType_AssignmentRejected :: EventType
- pattern EventType_AssignmentReturned :: EventType
- pattern EventType_AssignmentSubmitted :: EventType
- pattern EventType_HITCreated :: EventType
- pattern EventType_HITDisposed :: EventType
- pattern EventType_HITExpired :: EventType
- pattern EventType_HITExtended :: EventType
- pattern EventType_HITReviewable :: EventType
- pattern EventType_Ping :: EventType
- newtype HITAccessActions where
- newtype HITReviewStatus where
- newtype HITStatus where
- HITStatus' { }
- pattern HITStatus_Assignable :: HITStatus
- pattern HITStatus_Disposed :: HITStatus
- pattern HITStatus_Reviewable :: HITStatus
- pattern HITStatus_Reviewing :: HITStatus
- pattern HITStatus_Unassignable :: HITStatus
- newtype NotificationTransport where
- newtype NotifyWorkersFailureCode where
- newtype QualificationStatus where
- newtype QualificationTypeStatus where
- newtype ReviewActionStatus where
- ReviewActionStatus' { }
- pattern ReviewActionStatus_Cancelled :: ReviewActionStatus
- pattern ReviewActionStatus_Failed :: ReviewActionStatus
- pattern ReviewActionStatus_Intended :: ReviewActionStatus
- pattern ReviewActionStatus_Succeeded :: ReviewActionStatus
- newtype ReviewPolicyLevel where
- ReviewPolicyLevel' { }
- pattern ReviewPolicyLevel_Assignment :: ReviewPolicyLevel
- pattern ReviewPolicyLevel_HIT :: ReviewPolicyLevel
- newtype ReviewableHITStatus where
- data Assignment = Assignment' {
- acceptTime :: Maybe POSIX
- answer :: Maybe Text
- approvalTime :: Maybe POSIX
- assignmentId :: Maybe Text
- assignmentStatus :: Maybe AssignmentStatus
- autoApprovalTime :: Maybe POSIX
- deadline :: Maybe POSIX
- hITId :: Maybe Text
- rejectionTime :: Maybe POSIX
- requesterFeedback :: Maybe Text
- submitTime :: Maybe POSIX
- workerId :: Maybe Text
- newAssignment :: Assignment
- assignment_acceptTime :: Lens' Assignment (Maybe UTCTime)
- assignment_answer :: Lens' Assignment (Maybe Text)
- assignment_approvalTime :: Lens' Assignment (Maybe UTCTime)
- assignment_assignmentId :: Lens' Assignment (Maybe Text)
- assignment_assignmentStatus :: Lens' Assignment (Maybe AssignmentStatus)
- assignment_autoApprovalTime :: Lens' Assignment (Maybe UTCTime)
- assignment_deadline :: Lens' Assignment (Maybe UTCTime)
- assignment_hITId :: Lens' Assignment (Maybe Text)
- assignment_rejectionTime :: Lens' Assignment (Maybe UTCTime)
- assignment_requesterFeedback :: Lens' Assignment (Maybe Text)
- assignment_submitTime :: Lens' Assignment (Maybe UTCTime)
- assignment_workerId :: Lens' Assignment (Maybe Text)
- data BonusPayment = BonusPayment' {}
- newBonusPayment :: BonusPayment
- bonusPayment_assignmentId :: Lens' BonusPayment (Maybe Text)
- bonusPayment_bonusAmount :: Lens' BonusPayment (Maybe Text)
- bonusPayment_grantTime :: Lens' BonusPayment (Maybe UTCTime)
- bonusPayment_reason :: Lens' BonusPayment (Maybe Text)
- bonusPayment_workerId :: Lens' BonusPayment (Maybe Text)
- data HIT = HIT' {
- assignmentDurationInSeconds :: Maybe Integer
- autoApprovalDelayInSeconds :: Maybe Integer
- creationTime :: Maybe POSIX
- description :: Maybe Text
- expiration :: Maybe POSIX
- hITGroupId :: Maybe Text
- hITId :: Maybe Text
- hITLayoutId :: Maybe Text
- hITReviewStatus :: Maybe HITReviewStatus
- hITStatus :: Maybe HITStatus
- hITTypeId :: Maybe Text
- keywords :: Maybe Text
- maxAssignments :: Maybe Int
- numberOfAssignmentsAvailable :: Maybe Int
- numberOfAssignmentsCompleted :: Maybe Int
- numberOfAssignmentsPending :: Maybe Int
- qualificationRequirements :: Maybe [QualificationRequirement]
- question :: Maybe Text
- requesterAnnotation :: Maybe Text
- reward :: Maybe Text
- title :: Maybe Text
- newHIT :: HIT
- hit_assignmentDurationInSeconds :: Lens' HIT (Maybe Integer)
- hit_autoApprovalDelayInSeconds :: Lens' HIT (Maybe Integer)
- hit_creationTime :: Lens' HIT (Maybe UTCTime)
- hit_description :: Lens' HIT (Maybe Text)
- hit_expiration :: Lens' HIT (Maybe UTCTime)
- hit_hITGroupId :: Lens' HIT (Maybe Text)
- hit_hITId :: Lens' HIT (Maybe Text)
- hit_hITLayoutId :: Lens' HIT (Maybe Text)
- hit_hITReviewStatus :: Lens' HIT (Maybe HITReviewStatus)
- hit_hITStatus :: Lens' HIT (Maybe HITStatus)
- hit_hITTypeId :: Lens' HIT (Maybe Text)
- hit_keywords :: Lens' HIT (Maybe Text)
- hit_maxAssignments :: Lens' HIT (Maybe Int)
- hit_numberOfAssignmentsAvailable :: Lens' HIT (Maybe Int)
- hit_numberOfAssignmentsCompleted :: Lens' HIT (Maybe Int)
- hit_numberOfAssignmentsPending :: Lens' HIT (Maybe Int)
- hit_qualificationRequirements :: Lens' HIT (Maybe [QualificationRequirement])
- hit_question :: Lens' HIT (Maybe Text)
- hit_requesterAnnotation :: Lens' HIT (Maybe Text)
- hit_reward :: Lens' HIT (Maybe Text)
- hit_title :: Lens' HIT (Maybe Text)
- data HITLayoutParameter = HITLayoutParameter' {}
- newHITLayoutParameter :: Text -> Text -> HITLayoutParameter
- hITLayoutParameter_name :: Lens' HITLayoutParameter Text
- hITLayoutParameter_value :: Lens' HITLayoutParameter Text
- data Locale = Locale' {
- subdivision :: Maybe Text
- country :: Text
- newLocale :: Text -> Locale
- locale_subdivision :: Lens' Locale (Maybe Text)
- locale_country :: Lens' Locale Text
- data NotificationSpecification = NotificationSpecification' {}
- newNotificationSpecification :: Text -> NotificationTransport -> Text -> NotificationSpecification
- notificationSpecification_destination :: Lens' NotificationSpecification Text
- notificationSpecification_transport :: Lens' NotificationSpecification NotificationTransport
- notificationSpecification_version :: Lens' NotificationSpecification Text
- notificationSpecification_eventTypes :: Lens' NotificationSpecification [EventType]
- data NotifyWorkersFailureStatus = NotifyWorkersFailureStatus' {}
- newNotifyWorkersFailureStatus :: NotifyWorkersFailureStatus
- notifyWorkersFailureStatus_notifyWorkersFailureCode :: Lens' NotifyWorkersFailureStatus (Maybe NotifyWorkersFailureCode)
- notifyWorkersFailureStatus_notifyWorkersFailureMessage :: Lens' NotifyWorkersFailureStatus (Maybe Text)
- notifyWorkersFailureStatus_workerId :: Lens' NotifyWorkersFailureStatus (Maybe Text)
- data ParameterMapEntry = ParameterMapEntry' {}
- newParameterMapEntry :: ParameterMapEntry
- parameterMapEntry_key :: Lens' ParameterMapEntry (Maybe Text)
- parameterMapEntry_values :: Lens' ParameterMapEntry (Maybe [Text])
- data PolicyParameter = PolicyParameter' {
- key :: Maybe Text
- mapEntries :: Maybe [ParameterMapEntry]
- values :: Maybe [Text]
- newPolicyParameter :: PolicyParameter
- policyParameter_key :: Lens' PolicyParameter (Maybe Text)
- policyParameter_mapEntries :: Lens' PolicyParameter (Maybe [ParameterMapEntry])
- policyParameter_values :: Lens' PolicyParameter (Maybe [Text])
- data Qualification = Qualification' {}
- newQualification :: Qualification
- qualification_grantTime :: Lens' Qualification (Maybe UTCTime)
- qualification_integerValue :: Lens' Qualification (Maybe Int)
- qualification_localeValue :: Lens' Qualification (Maybe Locale)
- qualification_qualificationTypeId :: Lens' Qualification (Maybe Text)
- qualification_status :: Lens' Qualification (Maybe QualificationStatus)
- qualification_workerId :: Lens' Qualification (Maybe Text)
- data QualificationRequest = QualificationRequest' {}
- newQualificationRequest :: QualificationRequest
- qualificationRequest_answer :: Lens' QualificationRequest (Maybe Text)
- qualificationRequest_qualificationRequestId :: Lens' QualificationRequest (Maybe Text)
- qualificationRequest_qualificationTypeId :: Lens' QualificationRequest (Maybe Text)
- qualificationRequest_submitTime :: Lens' QualificationRequest (Maybe UTCTime)
- qualificationRequest_test :: Lens' QualificationRequest (Maybe Text)
- qualificationRequest_workerId :: Lens' QualificationRequest (Maybe Text)
- data QualificationRequirement = QualificationRequirement' {}
- newQualificationRequirement :: Text -> Comparator -> QualificationRequirement
- qualificationRequirement_actionsGuarded :: Lens' QualificationRequirement (Maybe HITAccessActions)
- qualificationRequirement_integerValues :: Lens' QualificationRequirement (Maybe [Int])
- qualificationRequirement_localeValues :: Lens' QualificationRequirement (Maybe [Locale])
- qualificationRequirement_requiredToPreview :: Lens' QualificationRequirement (Maybe Bool)
- qualificationRequirement_qualificationTypeId :: Lens' QualificationRequirement Text
- qualificationRequirement_comparator :: Lens' QualificationRequirement Comparator
- data QualificationType = QualificationType' {
- answerKey :: Maybe Text
- autoGranted :: Maybe Bool
- autoGrantedValue :: Maybe Int
- creationTime :: Maybe POSIX
- description :: Maybe Text
- isRequestable :: Maybe Bool
- keywords :: Maybe Text
- name :: Maybe Text
- qualificationTypeId :: Maybe Text
- qualificationTypeStatus :: Maybe QualificationTypeStatus
- retryDelayInSeconds :: Maybe Integer
- test :: Maybe Text
- testDurationInSeconds :: Maybe Integer
- newQualificationType :: QualificationType
- qualificationType_answerKey :: Lens' QualificationType (Maybe Text)
- qualificationType_autoGranted :: Lens' QualificationType (Maybe Bool)
- qualificationType_autoGrantedValue :: Lens' QualificationType (Maybe Int)
- qualificationType_creationTime :: Lens' QualificationType (Maybe UTCTime)
- qualificationType_description :: Lens' QualificationType (Maybe Text)
- qualificationType_isRequestable :: Lens' QualificationType (Maybe Bool)
- qualificationType_keywords :: Lens' QualificationType (Maybe Text)
- qualificationType_name :: Lens' QualificationType (Maybe Text)
- qualificationType_qualificationTypeId :: Lens' QualificationType (Maybe Text)
- qualificationType_qualificationTypeStatus :: Lens' QualificationType (Maybe QualificationTypeStatus)
- qualificationType_retryDelayInSeconds :: Lens' QualificationType (Maybe Integer)
- qualificationType_test :: Lens' QualificationType (Maybe Text)
- qualificationType_testDurationInSeconds :: Lens' QualificationType (Maybe Integer)
- data ReviewActionDetail = ReviewActionDetail' {}
- newReviewActionDetail :: ReviewActionDetail
- reviewActionDetail_actionId :: Lens' ReviewActionDetail (Maybe Text)
- reviewActionDetail_actionName :: Lens' ReviewActionDetail (Maybe Text)
- reviewActionDetail_completeTime :: Lens' ReviewActionDetail (Maybe UTCTime)
- reviewActionDetail_errorCode :: Lens' ReviewActionDetail (Maybe Text)
- reviewActionDetail_result :: Lens' ReviewActionDetail (Maybe Text)
- reviewActionDetail_status :: Lens' ReviewActionDetail (Maybe ReviewActionStatus)
- reviewActionDetail_targetId :: Lens' ReviewActionDetail (Maybe Text)
- reviewActionDetail_targetType :: Lens' ReviewActionDetail (Maybe Text)
- data ReviewPolicy = ReviewPolicy' {
- parameters :: Maybe [PolicyParameter]
- policyName :: Text
- newReviewPolicy :: Text -> ReviewPolicy
- reviewPolicy_parameters :: Lens' ReviewPolicy (Maybe [PolicyParameter])
- reviewPolicy_policyName :: Lens' ReviewPolicy Text
- data ReviewReport = ReviewReport' {}
- newReviewReport :: ReviewReport
- reviewReport_reviewActions :: Lens' ReviewReport (Maybe [ReviewActionDetail])
- reviewReport_reviewResults :: Lens' ReviewReport (Maybe [ReviewResultDetail])
- data ReviewResultDetail = ReviewResultDetail' {}
- newReviewResultDetail :: ReviewResultDetail
- reviewResultDetail_actionId :: Lens' ReviewResultDetail (Maybe Text)
- reviewResultDetail_key :: Lens' ReviewResultDetail (Maybe Text)
- reviewResultDetail_questionId :: Lens' ReviewResultDetail (Maybe Text)
- reviewResultDetail_subjectId :: Lens' ReviewResultDetail (Maybe Text)
- reviewResultDetail_subjectType :: Lens' ReviewResultDetail (Maybe Text)
- reviewResultDetail_value :: Lens' ReviewResultDetail (Maybe Text)
- data WorkerBlock = WorkerBlock' {}
- newWorkerBlock :: WorkerBlock
- workerBlock_reason :: Lens' WorkerBlock (Maybe Text)
- workerBlock_workerId :: Lens' WorkerBlock (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2017-01-17 of the Amazon Mechanical Turk SDK configuration.
Errors
_RequestError :: AsError a => Fold a ServiceError Source #
Your request is invalid.
_ServiceFault :: AsError a => Fold a ServiceError Source #
Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
AssignmentStatus
newtype AssignmentStatus Source #
Constructors
| AssignmentStatus' | |
Fields | |
Bundled Patterns
| pattern AssignmentStatus_Approved :: AssignmentStatus | |
| pattern AssignmentStatus_Rejected :: AssignmentStatus | |
| pattern AssignmentStatus_Submitted :: AssignmentStatus |
Instances
Comparator
newtype Comparator Source #
Constructors
| Comparator' | |
Fields | |
Bundled Patterns
| pattern Comparator_DoesNotExist :: Comparator | |
| pattern Comparator_EqualTo :: Comparator | |
| pattern Comparator_Exists :: Comparator | |
| pattern Comparator_GreaterThan :: Comparator | |
| pattern Comparator_GreaterThanOrEqualTo :: Comparator | |
| pattern Comparator_In :: Comparator | |
| pattern Comparator_LessThan :: Comparator | |
| pattern Comparator_LessThanOrEqualTo :: Comparator | |
| pattern Comparator_NotEqualTo :: Comparator | |
| pattern Comparator_NotIn :: Comparator |
Instances
EventType
Constructors
| EventType' | |
Fields | |
Bundled Patterns
| pattern EventType_AssignmentAbandoned :: EventType | |
| pattern EventType_AssignmentAccepted :: EventType | |
| pattern EventType_AssignmentApproved :: EventType | |
| pattern EventType_AssignmentRejected :: EventType | |
| pattern EventType_AssignmentReturned :: EventType | |
| pattern EventType_AssignmentSubmitted :: EventType | |
| pattern EventType_HITCreated :: EventType | |
| pattern EventType_HITDisposed :: EventType | |
| pattern EventType_HITExpired :: EventType | |
| pattern EventType_HITExtended :: EventType | |
| pattern EventType_HITReviewable :: EventType | |
| pattern EventType_Ping :: EventType |
Instances
HITAccessActions
newtype HITAccessActions Source #
Constructors
| HITAccessActions' | |
Fields | |
Bundled Patterns
| pattern HITAccessActions_Accept :: HITAccessActions | |
| pattern HITAccessActions_DiscoverPreviewAndAccept :: HITAccessActions | |
| pattern HITAccessActions_PreviewAndAccept :: HITAccessActions |
Instances
HITReviewStatus
newtype HITReviewStatus Source #
Constructors
| HITReviewStatus' | |
Fields | |
Bundled Patterns
| pattern HITReviewStatus_MarkedForReview :: HITReviewStatus | |
| pattern HITReviewStatus_NotReviewed :: HITReviewStatus | |
| pattern HITReviewStatus_ReviewedAppropriate :: HITReviewStatus | |
| pattern HITReviewStatus_ReviewedInappropriate :: HITReviewStatus |
Instances
HITStatus
Constructors
| HITStatus' | |
Fields | |
Bundled Patterns
| pattern HITStatus_Assignable :: HITStatus | |
| pattern HITStatus_Disposed :: HITStatus | |
| pattern HITStatus_Reviewable :: HITStatus | |
| pattern HITStatus_Reviewing :: HITStatus | |
| pattern HITStatus_Unassignable :: HITStatus |
Instances
NotificationTransport
newtype NotificationTransport Source #
Constructors
| NotificationTransport' | |
Fields | |
Bundled Patterns
| pattern NotificationTransport_Email :: NotificationTransport | |
| pattern NotificationTransport_SNS :: NotificationTransport | |
| pattern NotificationTransport_SQS :: NotificationTransport |
Instances
NotifyWorkersFailureCode
newtype NotifyWorkersFailureCode Source #
Constructors
| NotifyWorkersFailureCode' | |
Fields | |
Bundled Patterns
| pattern NotifyWorkersFailureCode_HardFailure :: NotifyWorkersFailureCode | |
| pattern NotifyWorkersFailureCode_SoftFailure :: NotifyWorkersFailureCode |
Instances
QualificationStatus
newtype QualificationStatus Source #
Constructors
| QualificationStatus' | |
Fields | |
Bundled Patterns
| pattern QualificationStatus_Granted :: QualificationStatus | |
| pattern QualificationStatus_Revoked :: QualificationStatus |
Instances
QualificationTypeStatus
newtype QualificationTypeStatus Source #
Constructors
| QualificationTypeStatus' | |
Fields | |
Bundled Patterns
| pattern QualificationTypeStatus_Active :: QualificationTypeStatus | |
| pattern QualificationTypeStatus_Inactive :: QualificationTypeStatus |
Instances
ReviewActionStatus
newtype ReviewActionStatus Source #
Constructors
| ReviewActionStatus' | |
Fields | |
Bundled Patterns
| pattern ReviewActionStatus_Cancelled :: ReviewActionStatus | |
| pattern ReviewActionStatus_Failed :: ReviewActionStatus | |
| pattern ReviewActionStatus_Intended :: ReviewActionStatus | |
| pattern ReviewActionStatus_Succeeded :: ReviewActionStatus |
Instances
ReviewPolicyLevel
newtype ReviewPolicyLevel Source #
Constructors
| ReviewPolicyLevel' | |
Fields | |
Bundled Patterns
| pattern ReviewPolicyLevel_Assignment :: ReviewPolicyLevel | |
| pattern ReviewPolicyLevel_HIT :: ReviewPolicyLevel |
Instances
ReviewableHITStatus
newtype ReviewableHITStatus Source #
Constructors
| ReviewableHITStatus' | |
Fields | |
Bundled Patterns
| pattern ReviewableHITStatus_Reviewable :: ReviewableHITStatus | |
| pattern ReviewableHITStatus_Reviewing :: ReviewableHITStatus |
Instances
Assignment
data Assignment Source #
The Assignment data structure represents a single assignment of a HIT to a Worker. The assignment tracks the Worker's efforts to complete the HIT, and contains the results for later retrieval.
See: newAssignment smart constructor.
Constructors
| Assignment' | |
Fields
| |
Instances
newAssignment :: Assignment Source #
Create a value of Assignment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceptTime:Assignment', assignment_acceptTime - The date and time the Worker accepted the assignment.
$sel:answer:Assignment', assignment_answer - 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.
$sel:approvalTime:Assignment', assignment_approvalTime - 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.
$sel:assignmentId:Assignment', assignment_assignmentId - A unique identifier for the assignment.
$sel:assignmentStatus:Assignment', assignment_assignmentStatus - The status of the assignment.
$sel:autoApprovalTime:Assignment', assignment_autoApprovalTime - 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.
$sel:deadline:Assignment', assignment_deadline - 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.
$sel:hITId:Assignment', assignment_hITId - The ID of the HIT.
$sel:rejectionTime:Assignment', assignment_rejectionTime - If the Worker has submitted results and the Requester has rejected the
results, RejectionTime is the date and time the Requester rejected the
results.
$sel:requesterFeedback:Assignment', assignment_requesterFeedback - 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.
$sel:submitTime:Assignment', assignment_submitTime - 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.
$sel:workerId:Assignment', assignment_workerId - The ID of the Worker who accepted the HIT.
assignment_acceptTime :: Lens' Assignment (Maybe UTCTime) Source #
The date and time the Worker accepted the assignment.
assignment_answer :: Lens' Assignment (Maybe Text) Source #
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) Source #
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) Source #
A unique identifier for the assignment.
assignment_assignmentStatus :: Lens' Assignment (Maybe AssignmentStatus) Source #
The status of the assignment.
assignment_autoApprovalTime :: Lens' Assignment (Maybe UTCTime) Source #
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) Source #
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) Source #
The ID of the HIT.
assignment_rejectionTime :: Lens' Assignment (Maybe UTCTime) Source #
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) Source #
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) Source #
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) Source #
The ID of the Worker who accepted the HIT.
BonusPayment
data BonusPayment Source #
An object representing a Bonus payment paid to a Worker.
See: newBonusPayment smart constructor.
Constructors
| BonusPayment' | |
Fields
| |
Instances
newBonusPayment :: BonusPayment Source #
Create a value of BonusPayment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignmentId:BonusPayment', bonusPayment_assignmentId - The ID of the assignment associated with this bonus payment.
$sel:bonusAmount:BonusPayment', bonusPayment_bonusAmount - Undocumented member.
$sel:grantTime:BonusPayment', bonusPayment_grantTime - The date and time of when the bonus was granted.
$sel:reason:BonusPayment', bonusPayment_reason - The Reason text given when the bonus was granted, if any.
$sel:workerId:BonusPayment', bonusPayment_workerId - The ID of the Worker to whom the bonus was paid.
bonusPayment_assignmentId :: Lens' BonusPayment (Maybe Text) Source #
The ID of the assignment associated with this bonus payment.
bonusPayment_bonusAmount :: Lens' BonusPayment (Maybe Text) Source #
Undocumented member.
bonusPayment_grantTime :: Lens' BonusPayment (Maybe UTCTime) Source #
The date and time of when the bonus was granted.
bonusPayment_reason :: Lens' BonusPayment (Maybe Text) Source #
The Reason text given when the bonus was granted, if any.
bonusPayment_workerId :: Lens' BonusPayment (Maybe Text) Source #
The ID of the Worker to whom the bonus was paid.
HIT
The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.
See: newHIT smart constructor.
Constructors
| HIT' | |
Fields
| |
Instances
Create a value of HIT with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignmentDurationInSeconds:HIT', hit_assignmentDurationInSeconds - The length of time, in seconds, that a Worker has to complete the HIT
after accepting it.
$sel:autoApprovalDelayInSeconds:HIT', hit_autoApprovalDelayInSeconds - 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.
$sel:creationTime:HIT', hit_creationTime - The date and time the HIT was created.
$sel:description:HIT', hit_description - A general description of the HIT.
$sel:expiration:HIT', hit_expiration - The date and time the HIT expires.
$sel:hITGroupId:HIT', hit_hITGroupId - The ID of the HIT Group of this HIT.
$sel:hITId:HIT', hit_hITId - A unique identifier for the HIT.
$sel:hITLayoutId:HIT', hit_hITLayoutId - The ID of the HIT Layout of this HIT.
$sel:hITReviewStatus:HIT', hit_hITReviewStatus - Indicates the review status of the HIT. Valid Values are NotReviewed |
MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
$sel:hITStatus:HIT', hit_hITStatus - The status of the HIT and its assignments. Valid Values are Assignable |
Unassignable | Reviewable | Reviewing | Disposed.
$sel:hITTypeId:HIT', hit_hITTypeId - The ID of the HIT type of this HIT
$sel:keywords:HIT', hit_keywords - 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.
$sel:maxAssignments:HIT', hit_maxAssignments - The number of times the HIT can be accepted and completed before the HIT
becomes unavailable.
$sel:numberOfAssignmentsAvailable:HIT', hit_numberOfAssignmentsAvailable - The number of assignments for this HIT that are available for Workers to
accept.
$sel:numberOfAssignmentsCompleted:HIT', hit_numberOfAssignmentsCompleted - The number of assignments for this HIT that have been approved or
rejected.
$sel:numberOfAssignmentsPending:HIT', hit_numberOfAssignmentsPending - 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.
$sel:qualificationRequirements:HIT', hit_qualificationRequirements - 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.
$sel:question:HIT', hit_question - The data the Worker completing the HIT uses produce the results. This is
either either a QuestionForm, HTMLQuestion or an ExternalQuestion data
structure.
$sel:requesterAnnotation:HIT', hit_requesterAnnotation - An arbitrary data field the Requester who created the HIT can use. This
field is visible only to the creator of the HIT.
$sel:reward:HIT', hit_reward - Undocumented member.
$sel:title:HIT', hit_title - The title of the HIT.
hit_assignmentDurationInSeconds :: Lens' HIT (Maybe Integer) Source #
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
hit_autoApprovalDelayInSeconds :: Lens' HIT (Maybe Integer) Source #
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_hITReviewStatus :: Lens' HIT (Maybe HITReviewStatus) Source #
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
hit_hITStatus :: Lens' HIT (Maybe HITStatus) Source #
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
hit_keywords :: Lens' HIT (Maybe Text) Source #
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) Source #
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
hit_numberOfAssignmentsAvailable :: Lens' HIT (Maybe Int) Source #
The number of assignments for this HIT that are available for Workers to accept.
hit_numberOfAssignmentsCompleted :: Lens' HIT (Maybe Int) Source #
The number of assignments for this HIT that have been approved or rejected.
hit_numberOfAssignmentsPending :: Lens' HIT (Maybe Int) Source #
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]) Source #
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) Source #
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) Source #
An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.
HITLayoutParameter
data HITLayoutParameter Source #
The HITLayoutParameter data structure defines parameter values used with a HITLayout. A HITLayout is a reusable Amazon Mechanical Turk project template used to provide Human Intelligence Task (HIT) question data for CreateHIT.
See: newHITLayoutParameter smart constructor.
Constructors
| HITLayoutParameter' | |
Instances
newHITLayoutParameter Source #
Arguments
| :: Text | |
| -> Text | |
| -> HITLayoutParameter |
Create a value of HITLayoutParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:HITLayoutParameter', hITLayoutParameter_name - The name of the parameter in the HITLayout.
$sel:value:HITLayoutParameter', hITLayoutParameter_value - The value substituted for the parameter referenced in the HITLayout.
hITLayoutParameter_name :: Lens' HITLayoutParameter Text Source #
The name of the parameter in the HITLayout.
hITLayoutParameter_value :: Lens' HITLayoutParameter Text Source #
The value substituted for the parameter referenced in the HITLayout.
Locale
The Locale data structure represents a geographical region or location.
See: newLocale smart constructor.
Constructors
| Locale' | |
Fields
| |
Instances
| FromJSON Locale Source # | |
| ToJSON Locale Source # | |
Defined in Amazonka.MechanicalTurk.Types.Locale | |
| Generic Locale Source # | |
| Read Locale Source # | |
| Show Locale Source # | |
| NFData Locale Source # | |
Defined in Amazonka.MechanicalTurk.Types.Locale | |
| Eq Locale Source # | |
| Hashable Locale Source # | |
Defined in Amazonka.MechanicalTurk.Types.Locale | |
| type Rep Locale Source # | |
Defined in Amazonka.MechanicalTurk.Types.Locale type Rep Locale = D1 ('MetaData "Locale" "Amazonka.MechanicalTurk.Types.Locale" "amazonka-mechanicalturk-2.0-7Thix2UjvlJINPIH68shk3" 'False) (C1 ('MetaCons "Locale'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subdivision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Locale with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subdivision:Locale', locale_subdivision - 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.
$sel:country:Locale', locale_country - 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.
locale_subdivision :: Lens' Locale (Maybe Text) Source #
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 Source #
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
data NotificationSpecification Source #
The NotificationSpecification data structure describes a HIT event notification for a HIT type.
See: newNotificationSpecification smart constructor.
Constructors
| NotificationSpecification' | |
Fields
| |
Instances
newNotificationSpecification Source #
Arguments
| :: Text | |
| -> NotificationTransport | |
| -> Text | |
| -> NotificationSpecification |
Create a value of NotificationSpecification with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destination:NotificationSpecification', notificationSpecification_destination - 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.
$sel:transport:NotificationSpecification', notificationSpecification_transport - The method Amazon Mechanical Turk uses to send the notification. Valid
Values: Email | SQS | SNS.
$sel:version:NotificationSpecification', notificationSpecification_version - The version of the Notification API to use. Valid value is 2006-05-05.
$sel:eventTypes:NotificationSpecification', notificationSpecification_eventTypes - 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.
notificationSpecification_destination :: Lens' NotificationSpecification Text Source #
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 Source #
The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
notificationSpecification_version :: Lens' NotificationSpecification Text Source #
The version of the Notification API to use. Valid value is 2006-05-05.
notificationSpecification_eventTypes :: Lens' NotificationSpecification [EventType] Source #
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
data NotifyWorkersFailureStatus Source #
When MTurk encounters an issue with notifying the Workers you specified, it returns back this object with failure details.
See: newNotifyWorkersFailureStatus smart constructor.
Constructors
| NotifyWorkersFailureStatus' | |
Fields
| |
Instances
newNotifyWorkersFailureStatus :: NotifyWorkersFailureStatus Source #
Create a value of NotifyWorkersFailureStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notifyWorkersFailureCode:NotifyWorkersFailureStatus', notifyWorkersFailureStatus_notifyWorkersFailureCode - Encoded value for the failure type.
$sel:notifyWorkersFailureMessage:NotifyWorkersFailureStatus', notifyWorkersFailureStatus_notifyWorkersFailureMessage - A message detailing the reason the Worker could not be notified.
$sel:workerId:NotifyWorkersFailureStatus', notifyWorkersFailureStatus_workerId - The ID of the Worker.
notifyWorkersFailureStatus_notifyWorkersFailureCode :: Lens' NotifyWorkersFailureStatus (Maybe NotifyWorkersFailureCode) Source #
Encoded value for the failure type.
notifyWorkersFailureStatus_notifyWorkersFailureMessage :: Lens' NotifyWorkersFailureStatus (Maybe Text) Source #
A message detailing the reason the Worker could not be notified.
notifyWorkersFailureStatus_workerId :: Lens' NotifyWorkersFailureStatus (Maybe Text) Source #
The ID of the Worker.
ParameterMapEntry
data ParameterMapEntry Source #
This data structure is the data type for the AnswerKey parameter of the ScoreMyKnownAnswers/2011-09-01 Review Policy.
See: newParameterMapEntry smart constructor.
Constructors
| ParameterMapEntry' | |
Fields
| |
Instances
newParameterMapEntry :: ParameterMapEntry Source #
Create a value of ParameterMapEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:ParameterMapEntry', parameterMapEntry_key - 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.
$sel:values:ParameterMapEntry', parameterMapEntry_values - 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.
parameterMapEntry_key :: Lens' ParameterMapEntry (Maybe Text) Source #
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]) Source #
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
data PolicyParameter Source #
Name of the parameter from the Review policy.
See: newPolicyParameter smart constructor.
Constructors
| PolicyParameter' | |
Fields
| |
Instances
newPolicyParameter :: PolicyParameter Source #
Create a value of PolicyParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PolicyParameter, policyParameter_key - Name of the parameter from the list of Review Polices.
$sel:mapEntries:PolicyParameter', policyParameter_mapEntries - List of ParameterMapEntry objects.
PolicyParameter, policyParameter_values - The list of values of the Parameter
policyParameter_key :: Lens' PolicyParameter (Maybe Text) Source #
Name of the parameter from the list of Review Polices.
policyParameter_mapEntries :: Lens' PolicyParameter (Maybe [ParameterMapEntry]) Source #
List of ParameterMapEntry objects.
policyParameter_values :: Lens' PolicyParameter (Maybe [Text]) Source #
The list of values of the Parameter
Qualification
data Qualification Source #
The Qualification data structure represents a Qualification assigned to a user, including the Qualification type and the value (score).
See: newQualification smart constructor.
Constructors
| Qualification' | |
Fields
| |
Instances
newQualification :: Qualification Source #
Create a value of Qualification with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:grantTime:Qualification', qualification_grantTime - 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.
$sel:integerValue:Qualification', qualification_integerValue - The value (score) of the Qualification, if the Qualification has an
integer value.
$sel:localeValue:Qualification', qualification_localeValue - Undocumented member.
$sel:qualificationTypeId:Qualification', qualification_qualificationTypeId - The ID of the Qualification type for the Qualification.
$sel:status:Qualification', qualification_status - The status of the Qualification. Valid values are Granted | Revoked.
$sel:workerId:Qualification', qualification_workerId - The ID of the Worker who possesses the Qualification.
qualification_grantTime :: Lens' Qualification (Maybe UTCTime) Source #
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) Source #
The value (score) of the Qualification, if the Qualification has an integer value.
qualification_localeValue :: Lens' Qualification (Maybe Locale) Source #
Undocumented member.
qualification_qualificationTypeId :: Lens' Qualification (Maybe Text) Source #
The ID of the Qualification type for the Qualification.
qualification_status :: Lens' Qualification (Maybe QualificationStatus) Source #
The status of the Qualification. Valid values are Granted | Revoked.
qualification_workerId :: Lens' Qualification (Maybe Text) Source #
The ID of the Worker who possesses the Qualification.
QualificationRequest
data QualificationRequest Source #
The QualificationRequest data structure represents a request a Worker has made for a Qualification.
See: newQualificationRequest smart constructor.
Constructors
| QualificationRequest' | |
Fields
| |
Instances
newQualificationRequest :: QualificationRequest Source #
Create a value of QualificationRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:answer:QualificationRequest', qualificationRequest_answer - 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.
$sel:qualificationRequestId:QualificationRequest', qualificationRequest_qualificationRequestId - The ID of the Qualification request, a unique identifier generated when
the request was submitted.
$sel:qualificationTypeId:QualificationRequest', qualificationRequest_qualificationTypeId - The ID of the Qualification type the Worker is requesting, as returned
by the CreateQualificationType operation.
$sel:submitTime:QualificationRequest', qualificationRequest_submitTime - 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.
$sel:test:QualificationRequest', qualificationRequest_test - 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.
$sel:workerId:QualificationRequest', qualificationRequest_workerId - The ID of the Worker requesting the Qualification.
qualificationRequest_answer :: Lens' QualificationRequest (Maybe Text) Source #
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) Source #
The ID of the Qualification request, a unique identifier generated when the request was submitted.
qualificationRequest_qualificationTypeId :: Lens' QualificationRequest (Maybe Text) Source #
The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation.
qualificationRequest_submitTime :: Lens' QualificationRequest (Maybe UTCTime) Source #
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) Source #
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) Source #
The ID of the Worker requesting the Qualification.
QualificationRequirement
data QualificationRequirement Source #
The QualificationRequirement data structure describes a Qualification that a Worker must have before the Worker is allowed to accept a HIT. A requirement may optionally state that a Worker must have the Qualification in order to preview the HIT, or see the HIT in search results.
See: newQualificationRequirement smart constructor.
Constructors
| QualificationRequirement' | |
Fields
| |
Instances
newQualificationRequirement Source #
Arguments
| :: Text | |
| -> Comparator | |
| -> QualificationRequirement |
Create a value of QualificationRequirement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionsGuarded:QualificationRequirement', qualificationRequirement_actionsGuarded - 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.
$sel:integerValues:QualificationRequirement', qualificationRequirement_integerValues - 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.
$sel:localeValues:QualificationRequirement', qualificationRequirement_localeValues - 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.
$sel:requiredToPreview:QualificationRequirement', qualificationRequirement_requiredToPreview - 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.
$sel:qualificationTypeId:QualificationRequirement', qualificationRequirement_qualificationTypeId - The ID of the Qualification type for the requirement.
$sel:comparator:QualificationRequirement', 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.
qualificationRequirement_actionsGuarded :: Lens' QualificationRequirement (Maybe HITAccessActions) Source #
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]) Source #
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]) Source #
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) Source #
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 Source #
The ID of the Qualification type for the requirement.
qualificationRequirement_comparator :: Lens' QualificationRequirement Comparator Source #
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
data QualificationType Source #
The QualificationType data structure represents a Qualification type, a description of a property of a Worker that must match the requirements of a HIT for the Worker to be able to accept the HIT. The type also describes how a Worker can obtain a Qualification of that type, such as through a Qualification test.
See: newQualificationType smart constructor.
Constructors
| QualificationType' | |
Fields
| |
Instances
newQualificationType :: QualificationType Source #
Create a value of QualificationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:answerKey:QualificationType', qualificationType_answerKey - The answers to the Qualification test specified in the Test parameter.
$sel:autoGranted:QualificationType', qualificationType_autoGranted - Specifies that requests for the Qualification type are granted
immediately, without prompting the Worker with a Qualification test.
Valid values are True | False.
$sel:autoGrantedValue:QualificationType', qualificationType_autoGrantedValue - The Qualification integer value to use for automatically granted
Qualifications, if AutoGranted is true. This is 1 by default.
$sel:creationTime:QualificationType', qualificationType_creationTime - The date and time the Qualification type was created.
$sel:description:QualificationType', qualificationType_description - A long description for the Qualification type.
$sel:isRequestable:QualificationType', qualificationType_isRequestable - 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.
$sel:keywords:QualificationType', qualificationType_keywords - One or more words or phrases that describe theQualification type,
separated by commas. The Keywords make the type easier to find using a
search.
$sel:name:QualificationType', qualificationType_name - 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.
$sel:qualificationTypeId:QualificationType', qualificationType_qualificationTypeId - A unique identifier for the Qualification type. A Qualification type is
given a Qualification type ID when you call the CreateQualificationType
operation.
$sel:qualificationTypeStatus:QualificationType', qualificationType_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.
$sel:retryDelayInSeconds:QualificationType', qualificationType_retryDelayInSeconds - 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.
$sel:test:QualificationType', qualificationType_test - 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.
$sel:testDurationInSeconds:QualificationType', qualificationType_testDurationInSeconds - The amount of time, in seconds, given to a Worker to complete the
Qualification test, beginning from the time the Worker requests the
Qualification.
qualificationType_answerKey :: Lens' QualificationType (Maybe Text) Source #
The answers to the Qualification test specified in the Test parameter.
qualificationType_autoGranted :: Lens' QualificationType (Maybe Bool) Source #
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) Source #
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) Source #
The date and time the Qualification type was created.
qualificationType_description :: Lens' QualificationType (Maybe Text) Source #
A long description for the Qualification type.
qualificationType_isRequestable :: Lens' QualificationType (Maybe Bool) Source #
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) Source #
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) Source #
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) Source #
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) Source #
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) Source #
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) Source #
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) Source #
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
data ReviewActionDetail Source #
Both the AssignmentReviewReport and the HITReviewReport elements contains the ReviewActionDetail data structure. This structure is returned multiple times for each action specified in the Review Policy.
See: newReviewActionDetail smart constructor.
Constructors
| ReviewActionDetail' | |
Fields
| |
Instances
newReviewActionDetail :: ReviewActionDetail Source #
Create a value of ReviewActionDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionId:ReviewActionDetail', reviewActionDetail_actionId - The unique identifier for the action.
$sel:actionName:ReviewActionDetail', reviewActionDetail_actionName - 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.
$sel:completeTime:ReviewActionDetail', reviewActionDetail_completeTime - The date when the action was completed.
$sel:errorCode:ReviewActionDetail', reviewActionDetail_errorCode - Present only when the Results have a FAILED Status.
$sel:result:ReviewActionDetail', reviewActionDetail_result - A description of the outcome of the review.
$sel:status:ReviewActionDetail', reviewActionDetail_status - The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or
CANCELLED.
$sel:targetId:ReviewActionDetail', reviewActionDetail_targetId - The specific HITId or AssignmentID targeted by the action.
$sel:targetType:ReviewActionDetail', reviewActionDetail_targetType - The type of object in TargetId.
reviewActionDetail_actionId :: Lens' ReviewActionDetail (Maybe Text) Source #
The unique identifier for the action.
reviewActionDetail_actionName :: Lens' ReviewActionDetail (Maybe Text) Source #
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) Source #
The date when the action was completed.
reviewActionDetail_errorCode :: Lens' ReviewActionDetail (Maybe Text) Source #
Present only when the Results have a FAILED Status.
reviewActionDetail_result :: Lens' ReviewActionDetail (Maybe Text) Source #
A description of the outcome of the review.
reviewActionDetail_status :: Lens' ReviewActionDetail (Maybe ReviewActionStatus) Source #
The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.
reviewActionDetail_targetId :: Lens' ReviewActionDetail (Maybe Text) Source #
The specific HITId or AssignmentID targeted by the action.
reviewActionDetail_targetType :: Lens' ReviewActionDetail (Maybe Text) Source #
The type of object in TargetId.
ReviewPolicy
data ReviewPolicy Source #
HIT Review Policy data structures represent HIT review policies, which you specify when you create a HIT.
See: newReviewPolicy smart constructor.
Constructors
| ReviewPolicy' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ReviewPolicy |
Create a value of ReviewPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameters:ReviewPolicy', reviewPolicy_parameters - Name of the parameter from the Review policy.
$sel:policyName:ReviewPolicy', reviewPolicy_policyName - Name of a Review Policy: SimplePlurality/2011-09-01 or
ScoreMyKnownAnswers/2011-09-01
reviewPolicy_parameters :: Lens' ReviewPolicy (Maybe [PolicyParameter]) Source #
Name of the parameter from the Review policy.
reviewPolicy_policyName :: Lens' ReviewPolicy Text Source #
Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01
ReviewReport
data ReviewReport Source #
Contains both ReviewResult and ReviewAction elements for a particular HIT.
See: newReviewReport smart constructor.
Constructors
| ReviewReport' | |
Fields
| |
Instances
newReviewReport :: ReviewReport Source #
Create a value of ReviewReport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reviewActions:ReviewReport', reviewReport_reviewActions - A list of ReviewAction objects for each action specified in the Review
Policy.
$sel:reviewResults:ReviewReport', reviewReport_reviewResults - A list of ReviewResults objects for each action specified in the Review
Policy.
reviewReport_reviewActions :: Lens' ReviewReport (Maybe [ReviewActionDetail]) Source #
A list of ReviewAction objects for each action specified in the Review Policy.
reviewReport_reviewResults :: Lens' ReviewReport (Maybe [ReviewResultDetail]) Source #
A list of ReviewResults objects for each action specified in the Review Policy.
ReviewResultDetail
data ReviewResultDetail Source #
This data structure is returned multiple times for each result specified in the Review Policy.
See: newReviewResultDetail smart constructor.
Constructors
| ReviewResultDetail' | |
Fields
| |
Instances
newReviewResultDetail :: ReviewResultDetail Source #
Create a value of ReviewResultDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionId:ReviewResultDetail', reviewResultDetail_actionId - A unique identifier of the Review action result.
$sel:key:ReviewResultDetail', reviewResultDetail_key - Key identifies the particular piece of reviewed information.
$sel:questionId:ReviewResultDetail', reviewResultDetail_questionId - 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.
$sel:subjectId:ReviewResultDetail', reviewResultDetail_subjectId - 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.
$sel:subjectType:ReviewResultDetail', reviewResultDetail_subjectType - The type of the object from the SubjectId field.
$sel:value:ReviewResultDetail', reviewResultDetail_value - The values of Key provided by the review policies you have selected.
reviewResultDetail_actionId :: Lens' ReviewResultDetail (Maybe Text) Source #
A unique identifier of the Review action result.
reviewResultDetail_key :: Lens' ReviewResultDetail (Maybe Text) Source #
Key identifies the particular piece of reviewed information.
reviewResultDetail_questionId :: Lens' ReviewResultDetail (Maybe Text) Source #
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) Source #
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) Source #
The type of the object from the SubjectId field.
reviewResultDetail_value :: Lens' ReviewResultDetail (Maybe Text) Source #
The values of Key provided by the review policies you have selected.
WorkerBlock
data WorkerBlock Source #
The WorkerBlock data structure represents a Worker who has been blocked. It has two elements: the WorkerId and the Reason for the block.
See: newWorkerBlock smart constructor.
Constructors
| WorkerBlock' | |
Instances
newWorkerBlock :: WorkerBlock Source #
Create a value of WorkerBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reason:WorkerBlock', workerBlock_reason - A message explaining the reason the Worker was blocked.
$sel:workerId:WorkerBlock', workerBlock_workerId - The ID of the Worker who accepted the HIT.
workerBlock_reason :: Lens' WorkerBlock (Maybe Text) Source #
A message explaining the reason the Worker was blocked.
workerBlock_workerId :: Lens' WorkerBlock (Maybe Text) Source #
The ID of the Worker who accepted the HIT.