aws_mturk
Amazon Mechanical Turk API Reference
Summary
Functions
-
accept_qualification_request(Client, Input)
The
AcceptQualificationRequest
operation approves a Worker's request for a Qualification. - accept_qualification_request(Client, Input, Options)
-
approve_assignment(Client, Input)
The
ApproveAssignment
operation approves the results of a completed assignment. - approve_assignment(Client, Input, Options)
-
associate_qualification_with_worker(Client, Input)
The
AssociateQualificationWithWorker
operation gives a Worker a Qualification. - associate_qualification_with_worker(Client, Input, Options)
-
create_additional_assignments_for_hit(Client, Input)
The
CreateAdditionalAssignmentsForHIT
operation increases the maximum number of assignments of an existing HIT. - create_additional_assignments_for_hit(Client, Input, Options)
-
create_hit(Client, Input)
The
CreateHIT
operation creates a new Human Intelligence Task (HIT). - create_hit(Client, Input, Options)
-
create_hit_type(Client, Input)
The
CreateHITType
operation creates a new HIT type. - create_hit_type(Client, Input, Options)
-
create_hit_with_hit_type(Client, Input)
The
CreateHITWithHITType
operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by theCreateHITType
operation. - create_hit_with_hit_type(Client, Input, Options)
-
create_qualification_type(Client, Input)
The
CreateQualificationType
operation creates a new Qualification type, which is represented by aQualificationType
data structure. - create_qualification_type(Client, Input, Options)
-
create_worker_block(Client, Input)
The
CreateWorkerBlock
operation allows you to prevent a Worker from working on your HITs. - create_worker_block(Client, Input, Options)
-
delete_hit(Client, Input)
The
DeleteHIT
operation is used to delete HIT that is no longer needed. - delete_hit(Client, Input, Options)
-
delete_qualification_type(Client, Input)
The
DeleteQualificationType
deletes a Qualification type and deletes any HIT types that are associated with the Qualification type. - delete_qualification_type(Client, Input, Options)
-
delete_worker_block(Client, Input)
The
DeleteWorkerBlock
operation allows you to reinstate a blocked Worker to work on your HITs. - delete_worker_block(Client, Input, Options)
-
disassociate_qualification_from_worker(Client, Input)
The
DisassociateQualificationFromWorker
revokes a previously granted Qualification from a user. - disassociate_qualification_from_worker(Client, Input, Options)
-
get_account_balance(Client, Input)
The
GetAccountBalance
operation retrieves the amount of money in your Amazon Mechanical Turk account. - get_account_balance(Client, Input, Options)
-
get_assignment(Client, Input)
The
GetAssignment
operation retrieves the details of the specified Assignment. - get_assignment(Client, Input, Options)
-
get_file_upload_url(Client, Input)
The
GetFileUploadURL
operation generates and returns a temporary URL. - get_file_upload_url(Client, Input, Options)
-
get_hit(Client, Input)
The
GetHIT
operation retrieves the details of the specified HIT. - get_hit(Client, Input, Options)
-
get_qualification_score(Client, Input)
The
GetQualificationScore
operation returns the value of a Worker's Qualification for a given Qualification type. - get_qualification_score(Client, Input, Options)
-
get_qualification_type(Client, Input)
The
GetQualificationType
operation retrieves information about a Qualification type using its ID. - get_qualification_type(Client, Input, Options)
-
list_assignments_for_hit(Client, Input)
The
ListAssignmentsForHIT
operation retrieves completed assignments for a HIT. - list_assignments_for_hit(Client, Input, Options)
-
list_bonus_payments(Client, Input)
The
ListBonusPayments
operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment. - list_bonus_payments(Client, Input, Options)
-
list_hits(Client, Input)
The
ListHITs
operation returns all of a Requester's HITs. - list_hits(Client, Input, Options)
-
list_hits_for_qualification_type(Client, Input)
The
ListHITsForQualificationType
operation returns the HITs that use the given Qualification type for a Qualification requirement. - list_hits_for_qualification_type(Client, Input, Options)
-
list_qualification_requests(Client, Input)
The
ListQualificationRequests
operation retrieves requests for Qualifications of a particular Qualification type. - list_qualification_requests(Client, Input, Options)
-
list_qualification_types(Client, Input)
The
ListQualificationTypes
operation returns a list of Qualification types, filtered by an optional search term. - list_qualification_types(Client, Input, Options)
-
list_review_policy_results_for_hit(Client, Input)
The
ListReviewPolicyResultsForHIT
operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. - list_review_policy_results_for_hit(Client, Input, Options)
-
list_reviewable_hits(Client, Input)
The
ListReviewableHITs
operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation. - list_reviewable_hits(Client, Input, Options)
-
list_worker_blocks(Client, Input)
The
ListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs. - list_worker_blocks(Client, Input, Options)
-
list_workers_with_qualification_type(Client, Input)
The
ListWorkersWithQualificationType
operation returns all of the Workers that have been associated with a given Qualification type. - list_workers_with_qualification_type(Client, Input, Options)
-
notify_workers(Client, Input)
The
NotifyWorkers
operation sends an email to one or more Workers that you specify with the Worker ID. - notify_workers(Client, Input, Options)
-
reject_assignment(Client, Input)
The
RejectAssignment
operation rejects the results of a completed assignment. - reject_assignment(Client, Input, Options)
-
reject_qualification_request(Client, Input)
The
RejectQualificationRequest
operation rejects a user's request for a Qualification. - reject_qualification_request(Client, Input, Options)
-
send_bonus(Client, Input)
The
SendBonus
operation issues a payment of money from your account to a Worker. - send_bonus(Client, Input, Options)
-
send_test_event_notification(Client, Input)
The
SendTestEventNotification
operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. - send_test_event_notification(Client, Input, Options)
-
update_expiration_for_hit(Client, Input)
The
UpdateExpirationForHIT
operation allows you update the expiration time of a HIT. - update_expiration_for_hit(Client, Input, Options)
-
update_hit_review_status(Client, Input)
The
UpdateHITReviewStatus
operation updates the status of a HIT. - update_hit_review_status(Client, Input, Options)
-
update_hit_type_of_hit(Client, Input)
The
UpdateHITTypeOfHIT
operation allows you to change the HITType properties of a HIT. - update_hit_type_of_hit(Client, Input, Options)
-
update_notification_settings(Client, Input)
The
UpdateNotificationSettings
operation creates, updates, disables or re-enables notifications for a HIT type. - update_notification_settings(Client, Input, Options)
-
update_qualification_type(Client, Input)
The
UpdateQualificationType
operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. - update_qualification_type(Client, Input, Options)
Functions
accept_qualification_request(Client, Input)
The AcceptQualificationRequest
operation approves a Worker's
request for a Qualification.
Only the owner of the Qualification type can grant a Qualification request for that type.
A successful request for theAcceptQualificationRequest
operation
returns with no errors and an empty body.
accept_qualification_request(Client, Input, Options)
approve_assignment(Client, Input)
The ApproveAssignment
operation approves the results of a completed
assignment.
Approving an assignment initiates two payments from the Requester's Amazon.com account
The Worker who submitted the results is paid the reward specified in the HIT.
Amazon Mechanical Turk fees are debited.
If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns an exception, and the approval is not processed. You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site.
You can also call this operation for assignments that were previous rejected and approve them by explicitly overriding the previous rejection. This only works on rejected assignments that were submitted within the previous 30 days and only if the assignment's related HIT has not been deleted.approve_assignment(Client, Input, Options)
associate_qualification_with_worker(Client, Input)
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.
You can only assign a Qualification of a Qualification type that you
created (using the CreateQualificationType
operation).
AssociateQualificationWithWorker
does not affect any pending
Qualification requests for the Qualification by the Worker. If you assign
a Qualification to a Worker, then later grant a Qualification request made
by the Worker, the granting of the request may modify the Qualification
score. To resolve a pending Qualification request without affecting the
Qualification the Worker already has, reject the request with the
RejectQualificationRequest
operation.
associate_qualification_with_worker(Client, Input, Options)
create_additional_assignments_for_hit(Client, Input)
The CreateAdditionalAssignmentsForHIT
operation increases the
maximum number of assignments of an existing HIT.
To extend the maximum number of assignments, specify the number of additional assignments.
HITs created with fewer than 10 assignments cannot be extended to have 10
or more assignments. Attempting to add assignments in a way that brings
the total number of assignments for a HIT from fewer than 10 assignments
to 10 or more assignments will result in an
AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease
exception.
AWS.MechanicalTurk.HITTooOldForExtension
exception.
create_additional_assignments_for_hit(Client, Input, Options)
create_hit(Client, Input)
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.
This operation allows you to specify a new HIT by passing in values for
the properties of the HIT, such as its title, reward amount and number of
assignments. When you pass these values to CreateHIT
, a new HIT is
created for you, with a new HITTypeID
. The HITTypeID can be used to
create additional HITs in the future without needing to specify common
parameters such as the title, description and reward amount each time.
An alternative way to create HITs is to first generate a HITTypeID using
the CreateHITType
operation and then call the CreateHITWithHITType
operation. This is the recommended best practice for Requesters who are
creating large numbers of HITs.
CreateHIT also supports several ways to provide question data: by
providing a value for the Question
parameter that fully specifies the
contents of the HIT, or by providing a HitLayoutId
and associated
HitLayoutParameters
.
create_hit(Client, Input, Options)
create_hit_type(Client, Input)
The CreateHITType
operation creates a new HIT type.
create_hit_type(Client, Input, Options)
create_hit_with_hit_type(Client, Input)
The CreateHITWithHITType
operation creates a new Human Intelligence
Task (HIT) using an existing HITTypeID generated by the CreateHITType
operation.
This is an alternative way to create HITs from the CreateHIT
operation.
This is the recommended best practice for Requesters who are creating
large numbers of HITs.
CreateHITWithHITType also supports several ways to provide question data:
by providing a value for the Question
parameter that fully specifies the
contents of the HIT, or by providing a HitLayoutId
and associated
HitLayoutParameters
.
create_hit_with_hit_type(Client, Input, Options)
create_qualification_type(Client, Input)
The CreateQualificationType
operation creates a new Qualification
type, which is represented by a QualificationType
data structure.
create_qualification_type(Client, Input, Options)
create_worker_block(Client, Input)
The CreateWorkerBlock
operation allows you to prevent a Worker from
working on your HITs.
create_worker_block(Client, Input, Options)
delete_hit(Client, Input)
The DeleteHIT
operation is used to delete HIT that is no longer
needed.
Only the Requester who created the HIT can delete it.
You can only dispose of HITs that are in the Reviewable
state, with all
of their submitted assignments already either approved or rejected. If you
call the DeleteHIT operation on a HIT that is not in the Reviewable
state (for example, that has not expired, or still has active
assignments), or on a HIT that is Reviewable but without all of its
submitted assignments already approved or rejected, the service will
return an error.
HITs are automatically disposed of after 120 days.
After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.
Disposed HITs are not returned in results for the ListHITs operation.
Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs.delete_hit(Client, Input, Options)
delete_qualification_type(Client, Input)
The DeleteQualificationType
deletes a Qualification type and
deletes any HIT types that are associated with the Qualification type.
This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types.
DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType.delete_qualification_type(Client, Input, Options)
delete_worker_block(Client, Input)
The DeleteWorkerBlock
operation allows you to reinstate a blocked
Worker to work on your HITs.
delete_worker_block(Client, Input, Options)
disassociate_qualification_from_worker(Client, Input)
The DisassociateQualificationFromWorker
revokes a previously
granted Qualification from a user.
disassociate_qualification_from_worker(Client, Input, Options)
get_account_balance(Client, Input)
The GetAccountBalance
operation retrieves the amount of money in
your Amazon Mechanical Turk account.
get_account_balance(Client, Input, Options)
get_assignment(Client, Input)
The GetAssignment
operation retrieves the details of the specified
Assignment.
get_assignment(Client, Input, Options)
get_file_upload_url(Client, Input)
The GetFileUploadURL
operation generates and returns a temporary
URL.
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.
get_file_upload_url(Client, Input, Options)
get_hit(Client, Input)
The GetHIT
operation retrieves the details of the specified HIT.
get_hit(Client, Input, Options)
get_qualification_score(Client, Input)
The GetQualificationScore
operation returns the value of a Worker's
Qualification for a given Qualification type.
To get a Worker's Qualification, you must know the Worker's ID. The
Worker's ID is included in the assignment data returned by the
ListAssignmentsForHIT
operation.
get_qualification_score(Client, Input, Options)
get_qualification_type(Client, Input)
The GetQualificationType
operation retrieves information about a
Qualification type using its ID.
get_qualification_type(Client, Input, Options)
list_assignments_for_hit(Client, Input)
The ListAssignmentsForHIT
operation retrieves completed assignments
for a HIT.
You can use this operation to retrieve the results for a HIT.
You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation.
Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set.
Only the Requester who created the HIT can retrieve the assignments for that HIT.
Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination.list_assignments_for_hit(Client, Input, Options)
list_bonus_payments(Client, Input)
The ListBonusPayments
operation retrieves the amounts of bonuses
you have paid to Workers for a given HIT or assignment.
list_bonus_payments(Client, Input, Options)
list_hits(Client, Input)
The ListHITs
operation returns all of a Requester's HITs.
list_hits(Client, Input, Options)
list_hits_for_qualification_type(Client, Input)
The ListHITsForQualificationType
operation returns the HITs that
use the given Qualification type for a Qualification requirement.
DeleteHIT
operation or that have been auto-deleted.
list_hits_for_qualification_type(Client, Input, Options)
list_qualification_requests(Client, Input)
The ListQualificationRequests
operation retrieves requests for
Qualifications of a particular Qualification type.
list_qualification_requests(Client, Input, Options)
list_qualification_types(Client, Input)
The ListQualificationTypes
operation returns a list of
Qualification types, filtered by an optional search term.
list_qualification_types(Client, Input, Options)
list_review_policy_results_for_hit(Client, Input)
The ListReviewPolicyResultsForHIT
operation retrieves the computed
results and the actions taken in the course of executing your Review
Policies for a given HIT.
list_review_policy_results_for_hit(Client, Input, Options)
list_reviewable_hits(Client, Input)
The ListReviewableHITs
operation retrieves the HITs with Status
equal to Reviewable or Status equal to Reviewing that belong to the
Requester calling the operation.
list_reviewable_hits(Client, Input, Options)
list_worker_blocks(Client, Input)
The ListWorkersBlocks
operation retrieves a list of Workers who are
blocked from working on your HITs.
list_worker_blocks(Client, Input, Options)
list_workers_with_qualification_type(Client, Input)
The ListWorkersWithQualificationType
operation returns all of the
Workers that have been associated with a given Qualification type.
list_workers_with_qualification_type(Client, Input, Options)
notify_workers(Client, Input)
The NotifyWorkers
operation sends an email to one or more Workers
that you specify with the Worker ID.
notify_workers(Client, Input, Options)
reject_assignment(Client, Input)
The RejectAssignment
operation rejects the results of a completed
assignment.
You can include an optional feedback message with the rejection, which the Worker can see in the Status section of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the assignment was rejected, and can improve the quality of the results the Worker submits in the future.
Only the Requester who created the HIT can reject an assignment for the HIT.reject_assignment(Client, Input, Options)
reject_qualification_request(Client, Input)
The RejectQualificationRequest
operation rejects a user's request
for a Qualification.
reject_qualification_request(Client, Input, Options)
send_bonus(Client, Input)
The SendBonus
operation issues a payment of money from your account
to a Worker.
send_bonus(Client, Input, Options)
send_test_event_notification(Client, Input)
The SendTestEventNotification
operation causes Amazon Mechanical
Turk to send a notification message as if a HIT event occurred, according
to the provided notification specification.
send_test_event_notification(Client, Input, Options)
update_expiration_for_hit(Client, Input)
The UpdateExpirationForHIT
operation allows you update the
expiration time of a HIT.
update_expiration_for_hit(Client, Input, Options)
update_hit_review_status(Client, Input)
The UpdateHITReviewStatus
operation updates the status of a HIT.
update_hit_review_status(Client, Input, Options)
update_hit_type_of_hit(Client, Input)
The UpdateHITTypeOfHIT
operation allows you to change the HITType
properties of a HIT.
update_hit_type_of_hit(Client, Input, Options)
update_notification_settings(Client, Input)
The UpdateNotificationSettings
operation creates, updates, disables
or re-enables notifications for a HIT type.
UpdateNotificationSettings
.
update_notification_settings(Client, Input, Options)
update_qualification_type(Client, Input)
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.
Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries.
You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.
If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test.
If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values.
If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually.
You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.