Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- Waiters
- Operations
- ApproveAssignment
- ListReviewPolicyResultsForHIT
- ListHITs (Paginated)
- ListWorkersWithQualificationType (Paginated)
- DeleteHIT
- ListReviewableHITs (Paginated)
- GetAssignment
- DeleteQualificationType
- UpdateQualificationType
- ListQualificationTypes (Paginated)
- UpdateHITTypeOfHIT
- DisassociateQualificationFromWorker
- SendTestEventNotification
- NotifyWorkers
- CreateHITWithHITType
- CreateHITType
- SendBonus
- ListQualificationRequests (Paginated)
- UpdateExpirationForHIT
- RejectAssignment
- ListAssignmentsForHIT (Paginated)
- RejectQualificationRequest
- GetQualificationScore
- GetQualificationType
- UpdateHITReviewStatus
- CreateQualificationType
- AcceptQualificationRequest
- GetFileUploadURL
- CreateAdditionalAssignmentsForHIT
- GetHIT
- CreateWorkerBlock
- ListHITsForQualificationType (Paginated)
- ListBonusPayments (Paginated)
- ListWorkerBlocks (Paginated)
- DeleteWorkerBlock
- UpdateNotificationSettings
- AssociateQualificationWithWorker
- CreateHIT
- GetAccountBalance
- Types
- 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
Derived from API version 2017-01-17
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Mechanical Turk API Reference
Synopsis
- defaultService :: Service
- _ServiceFault :: AsError a => Getting (First ServiceError) a ServiceError
- _RequestError :: AsError a => Getting (First ServiceError) a ServiceError
- data ApproveAssignment = ApproveAssignment' (Maybe Bool) (Maybe Text) Text
- newApproveAssignment :: Text -> ApproveAssignment
- data ApproveAssignmentResponse = ApproveAssignmentResponse' Int
- newApproveAssignmentResponse :: Int -> ApproveAssignmentResponse
- data ListReviewPolicyResultsForHIT = ListReviewPolicyResultsForHIT' (Maybe Bool) (Maybe [ReviewPolicyLevel]) (Maybe Bool) (Maybe Text) (Maybe Natural) Text
- newListReviewPolicyResultsForHIT :: Text -> ListReviewPolicyResultsForHIT
- data ListReviewPolicyResultsForHITResponse = ListReviewPolicyResultsForHITResponse' (Maybe ReviewPolicy) (Maybe ReviewReport) (Maybe Text) (Maybe ReviewReport) (Maybe Text) (Maybe ReviewPolicy) Int
- newListReviewPolicyResultsForHITResponse :: Int -> ListReviewPolicyResultsForHITResponse
- data ListHITs = ListHITs' (Maybe Text) (Maybe Natural)
- newListHITs :: ListHITs
- data ListHITsResponse = ListHITsResponse' (Maybe Text) (Maybe Int) (Maybe [HIT]) Int
- newListHITsResponse :: Int -> ListHITsResponse
- data ListWorkersWithQualificationType = ListWorkersWithQualificationType' (Maybe QualificationStatus) (Maybe Text) (Maybe Natural) Text
- newListWorkersWithQualificationType :: Text -> ListWorkersWithQualificationType
- data ListWorkersWithQualificationTypeResponse = ListWorkersWithQualificationTypeResponse' (Maybe Text) (Maybe Int) (Maybe [Qualification]) Int
- newListWorkersWithQualificationTypeResponse :: Int -> ListWorkersWithQualificationTypeResponse
- data DeleteHIT = DeleteHIT' Text
- newDeleteHIT :: Text -> DeleteHIT
- data DeleteHITResponse = DeleteHITResponse' Int
- newDeleteHITResponse :: Int -> DeleteHITResponse
- data ListReviewableHITs = ListReviewableHITs' (Maybe ReviewableHITStatus) (Maybe Text) (Maybe Text) (Maybe Natural)
- newListReviewableHITs :: ListReviewableHITs
- data ListReviewableHITsResponse = ListReviewableHITsResponse' (Maybe Text) (Maybe Int) (Maybe [HIT]) Int
- newListReviewableHITsResponse :: Int -> ListReviewableHITsResponse
- data GetAssignment = GetAssignment' Text
- newGetAssignment :: Text -> GetAssignment
- data GetAssignmentResponse = GetAssignmentResponse' (Maybe HIT) (Maybe Assignment) Int
- newGetAssignmentResponse :: Int -> GetAssignmentResponse
- data DeleteQualificationType = DeleteQualificationType' Text
- newDeleteQualificationType :: Text -> DeleteQualificationType
- data DeleteQualificationTypeResponse = DeleteQualificationTypeResponse' Int
- newDeleteQualificationTypeResponse :: Int -> DeleteQualificationTypeResponse
- data UpdateQualificationType = UpdateQualificationType' (Maybe Integer) (Maybe QualificationTypeStatus) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Integer) Text
- newUpdateQualificationType :: Text -> UpdateQualificationType
- data UpdateQualificationTypeResponse = UpdateQualificationTypeResponse' (Maybe QualificationType) Int
- newUpdateQualificationTypeResponse :: Int -> UpdateQualificationTypeResponse
- data ListQualificationTypes = ListQualificationTypes' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Natural) Bool
- newListQualificationTypes :: Bool -> ListQualificationTypes
- data ListQualificationTypesResponse = ListQualificationTypesResponse' (Maybe [QualificationType]) (Maybe Text) (Maybe Int) Int
- newListQualificationTypesResponse :: Int -> ListQualificationTypesResponse
- data UpdateHITTypeOfHIT = UpdateHITTypeOfHIT' Text Text
- newUpdateHITTypeOfHIT :: Text -> Text -> UpdateHITTypeOfHIT
- data UpdateHITTypeOfHITResponse = UpdateHITTypeOfHITResponse' Int
- newUpdateHITTypeOfHITResponse :: Int -> UpdateHITTypeOfHITResponse
- data DisassociateQualificationFromWorker = DisassociateQualificationFromWorker' (Maybe Text) Text Text
- newDisassociateQualificationFromWorker :: Text -> Text -> DisassociateQualificationFromWorker
- data DisassociateQualificationFromWorkerResponse = DisassociateQualificationFromWorkerResponse' Int
- newDisassociateQualificationFromWorkerResponse :: Int -> DisassociateQualificationFromWorkerResponse
- data SendTestEventNotification = SendTestEventNotification' NotificationSpecification EventType
- newSendTestEventNotification :: NotificationSpecification -> EventType -> SendTestEventNotification
- data SendTestEventNotificationResponse = SendTestEventNotificationResponse' Int
- newSendTestEventNotificationResponse :: Int -> SendTestEventNotificationResponse
- data NotifyWorkers = NotifyWorkers' Text Text [Text]
- newNotifyWorkers :: Text -> Text -> NotifyWorkers
- data NotifyWorkersResponse = NotifyWorkersResponse' (Maybe [NotifyWorkersFailureStatus]) Int
- newNotifyWorkersResponse :: Int -> NotifyWorkersResponse
- data CreateHITWithHITType = CreateHITWithHITType' (Maybe ReviewPolicy) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [HITLayoutParameter]) (Maybe Text) (Maybe ReviewPolicy) Text Integer
- newCreateHITWithHITType :: Text -> Integer -> CreateHITWithHITType
- data CreateHITWithHITTypeResponse = CreateHITWithHITTypeResponse' (Maybe HIT) Int
- newCreateHITWithHITTypeResponse :: Int -> CreateHITWithHITTypeResponse
- data CreateHITType = CreateHITType' (Maybe Integer) (Maybe Text) (Maybe [QualificationRequirement]) Integer Text Text Text
- newCreateHITType :: Integer -> Text -> Text -> Text -> CreateHITType
- data CreateHITTypeResponse = CreateHITTypeResponse' (Maybe Text) Int
- newCreateHITTypeResponse :: Int -> CreateHITTypeResponse
- data SendBonus = SendBonus' (Maybe Text) Text Text Text Text
- newSendBonus :: Text -> Text -> Text -> Text -> SendBonus
- data SendBonusResponse = SendBonusResponse' Int
- newSendBonusResponse :: Int -> SendBonusResponse
- data ListQualificationRequests = ListQualificationRequests' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListQualificationRequests :: ListQualificationRequests
- data ListQualificationRequestsResponse = ListQualificationRequestsResponse' (Maybe [QualificationRequest]) (Maybe Text) (Maybe Int) Int
- newListQualificationRequestsResponse :: Int -> ListQualificationRequestsResponse
- data UpdateExpirationForHIT = UpdateExpirationForHIT' Text POSIX
- newUpdateExpirationForHIT :: Text -> UTCTime -> UpdateExpirationForHIT
- data UpdateExpirationForHITResponse = UpdateExpirationForHITResponse' Int
- newUpdateExpirationForHITResponse :: Int -> UpdateExpirationForHITResponse
- data RejectAssignment = RejectAssignment' Text Text
- newRejectAssignment :: Text -> Text -> RejectAssignment
- data RejectAssignmentResponse = RejectAssignmentResponse' Int
- newRejectAssignmentResponse :: Int -> RejectAssignmentResponse
- data ListAssignmentsForHIT = ListAssignmentsForHIT' (Maybe [AssignmentStatus]) (Maybe Text) (Maybe Natural) Text
- newListAssignmentsForHIT :: Text -> ListAssignmentsForHIT
- data ListAssignmentsForHITResponse = ListAssignmentsForHITResponse' (Maybe Text) (Maybe Int) (Maybe [Assignment]) Int
- newListAssignmentsForHITResponse :: Int -> ListAssignmentsForHITResponse
- data RejectQualificationRequest = RejectQualificationRequest' (Maybe Text) Text
- newRejectQualificationRequest :: Text -> RejectQualificationRequest
- data RejectQualificationRequestResponse = RejectQualificationRequestResponse' Int
- newRejectQualificationRequestResponse :: Int -> RejectQualificationRequestResponse
- data GetQualificationScore = GetQualificationScore' Text Text
- newGetQualificationScore :: Text -> Text -> GetQualificationScore
- data GetQualificationScoreResponse = GetQualificationScoreResponse' (Maybe Qualification) Int
- newGetQualificationScoreResponse :: Int -> GetQualificationScoreResponse
- data GetQualificationType = GetQualificationType' Text
- newGetQualificationType :: Text -> GetQualificationType
- data GetQualificationTypeResponse = GetQualificationTypeResponse' (Maybe QualificationType) Int
- newGetQualificationTypeResponse :: Int -> GetQualificationTypeResponse
- data UpdateHITReviewStatus = UpdateHITReviewStatus' (Maybe Bool) Text
- newUpdateHITReviewStatus :: Text -> UpdateHITReviewStatus
- data UpdateHITReviewStatusResponse = UpdateHITReviewStatusResponse' Int
- newUpdateHITReviewStatusResponse :: Int -> UpdateHITReviewStatusResponse
- data CreateQualificationType = CreateQualificationType' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Integer) Text Text QualificationTypeStatus
- newCreateQualificationType :: Text -> Text -> QualificationTypeStatus -> CreateQualificationType
- data CreateQualificationTypeResponse = CreateQualificationTypeResponse' (Maybe QualificationType) Int
- newCreateQualificationTypeResponse :: Int -> CreateQualificationTypeResponse
- data AcceptQualificationRequest = AcceptQualificationRequest' (Maybe Int) Text
- newAcceptQualificationRequest :: Text -> AcceptQualificationRequest
- data AcceptQualificationRequestResponse = AcceptQualificationRequestResponse' Int
- newAcceptQualificationRequestResponse :: Int -> AcceptQualificationRequestResponse
- data GetFileUploadURL = GetFileUploadURL' Text Text
- newGetFileUploadURL :: Text -> Text -> GetFileUploadURL
- data GetFileUploadURLResponse = GetFileUploadURLResponse' (Maybe Text) Int
- newGetFileUploadURLResponse :: Int -> GetFileUploadURLResponse
- data CreateAdditionalAssignmentsForHIT = CreateAdditionalAssignmentsForHIT' (Maybe Text) Text Int
- newCreateAdditionalAssignmentsForHIT :: Text -> Int -> CreateAdditionalAssignmentsForHIT
- data CreateAdditionalAssignmentsForHITResponse = CreateAdditionalAssignmentsForHITResponse' Int
- newCreateAdditionalAssignmentsForHITResponse :: Int -> CreateAdditionalAssignmentsForHITResponse
- data GetHIT = GetHIT' Text
- newGetHIT :: Text -> GetHIT
- data GetHITResponse = GetHITResponse' (Maybe HIT) Int
- newGetHITResponse :: Int -> GetHITResponse
- data CreateWorkerBlock = CreateWorkerBlock' Text Text
- newCreateWorkerBlock :: Text -> Text -> CreateWorkerBlock
- data CreateWorkerBlockResponse = CreateWorkerBlockResponse' Int
- newCreateWorkerBlockResponse :: Int -> CreateWorkerBlockResponse
- data ListHITsForQualificationType = ListHITsForQualificationType' (Maybe Text) (Maybe Natural) Text
- newListHITsForQualificationType :: Text -> ListHITsForQualificationType
- data ListHITsForQualificationTypeResponse = ListHITsForQualificationTypeResponse' (Maybe Text) (Maybe Int) (Maybe [HIT]) Int
- newListHITsForQualificationTypeResponse :: Int -> ListHITsForQualificationTypeResponse
- data ListBonusPayments = ListBonusPayments' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural)
- newListBonusPayments :: ListBonusPayments
- data ListBonusPaymentsResponse = ListBonusPaymentsResponse' (Maybe [BonusPayment]) (Maybe Text) (Maybe Int) Int
- newListBonusPaymentsResponse :: Int -> ListBonusPaymentsResponse
- data ListWorkerBlocks = ListWorkerBlocks' (Maybe Text) (Maybe Natural)
- newListWorkerBlocks :: ListWorkerBlocks
- data ListWorkerBlocksResponse = ListWorkerBlocksResponse' (Maybe [WorkerBlock]) (Maybe Text) (Maybe Int) Int
- newListWorkerBlocksResponse :: Int -> ListWorkerBlocksResponse
- data DeleteWorkerBlock = DeleteWorkerBlock' (Maybe Text) Text
- newDeleteWorkerBlock :: Text -> DeleteWorkerBlock
- data DeleteWorkerBlockResponse = DeleteWorkerBlockResponse' Int
- newDeleteWorkerBlockResponse :: Int -> DeleteWorkerBlockResponse
- data UpdateNotificationSettings = UpdateNotificationSettings' (Maybe NotificationSpecification) (Maybe Bool) Text
- newUpdateNotificationSettings :: Text -> UpdateNotificationSettings
- data UpdateNotificationSettingsResponse = UpdateNotificationSettingsResponse' Int
- newUpdateNotificationSettingsResponse :: Int -> UpdateNotificationSettingsResponse
- data AssociateQualificationWithWorker = AssociateQualificationWithWorker' (Maybe Int) (Maybe Bool) Text Text
- newAssociateQualificationWithWorker :: Text -> Text -> AssociateQualificationWithWorker
- data AssociateQualificationWithWorkerResponse = AssociateQualificationWithWorkerResponse' Int
- newAssociateQualificationWithWorkerResponse :: Int -> AssociateQualificationWithWorkerResponse
- data CreateHIT = CreateHIT' (Maybe ReviewPolicy) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [HITLayoutParameter]) (Maybe [QualificationRequirement]) (Maybe Text) (Maybe ReviewPolicy) Integer Integer Text Text Text
- newCreateHIT :: Integer -> Integer -> Text -> Text -> Text -> CreateHIT
- data CreateHITResponse = CreateHITResponse' (Maybe HIT) Int
- newCreateHITResponse :: Int -> CreateHITResponse
- data GetAccountBalance = GetAccountBalance' {
- newGetAccountBalance :: GetAccountBalance
- data GetAccountBalanceResponse = GetAccountBalanceResponse' (Maybe Text) (Maybe Text) Int
- newGetAccountBalanceResponse :: Int -> GetAccountBalanceResponse
- 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' (Maybe POSIX) (Maybe Text) (Maybe AssignmentStatus) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newAssignment :: Assignment
- data BonusPayment = BonusPayment' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newBonusPayment :: BonusPayment
- data HIT = HIT' (Maybe POSIX) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe HITStatus) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [QualificationRequirement]) (Maybe Text) (Maybe Text) (Maybe HITReviewStatus) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Integer)
- newHIT :: HIT
- data HITLayoutParameter = HITLayoutParameter' Text Text
- newHITLayoutParameter :: Text -> Text -> HITLayoutParameter
- data Locale = Locale' (Maybe Text) Text
- newLocale :: Text -> Locale
- data NotificationSpecification = NotificationSpecification' Text NotificationTransport Text [EventType]
- newNotificationSpecification :: Text -> NotificationTransport -> Text -> NotificationSpecification
- data NotifyWorkersFailureStatus = NotifyWorkersFailureStatus' (Maybe Text) (Maybe NotifyWorkersFailureCode) (Maybe Text)
- newNotifyWorkersFailureStatus :: NotifyWorkersFailureStatus
- data ParameterMapEntry = ParameterMapEntry' (Maybe [Text]) (Maybe Text)
- newParameterMapEntry :: ParameterMapEntry
- data PolicyParameter = PolicyParameter' (Maybe [Text]) (Maybe [ParameterMapEntry]) (Maybe Text)
- newPolicyParameter :: PolicyParameter
- data Qualification = Qualification' (Maybe QualificationStatus) (Maybe Int) (Maybe Locale) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newQualification :: Qualification
- data QualificationRequest = QualificationRequest' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newQualificationRequest :: QualificationRequest
- data QualificationRequirement = QualificationRequirement' (Maybe [Locale]) (Maybe HITAccessActions) (Maybe Bool) (Maybe [Int]) Text Comparator
- newQualificationRequirement :: Text -> Comparator -> QualificationRequirement
- data QualificationType = QualificationType' (Maybe POSIX) (Maybe Integer) (Maybe QualificationTypeStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Integer)
- newQualificationType :: QualificationType
- data ReviewActionDetail = ReviewActionDetail' (Maybe ReviewActionStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newReviewActionDetail :: ReviewActionDetail
- data ReviewPolicy = ReviewPolicy' (Maybe [PolicyParameter]) Text
- newReviewPolicy :: Text -> ReviewPolicy
- data ReviewReport = ReviewReport' (Maybe [ReviewActionDetail]) (Maybe [ReviewResultDetail])
- newReviewReport :: ReviewReport
- data ReviewResultDetail = ReviewResultDetail' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newReviewResultDetail :: ReviewResultDetail
- data WorkerBlock = WorkerBlock' (Maybe Text) (Maybe Text)
- newWorkerBlock :: WorkerBlock
Service Configuration
defaultService :: Service Source #
API version 2017-01-17
of the Amazon Mechanical Turk SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by MechanicalTurk
.
ServiceFault
_ServiceFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
RequestError
_RequestError :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your request is invalid.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ApproveAssignment
data ApproveAssignment Source #
See: newApproveAssignment
smart constructor.
Instances
Create a value of ApproveAssignment
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:overrideRejection:ApproveAssignment'
, approveAssignment_overrideRejection
- A flag indicating that an assignment should be approved even if it was
previously rejected. Defaults to False
.
$sel:requesterFeedback:ApproveAssignment'
, approveAssignment_requesterFeedback
- A message for the Worker, which the Worker can see in the Status section
of the web site.
$sel:assignmentId:ApproveAssignment'
, approveAssignment_assignmentId
- The ID of the assignment. The assignment must correspond to a HIT
created by the Requester.
data ApproveAssignmentResponse Source #
See: newApproveAssignmentResponse
smart constructor.
Instances
newApproveAssignmentResponse Source #
Create a value of ApproveAssignmentResponse
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:httpStatus:ApproveAssignmentResponse'
, approveAssignmentResponse_httpStatus
- The response's http status code.
ListReviewPolicyResultsForHIT
data ListReviewPolicyResultsForHIT Source #
See: newListReviewPolicyResultsForHIT
smart constructor.
ListReviewPolicyResultsForHIT' (Maybe Bool) (Maybe [ReviewPolicyLevel]) (Maybe Bool) (Maybe Text) (Maybe Natural) Text |
Instances
newListReviewPolicyResultsForHIT Source #
Create a value of ListReviewPolicyResultsForHIT
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:retrieveResults:ListReviewPolicyResultsForHIT'
, listReviewPolicyResultsForHIT_retrieveResults
- Specify if the operation should retrieve a list of the results computed
by the Review Policies.
$sel:policyLevels:ListReviewPolicyResultsForHIT'
, listReviewPolicyResultsForHIT_policyLevels
- 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.
$sel:retrieveActions:ListReviewPolicyResultsForHIT'
, listReviewPolicyResultsForHIT_retrieveActions
- Specify if the operation should retrieve a list of the actions taken
executing the Review Policies and their outcomes.
$sel:nextToken:ListReviewPolicyResultsForHIT'
, listReviewPolicyResultsForHIT_nextToken
- Pagination token
$sel:maxResults:ListReviewPolicyResultsForHIT'
, listReviewPolicyResultsForHIT_maxResults
- Limit the number of results returned.
$sel:hITId:ListReviewPolicyResultsForHIT'
, listReviewPolicyResultsForHIT_hITId
- The unique identifier of the HIT to retrieve review results for.
data ListReviewPolicyResultsForHITResponse Source #
See: newListReviewPolicyResultsForHITResponse
smart constructor.
ListReviewPolicyResultsForHITResponse' (Maybe ReviewPolicy) (Maybe ReviewReport) (Maybe Text) (Maybe ReviewReport) (Maybe Text) (Maybe ReviewPolicy) Int |
Instances
newListReviewPolicyResultsForHITResponse Source #
Create a value of ListReviewPolicyResultsForHITResponse
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:hITReviewPolicy:ListReviewPolicyResultsForHITResponse'
, listReviewPolicyResultsForHITResponse_hITReviewPolicy
- The name of the HIT-level Review Policy. This contains only the
PolicyName element.
$sel:hITReviewReport:ListReviewPolicyResultsForHITResponse'
, listReviewPolicyResultsForHITResponse_hITReviewReport
- Contains both ReviewResult and ReviewAction elements for a particular
HIT.
$sel:nextToken:ListReviewPolicyResultsForHIT'
, listReviewPolicyResultsForHITResponse_nextToken
- Undocumented member.
$sel:assignmentReviewReport:ListReviewPolicyResultsForHITResponse'
, listReviewPolicyResultsForHITResponse_assignmentReviewReport
- Contains both ReviewResult and ReviewAction elements for an Assignment.
$sel:hITId:ListReviewPolicyResultsForHIT'
, listReviewPolicyResultsForHITResponse_hITId
- The HITId of the HIT for which results have been returned.
$sel:assignmentReviewPolicy:ListReviewPolicyResultsForHITResponse'
, listReviewPolicyResultsForHITResponse_assignmentReviewPolicy
- The name of the Assignment-level Review Policy. This contains only the
PolicyName element.
$sel:httpStatus:ListReviewPolicyResultsForHITResponse'
, listReviewPolicyResultsForHITResponse_httpStatus
- The response's http status code.
ListHITs (Paginated)
See: newListHITs
smart constructor.
Instances
newListHITs :: ListHITs Source #
Create a value of ListHITs
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:nextToken:ListHITs'
, listHITs_nextToken
- Pagination token
$sel:maxResults:ListHITs'
, listHITs_maxResults
- Undocumented member.
data ListHITsResponse Source #
See: newListHITsResponse
smart constructor.
Instances
Create a value of ListHITsResponse
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:nextToken:ListHITs'
, listHITsResponse_nextToken
- Undocumented member.
$sel:numResults:ListHITsResponse'
, listHITsResponse_numResults
- The number of HITs on this page in the filtered results list, equivalent
to the number of HITs being returned by this call.
$sel:hITs:ListHITsResponse'
, listHITsResponse_hITs
- The list of HIT elements returned by the query.
$sel:httpStatus:ListHITsResponse'
, listHITsResponse_httpStatus
- The response's http status code.
ListWorkersWithQualificationType (Paginated)
data ListWorkersWithQualificationType Source #
See: newListWorkersWithQualificationType
smart constructor.
Instances
newListWorkersWithQualificationType Source #
Create a value of ListWorkersWithQualificationType
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:status:ListWorkersWithQualificationType'
, listWorkersWithQualificationType_status
- The status of the Qualifications to return. Can be Granted | Revoked
.
$sel:nextToken:ListWorkersWithQualificationType'
, listWorkersWithQualificationType_nextToken
- Pagination Token
$sel:maxResults:ListWorkersWithQualificationType'
, listWorkersWithQualificationType_maxResults
- Limit the number of results returned.
$sel:qualificationTypeId:ListWorkersWithQualificationType'
, listWorkersWithQualificationType_qualificationTypeId
- The ID of the Qualification type of the Qualifications to return.
data ListWorkersWithQualificationTypeResponse Source #
See: newListWorkersWithQualificationTypeResponse
smart constructor.
Instances
newListWorkersWithQualificationTypeResponse Source #
Create a value of ListWorkersWithQualificationTypeResponse
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:nextToken:ListWorkersWithQualificationType'
, listWorkersWithQualificationTypeResponse_nextToken
- Undocumented member.
$sel:numResults:ListWorkersWithQualificationTypeResponse'
, listWorkersWithQualificationTypeResponse_numResults
- The number of Qualifications on this page in the filtered results list,
equivalent to the number of Qualifications being returned by this call.
$sel:qualifications:ListWorkersWithQualificationTypeResponse'
, listWorkersWithQualificationTypeResponse_qualifications
- The list of Qualification elements returned by this call.
$sel:httpStatus:ListWorkersWithQualificationTypeResponse'
, listWorkersWithQualificationTypeResponse_httpStatus
- The response's http status code.
DeleteHIT
See: newDeleteHIT
smart constructor.
Instances
Create a value of DeleteHIT
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:hITId:DeleteHIT'
, deleteHIT_hITId
- The ID of the HIT to be deleted.
data DeleteHITResponse Source #
See: newDeleteHITResponse
smart constructor.
Instances
Create a value of DeleteHITResponse
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:httpStatus:DeleteHITResponse'
, deleteHITResponse_httpStatus
- The response's http status code.
ListReviewableHITs (Paginated)
data ListReviewableHITs Source #
See: newListReviewableHITs
smart constructor.
Instances
newListReviewableHITs :: ListReviewableHITs Source #
Create a value of ListReviewableHITs
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:status:ListReviewableHITs'
, listReviewableHITs_status
- Can be either Reviewable
or Reviewing
. Reviewable is the default
value.
$sel:hITTypeId:ListReviewableHITs'
, listReviewableHITs_hITTypeId
- The ID of the HIT type of the HITs to consider for the query. If not
specified, all HITs for the Reviewer are considered
$sel:nextToken:ListReviewableHITs'
, listReviewableHITs_nextToken
- Pagination Token
$sel:maxResults:ListReviewableHITs'
, listReviewableHITs_maxResults
- Limit the number of results returned.
data ListReviewableHITsResponse Source #
See: newListReviewableHITsResponse
smart constructor.
Instances
newListReviewableHITsResponse Source #
Create a value of ListReviewableHITsResponse
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:nextToken:ListReviewableHITs'
, listReviewableHITsResponse_nextToken
- Undocumented member.
$sel:numResults:ListReviewableHITsResponse'
, listReviewableHITsResponse_numResults
- The number of HITs on this page in the filtered results list, equivalent
to the number of HITs being returned by this call.
$sel:hITs:ListReviewableHITsResponse'
, listReviewableHITsResponse_hITs
- The list of HIT elements returned by the query.
$sel:httpStatus:ListReviewableHITsResponse'
, listReviewableHITsResponse_httpStatus
- The response's http status code.
GetAssignment
data GetAssignment Source #
See: newGetAssignment
smart constructor.
Instances
Create a value of GetAssignment
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:GetAssignment'
, getAssignment_assignmentId
- The ID of the Assignment to be retrieved.
data GetAssignmentResponse Source #
See: newGetAssignmentResponse
smart constructor.
Instances
newGetAssignmentResponse Source #
Create a value of GetAssignmentResponse
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:hit:GetAssignmentResponse'
, getAssignmentResponse_hit
- The HIT associated with this assignment. The response includes one HIT
element.
$sel:assignment:GetAssignmentResponse'
, getAssignmentResponse_assignment
- The assignment. The response includes one Assignment element.
$sel:httpStatus:GetAssignmentResponse'
, getAssignmentResponse_httpStatus
- The response's http status code.
DeleteQualificationType
data DeleteQualificationType Source #
See: newDeleteQualificationType
smart constructor.
Instances
newDeleteQualificationType Source #
Create a value of DeleteQualificationType
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:qualificationTypeId:DeleteQualificationType'
, deleteQualificationType_qualificationTypeId
- The ID of the QualificationType to dispose.
data DeleteQualificationTypeResponse Source #
See: newDeleteQualificationTypeResponse
smart constructor.
Instances
Eq DeleteQualificationTypeResponse Source # | |
Read DeleteQualificationTypeResponse Source # | |
Show DeleteQualificationTypeResponse Source # | |
Generic DeleteQualificationTypeResponse Source # | |
NFData DeleteQualificationTypeResponse Source # | |
Defined in Amazonka.MechanicalTurk.DeleteQualificationType rnf :: DeleteQualificationTypeResponse -> () # | |
type Rep DeleteQualificationTypeResponse Source # | |
Defined in Amazonka.MechanicalTurk.DeleteQualificationType type Rep DeleteQualificationTypeResponse = D1 ('MetaData "DeleteQualificationTypeResponse" "Amazonka.MechanicalTurk.DeleteQualificationType" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "DeleteQualificationTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteQualificationTypeResponse Source #
Create a value of DeleteQualificationTypeResponse
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:httpStatus:DeleteQualificationTypeResponse'
, deleteQualificationTypeResponse_httpStatus
- The response's http status code.
UpdateQualificationType
data UpdateQualificationType Source #
See: newUpdateQualificationType
smart constructor.
UpdateQualificationType' (Maybe Integer) (Maybe QualificationTypeStatus) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Integer) Text |
Instances
newUpdateQualificationType Source #
Create a value of UpdateQualificationType
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:testDurationInSeconds:UpdateQualificationType'
, updateQualificationType_testDurationInSeconds
- The number of seconds the Worker has to complete the Qualification test,
starting from the time the Worker requests the Qualification.
$sel:qualificationTypeStatus:UpdateQualificationType'
, updateQualificationType_qualificationTypeStatus
- The new status of the Qualification type - Active | Inactive
$sel:answerKey:UpdateQualificationType'
, updateQualificationType_answerKey
- The answers to the Qualification test specified in the Test parameter,
in the form of an AnswerKey data structure.
$sel:test:UpdateQualificationType'
, updateQualificationType_test
- 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.
$sel:autoGranted:UpdateQualificationType'
, updateQualificationType_autoGranted
- 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.
$sel:autoGrantedValue:UpdateQualificationType'
, updateQualificationType_autoGrantedValue
- The Qualification value to use for automatically granted Qualifications.
This parameter is used only if the AutoGranted parameter is true.
$sel:description:UpdateQualificationType'
, updateQualificationType_description
- The new description of the Qualification type.
$sel:retryDelayInSeconds:UpdateQualificationType'
, updateQualificationType_retryDelayInSeconds
- 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.
$sel:qualificationTypeId:UpdateQualificationType'
, updateQualificationType_qualificationTypeId
- The ID of the Qualification type to update.
data UpdateQualificationTypeResponse Source #
See: newUpdateQualificationTypeResponse
smart constructor.
Instances
Eq UpdateQualificationTypeResponse Source # | |
Read UpdateQualificationTypeResponse Source # | |
Show UpdateQualificationTypeResponse Source # | |
Generic UpdateQualificationTypeResponse Source # | |
NFData UpdateQualificationTypeResponse Source # | |
Defined in Amazonka.MechanicalTurk.UpdateQualificationType rnf :: UpdateQualificationTypeResponse -> () # | |
type Rep UpdateQualificationTypeResponse Source # | |
Defined in Amazonka.MechanicalTurk.UpdateQualificationType type Rep UpdateQualificationTypeResponse = D1 ('MetaData "UpdateQualificationTypeResponse" "Amazonka.MechanicalTurk.UpdateQualificationType" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "UpdateQualificationTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "qualificationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QualificationType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateQualificationTypeResponse Source #
Create a value of UpdateQualificationTypeResponse
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:qualificationType:UpdateQualificationTypeResponse'
, updateQualificationTypeResponse_qualificationType
- Contains a QualificationType data structure.
$sel:httpStatus:UpdateQualificationTypeResponse'
, updateQualificationTypeResponse_httpStatus
- The response's http status code.
ListQualificationTypes (Paginated)
data ListQualificationTypes Source #
See: newListQualificationTypes
smart constructor.
Instances
newListQualificationTypes Source #
Create a value of ListQualificationTypes
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:mustBeOwnedByCaller:ListQualificationTypes'
, listQualificationTypes_mustBeOwnedByCaller
- Specifies that only Qualification types that the Requester created are
returned. If false, the operation returns all Qualification types.
$sel:nextToken:ListQualificationTypes'
, listQualificationTypes_nextToken
- Undocumented member.
$sel:query:ListQualificationTypes'
, listQualificationTypes_query
- A text query against all of the searchable attributes of Qualification
types.
$sel:maxResults:ListQualificationTypes'
, listQualificationTypes_maxResults
- The maximum number of results to return in a single call.
$sel:mustBeRequestable:ListQualificationTypes'
, listQualificationTypes_mustBeRequestable
- 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.
data ListQualificationTypesResponse Source #
See: newListQualificationTypesResponse
smart constructor.
Instances
newListQualificationTypesResponse Source #
Create a value of ListQualificationTypesResponse
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:qualificationTypes:ListQualificationTypesResponse'
, listQualificationTypesResponse_qualificationTypes
- The list of QualificationType elements returned by the query.
$sel:nextToken:ListQualificationTypes'
, listQualificationTypesResponse_nextToken
- Undocumented member.
$sel:numResults:ListQualificationTypesResponse'
, listQualificationTypesResponse_numResults
- The number of Qualification types on this page in the filtered results
list, equivalent to the number of types this operation returns.
$sel:httpStatus:ListQualificationTypesResponse'
, listQualificationTypesResponse_httpStatus
- The response's http status code.
UpdateHITTypeOfHIT
data UpdateHITTypeOfHIT Source #
See: newUpdateHITTypeOfHIT
smart constructor.
Instances
newUpdateHITTypeOfHIT Source #
Create a value of UpdateHITTypeOfHIT
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:hITId:UpdateHITTypeOfHIT'
, updateHITTypeOfHIT_hITId
- The HIT to update.
$sel:hITTypeId:UpdateHITTypeOfHIT'
, updateHITTypeOfHIT_hITTypeId
- The ID of the new HIT type.
data UpdateHITTypeOfHITResponse Source #
See: newUpdateHITTypeOfHITResponse
smart constructor.
Instances
newUpdateHITTypeOfHITResponse Source #
Create a value of UpdateHITTypeOfHITResponse
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:httpStatus:UpdateHITTypeOfHITResponse'
, updateHITTypeOfHITResponse_httpStatus
- The response's http status code.
DisassociateQualificationFromWorker
data DisassociateQualificationFromWorker Source #
See: newDisassociateQualificationFromWorker
smart constructor.
Instances
newDisassociateQualificationFromWorker Source #
:: Text | |
-> Text |
|
-> DisassociateQualificationFromWorker |
Create a value of DisassociateQualificationFromWorker
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:DisassociateQualificationFromWorker'
, disassociateQualificationFromWorker_reason
- A text message that explains why the Qualification was revoked. The user
who had the Qualification sees this message.
$sel:workerId:DisassociateQualificationFromWorker'
, disassociateQualificationFromWorker_workerId
- The ID of the Worker who possesses the Qualification to be revoked.
$sel:qualificationTypeId:DisassociateQualificationFromWorker'
, disassociateQualificationFromWorker_qualificationTypeId
- The ID of the Qualification type of the Qualification to be revoked.
data DisassociateQualificationFromWorkerResponse Source #
See: newDisassociateQualificationFromWorkerResponse
smart constructor.
Instances
Eq DisassociateQualificationFromWorkerResponse Source # | |
Read DisassociateQualificationFromWorkerResponse Source # | |
Show DisassociateQualificationFromWorkerResponse Source # | |
Generic DisassociateQualificationFromWorkerResponse Source # | |
NFData DisassociateQualificationFromWorkerResponse Source # | |
type Rep DisassociateQualificationFromWorkerResponse Source # | |
Defined in Amazonka.MechanicalTurk.DisassociateQualificationFromWorker type Rep DisassociateQualificationFromWorkerResponse = D1 ('MetaData "DisassociateQualificationFromWorkerResponse" "Amazonka.MechanicalTurk.DisassociateQualificationFromWorker" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "DisassociateQualificationFromWorkerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDisassociateQualificationFromWorkerResponse Source #
:: Int |
|
-> DisassociateQualificationFromWorkerResponse |
Create a value of DisassociateQualificationFromWorkerResponse
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:httpStatus:DisassociateQualificationFromWorkerResponse'
, disassociateQualificationFromWorkerResponse_httpStatus
- The response's http status code.
SendTestEventNotification
data SendTestEventNotification Source #
See: newSendTestEventNotification
smart constructor.
Instances
newSendTestEventNotification Source #
Create a value of SendTestEventNotification
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:notification:SendTestEventNotification'
, sendTestEventNotification_notification
- 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.
$sel:testEventType:SendTestEventNotification'
, sendTestEventNotification_testEventType
- 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.
data SendTestEventNotificationResponse Source #
See: newSendTestEventNotificationResponse
smart constructor.
Instances
Eq SendTestEventNotificationResponse Source # | |
Read SendTestEventNotificationResponse Source # | |
Show SendTestEventNotificationResponse Source # | |
Generic SendTestEventNotificationResponse Source # | |
NFData SendTestEventNotificationResponse Source # | |
Defined in Amazonka.MechanicalTurk.SendTestEventNotification rnf :: SendTestEventNotificationResponse -> () # | |
type Rep SendTestEventNotificationResponse Source # | |
Defined in Amazonka.MechanicalTurk.SendTestEventNotification type Rep SendTestEventNotificationResponse = D1 ('MetaData "SendTestEventNotificationResponse" "Amazonka.MechanicalTurk.SendTestEventNotification" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "SendTestEventNotificationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newSendTestEventNotificationResponse Source #
Create a value of SendTestEventNotificationResponse
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:httpStatus:SendTestEventNotificationResponse'
, sendTestEventNotificationResponse_httpStatus
- The response's http status code.
NotifyWorkers
data NotifyWorkers Source #
See: newNotifyWorkers
smart constructor.
Instances
Create a value of NotifyWorkers
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:subject:NotifyWorkers'
, notifyWorkers_subject
- The subject line of the email message to send. Can include up to 200
characters.
$sel:messageText:NotifyWorkers'
, notifyWorkers_messageText
- The text of the email message to send. Can include up to 4,096
characters
$sel:workerIds:NotifyWorkers'
, notifyWorkers_workerIds
- A list of Worker IDs you wish to notify. You can notify upto 100 Workers
at a time.
data NotifyWorkersResponse Source #
See: newNotifyWorkersResponse
smart constructor.
Instances
newNotifyWorkersResponse Source #
Create a value of NotifyWorkersResponse
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:notifyWorkersFailureStatuses:NotifyWorkersResponse'
, notifyWorkersResponse_notifyWorkersFailureStatuses
- When MTurk sends notifications to the list of Workers, it returns back
any failures it encounters in this list of NotifyWorkersFailureStatus
objects.
$sel:httpStatus:NotifyWorkersResponse'
, notifyWorkersResponse_httpStatus
- The response's http status code.
CreateHITWithHITType
data CreateHITWithHITType Source #
See: newCreateHITWithHITType
smart constructor.
CreateHITWithHITType' (Maybe ReviewPolicy) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [HITLayoutParameter]) (Maybe Text) (Maybe ReviewPolicy) Text Integer |
Instances
newCreateHITWithHITType Source #
:: Text | |
-> Integer | |
-> CreateHITWithHITType |
Create a value of CreateHITWithHITType
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:hITReviewPolicy:CreateHITWithHITType'
, createHITWithHITType_hITReviewPolicy
- The HIT-level Review Policy applies to the HIT. You can specify for
Mechanical Turk to take various actions based on the policy.
$sel:uniqueRequestToken:CreateHITWithHITType'
, createHITWithHITType_uniqueRequestToken
- 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.
$sel:requesterAnnotation:CreateHITWithHITType'
, createHITWithHITType_requesterAnnotation
- 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.
$sel:maxAssignments:CreateHITWithHITType'
, createHITWithHITType_maxAssignments
- The number of times the HIT can be accepted and completed before the HIT
becomes unavailable.
$sel:hITLayoutId:CreateHITWithHITType'
, createHITWithHITType_hITLayoutId
- 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.
$sel:hITLayoutParameters:CreateHITWithHITType'
, createHITWithHITType_hITLayoutParameters
- If the HITLayoutId is provided, any placeholder values must be filled in
with values using the HITLayoutParameter structure. For more
information, see HITLayout.
$sel:question:CreateHITWithHITType'
, createHITWithHITType_question
- 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.
$sel:assignmentReviewPolicy:CreateHITWithHITType'
, createHITWithHITType_assignmentReviewPolicy
- 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.
$sel:hITTypeId:CreateHITWithHITType'
, createHITWithHITType_hITTypeId
- The HIT type ID you want to create this HIT with.
$sel:lifetimeInSeconds:CreateHITWithHITType'
, createHITWithHITType_lifetimeInSeconds
- 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.
data CreateHITWithHITTypeResponse Source #
See: newCreateHITWithHITTypeResponse
smart constructor.
Instances
newCreateHITWithHITTypeResponse Source #
Create a value of CreateHITWithHITTypeResponse
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:hit:CreateHITWithHITTypeResponse'
, createHITWithHITTypeResponse_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.
$sel:httpStatus:CreateHITWithHITTypeResponse'
, createHITWithHITTypeResponse_httpStatus
- The response's http status code.
CreateHITType
data CreateHITType Source #
See: newCreateHITType
smart constructor.
CreateHITType' (Maybe Integer) (Maybe Text) (Maybe [QualificationRequirement]) Integer Text Text Text |
Instances
:: Integer | |
-> Text | |
-> Text | |
-> Text | |
-> CreateHITType |
Create a value of CreateHITType
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:autoApprovalDelayInSeconds:CreateHITType'
, createHITType_autoApprovalDelayInSeconds
- 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.
$sel:keywords:CreateHITType'
, createHITType_keywords
- One or more words or phrases that describe the HIT, separated by commas.
These words are used in searches to find HITs.
$sel:qualificationRequirements:CreateHITType'
, createHITType_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:assignmentDurationInSeconds:CreateHITType'
, createHITType_assignmentDurationInSeconds
- 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.
$sel:reward:CreateHITType'
, createHITType_reward
- The amount of money the Requester will pay a Worker for successfully
completing the HIT.
$sel:title:CreateHITType'
, createHITType_title
- 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.
$sel:description:CreateHITType'
, createHITType_description
- 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.
data CreateHITTypeResponse Source #
See: newCreateHITTypeResponse
smart constructor.
Instances
newCreateHITTypeResponse Source #
Create a value of CreateHITTypeResponse
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:hITTypeId:CreateHITTypeResponse'
, createHITTypeResponse_hITTypeId
- The ID of the newly registered HIT type.
$sel:httpStatus:CreateHITTypeResponse'
, createHITTypeResponse_httpStatus
- The response's http status code.
SendBonus
See: newSendBonus
smart constructor.
Instances
Create a value of SendBonus
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:uniqueRequestToken:SendBonus'
, sendBonus_uniqueRequestToken
- 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.
$sel:workerId:SendBonus'
, sendBonus_workerId
- The ID of the Worker being paid the bonus.
$sel:bonusAmount:SendBonus'
, sendBonus_bonusAmount
- 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.
$sel:assignmentId:SendBonus'
, sendBonus_assignmentId
- The ID of the assignment for which this bonus is paid.
$sel:reason:SendBonus'
, sendBonus_reason
- A message that explains the reason for the bonus payment. The Worker
receiving the bonus can see this message.
data SendBonusResponse Source #
See: newSendBonusResponse
smart constructor.
Instances
Create a value of SendBonusResponse
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:httpStatus:SendBonusResponse'
, sendBonusResponse_httpStatus
- The response's http status code.
ListQualificationRequests (Paginated)
data ListQualificationRequests Source #
See: newListQualificationRequests
smart constructor.
Instances
newListQualificationRequests :: ListQualificationRequests Source #
Create a value of ListQualificationRequests
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:nextToken:ListQualificationRequests'
, listQualificationRequests_nextToken
- Undocumented member.
$sel:qualificationTypeId:ListQualificationRequests'
, listQualificationRequests_qualificationTypeId
- The ID of the QualificationType.
$sel:maxResults:ListQualificationRequests'
, listQualificationRequests_maxResults
- The maximum number of results to return in a single call.
data ListQualificationRequestsResponse Source #
See: newListQualificationRequestsResponse
smart constructor.
Instances
newListQualificationRequestsResponse Source #
Create a value of ListQualificationRequestsResponse
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:qualificationRequests:ListQualificationRequestsResponse'
, listQualificationRequestsResponse_qualificationRequests
- The Qualification request. The response includes one
QualificationRequest element for each Qualification request returned by
the query.
$sel:nextToken:ListQualificationRequests'
, listQualificationRequestsResponse_nextToken
- Undocumented member.
$sel:numResults:ListQualificationRequestsResponse'
, listQualificationRequestsResponse_numResults
- 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.
$sel:httpStatus:ListQualificationRequestsResponse'
, listQualificationRequestsResponse_httpStatus
- The response's http status code.
UpdateExpirationForHIT
data UpdateExpirationForHIT Source #
See: newUpdateExpirationForHIT
smart constructor.
Instances
newUpdateExpirationForHIT Source #
:: Text | |
-> UTCTime | |
-> UpdateExpirationForHIT |
Create a value of UpdateExpirationForHIT
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:hITId:UpdateExpirationForHIT'
, updateExpirationForHIT_hITId
- The HIT to update.
$sel:expireAt:UpdateExpirationForHIT'
, updateExpirationForHIT_expireAt
- The date and time at which you want the HIT to expire
data UpdateExpirationForHITResponse Source #
See: newUpdateExpirationForHITResponse
smart constructor.
Instances
Eq UpdateExpirationForHITResponse Source # | |
Read UpdateExpirationForHITResponse Source # | |
Show UpdateExpirationForHITResponse Source # | |
Generic UpdateExpirationForHITResponse Source # | |
NFData UpdateExpirationForHITResponse Source # | |
Defined in Amazonka.MechanicalTurk.UpdateExpirationForHIT rnf :: UpdateExpirationForHITResponse -> () # | |
type Rep UpdateExpirationForHITResponse Source # | |
Defined in Amazonka.MechanicalTurk.UpdateExpirationForHIT type Rep UpdateExpirationForHITResponse = D1 ('MetaData "UpdateExpirationForHITResponse" "Amazonka.MechanicalTurk.UpdateExpirationForHIT" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "UpdateExpirationForHITResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateExpirationForHITResponse Source #
Create a value of UpdateExpirationForHITResponse
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:httpStatus:UpdateExpirationForHITResponse'
, updateExpirationForHITResponse_httpStatus
- The response's http status code.
RejectAssignment
data RejectAssignment Source #
See: newRejectAssignment
smart constructor.
Instances
:: Text | |
-> Text | |
-> RejectAssignment |
Create a value of RejectAssignment
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:RejectAssignment'
, rejectAssignment_assignmentId
- The ID of the assignment. The assignment must correspond to a HIT
created by the Requester.
$sel:requesterFeedback:RejectAssignment'
, rejectAssignment_requesterFeedback
- A message for the Worker, which the Worker can see in the Status section
of the web site.
data RejectAssignmentResponse Source #
See: newRejectAssignmentResponse
smart constructor.
Instances
newRejectAssignmentResponse Source #
Create a value of RejectAssignmentResponse
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:httpStatus:RejectAssignmentResponse'
, rejectAssignmentResponse_httpStatus
- The response's http status code.
ListAssignmentsForHIT (Paginated)
data ListAssignmentsForHIT Source #
See: newListAssignmentsForHIT
smart constructor.
Instances
newListAssignmentsForHIT Source #
Create a value of ListAssignmentsForHIT
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:assignmentStatuses:ListAssignmentsForHIT'
, listAssignmentsForHIT_assignmentStatuses
- The status of the assignments to return: Submitted | Approved | Rejected
$sel:nextToken:ListAssignmentsForHIT'
, listAssignmentsForHIT_nextToken
- Pagination token
$sel:maxResults:ListAssignmentsForHIT'
, listAssignmentsForHIT_maxResults
- Undocumented member.
$sel:hITId:ListAssignmentsForHIT'
, listAssignmentsForHIT_hITId
- The ID of the HIT.
data ListAssignmentsForHITResponse Source #
See: newListAssignmentsForHITResponse
smart constructor.
Instances
newListAssignmentsForHITResponse Source #
Create a value of ListAssignmentsForHITResponse
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:nextToken:ListAssignmentsForHIT'
, listAssignmentsForHITResponse_nextToken
- Undocumented member.
$sel:numResults:ListAssignmentsForHITResponse'
, listAssignmentsForHITResponse_numResults
- The number of assignments on the page in the filtered results list,
equivalent to the number of assignments returned by this call.
$sel:assignments:ListAssignmentsForHITResponse'
, listAssignmentsForHITResponse_assignments
- The collection of Assignment data structures returned by this call.
$sel:httpStatus:ListAssignmentsForHITResponse'
, listAssignmentsForHITResponse_httpStatus
- The response's http status code.
RejectQualificationRequest
data RejectQualificationRequest Source #
See: newRejectQualificationRequest
smart constructor.
Instances
newRejectQualificationRequest Source #
Create a value of RejectQualificationRequest
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:RejectQualificationRequest'
, rejectQualificationRequest_reason
- A text message explaining why the request was rejected, to be shown to
the Worker who made the request.
$sel:qualificationRequestId:RejectQualificationRequest'
, rejectQualificationRequest_qualificationRequestId
- The ID of the Qualification request, as returned by the
ListQualificationRequests
operation.
data RejectQualificationRequestResponse Source #
See: newRejectQualificationRequestResponse
smart constructor.
Instances
Eq RejectQualificationRequestResponse Source # | |
Read RejectQualificationRequestResponse Source # | |
Show RejectQualificationRequestResponse Source # | |
Generic RejectQualificationRequestResponse Source # | |
NFData RejectQualificationRequestResponse Source # | |
Defined in Amazonka.MechanicalTurk.RejectQualificationRequest rnf :: RejectQualificationRequestResponse -> () # | |
type Rep RejectQualificationRequestResponse Source # | |
Defined in Amazonka.MechanicalTurk.RejectQualificationRequest type Rep RejectQualificationRequestResponse = D1 ('MetaData "RejectQualificationRequestResponse" "Amazonka.MechanicalTurk.RejectQualificationRequest" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "RejectQualificationRequestResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newRejectQualificationRequestResponse Source #
Create a value of RejectQualificationRequestResponse
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:httpStatus:RejectQualificationRequestResponse'
, rejectQualificationRequestResponse_httpStatus
- The response's http status code.
GetQualificationScore
data GetQualificationScore Source #
See: newGetQualificationScore
smart constructor.
Instances
newGetQualificationScore Source #
:: Text | |
-> Text | |
-> GetQualificationScore |
Create a value of GetQualificationScore
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:qualificationTypeId:GetQualificationScore'
, getQualificationScore_qualificationTypeId
- The ID of the QualificationType.
$sel:workerId:GetQualificationScore'
, getQualificationScore_workerId
- The ID of the Worker whose Qualification is being updated.
data GetQualificationScoreResponse Source #
See: newGetQualificationScoreResponse
smart constructor.
Instances
newGetQualificationScoreResponse Source #
Create a value of GetQualificationScoreResponse
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:qualification:GetQualificationScoreResponse'
, getQualificationScoreResponse_qualification
- The Qualification data structure of the Qualification assigned to a
user, including the Qualification type and the value (score).
$sel:httpStatus:GetQualificationScoreResponse'
, getQualificationScoreResponse_httpStatus
- The response's http status code.
GetQualificationType
data GetQualificationType Source #
See: newGetQualificationType
smart constructor.
Instances
newGetQualificationType Source #
Create a value of GetQualificationType
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:qualificationTypeId:GetQualificationType'
, getQualificationType_qualificationTypeId
- The ID of the QualificationType.
data GetQualificationTypeResponse Source #
See: newGetQualificationTypeResponse
smart constructor.
Instances
newGetQualificationTypeResponse Source #
Create a value of GetQualificationTypeResponse
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:qualificationType:GetQualificationTypeResponse'
, getQualificationTypeResponse_qualificationType
- The returned Qualification Type
$sel:httpStatus:GetQualificationTypeResponse'
, getQualificationTypeResponse_httpStatus
- The response's http status code.
UpdateHITReviewStatus
data UpdateHITReviewStatus Source #
See: newUpdateHITReviewStatus
smart constructor.
Instances
newUpdateHITReviewStatus Source #
Create a value of UpdateHITReviewStatus
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:revert:UpdateHITReviewStatus'
, updateHITReviewStatus_revert
- Specifies how to update the HIT status. Default is False
.
- Setting this to false will only transition a HIT from
Reviewable
toReviewing
- Setting this to true will only transition a HIT from
Reviewing
toReviewable
$sel:hITId:UpdateHITReviewStatus'
, updateHITReviewStatus_hITId
- The ID of the HIT to update.
data UpdateHITReviewStatusResponse Source #
See: newUpdateHITReviewStatusResponse
smart constructor.
Instances
newUpdateHITReviewStatusResponse Source #
Create a value of UpdateHITReviewStatusResponse
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:httpStatus:UpdateHITReviewStatusResponse'
, updateHITReviewStatusResponse_httpStatus
- The response's http status code.
CreateQualificationType
data CreateQualificationType Source #
See: newCreateQualificationType
smart constructor.
CreateQualificationType' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Integer) Text Text QualificationTypeStatus |
Instances
newCreateQualificationType Source #
Create a value of CreateQualificationType
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:testDurationInSeconds:CreateQualificationType'
, createQualificationType_testDurationInSeconds
- The number of seconds the Worker has to complete the Qualification test,
starting from the time the Worker requests the Qualification.
$sel:answerKey:CreateQualificationType'
, createQualificationType_answerKey
- 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.
$sel:test:CreateQualificationType'
, createQualificationType_test
- 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.
$sel:keywords:CreateQualificationType'
, createQualificationType_keywords
- 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.
$sel:autoGranted:CreateQualificationType'
, createQualificationType_autoGranted
- 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.
$sel:autoGrantedValue:CreateQualificationType'
, createQualificationType_autoGrantedValue
- The Qualification value to use for automatically granted Qualifications.
This parameter is used only if the AutoGranted parameter is true.
$sel:retryDelayInSeconds:CreateQualificationType'
, createQualificationType_retryDelayInSeconds
- 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.
$sel:name:CreateQualificationType'
, createQualificationType_name
- 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.
$sel:description:CreateQualificationType'
, createQualificationType_description
- 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.
$sel:qualificationTypeStatus:CreateQualificationType'
, createQualificationType_qualificationTypeStatus
- The initial status of the Qualification type.
Constraints: Valid values are: Active | Inactive
data CreateQualificationTypeResponse Source #
See: newCreateQualificationTypeResponse
smart constructor.
Instances
Eq CreateQualificationTypeResponse Source # | |
Read CreateQualificationTypeResponse Source # | |
Show CreateQualificationTypeResponse Source # | |
Generic CreateQualificationTypeResponse Source # | |
NFData CreateQualificationTypeResponse Source # | |
Defined in Amazonka.MechanicalTurk.CreateQualificationType rnf :: CreateQualificationTypeResponse -> () # | |
type Rep CreateQualificationTypeResponse Source # | |
Defined in Amazonka.MechanicalTurk.CreateQualificationType type Rep CreateQualificationTypeResponse = D1 ('MetaData "CreateQualificationTypeResponse" "Amazonka.MechanicalTurk.CreateQualificationType" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "CreateQualificationTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "qualificationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QualificationType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateQualificationTypeResponse Source #
Create a value of CreateQualificationTypeResponse
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:qualificationType:CreateQualificationTypeResponse'
, createQualificationTypeResponse_qualificationType
- The created Qualification type, returned as a QualificationType data
structure.
$sel:httpStatus:CreateQualificationTypeResponse'
, createQualificationTypeResponse_httpStatus
- The response's http status code.
AcceptQualificationRequest
data AcceptQualificationRequest Source #
See: newAcceptQualificationRequest
smart constructor.
Instances
newAcceptQualificationRequest Source #
Create a value of AcceptQualificationRequest
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:integerValue:AcceptQualificationRequest'
, acceptQualificationRequest_integerValue
- 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.
$sel:qualificationRequestId:AcceptQualificationRequest'
, acceptQualificationRequest_qualificationRequestId
- The ID of the Qualification request, as returned by the
GetQualificationRequests
operation.
data AcceptQualificationRequestResponse Source #
See: newAcceptQualificationRequestResponse
smart constructor.
Instances
Eq AcceptQualificationRequestResponse Source # | |
Read AcceptQualificationRequestResponse Source # | |
Show AcceptQualificationRequestResponse Source # | |
Generic AcceptQualificationRequestResponse Source # | |
NFData AcceptQualificationRequestResponse Source # | |
Defined in Amazonka.MechanicalTurk.AcceptQualificationRequest rnf :: AcceptQualificationRequestResponse -> () # | |
type Rep AcceptQualificationRequestResponse Source # | |
Defined in Amazonka.MechanicalTurk.AcceptQualificationRequest type Rep AcceptQualificationRequestResponse = D1 ('MetaData "AcceptQualificationRequestResponse" "Amazonka.MechanicalTurk.AcceptQualificationRequest" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "AcceptQualificationRequestResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newAcceptQualificationRequestResponse Source #
Create a value of AcceptQualificationRequestResponse
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:httpStatus:AcceptQualificationRequestResponse'
, acceptQualificationRequestResponse_httpStatus
- The response's http status code.
GetFileUploadURL
data GetFileUploadURL Source #
See: newGetFileUploadURL
smart constructor.
Instances
:: Text | |
-> Text | |
-> GetFileUploadURL |
Create a value of GetFileUploadURL
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:GetFileUploadURL'
, getFileUploadURL_assignmentId
- The ID of the assignment that contains the question with a
FileUploadAnswer.
$sel:questionIdentifier:GetFileUploadURL'
, getFileUploadURL_questionIdentifier
- The identifier of the question with a FileUploadAnswer, as specified in
the QuestionForm of the HIT.
data GetFileUploadURLResponse Source #
See: newGetFileUploadURLResponse
smart constructor.
Instances
newGetFileUploadURLResponse Source #
Create a value of GetFileUploadURLResponse
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:fileUploadURL:GetFileUploadURLResponse'
, getFileUploadURLResponse_fileUploadURL
- A temporary URL for the file that the Worker uploaded for the answer.
$sel:httpStatus:GetFileUploadURLResponse'
, getFileUploadURLResponse_httpStatus
- The response's http status code.
CreateAdditionalAssignmentsForHIT
data CreateAdditionalAssignmentsForHIT Source #
See: newCreateAdditionalAssignmentsForHIT
smart constructor.
Instances
newCreateAdditionalAssignmentsForHIT Source #
:: Text | |
-> Int |
|
-> CreateAdditionalAssignmentsForHIT |
Create a value of CreateAdditionalAssignmentsForHIT
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:uniqueRequestToken:CreateAdditionalAssignmentsForHIT'
, createAdditionalAssignmentsForHIT_uniqueRequestToken
- 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.
$sel:hITId:CreateAdditionalAssignmentsForHIT'
, createAdditionalAssignmentsForHIT_hITId
- The ID of the HIT to extend.
$sel:numberOfAdditionalAssignments:CreateAdditionalAssignmentsForHIT'
, createAdditionalAssignmentsForHIT_numberOfAdditionalAssignments
- The number of additional assignments to request for this HIT.
data CreateAdditionalAssignmentsForHITResponse Source #
See: newCreateAdditionalAssignmentsForHITResponse
smart constructor.
Instances
Eq CreateAdditionalAssignmentsForHITResponse Source # | |
Read CreateAdditionalAssignmentsForHITResponse Source # | |
Show CreateAdditionalAssignmentsForHITResponse Source # | |
Generic CreateAdditionalAssignmentsForHITResponse Source # | |
NFData CreateAdditionalAssignmentsForHITResponse Source # | |
type Rep CreateAdditionalAssignmentsForHITResponse Source # | |
Defined in Amazonka.MechanicalTurk.CreateAdditionalAssignmentsForHIT type Rep CreateAdditionalAssignmentsForHITResponse = D1 ('MetaData "CreateAdditionalAssignmentsForHITResponse" "Amazonka.MechanicalTurk.CreateAdditionalAssignmentsForHIT" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "CreateAdditionalAssignmentsForHITResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateAdditionalAssignmentsForHITResponse Source #
Create a value of CreateAdditionalAssignmentsForHITResponse
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:httpStatus:CreateAdditionalAssignmentsForHITResponse'
, createAdditionalAssignmentsForHITResponse_httpStatus
- The response's http status code.
GetHIT
See: newGetHIT
smart constructor.
Instances
Eq GetHIT Source # | |
Read GetHIT Source # | |
Show GetHIT Source # | |
Generic GetHIT Source # | |
NFData GetHIT Source # | |
Defined in Amazonka.MechanicalTurk.GetHIT | |
Hashable GetHIT Source # | |
Defined in Amazonka.MechanicalTurk.GetHIT | |
ToJSON GetHIT Source # | |
Defined in Amazonka.MechanicalTurk.GetHIT | |
AWSRequest GetHIT Source # | |
Defined in Amazonka.MechanicalTurk.GetHIT type AWSResponse GetHIT # request :: GetHIT -> Request GetHIT # response :: MonadResource m => Logger -> Service -> Proxy GetHIT -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetHIT))) # | |
ToHeaders GetHIT Source # | |
Defined in Amazonka.MechanicalTurk.GetHIT | |
ToPath GetHIT Source # | |
Defined in Amazonka.MechanicalTurk.GetHIT toPath :: GetHIT -> ByteString # | |
ToQuery GetHIT Source # | |
Defined in Amazonka.MechanicalTurk.GetHIT toQuery :: GetHIT -> QueryString # | |
type Rep GetHIT Source # | |
Defined in Amazonka.MechanicalTurk.GetHIT | |
type AWSResponse GetHIT Source # | |
Defined in Amazonka.MechanicalTurk.GetHIT |
Create a value of GetHIT
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:hITId:GetHIT'
, getHIT_hITId
- The ID of the HIT to be retrieved.
data GetHITResponse Source #
See: newGetHITResponse
smart constructor.
Instances
Create a value of GetHITResponse
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:hit:GetHITResponse'
, getHITResponse_hit
- Contains the requested HIT data.
$sel:httpStatus:GetHITResponse'
, getHITResponse_httpStatus
- The response's http status code.
CreateWorkerBlock
data CreateWorkerBlock Source #
See: newCreateWorkerBlock
smart constructor.
Instances
Create a value of CreateWorkerBlock
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:workerId:CreateWorkerBlock'
, createWorkerBlock_workerId
- The ID of the Worker to block.
$sel:reason:CreateWorkerBlock'
, createWorkerBlock_reason
- 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.
data CreateWorkerBlockResponse Source #
See: newCreateWorkerBlockResponse
smart constructor.
Instances
newCreateWorkerBlockResponse Source #
Create a value of CreateWorkerBlockResponse
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:httpStatus:CreateWorkerBlockResponse'
, createWorkerBlockResponse_httpStatus
- The response's http status code.
ListHITsForQualificationType (Paginated)
data ListHITsForQualificationType Source #
See: newListHITsForQualificationType
smart constructor.
Instances
newListHITsForQualificationType Source #
Create a value of ListHITsForQualificationType
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:nextToken:ListHITsForQualificationType'
, listHITsForQualificationType_nextToken
- Pagination Token
$sel:maxResults:ListHITsForQualificationType'
, listHITsForQualificationType_maxResults
- Limit the number of results returned.
$sel:qualificationTypeId:ListHITsForQualificationType'
, listHITsForQualificationType_qualificationTypeId
- The ID of the Qualification type to use when querying HITs.
data ListHITsForQualificationTypeResponse Source #
See: newListHITsForQualificationTypeResponse
smart constructor.
Instances
newListHITsForQualificationTypeResponse Source #
Create a value of ListHITsForQualificationTypeResponse
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:nextToken:ListHITsForQualificationType'
, listHITsForQualificationTypeResponse_nextToken
- Undocumented member.
$sel:numResults:ListHITsForQualificationTypeResponse'
, listHITsForQualificationTypeResponse_numResults
- The number of HITs on this page in the filtered results list, equivalent
to the number of HITs being returned by this call.
$sel:hITs:ListHITsForQualificationTypeResponse'
, listHITsForQualificationTypeResponse_hITs
- The list of HIT elements returned by the query.
$sel:httpStatus:ListHITsForQualificationTypeResponse'
, listHITsForQualificationTypeResponse_httpStatus
- The response's http status code.
ListBonusPayments (Paginated)
data ListBonusPayments Source #
See: newListBonusPayments
smart constructor.
Instances
newListBonusPayments :: ListBonusPayments Source #
Create a value of ListBonusPayments
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:nextToken:ListBonusPayments'
, listBonusPayments_nextToken
- Pagination token
$sel:hITId:ListBonusPayments'
, listBonusPayments_hITId
- 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
$sel:assignmentId:ListBonusPayments'
, listBonusPayments_assignmentId
- 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
$sel:maxResults:ListBonusPayments'
, listBonusPayments_maxResults
- Undocumented member.
data ListBonusPaymentsResponse Source #
See: newListBonusPaymentsResponse
smart constructor.
Instances
newListBonusPaymentsResponse Source #
Create a value of ListBonusPaymentsResponse
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:bonusPayments:ListBonusPaymentsResponse'
, listBonusPaymentsResponse_bonusPayments
- A successful request to the ListBonusPayments operation returns a list
of BonusPayment objects.
$sel:nextToken:ListBonusPayments'
, listBonusPaymentsResponse_nextToken
- Undocumented member.
$sel:numResults:ListBonusPaymentsResponse'
, listBonusPaymentsResponse_numResults
- 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.
$sel:httpStatus:ListBonusPaymentsResponse'
, listBonusPaymentsResponse_httpStatus
- The response's http status code.
ListWorkerBlocks (Paginated)
data ListWorkerBlocks Source #
See: newListWorkerBlocks
smart constructor.
Instances
newListWorkerBlocks :: ListWorkerBlocks Source #
Create a value of ListWorkerBlocks
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:nextToken:ListWorkerBlocks'
, listWorkerBlocks_nextToken
- Pagination token
$sel:maxResults:ListWorkerBlocks'
, listWorkerBlocks_maxResults
- Undocumented member.
data ListWorkerBlocksResponse Source #
See: newListWorkerBlocksResponse
smart constructor.
Instances
newListWorkerBlocksResponse Source #
Create a value of ListWorkerBlocksResponse
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:workerBlocks:ListWorkerBlocksResponse'
, listWorkerBlocksResponse_workerBlocks
- The list of WorkerBlocks, containing the collection of Worker IDs and
reasons for blocking.
$sel:nextToken:ListWorkerBlocks'
, listWorkerBlocksResponse_nextToken
- Undocumented member.
$sel:numResults:ListWorkerBlocksResponse'
, listWorkerBlocksResponse_numResults
- The number of assignments on the page in the filtered results list,
equivalent to the number of assignments returned by this call.
$sel:httpStatus:ListWorkerBlocksResponse'
, listWorkerBlocksResponse_httpStatus
- The response's http status code.
DeleteWorkerBlock
data DeleteWorkerBlock Source #
See: newDeleteWorkerBlock
smart constructor.
Instances
Create a value of DeleteWorkerBlock
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:DeleteWorkerBlock'
, deleteWorkerBlock_reason
- A message that explains the reason for unblocking the Worker. The Worker
does not see this message.
$sel:workerId:DeleteWorkerBlock'
, deleteWorkerBlock_workerId
- The ID of the Worker to unblock.
data DeleteWorkerBlockResponse Source #
See: newDeleteWorkerBlockResponse
smart constructor.
Instances
newDeleteWorkerBlockResponse Source #
Create a value of DeleteWorkerBlockResponse
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:httpStatus:DeleteWorkerBlockResponse'
, deleteWorkerBlockResponse_httpStatus
- The response's http status code.
UpdateNotificationSettings
data UpdateNotificationSettings Source #
See: newUpdateNotificationSettings
smart constructor.
Instances
newUpdateNotificationSettings Source #
Create a value of UpdateNotificationSettings
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:notification:UpdateNotificationSettings'
, updateNotificationSettings_notification
- The notification specification for the HIT type.
$sel:active:UpdateNotificationSettings'
, updateNotificationSettings_active
- 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.
$sel:hITTypeId:UpdateNotificationSettings'
, updateNotificationSettings_hITTypeId
- The ID of the HIT type whose notification specification is being
updated.
data UpdateNotificationSettingsResponse Source #
See: newUpdateNotificationSettingsResponse
smart constructor.
Instances
Eq UpdateNotificationSettingsResponse Source # | |
Read UpdateNotificationSettingsResponse Source # | |
Show UpdateNotificationSettingsResponse Source # | |
Generic UpdateNotificationSettingsResponse Source # | |
NFData UpdateNotificationSettingsResponse Source # | |
Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings rnf :: UpdateNotificationSettingsResponse -> () # | |
type Rep UpdateNotificationSettingsResponse Source # | |
Defined in Amazonka.MechanicalTurk.UpdateNotificationSettings type Rep UpdateNotificationSettingsResponse = D1 ('MetaData "UpdateNotificationSettingsResponse" "Amazonka.MechanicalTurk.UpdateNotificationSettings" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "UpdateNotificationSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateNotificationSettingsResponse Source #
Create a value of UpdateNotificationSettingsResponse
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:httpStatus:UpdateNotificationSettingsResponse'
, updateNotificationSettingsResponse_httpStatus
- The response's http status code.
AssociateQualificationWithWorker
data AssociateQualificationWithWorker Source #
See: newAssociateQualificationWithWorker
smart constructor.
Instances
newAssociateQualificationWithWorker Source #
Create a value of AssociateQualificationWithWorker
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:integerValue:AssociateQualificationWithWorker'
, associateQualificationWithWorker_integerValue
- The value of the Qualification to assign.
$sel:sendNotification:AssociateQualificationWithWorker'
, associateQualificationWithWorker_sendNotification
- 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.
$sel:qualificationTypeId:AssociateQualificationWithWorker'
, associateQualificationWithWorker_qualificationTypeId
- The ID of the Qualification type to use for the assigned Qualification.
$sel:workerId:AssociateQualificationWithWorker'
, associateQualificationWithWorker_workerId
- The ID of the Worker to whom the Qualification is being assigned. Worker
IDs are included with submitted HIT assignments and Qualification
requests.
data AssociateQualificationWithWorkerResponse Source #
See: newAssociateQualificationWithWorkerResponse
smart constructor.
Instances
Eq AssociateQualificationWithWorkerResponse Source # | |
Read AssociateQualificationWithWorkerResponse Source # | |
Show AssociateQualificationWithWorkerResponse Source # | |
Generic AssociateQualificationWithWorkerResponse Source # | |
Defined in Amazonka.MechanicalTurk.AssociateQualificationWithWorker type Rep AssociateQualificationWithWorkerResponse :: Type -> Type # | |
NFData AssociateQualificationWithWorkerResponse Source # | |
type Rep AssociateQualificationWithWorkerResponse Source # | |
Defined in Amazonka.MechanicalTurk.AssociateQualificationWithWorker type Rep AssociateQualificationWithWorkerResponse = D1 ('MetaData "AssociateQualificationWithWorkerResponse" "Amazonka.MechanicalTurk.AssociateQualificationWithWorker" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "AssociateQualificationWithWorkerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newAssociateQualificationWithWorkerResponse Source #
Create a value of AssociateQualificationWithWorkerResponse
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:httpStatus:AssociateQualificationWithWorkerResponse'
, associateQualificationWithWorkerResponse_httpStatus
- The response's http status code.
CreateHIT
See: newCreateHIT
smart constructor.
CreateHIT' (Maybe ReviewPolicy) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [HITLayoutParameter]) (Maybe [QualificationRequirement]) (Maybe Text) (Maybe ReviewPolicy) Integer Integer Text Text Text |
Instances
Create a value of CreateHIT
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:hITReviewPolicy:CreateHIT'
, createHIT_hITReviewPolicy
- The HIT-level Review Policy applies to the HIT. You can specify for
Mechanical Turk to take various actions based on the policy.
$sel:uniqueRequestToken:CreateHIT'
, createHIT_uniqueRequestToken
- 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.
$sel:autoApprovalDelayInSeconds:CreateHIT'
, createHIT_autoApprovalDelayInSeconds
- 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.
$sel:requesterAnnotation:CreateHIT'
, createHIT_requesterAnnotation
- 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.
$sel:maxAssignments:CreateHIT'
, createHIT_maxAssignments
- The number of times the HIT can be accepted and completed before the HIT
becomes unavailable.
$sel:keywords:CreateHIT'
, createHIT_keywords
- One or more words or phrases that describe the HIT, separated by commas.
These words are used in searches to find HITs.
$sel:hITLayoutId:CreateHIT'
, createHIT_hITLayoutId
- 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.
$sel:hITLayoutParameters:CreateHIT'
, createHIT_hITLayoutParameters
- If the HITLayoutId is provided, any placeholder values must be filled in
with values using the HITLayoutParameter structure. For more
information, see HITLayout.
$sel:qualificationRequirements:CreateHIT'
, createHIT_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:CreateHIT'
, createHIT_question
- 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.
$sel:assignmentReviewPolicy:CreateHIT'
, createHIT_assignmentReviewPolicy
- 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.
$sel:lifetimeInSeconds:CreateHIT'
, createHIT_lifetimeInSeconds
- 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.
$sel:assignmentDurationInSeconds:CreateHIT'
, createHIT_assignmentDurationInSeconds
- 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.
$sel:reward:CreateHIT'
, createHIT_reward
- The amount of money the Requester will pay a Worker for successfully
completing the HIT.
$sel:title:CreateHIT'
, createHIT_title
- 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.
$sel:description:CreateHIT'
, createHIT_description
- 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.
data CreateHITResponse Source #
See: newCreateHITResponse
smart constructor.
Instances
Create a value of CreateHITResponse
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:hit:CreateHITResponse'
, createHITResponse_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.
$sel:httpStatus:CreateHITResponse'
, createHITResponse_httpStatus
- The response's http status code.
GetAccountBalance
data GetAccountBalance Source #
See: newGetAccountBalance
smart constructor.
Instances
newGetAccountBalance :: GetAccountBalance Source #
Create a value of GetAccountBalance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetAccountBalanceResponse Source #
See: newGetAccountBalanceResponse
smart constructor.
Instances
newGetAccountBalanceResponse Source #
Create a value of GetAccountBalanceResponse
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:availableBalance:GetAccountBalanceResponse'
, getAccountBalanceResponse_availableBalance
- Undocumented member.
$sel:onHoldBalance:GetAccountBalanceResponse'
, getAccountBalanceResponse_onHoldBalance
- Undocumented member.
$sel:httpStatus:GetAccountBalanceResponse'
, getAccountBalanceResponse_httpStatus
- The response's http status code.
Types
AssignmentStatus
newtype AssignmentStatus Source #
pattern AssignmentStatus_Approved :: AssignmentStatus | |
pattern AssignmentStatus_Rejected :: AssignmentStatus | |
pattern AssignmentStatus_Submitted :: AssignmentStatus |
Instances
Comparator
newtype Comparator Source #
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
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 #
pattern HITAccessActions_Accept :: HITAccessActions | |
pattern HITAccessActions_DiscoverPreviewAndAccept :: HITAccessActions | |
pattern HITAccessActions_PreviewAndAccept :: HITAccessActions |
Instances
HITReviewStatus
newtype HITReviewStatus Source #
pattern HITReviewStatus_MarkedForReview :: HITReviewStatus | |
pattern HITReviewStatus_NotReviewed :: HITReviewStatus | |
pattern HITReviewStatus_ReviewedAppropriate :: HITReviewStatus | |
pattern HITReviewStatus_ReviewedInappropriate :: HITReviewStatus |
Instances
HITStatus
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 #
pattern NotificationTransport_Email :: NotificationTransport | |
pattern NotificationTransport_SNS :: NotificationTransport | |
pattern NotificationTransport_SQS :: NotificationTransport |
Instances
NotifyWorkersFailureCode
newtype NotifyWorkersFailureCode Source #
pattern NotifyWorkersFailureCode_HardFailure :: NotifyWorkersFailureCode | |
pattern NotifyWorkersFailureCode_SoftFailure :: NotifyWorkersFailureCode |
Instances
QualificationStatus
newtype QualificationStatus Source #
pattern QualificationStatus_Granted :: QualificationStatus | |
pattern QualificationStatus_Revoked :: QualificationStatus |
Instances
QualificationTypeStatus
newtype QualificationTypeStatus Source #
pattern QualificationTypeStatus_Active :: QualificationTypeStatus | |
pattern QualificationTypeStatus_Inactive :: QualificationTypeStatus |
Instances
ReviewActionStatus
newtype ReviewActionStatus Source #
pattern ReviewActionStatus_Cancelled :: ReviewActionStatus | |
pattern ReviewActionStatus_Failed :: ReviewActionStatus | |
pattern ReviewActionStatus_Intended :: ReviewActionStatus | |
pattern ReviewActionStatus_Succeeded :: ReviewActionStatus |
Instances
ReviewPolicyLevel
newtype ReviewPolicyLevel Source #
pattern ReviewPolicyLevel_Assignment :: ReviewPolicyLevel | |
pattern ReviewPolicyLevel_HIT :: ReviewPolicyLevel |
Instances
ReviewableHITStatus
newtype ReviewableHITStatus Source #
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.
Assignment' (Maybe POSIX) (Maybe Text) (Maybe AssignmentStatus) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
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:assignmentStatus:Assignment'
, assignment_assignmentStatus
- The status of the assignment.
$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: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: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: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: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:hITId:Assignment'
, assignment_hITId
- The ID of the HIT.
$sel:workerId:Assignment'
, assignment_workerId
- The ID of the Worker who accepted the HIT.
$sel:assignmentId:Assignment'
, assignment_assignmentId
- A unique identifier for the assignment.
$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.
BonusPayment
data BonusPayment Source #
An object representing a Bonus payment paid to a Worker.
See: newBonusPayment
smart constructor.
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:reason:BonusPayment'
, bonusPayment_reason
- The Reason text given when the bonus was granted, if any.
$sel:grantTime:BonusPayment'
, bonusPayment_grantTime
- The date and time of when the bonus was granted.
$sel:workerId:BonusPayment'
, bonusPayment_workerId
- The ID of the Worker to whom the bonus was paid.
$sel:assignmentId:BonusPayment'
, bonusPayment_assignmentId
- The ID of the assignment associated with this bonus payment.
$sel:bonusAmount:BonusPayment'
, bonusPayment_bonusAmount
- Undocumented member.
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.
HIT' (Maybe POSIX) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe HITStatus) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [QualificationRequirement]) (Maybe Text) (Maybe Text) (Maybe HITReviewStatus) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Integer) |
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:creationTime:HIT'
, hit_creationTime
- The date and time the HIT was created.
$sel:hITGroupId:HIT'
, hit_hITGroupId
- The ID of the HIT Group of this HIT.
$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:hITTypeId:HIT'
, hit_hITTypeId
- The ID of the HIT type of this HIT
$sel:expiration:HIT'
, hit_expiration
- The date and time the HIT expires.
$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: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:hITStatus:HIT'
, hit_hITStatus
- The status of the HIT and its assignments. Valid Values are Assignable |
Unassignable | Reviewable | Reviewing | Disposed.
$sel:maxAssignments:HIT'
, hit_maxAssignments
- The number of times the HIT can be accepted and completed before the HIT
becomes unavailable.
$sel:numberOfAssignmentsCompleted:HIT'
, hit_numberOfAssignmentsCompleted
- The number of assignments for this HIT that have been approved or
rejected.
$sel:reward:HIT'
, hit_reward
- Undocumented member.
$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:hITLayoutId:HIT'
, hit_hITLayoutId
- The ID of the HIT Layout of this HIT.
$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:title:HIT'
, hit_title
- The title of the HIT.
$sel:hITId:HIT'
, hit_hITId
- A unique identifier for the HIT.
$sel:hITReviewStatus:HIT'
, hit_hITReviewStatus
- Indicates the review status of the HIT. Valid Values are NotReviewed |
MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
$sel:numberOfAssignmentsAvailable:HIT'
, hit_numberOfAssignmentsAvailable
- The number of assignments for this HIT that are available for Workers to
accept.
$sel:description:HIT'
, hit_description
- A general description of the HIT.
$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:assignmentDurationInSeconds:HIT'
, hit_assignmentDurationInSeconds
- The length of time, in seconds, that a Worker has to complete the HIT
after accepting it.
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.
Instances
newHITLayoutParameter Source #
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.
Locale
The Locale data structure represents a geographical region or location.
See: newLocale
smart constructor.
Instances
Eq Locale Source # | |
Read Locale Source # | |
Show Locale Source # | |
Generic Locale Source # | |
NFData Locale Source # | |
Defined in Amazonka.MechanicalTurk.Types.Locale | |
Hashable Locale Source # | |
Defined in Amazonka.MechanicalTurk.Types.Locale | |
ToJSON Locale Source # | |
Defined in Amazonka.MechanicalTurk.Types.Locale | |
FromJSON Locale Source # | |
type Rep Locale Source # | |
Defined in Amazonka.MechanicalTurk.Types.Locale type Rep Locale = D1 ('MetaData "Locale" "Amazonka.MechanicalTurk.Types.Locale" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" '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.
NotificationSpecification
data NotificationSpecification Source #
The NotificationSpecification data structure describes a HIT event notification for a HIT type.
See: newNotificationSpecification
smart constructor.
Instances
newNotificationSpecification Source #
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.
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.
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:notifyWorkersFailureMessage:NotifyWorkersFailureStatus'
, notifyWorkersFailureStatus_notifyWorkersFailureMessage
- A message detailing the reason the Worker could not be notified.
$sel:notifyWorkersFailureCode:NotifyWorkersFailureStatus'
, notifyWorkersFailureStatus_notifyWorkersFailureCode
- Encoded value for the failure type.
$sel:workerId:NotifyWorkersFailureStatus'
, notifyWorkersFailureStatus_workerId
- 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.
ParameterMapEntry' (Maybe [Text]) (Maybe Text) |
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: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.
$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.
PolicyParameter
data PolicyParameter Source #
Name of the parameter from the Review policy.
See: newPolicyParameter
smart constructor.
PolicyParameter' (Maybe [Text]) (Maybe [ParameterMapEntry]) (Maybe Text) |
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:
$sel:values:PolicyParameter'
, policyParameter_values
- The list of values of the Parameter
$sel:mapEntries:PolicyParameter'
, policyParameter_mapEntries
- List of ParameterMapEntry objects.
$sel:key:PolicyParameter'
, policyParameter_key
- Name of the parameter from the list of Review Polices.
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.
Qualification' (Maybe QualificationStatus) (Maybe Int) (Maybe Locale) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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:status:Qualification'
, qualification_status
- The status of the Qualification. Valid values are Granted | Revoked.
$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: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:workerId:Qualification'
, qualification_workerId
- 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.
QualificationRequest' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
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:qualificationRequestId:QualificationRequest'
, qualificationRequest_qualificationRequestId
- The ID of the Qualification request, a unique identifier generated when
the request was submitted.
$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:qualificationTypeId:QualificationRequest'
, qualificationRequest_qualificationTypeId
- The ID of the Qualification type the Worker is requesting, as returned
by the CreateQualificationType operation.
$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:workerId:QualificationRequest'
, qualificationRequest_workerId
- The ID of the Worker requesting the Qualification.
$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.
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.
QualificationRequirement' (Maybe [Locale]) (Maybe HITAccessActions) (Maybe Bool) (Maybe [Int]) Text Comparator |
Instances
newQualificationRequirement Source #
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: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: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: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: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: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.
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.
QualificationType' (Maybe POSIX) (Maybe Integer) (Maybe QualificationTypeStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Integer) |
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:creationTime:QualificationType'
, qualificationType_creationTime
- The date and time the Qualification type was created.
$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.
$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:answerKey:QualificationType'
, qualificationType_answerKey
- The answers to the Qualification test specified in the Test parameter.
$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: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: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: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: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: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: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.
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.
ReviewActionDetail' (Maybe ReviewActionStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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: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:actionId:ReviewActionDetail'
, reviewActionDetail_actionId
- The unique identifier for the action.
$sel:targetType:ReviewActionDetail'
, reviewActionDetail_targetType
- The type of object in TargetId.
$sel:result:ReviewActionDetail'
, reviewActionDetail_result
- A description of the outcome of the review.
$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.
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.
Instances
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
ReviewReport
data ReviewReport Source #
Contains both ReviewResult and ReviewAction elements for a particular HIT.
See: newReviewReport
smart constructor.
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.
ReviewResultDetail
data ReviewResultDetail Source #
This data structure is returned multiple times for each result specified in the Review Policy.
See: newReviewResultDetail
smart constructor.
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:value:ReviewResultDetail'
, reviewResultDetail_value
- The values of Key provided by the review policies you have selected.
$sel:actionId:ReviewResultDetail'
, reviewResultDetail_actionId
- A unique identifier of the Review action result.
$sel:subjectType:ReviewResultDetail'
, reviewResultDetail_subjectType
- The type of the object from the SubjectId field.
$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.
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.
WorkerBlock' (Maybe Text) (Maybe Text) |
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.