Package-level declarations

Types

Link copied to clipboard

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

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

Link copied to clipboard

The ApproveAssignment operation approves the results of a completed assignment.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MTurkClient.createHit(crossinline block: CreateHitRequest.Builder.() -> Unit): 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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun MTurkClient.deleteHit(crossinline block: DeleteHitRequest.Builder.() -> Unit): DeleteHitResponse

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user.

Link copied to clipboard

The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester. Alternatively, this operation will retrieve the remaining available AWS Billing usage if you have enabled AWS Billing. Note: If you have enabled AWS Billing and still have a remaining Prepaid HITs balance, this balance can be viewed on the My Account page in the Requester console.

Link copied to clipboard

The GetAssignment operation retrieves the details of the specified Assignment.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun MTurkClient.getHit(crossinline block: GetHitRequest.Builder.() -> Unit): GetHitResponse

The GetHIT operation retrieves the details of the specified HIT.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MTurkClient.listHits(crossinline block: ListHitsRequest.Builder.() -> Unit): 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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The RejectAssignment operation rejects the results of a completed assignment.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MTurkClient.sendBonus(crossinline block: SendBonusRequest.Builder.() -> Unit): SendBonusResponse

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.