❤
npm
Sign UpSign In

@datafire/amazonaws_mturk_requester

5.0.0 • Public • Published

@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

Output

ApproveAssignment

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

Input

Output

AssociateQualificationWithWorker

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

Input

Output

CreateAdditionalAssignmentsForHIT

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

Input

Output

CreateHIT

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

Input

Output

CreateHITType

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

Input

Output

CreateHITWithHITType

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

Input

Output

CreateQualificationType

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

Input

Output

CreateWorkerBlock

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

Input

Output

DeleteHIT

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

Input

Output

DeleteQualificationType

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

Input

  • input object

Output

DeleteWorkerBlock

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

Input

Output

DisassociateQualificationFromWorker

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

Input

Output

GetAccountBalance

amazonaws_mturk_requester.GetAccountBalance({}, context)

Input

  • input object

Output

GetAssignment

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

Input

  • input object

Output

GetFileUploadURL

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

Input

  • input object

Output

GetHIT

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

Input

Output

GetQualificationScore

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

Input

Output

GetQualificationType

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

Input

  • input object

Output

ListAssignmentsForHIT

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

Input

Output

ListBonusPayments

amazonaws_mturk_requester.ListBonusPayments({}, context)

Input

Output

ListHITs

amazonaws_mturk_requester.ListHITs({}, context)

Input

Output

ListHITsForQualificationType

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

Input

Output

ListQualificationRequests

amazonaws_mturk_requester.ListQualificationRequests({}, context)

Input

Output

ListQualificationTypes

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

Input

Output

ListReviewPolicyResultsForHIT

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

Input

Output

ListReviewableHITs

amazonaws_mturk_requester.ListReviewableHITs({}, context)

Input

Output

ListWorkerBlocks

amazonaws_mturk_requester.ListWorkerBlocks({}, context)

Input

Output

ListWorkersWithQualificationType

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

Input

Output

NotifyWorkers

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

Input

Output

RejectAssignment

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

Input

  • input object

Output

RejectQualificationRequest

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

Input

  • input object

Output

SendBonus

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

Input

Output

SendTestEventNotification

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

Input

Output

UpdateExpirationForHIT

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

Input

Output

UpdateHITReviewStatus

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

Input

Output

UpdateHITTypeOfHIT

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

Input

Output

UpdateNotificationSettings

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

Input

Output

UpdateQualificationType

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

Input

Output

Definitions

AcceptQualificationRequestRequest

  • AcceptQualificationRequestRequest object

AcceptQualificationRequestResponse

  • AcceptQualificationRequestResponse object

ApproveAssignmentRequest

  • ApproveAssignmentRequest object

ApproveAssignmentResponse

  • ApproveAssignmentResponse object

Assignment

AssignmentList

AssignmentStatus

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

AssignmentStatusList

AssociateQualificationWithWorkerRequest

  • AssociateQualificationWithWorkerRequest object

AssociateQualificationWithWorkerResponse

  • AssociateQualificationWithWorkerResponse object

BonusPayment

BonusPaymentList

Boolean

  • Boolean boolean

Comparator

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

CountryParameters

  • CountryParameters string

CreateAdditionalAssignmentsForHITRequest

  • CreateAdditionalAssignmentsForHITRequest object

CreateAdditionalAssignmentsForHITResponse

  • CreateAdditionalAssignmentsForHITResponse object

CreateHITRequest

CreateHITResponse

  • CreateHITResponse object

CreateHITTypeRequest

CreateHITTypeResponse

  • CreateHITTypeResponse object

CreateHITWithHITTypeRequest

CreateHITWithHITTypeResponse

  • CreateHITWithHITTypeResponse object

CreateQualificationTypeRequest

CreateQualificationTypeResponse

CreateWorkerBlockRequest

  • CreateWorkerBlockRequest object

CreateWorkerBlockResponse

  • CreateWorkerBlockResponse object

CurrencyAmount

  • CurrencyAmount string: A string representing a currency amount.

CustomerId

  • CustomerId string

CustomerIdList

DeleteHITRequest

  • DeleteHITRequest object

DeleteHITResponse

  • DeleteHITResponse object

DeleteQualificationTypeRequest

  • DeleteQualificationTypeRequest object

DeleteQualificationTypeResponse

  • DeleteQualificationTypeResponse object

DeleteWorkerBlockRequest

DeleteWorkerBlockResponse

  • DeleteWorkerBlockResponse object

DisassociateQualificationFromWorkerRequest

  • DisassociateQualificationFromWorkerRequest object

DisassociateQualificationFromWorkerResponse

  • DisassociateQualificationFromWorkerResponse object

EntityId

  • EntityId string

EventType

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

EventTypeList

ExceptionMessage

  • ExceptionMessage string

GetAccountBalanceRequest

  • GetAccountBalanceRequest object

GetAccountBalanceResponse

GetAssignmentRequest

  • GetAssignmentRequest object

GetAssignmentResponse

GetFileUploadURLRequest

  • GetFileUploadURLRequest object

GetFileUploadURLResponse

  • GetFileUploadURLResponse object

GetHITRequest

  • GetHITRequest object

GetHITResponse

  • GetHITResponse object

GetQualificationScoreRequest

  • GetQualificationScoreRequest object

GetQualificationScoreResponse

  • GetQualificationScoreResponse object

GetQualificationTypeRequest

  • GetQualificationTypeRequest object

GetQualificationTypeResponse

HIT

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.

HITLayoutParameterList

HITList

  • HITList array

HITReviewStatus

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

HITStatus

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

IdempotencyToken

  • IdempotencyToken string

Integer

  • Integer integer

IntegerList

ListAssignmentsForHITRequest

ListAssignmentsForHITResponse

ListBonusPaymentsRequest

ListBonusPaymentsResponse

ListHITsForQualificationTypeRequest

ListHITsForQualificationTypeResponse

ListHITsRequest

ListHITsResponse

ListQualificationRequestsRequest

ListQualificationRequestsResponse

ListQualificationTypesRequest

ListQualificationTypesResponse

ListReviewPolicyResultsForHITRequest

ListReviewPolicyResultsForHITResponse

ListReviewableHITsRequest

ListReviewableHITsResponse

ListWorkerBlocksRequest

ListWorkerBlocksResponse

ListWorkersWithQualificationTypeRequest

ListWorkersWithQualificationTypeResponse

Locale

LocaleList

  • LocaleList array

Long

  • Long integer

NotificationSpecification

  • NotificationSpecification object: The NotificationSpecification data structure describes a HIT event notification for a HIT type.

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.

NotifyWorkersFailureStatusList

NotifyWorkersRequest

NotifyWorkersResponse

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.

ParameterMapEntryList

PolicyParameter

PolicyParameterList

Qualification

  • Qualification object: The Qualification data structure represents a Qualification assigned to a user, including the Qualification type and the value (score).

QualificationList

QualificationRequest

  • QualificationRequest object: The QualificationRequest data structure represents a request a Worker has made for a Qualification.

QualificationRequestList

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.

QualificationRequirementList

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.

QualificationTypeList

QualificationTypeStatus

  • QualificationTypeStatus string (values: Active, Inactive)

RejectAssignmentRequest

  • RejectAssignmentRequest object

RejectAssignmentResponse

  • RejectAssignmentResponse object

RejectQualificationRequestRequest

  • RejectQualificationRequestRequest object

RejectQualificationRequestResponse

  • RejectQualificationRequestResponse object

RequestError

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.

ReviewActionDetailList

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.

ReviewPolicyLevel

  • ReviewPolicyLevel string (values: Assignment, HIT)

ReviewPolicyLevelList

ReviewReport

ReviewResultDetail

  • ReviewResultDetail object: This data structure is returned multiple times for each result specified in the Review Policy.

ReviewResultDetailList

ReviewableHITStatus

  • ReviewableHITStatus string (values: Reviewable, Reviewing)

SendBonusRequest

SendBonusResponse

  • SendBonusResponse object

SendTestEventNotificationRequest

SendTestEventNotificationResponse

  • SendTestEventNotificationResponse object

ServiceFault

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

String

  • String string

StringList

  • StringList array

Timestamp

  • Timestamp string

TurkErrorCode

  • TurkErrorCode string

UpdateExpirationForHITRequest

  • UpdateExpirationForHITRequest object

UpdateExpirationForHITResponse

  • UpdateExpirationForHITResponse object

UpdateHITReviewStatusRequest

  • UpdateHITReviewStatusRequest object

UpdateHITReviewStatusResponse

  • UpdateHITReviewStatusResponse object

UpdateHITTypeOfHITRequest

  • UpdateHITTypeOfHITRequest object

UpdateHITTypeOfHITResponse

  • UpdateHITTypeOfHITResponse object

UpdateNotificationSettingsRequest

UpdateNotificationSettingsResponse

  • UpdateNotificationSettingsResponse object

UpdateQualificationTypeRequest

UpdateQualificationTypeResponse

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.

WorkerBlockList

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_mturk_requester

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

0

Version

5.0.0

License

MIT

Unpacked Size

226 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware