@datafire/amazonaws_mturk_requester

Client library for Amazon Mechanical Turk

Installation and Usage

npm install --save @datafire/amazonaws_mturk_requester

let amazonaws_mturk_requester = require('@datafire/amazonaws_mturk_requester').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_mturk_requester.AcceptQualificationRequest({
  "QualificationRequestId": ""
}).then(data => {
  console.log(data);
});

Description

Amazon Mechanical Turk API Reference

Actions

AcceptQualificationRequest

amazonaws_mturk_requester.AcceptQualificationRequest({
  "QualificationRequestId": ""
}, context)

Input

• input object
  • IntegerValue Integer
  • QualificationRequestId required String

Output

• output AcceptQualificationRequestResponse

ApproveAssignment

amazonaws_mturk_requester.ApproveAssignment({
  "AssignmentId": ""
}, context)

Input

• input object
  • AssignmentId required EntityId
  • OverrideRejection Boolean
  • RequesterFeedback String

Output

• output ApproveAssignmentResponse

AssociateQualificationWithWorker

amazonaws_mturk_requester.AssociateQualificationWithWorker({
  "QualificationTypeId": "",
  "WorkerId": ""
}, context)

Input

• input object
  • IntegerValue Integer
  • QualificationTypeId required EntityId
  • SendNotification Boolean
  • WorkerId required CustomerId

Output

• output AssociateQualificationWithWorkerResponse

CreateAdditionalAssignmentsForHIT

amazonaws_mturk_requester.CreateAdditionalAssignmentsForHIT({
  "HITId": "",
  "NumberOfAdditionalAssignments": 0
}, context)

Input

• input object
  • HITId required EntityId
  • NumberOfAdditionalAssignments required Integer
  • UniqueRequestToken IdempotencyToken

Output

• output CreateAdditionalAssignmentsForHITResponse

CreateHIT

amazonaws_mturk_requester.CreateHIT({
  "LifetimeInSeconds": 0,
  "AssignmentDurationInSeconds": 0,
  "Reward": "",
  "Title": "",
  "Description": ""
}, context)

Input

• input object
  • AssignmentDurationInSeconds required Long
  • AssignmentReviewPolicy ReviewPolicy
  • AutoApprovalDelayInSeconds Long
  • Description required String
  • HITLayoutId EntityId
  • HITLayoutParameters HITLayoutParameterList
  • HITReviewPolicy ReviewPolicy
  • Keywords String
  • LifetimeInSeconds required Long
  • MaxAssignments Integer
  • QualificationRequirements QualificationRequirementList
  • Question String
  • RequesterAnnotation String
  • Reward required CurrencyAmount
  • Title required String
  • UniqueRequestToken IdempotencyToken

Output

• output CreateHITResponse

CreateHITType

amazonaws_mturk_requester.CreateHITType({
  "AssignmentDurationInSeconds": 0,
  "Reward": "",
  "Title": "",
  "Description": ""
}, context)

Input

• input object
  • AssignmentDurationInSeconds required Long
  • AutoApprovalDelayInSeconds Long
  • Description required String
  • Keywords String
  • QualificationRequirements QualificationRequirementList
  • Reward required CurrencyAmount
  • Title required String

Output

• output CreateHITTypeResponse

CreateHITWithHITType

amazonaws_mturk_requester.CreateHITWithHITType({
  "HITTypeId": "",
  "LifetimeInSeconds": 0
}, context)

Input

• input object
  • AssignmentReviewPolicy ReviewPolicy
  • HITLayoutId EntityId
  • HITLayoutParameters HITLayoutParameterList
  • HITReviewPolicy ReviewPolicy
  • HITTypeId required EntityId
  • LifetimeInSeconds required Long
  • MaxAssignments Integer
  • Question String
  • RequesterAnnotation String
  • UniqueRequestToken IdempotencyToken

Output

• output CreateHITWithHITTypeResponse

CreateQualificationType

amazonaws_mturk_requester.CreateQualificationType({
  "Name": "",
  "Description": "",
  "QualificationTypeStatus": ""
}, context)

Input

• input object
  • AnswerKey String
  • AutoGranted Boolean
  • AutoGrantedValue Integer
  • Description required String
  • Keywords String
  • Name required String
  • QualificationTypeStatus required QualificationTypeStatus
  • RetryDelayInSeconds Long
  • Test String
  • TestDurationInSeconds Long

Output

• output CreateQualificationTypeResponse

CreateWorkerBlock

amazonaws_mturk_requester.CreateWorkerBlock({
  "WorkerId": "",
  "Reason": ""
}, context)

Input

• input object
  • Reason required String
  • WorkerId required CustomerId

Output

• output CreateWorkerBlockResponse

DeleteHIT

amazonaws_mturk_requester.DeleteHIT({
  "HITId": ""
}, context)

Input

• input object
  • HITId required EntityId

Output

• output DeleteHITResponse

DeleteQualificationType

amazonaws_mturk_requester.DeleteQualificationType({
  "QualificationTypeId": ""
}, context)

Input

• input object
  • QualificationTypeId required EntityId

Output

• output DeleteQualificationTypeResponse

DeleteWorkerBlock

amazonaws_mturk_requester.DeleteWorkerBlock({
  "WorkerId": ""
}, context)

Input

• input object
  • Reason String
  • WorkerId required CustomerId

Output

• output DeleteWorkerBlockResponse

DisassociateQualificationFromWorker

amazonaws_mturk_requester.DisassociateQualificationFromWorker({
  "WorkerId": "",
  "QualificationTypeId": ""
}, context)

Input

• input object
  • QualificationTypeId required EntityId
  • Reason String
  • WorkerId required CustomerId

Output

• output DisassociateQualificationFromWorkerResponse

GetAccountBalance

amazonaws_mturk_requester.GetAccountBalance({}, context)

Input

• input object

Output

• output GetAccountBalanceResponse

GetAssignment

amazonaws_mturk_requester.GetAssignment({
  "AssignmentId": ""
}, context)

Input

• input object
  • AssignmentId required EntityId

Output

• output GetAssignmentResponse

GetFileUploadURL

amazonaws_mturk_requester.GetFileUploadURL({
  "AssignmentId": "",
  "QuestionIdentifier": ""
}, context)

Input

• input object
  • AssignmentId required EntityId
  • QuestionIdentifier required String

Output

• output GetFileUploadURLResponse

GetHIT

amazonaws_mturk_requester.GetHIT({
  "HITId": ""
}, context)

Input

• input object
  • HITId required EntityId

Output

• output GetHITResponse

GetQualificationScore

amazonaws_mturk_requester.GetQualificationScore({
  "QualificationTypeId": "",
  "WorkerId": ""
}, context)

Input

• input object
  • QualificationTypeId required EntityId
  • WorkerId required CustomerId

Output

• output GetQualificationScoreResponse

GetQualificationType

amazonaws_mturk_requester.GetQualificationType({
  "QualificationTypeId": ""
}, context)

Input

• input object
  • QualificationTypeId required EntityId

Output

• output GetQualificationTypeResponse

ListAssignmentsForHIT

amazonaws_mturk_requester.ListAssignmentsForHIT({
  "HITId": ""
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • AssignmentStatuses AssignmentStatusList
  • HITId required EntityId
  • MaxResults ResultSize
  • NextToken PaginationToken

Output

• output ListAssignmentsForHITResponse

ListBonusPayments

amazonaws_mturk_requester.ListBonusPayments({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • AssignmentId EntityId
  • HITId EntityId
  • MaxResults ResultSize
  • NextToken PaginationToken

Output

• output ListBonusPaymentsResponse

ListHITs

amazonaws_mturk_requester.ListHITs({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults ResultSize
  • NextToken PaginationToken

Output

• output ListHITsResponse

ListHITsForQualificationType

amazonaws_mturk_requester.ListHITsForQualificationType({
  "QualificationTypeId": ""
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults ResultSize
  • NextToken PaginationToken
  • QualificationTypeId required EntityId

Output

• output ListHITsForQualificationTypeResponse

ListQualificationRequests

amazonaws_mturk_requester.ListQualificationRequests({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults ResultSize
  • NextToken PaginationToken
  • QualificationTypeId EntityId

Output

• output ListQualificationRequestsResponse

ListQualificationTypes

amazonaws_mturk_requester.ListQualificationTypes({
  "MustBeRequestable": true
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults ResultSize
  • MustBeOwnedByCaller Boolean
  • MustBeRequestable required Boolean
  • NextToken PaginationToken
  • Query String

Output

• output ListQualificationTypesResponse

ListReviewPolicyResultsForHIT

amazonaws_mturk_requester.ListReviewPolicyResultsForHIT({
  "HITId": ""
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • HITId required EntityId
  • MaxResults ResultSize
  • NextToken PaginationToken
  • PolicyLevels ReviewPolicyLevelList
  • RetrieveActions Boolean
  • RetrieveResults Boolean

Output

• output ListReviewPolicyResultsForHITResponse

ListReviewableHITs

amazonaws_mturk_requester.ListReviewableHITs({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • HITTypeId EntityId
  • MaxResults ResultSize
  • NextToken PaginationToken
  • Status ReviewableHITStatus

Output

• output ListReviewableHITsResponse

ListWorkerBlocks

amazonaws_mturk_requester.ListWorkerBlocks({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults ResultSize
  • NextToken PaginationToken

Output

• output ListWorkerBlocksResponse

ListWorkersWithQualificationType

amazonaws_mturk_requester.ListWorkersWithQualificationType({
  "QualificationTypeId": ""
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults ResultSize
  • NextToken PaginationToken
  • QualificationTypeId required EntityId
  • Status QualificationStatus

Output

• output ListWorkersWithQualificationTypeResponse

NotifyWorkers

amazonaws_mturk_requester.NotifyWorkers({
  "Subject": "",
  "MessageText": "",
  "WorkerIds": []
}, context)

Input

• input object
  • MessageText required String
  • Subject required String
  • WorkerIds required CustomerIdList

Output

• output NotifyWorkersResponse

RejectAssignment

amazonaws_mturk_requester.RejectAssignment({
  "AssignmentId": "",
  "RequesterFeedback": ""
}, context)

Input

• input object
  • AssignmentId required EntityId
  • RequesterFeedback required String

Output

• output RejectAssignmentResponse

RejectQualificationRequest

amazonaws_mturk_requester.RejectQualificationRequest({
  "QualificationRequestId": ""
}, context)

Input

• input object
  • QualificationRequestId required String
  • Reason String

Output

• output RejectQualificationRequestResponse

SendBonus

amazonaws_mturk_requester.SendBonus({
  "WorkerId": "",
  "BonusAmount": "",
  "AssignmentId": "",
  "Reason": ""
}, context)

Input

• input object
  • AssignmentId required EntityId
  • BonusAmount required CurrencyAmount
  • Reason required String
  • UniqueRequestToken IdempotencyToken
  • WorkerId required CustomerId

Output

• output SendBonusResponse

SendTestEventNotification

amazonaws_mturk_requester.SendTestEventNotification({
  "Notification": {
    "Destination": "",
    "Transport": "",
    "Version": "",
    "EventTypes": []
  },
  "TestEventType": ""
}, context)

Input

• input object
  • Notification required NotificationSpecification
  • TestEventType required EventType

Output

• output SendTestEventNotificationResponse

UpdateExpirationForHIT

amazonaws_mturk_requester.UpdateExpirationForHIT({
  "HITId": "",
  "ExpireAt": ""
}, context)

Input

• input object
  • ExpireAt required Timestamp
  • HITId required EntityId

Output

• output UpdateExpirationForHITResponse

UpdateHITReviewStatus

amazonaws_mturk_requester.UpdateHITReviewStatus({
  "HITId": ""
}, context)

Input

• input object
  • HITId required EntityId
  • Revert Boolean

Output

• output UpdateHITReviewStatusResponse

UpdateHITTypeOfHIT

amazonaws_mturk_requester.UpdateHITTypeOfHIT({
  "HITId": "",
  "HITTypeId": ""
}, context)

Input

• input object
  • HITId required EntityId
  • HITTypeId required EntityId

Output

• output UpdateHITTypeOfHITResponse

UpdateNotificationSettings

amazonaws_mturk_requester.UpdateNotificationSettings({
  "HITTypeId": ""
}, context)

Input

• input object
  • Active Boolean
  • HITTypeId required EntityId
  • Notification NotificationSpecification

Output

• output UpdateNotificationSettingsResponse

UpdateQualificationType

amazonaws_mturk_requester.UpdateQualificationType({
  "QualificationTypeId": ""
}, context)

Input

• input object
  • AnswerKey String
  • AutoGranted Boolean
  • AutoGrantedValue Integer
  • Description String
  • QualificationTypeId required EntityId
  • QualificationTypeStatus QualificationTypeStatus
  • RetryDelayInSeconds Long
  • Test String
  • TestDurationInSeconds Long

Output

• output UpdateQualificationTypeResponse

Definitions

AcceptQualificationRequestRequest

• AcceptQualificationRequestRequest object
  • IntegerValue Integer
  • QualificationRequestId required String

AcceptQualificationRequestResponse

• AcceptQualificationRequestResponse object

ApproveAssignmentRequest

• ApproveAssignmentRequest object
  • AssignmentId required EntityId
  • OverrideRejection Boolean
  • RequesterFeedback String

ApproveAssignmentResponse

• ApproveAssignmentResponse object

Assignment

• Assignment object: 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.
  • AcceptTime Timestamp
  • Answer String
  • ApprovalTime Timestamp
  • AssignmentId EntityId
  • AssignmentStatus AssignmentStatus
  • AutoApprovalTime Timestamp
  • Deadline Timestamp
  • HITId EntityId
  • RejectionTime Timestamp
  • RequesterFeedback String
  • SubmitTime Timestamp
  • WorkerId CustomerId

AssignmentList

• AssignmentList array
  • items Assignment

AssignmentStatus

• AssignmentStatus string (values: Submitted, Approved, Rejected)

AssignmentStatusList

• AssignmentStatusList array
  • items AssignmentStatus

AssociateQualificationWithWorkerRequest

• AssociateQualificationWithWorkerRequest object
  • IntegerValue Integer
  • QualificationTypeId required EntityId
  • SendNotification Boolean
  • WorkerId required CustomerId

AssociateQualificationWithWorkerResponse

• AssociateQualificationWithWorkerResponse object

BonusPayment

• BonusPayment object: An object representing a Bonus payment paid to a Worker.
  • AssignmentId EntityId
  • BonusAmount CurrencyAmount
  • GrantTime Timestamp
  • Reason String
  • WorkerId CustomerId

BonusPaymentList

• BonusPaymentList array
  • items BonusPayment

Boolean

• Boolean boolean

Comparator

• Comparator string (values: LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, NotEqualTo, Exists, DoesNotExist, In, NotIn)

CountryParameters

• CountryParameters string

CreateAdditionalAssignmentsForHITRequest

• CreateAdditionalAssignmentsForHITRequest object
  • HITId required EntityId
  • NumberOfAdditionalAssignments required Integer
  • UniqueRequestToken IdempotencyToken

CreateAdditionalAssignmentsForHITResponse

• CreateAdditionalAssignmentsForHITResponse object

CreateHITRequest

• CreateHITRequest object
  • AssignmentDurationInSeconds required Long
  • AssignmentReviewPolicy ReviewPolicy
  • AutoApprovalDelayInSeconds Long
  • Description required String
  • HITLayoutId EntityId
  • HITLayoutParameters HITLayoutParameterList
  • HITReviewPolicy ReviewPolicy
  • Keywords String
  • LifetimeInSeconds required Long
  • MaxAssignments Integer
  • QualificationRequirements QualificationRequirementList
  • Question String
  • RequesterAnnotation String
  • Reward required CurrencyAmount
  • Title required String
  • UniqueRequestToken IdempotencyToken

CreateHITResponse

• CreateHITResponse object
  • HIT HIT

CreateHITTypeRequest

• CreateHITTypeRequest object
  • AssignmentDurationInSeconds required Long
  • AutoApprovalDelayInSeconds Long
  • Description required String
  • Keywords String
  • QualificationRequirements QualificationRequirementList
  • Reward required CurrencyAmount
  • Title required String

CreateHITTypeResponse

• CreateHITTypeResponse object
  • HITTypeId EntityId

CreateHITWithHITTypeRequest

• CreateHITWithHITTypeRequest object
  • AssignmentReviewPolicy ReviewPolicy
  • HITLayoutId EntityId
  • HITLayoutParameters HITLayoutParameterList
  • HITReviewPolicy ReviewPolicy
  • HITTypeId required EntityId
  • LifetimeInSeconds required Long
  • MaxAssignments Integer
  • Question String
  • RequesterAnnotation String
  • UniqueRequestToken IdempotencyToken

CreateHITWithHITTypeResponse

• CreateHITWithHITTypeResponse object
  • HIT HIT

CreateQualificationTypeRequest

• CreateQualificationTypeRequest object
  • AnswerKey String
  • AutoGranted Boolean
  • AutoGrantedValue Integer
  • Description required String
  • Keywords String
  • Name required String
  • QualificationTypeStatus required QualificationTypeStatus
  • RetryDelayInSeconds Long
  • Test String
  • TestDurationInSeconds Long

CreateQualificationTypeResponse

• CreateQualificationTypeResponse object
  • QualificationType QualificationType

CreateWorkerBlockRequest

• CreateWorkerBlockRequest object
  • Reason required String
  • WorkerId required CustomerId

CreateWorkerBlockResponse

• CreateWorkerBlockResponse object

CurrencyAmount

• CurrencyAmount string: A string representing a currency amount.

CustomerId

• CustomerId string

CustomerIdList

• CustomerIdList array
  • items CustomerId

DeleteHITRequest

• DeleteHITRequest object
  • HITId required EntityId

DeleteHITResponse

• DeleteHITResponse object

DeleteQualificationTypeRequest

• DeleteQualificationTypeRequest object
  • QualificationTypeId required EntityId

DeleteQualificationTypeResponse

• DeleteQualificationTypeResponse object

DeleteWorkerBlockRequest

• DeleteWorkerBlockRequest object
  • Reason String
  • WorkerId required CustomerId

DeleteWorkerBlockResponse

• DeleteWorkerBlockResponse object

DisassociateQualificationFromWorkerRequest

• DisassociateQualificationFromWorkerRequest object
  • QualificationTypeId required EntityId
  • Reason String
  • WorkerId required CustomerId

DisassociateQualificationFromWorkerResponse

• DisassociateQualificationFromWorkerResponse object

EntityId

• EntityId string

EventType

• EventType string (values: AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping)

EventTypeList

• EventTypeList array
  • items EventType

ExceptionMessage

• ExceptionMessage string

GetAccountBalanceRequest

• GetAccountBalanceRequest object

GetAccountBalanceResponse

• GetAccountBalanceResponse object
  • AvailableBalance CurrencyAmount
  • OnHoldBalance CurrencyAmount

GetAssignmentRequest

• GetAssignmentRequest object
  • AssignmentId required EntityId

GetAssignmentResponse

• GetAssignmentResponse object
  • Assignment Assignment
  • HIT HIT

GetFileUploadURLRequest

• GetFileUploadURLRequest object
  • AssignmentId required EntityId
  • QuestionIdentifier required String

GetFileUploadURLResponse

• GetFileUploadURLResponse object
  • FileUploadURL String

GetHITRequest

• GetHITRequest object
  • HITId required EntityId

GetHITResponse

• GetHITResponse object
  • HIT HIT

GetQualificationScoreRequest

• GetQualificationScoreRequest object
  • QualificationTypeId required EntityId
  • WorkerId required CustomerId

GetQualificationScoreResponse

• GetQualificationScoreResponse object
  • Qualification Qualification

GetQualificationTypeRequest

• GetQualificationTypeRequest object
  • QualificationTypeId required EntityId

GetQualificationTypeResponse

• GetQualificationTypeResponse object
  • QualificationType QualificationType

HIT

• HIT object: The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.
  • AssignmentDurationInSeconds Long
  • AutoApprovalDelayInSeconds Long
  • CreationTime Timestamp
  • Description String
  • Expiration Timestamp
  • HITGroupId EntityId
  • HITId EntityId
  • HITLayoutId EntityId
  • HITReviewStatus HITReviewStatus
  • HITStatus HITStatus
  • HITTypeId EntityId
  • Keywords String
  • MaxAssignments Integer
  • NumberOfAssignmentsAvailable Integer
  • NumberOfAssignmentsCompleted Integer
  • NumberOfAssignmentsPending Integer
  • QualificationRequirements QualificationRequirementList
  • Question String
  • RequesterAnnotation String
  • Reward CurrencyAmount
  • Title String

HITLayoutParameter

• HITLayoutParameter object: 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.
  • Name required String
  • Value required String

HITLayoutParameterList

• HITLayoutParameterList array
  • items HITLayoutParameter

HITList

• HITList array
  • items HIT

HITReviewStatus

• HITReviewStatus string (values: NotReviewed, MarkedForReview, ReviewedAppropriate, ReviewedInappropriate)

HITStatus

• HITStatus string (values: Assignable, Unassignable, Reviewable, Reviewing, Disposed)

IdempotencyToken

• IdempotencyToken string

Integer

• Integer integer

IntegerList

• IntegerList array
  • items Integer

ListAssignmentsForHITRequest

• ListAssignmentsForHITRequest object
  • AssignmentStatuses AssignmentStatusList
  • HITId required EntityId
  • MaxResults ResultSize
  • NextToken PaginationToken

ListAssignmentsForHITResponse

• ListAssignmentsForHITResponse object
  • Assignments AssignmentList
  • NextToken PaginationToken
  • NumResults Integer

ListBonusPaymentsRequest

• ListBonusPaymentsRequest object
  • AssignmentId EntityId
  • HITId EntityId
  • MaxResults ResultSize
  • NextToken PaginationToken

ListBonusPaymentsResponse

• ListBonusPaymentsResponse object
  • BonusPayments BonusPaymentList
  • NextToken PaginationToken
  • NumResults Integer

ListHITsForQualificationTypeRequest

• ListHITsForQualificationTypeRequest object
  • MaxResults ResultSize
  • NextToken PaginationToken
  • QualificationTypeId required EntityId

ListHITsForQualificationTypeResponse

• ListHITsForQualificationTypeResponse object
  • HITs HITList
  • NextToken PaginationToken
  • NumResults Integer

ListHITsRequest

• ListHITsRequest object
  • MaxResults ResultSize
  • NextToken PaginationToken

ListHITsResponse

• ListHITsResponse object
  • HITs HITList
  • NextToken PaginationToken
  • NumResults Integer

ListQualificationRequestsRequest

• ListQualificationRequestsRequest object
  • MaxResults ResultSize
  • NextToken PaginationToken
  • QualificationTypeId EntityId

ListQualificationRequestsResponse

• ListQualificationRequestsResponse object
  • NextToken PaginationToken
  • NumResults Integer
  • QualificationRequests QualificationRequestList

ListQualificationTypesRequest

• ListQualificationTypesRequest object
  • MaxResults ResultSize
  • MustBeOwnedByCaller Boolean
  • MustBeRequestable required Boolean
  • NextToken PaginationToken
  • Query String

ListQualificationTypesResponse

• ListQualificationTypesResponse object
  • NextToken PaginationToken
  • NumResults Integer
  • QualificationTypes QualificationTypeList

ListReviewPolicyResultsForHITRequest

• ListReviewPolicyResultsForHITRequest object
  • HITId required EntityId
  • MaxResults ResultSize
  • NextToken PaginationToken
  • PolicyLevels ReviewPolicyLevelList
  • RetrieveActions Boolean
  • RetrieveResults Boolean

ListReviewPolicyResultsForHITResponse

• ListReviewPolicyResultsForHITResponse object
  • AssignmentReviewPolicy ReviewPolicy
  • AssignmentReviewReport ReviewReport
  • HITId EntityId
  • HITReviewPolicy ReviewPolicy
  • HITReviewReport ReviewReport
  • NextToken PaginationToken

ListReviewableHITsRequest

• ListReviewableHITsRequest object
  • HITTypeId EntityId
  • MaxResults ResultSize
  • NextToken PaginationToken
  • Status ReviewableHITStatus

ListReviewableHITsResponse

• ListReviewableHITsResponse object
  • HITs HITList
  • NextToken PaginationToken
  • NumResults Integer

ListWorkerBlocksRequest

• ListWorkerBlocksRequest object
  • MaxResults ResultSize
  • NextToken PaginationToken

ListWorkerBlocksResponse

• ListWorkerBlocksResponse object
  • NextToken PaginationToken
  • NumResults Integer
  • WorkerBlocks WorkerBlockList

ListWorkersWithQualificationTypeRequest

• ListWorkersWithQualificationTypeRequest object
  • MaxResults ResultSize
  • NextToken PaginationToken
  • QualificationTypeId required EntityId
  • Status QualificationStatus

ListWorkersWithQualificationTypeResponse

• ListWorkersWithQualificationTypeResponse object
  • NextToken PaginationToken
  • NumResults Integer
  • Qualifications QualificationList

Locale

• Locale object: The Locale data structure represents a geographical region or location.
  • Country required CountryParameters
  • Subdivision CountryParameters

LocaleList

• LocaleList array
  • items Locale

Long

• Long integer

NotificationSpecification

• NotificationSpecification object: The NotificationSpecification data structure describes a HIT event notification for a HIT type.
  • Destination required String
  • EventTypes required EventTypeList
  • Transport required NotificationTransport
  • Version required String

NotificationTransport

• NotificationTransport string (values: Email, SQS, SNS)

NotifyWorkersFailureCode

• NotifyWorkersFailureCode string (values: SoftFailure, HardFailure)

NotifyWorkersFailureStatus

• NotifyWorkersFailureStatus object: When MTurk encounters an issue with notifying the Workers you specified, it returns back this object with failure details.
  • NotifyWorkersFailureCode NotifyWorkersFailureCode
  • NotifyWorkersFailureMessage String
  • WorkerId CustomerId

NotifyWorkersFailureStatusList

• NotifyWorkersFailureStatusList array
  • items NotifyWorkersFailureStatus

NotifyWorkersRequest

• NotifyWorkersRequest object
  • MessageText required String
  • Subject required String
  • WorkerIds required CustomerIdList

NotifyWorkersResponse

• NotifyWorkersResponse object
  • NotifyWorkersFailureStatuses NotifyWorkersFailureStatusList

PaginationToken

• PaginationToken string: If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

ParameterMapEntry

• ParameterMapEntry object: This data structure is the data type for the AnswerKey parameter of the ScoreMyKnownAnswers/2011-09-01 Review Policy.
  • Key String
  • Values StringList

ParameterMapEntryList

• ParameterMapEntryList array
  • items ParameterMapEntry

PolicyParameter

• PolicyParameter object: Name of the parameter from the Review policy.
  • Key String
  • MapEntries ParameterMapEntryList
  • Values StringList

PolicyParameterList

• PolicyParameterList array
  • items PolicyParameter

Qualification

• Qualification object: The Qualification data structure represents a Qualification assigned to a user, including the Qualification type and the value (score).
  • GrantTime Timestamp
  • IntegerValue Integer
  • LocaleValue Locale
  • QualificationTypeId EntityId
  • Status QualificationStatus
  • WorkerId CustomerId

QualificationList

• QualificationList array
  • items Qualification

QualificationRequest

• QualificationRequest object: The QualificationRequest data structure represents a request a Worker has made for a Qualification.
  • Answer String
  • QualificationRequestId String
  • QualificationTypeId EntityId
  • SubmitTime Timestamp
  • Test String
  • WorkerId CustomerId

QualificationRequestList

• QualificationRequestList array
  • items QualificationRequest

QualificationRequirement

• QualificationRequirement object: 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.
  • Comparator required Comparator
  • IntegerValues IntegerList
  • LocaleValues LocaleList
  • QualificationTypeId required String
  • RequiredToPreview Boolean

QualificationRequirementList

• QualificationRequirementList array
  • items QualificationRequirement

QualificationStatus

• QualificationStatus string (values: Granted, Revoked)

QualificationType

• QualificationType object: 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.
  • AnswerKey String
  • AutoGranted Boolean
  • AutoGrantedValue Integer
  • CreationTime Timestamp
  • Description String
  • IsRequestable Boolean
  • Keywords String
  • Name String
  • QualificationTypeId EntityId
  • QualificationTypeStatus QualificationTypeStatus
  • RetryDelayInSeconds Long
  • Test String
  • TestDurationInSeconds Long

QualificationTypeList

• QualificationTypeList array
  • items QualificationType

QualificationTypeStatus

• QualificationTypeStatus string (values: Active, Inactive)

RejectAssignmentRequest

• RejectAssignmentRequest object
  • AssignmentId required EntityId
  • RequesterFeedback required String

RejectAssignmentResponse

• RejectAssignmentResponse object

RejectQualificationRequestRequest

• RejectQualificationRequestRequest object
  • QualificationRequestId required String
  • Reason String

RejectQualificationRequestResponse

• RejectQualificationRequestResponse object

RequestError

• RequestError object: Your request is invalid.
  • Message ExceptionMessage
  • TurkErrorCode TurkErrorCode

ResultSize

• ResultSize integer

ReviewActionDetail

• ReviewActionDetail object: 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.
  • ActionId EntityId
  • ActionName String
  • CompleteTime Timestamp
  • ErrorCode String
  • Result String
  • Status ReviewActionStatus
  • TargetId EntityId
  • TargetType String

ReviewActionDetailList

• ReviewActionDetailList array
  • items ReviewActionDetail

ReviewActionStatus

• ReviewActionStatus string (values: Intended, Succeeded, Failed, Cancelled)

ReviewPolicy

• ReviewPolicy object: HIT Review Policy data structures represent HIT review policies, which you specify when you create a HIT.
  • Parameters PolicyParameterList
  • PolicyName required String

ReviewPolicyLevel

• ReviewPolicyLevel string (values: Assignment, HIT)

ReviewPolicyLevelList

• ReviewPolicyLevelList array
  • items ReviewPolicyLevel

ReviewReport

• ReviewReport object: Contains both ReviewResult and ReviewAction elements for a particular HIT.
  • ReviewActions ReviewActionDetailList
  • ReviewResults ReviewResultDetailList

ReviewResultDetail

• ReviewResultDetail object: This data structure is returned multiple times for each result specified in the Review Policy.
  • ActionId EntityId
  • Key String
  • QuestionId EntityId
  • SubjectId EntityId
  • SubjectType String
  • Value String

ReviewResultDetailList

• ReviewResultDetailList array
  • items ReviewResultDetail

ReviewableHITStatus

• ReviewableHITStatus string (values: Reviewable, Reviewing)

SendBonusRequest

• SendBonusRequest object
  • AssignmentId required EntityId
  • BonusAmount required CurrencyAmount
  • Reason required String
  • UniqueRequestToken IdempotencyToken
  • WorkerId required CustomerId

SendBonusResponse

• SendBonusResponse object

SendTestEventNotificationRequest

• SendTestEventNotificationRequest object
  • Notification required NotificationSpecification
  • TestEventType required EventType

SendTestEventNotificationResponse

• SendTestEventNotificationResponse object

ServiceFault

• ServiceFault object: Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
  • Message ExceptionMessage
  • TurkErrorCode TurkErrorCode

String

• String string

StringList

• StringList array
  • items String

Timestamp

• Timestamp string

TurkErrorCode

• TurkErrorCode string

UpdateExpirationForHITRequest

• UpdateExpirationForHITRequest object
  • ExpireAt required Timestamp
  • HITId required EntityId

UpdateExpirationForHITResponse

• UpdateExpirationForHITResponse object

UpdateHITReviewStatusRequest

• UpdateHITReviewStatusRequest object
  • HITId required EntityId
  • Revert Boolean

UpdateHITReviewStatusResponse

• UpdateHITReviewStatusResponse object

UpdateHITTypeOfHITRequest

• UpdateHITTypeOfHITRequest object
  • HITId required EntityId
  • HITTypeId required EntityId

UpdateHITTypeOfHITResponse

• UpdateHITTypeOfHITResponse object

UpdateNotificationSettingsRequest

• UpdateNotificationSettingsRequest object
  • Active Boolean
  • HITTypeId required EntityId
  • Notification NotificationSpecification

UpdateNotificationSettingsResponse

• UpdateNotificationSettingsResponse object

UpdateQualificationTypeRequest

• UpdateQualificationTypeRequest object
  • AnswerKey String
  • AutoGranted Boolean
  • AutoGrantedValue Integer
  • Description String
  • QualificationTypeId required EntityId
  • QualificationTypeStatus QualificationTypeStatus
  • RetryDelayInSeconds Long
  • Test String
  • TestDurationInSeconds Long

UpdateQualificationTypeResponse

• UpdateQualificationTypeResponse object
  • QualificationType QualificationType

WorkerBlock

• WorkerBlock object: The WorkerBlock data structure represents a Worker who has been blocked. It has two elements: the WorkerId and the Reason for the block.
  • Reason String
  • WorkerId CustomerId

WorkerBlockList

• WorkerBlockList array
  • items WorkerBlock