MTurk class

Constructors

MTurk({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

acceptQualificationRequest({required String qualificationRequestId, int? integerValue}) → Future<void>

The AcceptQualificationRequest operation approves a Worker's request for a Qualification.

approveAssignment({required String assignmentId, bool? overrideRejection, String? requesterFeedback}) → Future<void>

The ApproveAssignment operation approves the results of a completed assignment.

associateQualificationWithWorker({required String qualificationTypeId, required String workerId, int? integerValue, bool? sendNotification}) → Future<void>

The AssociateQualificationWithWorker operation gives a Worker a Qualification. AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It gives the Qualification directly to the Worker.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createAdditionalAssignmentsForHIT({required String hITId, required int numberOfAdditionalAssignments, String? uniqueRequestToken}) → Future<void>

The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT.

createHIT({required int assignmentDurationInSeconds, required String description, required int lifetimeInSeconds, required String reward, required String title, ReviewPolicy? assignmentReviewPolicy, int? autoApprovalDelayInSeconds, String? hITLayoutId, List<HITLayoutParameter>? hITLayoutParameters, ReviewPolicy? hITReviewPolicy, String? keywords, int? maxAssignments, List<QualificationRequirement>? qualificationRequirements, String? question, String? requesterAnnotation, String? uniqueRequestToken}) → Future<CreateHITResponse>

The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available for Workers to find and accept on the Amazon Mechanical Turk website.

createHITType({required int assignmentDurationInSeconds, required String description, required String reward, required String title, int? autoApprovalDelayInSeconds, String? keywords, List<QualificationRequirement>? qualificationRequirements}) → Future<CreateHITTypeResponse>

The CreateHITType operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned.

createHITWithHITType({required String hITTypeId, required int lifetimeInSeconds, ReviewPolicy? assignmentReviewPolicy, String? hITLayoutId, List<HITLayoutParameter>? hITLayoutParameters, ReviewPolicy? hITReviewPolicy, int? maxAssignments, String? question, String? requesterAnnotation, String? uniqueRequestToken}) → Future<CreateHITWithHITTypeResponse>

The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation.

createQualificationType({required String description, required String name, required QualificationTypeStatus qualificationTypeStatus, String? answerKey, bool? autoGranted, int? autoGrantedValue, String? keywords, int? retryDelayInSeconds, String? test, int? testDurationInSeconds}) → Future<CreateQualificationTypeResponse>

The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.

createWorkerBlock({required String reason, required String workerId}) → Future<void>

The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.

deleteHIT({required String hITId}) → Future<void>

The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it.

deleteQualificationType({required String qualificationTypeId}) → Future<void>

The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type.

deleteWorkerBlock({required String workerId, String? reason}) → Future<void>

The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully.

disassociateQualificationFromWorker({required String qualificationTypeId, required String workerId, String? reason}) → Future<void>

The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user.

getAccountBalance() → Future<GetAccountBalanceResponse>

The GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk account.

getAssignment({required String assignmentId}) → Future<GetAssignmentResponse>

The GetAssignment operation retrieves the details of the specified Assignment.

getFileUploadURL({required String assignmentId, required String questionIdentifier}) → Future<GetFileUploadURLResponse>

The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure will no longer support the FileUploadAnswer element to be used for the QuestionForm data structure. Instead, we recommend that Requesters who want to create HITs asking Workers to upload files to use Amazon S3.

getHIT({required String hITId}) → Future<GetHITResponse>

The GetHIT operation retrieves the details of the specified HIT.

getQualificationScore({required String qualificationTypeId, required String workerId}) → Future<GetQualificationScoreResponse>

The GetQualificationScore operation returns the value of a Worker's Qualification for a given Qualification type.

getQualificationType({required String qualificationTypeId}) → Future<GetQualificationTypeResponse>

The GetQualificationTypeoperation retrieves information about a Qualification type using its ID.

listAssignmentsForHIT({required String hITId, List<AssignmentStatus>? assignmentStatuses, int? maxResults, String? nextToken}) → Future<ListAssignmentsForHITResponse>

The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT.

listBonusPayments({String? assignmentId, String? hITId, int? maxResults, String? nextToken}) → Future<ListBonusPaymentsResponse>

The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.

listHITs({int? maxResults, String? nextToken}) → Future<ListHITsResponse>

The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.

listHITsForQualificationType({required String qualificationTypeId, int? maxResults, String? nextToken}) → Future<ListHITsForQualificationTypeResponse>

The ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted with the DeleteHIT operation or that have been auto-deleted.

listQualificationRequests({int? maxResults, String? nextToken, String? qualificationTypeId}) → Future<ListQualificationRequestsResponse>

The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation.

listQualificationTypes({required bool mustBeRequestable, int? maxResults, bool? mustBeOwnedByCaller, String? nextToken, String? query}) → Future<ListQualificationTypesResponse>

The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.

listReviewableHITs({String? hITTypeId, int? maxResults, String? nextToken, ReviewableHITStatus? status}) → Future<ListReviewableHITsResponse>

The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.

listReviewPolicyResultsForHIT({required String hITId, int? maxResults, String? nextToken, List<ReviewPolicyLevel>? policyLevels, bool? retrieveActions, bool? retrieveResults}) → Future<ListReviewPolicyResultsForHITResponse>

The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. For information about how to specify Review Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and HIT-level review results.

listWorkerBlocks({int? maxResults, String? nextToken}) → Future<ListWorkerBlocksResponse>

The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.

listWorkersWithQualificationType({required String qualificationTypeId, int? maxResults, String? nextToken, QualificationStatus? status}) → Future<ListWorkersWithQualificationTypeResponse>

The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyWorkers({required String messageText, required String subject, required List<String> workerIds}) → Future<NotifyWorkersResponse>

The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker.

rejectAssignment({required String assignmentId, required String requesterFeedback}) → Future<void>

The RejectAssignment operation rejects the results of a completed assignment.

rejectQualificationRequest({required String qualificationRequestId, String? reason}) → Future<void>

The RejectQualificationRequest operation rejects a user's request for a Qualification.

sendBonus({required String assignmentId, required String bonusAmount, required String reason, required String workerId, String? uniqueRequestToken}) → Future<void>

The SendBonus operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if your account does not have enough funds to pay for both the bonus and the fees.

sendTestEventNotification({required NotificationSpecification notification, required EventType testEventType}) → Future<void>

The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. This allows you to test notifications without setting up notifications for a real HIT type and trying to trigger them using the website. When you call this operation, the service attempts to send the test notification immediately.

toString() → String

A string representation of this object.

inherited

updateExpirationForHIT({required DateTime expireAt, required String hITId}) → Future<void>

The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update it to a time in the past, the HIT will be immediately expired.

updateHITReviewStatus({required String hITId, bool? revert}) → Future<void>

The UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status.

updateHITTypeOfHIT({required String hITId, required String hITTypeId}) → Future<void>

The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties and associates it with the new HITType properties. The HIT takes on the properties of the new HITType in place of the old ones.

updateNotificationSettings({required String hITTypeId, bool? active, NotificationSpecification? notification}) → Future<void>

The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification specification, the operation replaces the old specification with a new one. You can call the UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to modify the notification specification itself by providing updates to the Active status without specifying a new notification specification. To change the Active status of a HIT type's notifications, the HIT type must already have a notification specification, or one must be provided in the same call to UpdateNotificationSettings.

updateQualificationType({required String qualificationTypeId, String? answerKey, bool? autoGranted, int? autoGrantedValue, String? description, QualificationTypeStatus? qualificationTypeStatus, int? retryDelayInSeconds, String? test, int? testDurationInSeconds}) → Future<UpdateQualificationTypeResponse>

The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes.

Operators

operator ==(Object other) → bool

The equality operator.

inherited