Class: Aws::MTurk::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MTurk::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb
Overview
An API client for MTurk. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MTurk::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_qualification_request(params = {}) ⇒ Struct
The
AcceptQualificationRequest
operation approves a Worker's request for a Qualification. -
#approve_assignment(params = {}) ⇒ Struct
The
ApproveAssignment
operation approves the results of a completed assignment. -
#associate_qualification_with_worker(params = {}) ⇒ Struct
The
AssociateQualificationWithWorker
operation gives a Worker a Qualification. -
#create_additional_assignments_for_hit(params = {}) ⇒ Struct
The
CreateAdditionalAssignmentsForHIT
operation increases the maximum number of assignments of an existing HIT. -
#create_hit(params = {}) ⇒ Types::CreateHITResponse
The
CreateHIT
operation creates a new Human Intelligence Task (HIT). -
#create_hit_type(params = {}) ⇒ Types::CreateHITTypeResponse
The
CreateHITType
operation creates a new HIT type. -
#create_hit_with_hit_type(params = {}) ⇒ Types::CreateHITWithHITTypeResponse
The
CreateHITWithHITType
operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by theCreateHITType
operation. -
#create_qualification_type(params = {}) ⇒ Types::CreateQualificationTypeResponse
The
CreateQualificationType
operation creates a new Qualification type, which is represented by aQualificationType
data structure. -
#create_worker_block(params = {}) ⇒ Struct
The
CreateWorkerBlock
operation allows you to prevent a Worker from working on your HITs. -
#delete_hit(params = {}) ⇒ Struct
The
DeleteHIT
operation is used to delete HIT that is no longer needed. -
#delete_qualification_type(params = {}) ⇒ Struct
The
DeleteQualificationType
deletes a Qualification type and deletes any HIT types that are associated with the Qualification type. -
#delete_worker_block(params = {}) ⇒ Struct
The
DeleteWorkerBlock
operation allows you to reinstate a blocked Worker to work on your HITs. -
#disassociate_qualification_from_worker(params = {}) ⇒ Struct
The
DisassociateQualificationFromWorker
revokes a previously granted Qualification from a user. -
#get_account_balance(params = {}) ⇒ Types::GetAccountBalanceResponse
The
GetAccountBalance
operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester. -
#get_assignment(params = {}) ⇒ Types::GetAssignmentResponse
The
GetAssignment
operation retrieves the details of the specified Assignment. -
#get_file_upload_url(params = {}) ⇒ Types::GetFileUploadURLResponse
The
GetFileUploadURL
operation generates and returns a temporary URL. -
#get_hit(params = {}) ⇒ Types::GetHITResponse
The
GetHIT
operation retrieves the details of the specified HIT. -
#get_qualification_score(params = {}) ⇒ Types::GetQualificationScoreResponse
The
GetQualificationScore
operation returns the value of a Worker's Qualification for a given Qualification type. -
#get_qualification_type(params = {}) ⇒ Types::GetQualificationTypeResponse
The
GetQualificationType
operation retrieves information about a Qualification type using its ID. -
#list_assignments_for_hit(params = {}) ⇒ Types::ListAssignmentsForHITResponse
The
ListAssignmentsForHIT
operation retrieves completed assignments for a HIT. -
#list_bonus_payments(params = {}) ⇒ Types::ListBonusPaymentsResponse
The
ListBonusPayments
operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment. -
#list_hits(params = {}) ⇒ Types::ListHITsResponse
The
ListHITs
operation returns all of a Requester's HITs. -
#list_hits_for_qualification_type(params = {}) ⇒ Types::ListHITsForQualificationTypeResponse
The
ListHITsForQualificationType
operation returns the HITs that use the given Qualification type for a Qualification requirement. -
#list_qualification_requests(params = {}) ⇒ Types::ListQualificationRequestsResponse
The
ListQualificationRequests
operation retrieves requests for Qualifications of a particular Qualification type. -
#list_qualification_types(params = {}) ⇒ Types::ListQualificationTypesResponse
The
ListQualificationTypes
operation returns a list of Qualification types, filtered by an optional search term. -
#list_review_policy_results_for_hit(params = {}) ⇒ Types::ListReviewPolicyResultsForHITResponse
The
ListReviewPolicyResultsForHIT
operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. -
#list_reviewable_hits(params = {}) ⇒ Types::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. -
#list_worker_blocks(params = {}) ⇒ Types::ListWorkerBlocksResponse
The
ListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs. -
#list_workers_with_qualification_type(params = {}) ⇒ Types::ListWorkersWithQualificationTypeResponse
The
ListWorkersWithQualificationType
operation returns all of the Workers that have been associated with a given Qualification type. -
#notify_workers(params = {}) ⇒ Types::NotifyWorkersResponse
The
NotifyWorkers
operation sends an email to one or more Workers that you specify with the Worker ID. -
#reject_assignment(params = {}) ⇒ Struct
The
RejectAssignment
operation rejects the results of a completed assignment. -
#reject_qualification_request(params = {}) ⇒ Struct
The
RejectQualificationRequest
operation rejects a user's request for a Qualification. -
#send_bonus(params = {}) ⇒ Struct
The
SendBonus
operation issues a payment of money from your account to a Worker. -
#send_test_event_notification(params = {}) ⇒ Struct
The
SendTestEventNotification
operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. -
#update_expiration_for_hit(params = {}) ⇒ Struct
The
UpdateExpirationForHIT
operation allows you update the expiration time of a HIT. -
#update_hit_review_status(params = {}) ⇒ Struct
The
UpdateHITReviewStatus
operation updates the status of a HIT. -
#update_hit_type_of_hit(params = {}) ⇒ Struct
The
UpdateHITTypeOfHIT
operation allows you to change the HITType properties of a HIT. -
#update_notification_settings(params = {}) ⇒ Struct
The
UpdateNotificationSettings
operation creates, updates, disables or re-enables notifications for a HIT type. -
#update_qualification_type(params = {}) ⇒ Types::UpdateQualificationTypeResponse
The
UpdateQualificationType
operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
420 421 422 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#accept_qualification_request(params = {}) ⇒ Struct
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 the AcceptQualificationRequest
operation
returns with no errors and an empty body.
457 458 459 460 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 457 def accept_qualification_request(params = {}, = {}) req = build_request(:accept_qualification_request, params) req.send_request() end |
#approve_assignment(params = {}) ⇒ Struct
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.
511 512 513 514 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 511 def approve_assignment(params = {}, = {}) req = build_request(:approve_assignment, params) req.send_request() end |
#associate_qualification_with_worker(params = {}) ⇒ Struct
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.
566 567 568 569 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 566 def associate_qualification_with_worker(params = {}, = {}) req = build_request(:associate_qualification_with_worker, params) req.send_request() end |
#create_additional_assignments_for_hit(params = {}) ⇒ Struct
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.
AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease
exception.
- HITs that were created before July 22, 2015 cannot be extended.
Attempting to extend HITs that were created before July 22, 2015
will result in an
AWS.MechanicalTurk.HITTooOldForExtension
exception.
619 620 621 622 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 619 def create_additional_assignments_for_hit(params = {}, = {}) req = build_request(:create_additional_assignments_for_hit, params) req.send_request() end |
#create_hit(params = {}) ⇒ Types::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.
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
.
879 880 881 882 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 879 def create_hit(params = {}, = {}) req = build_request(:create_hit, params) req.send_request() end |
#create_hit_type(params = {}) ⇒ Types::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.
970 971 972 973 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 970 def create_hit_type(params = {}, = {}) req = build_request(:create_hit_type, params) req.send_request() end |
#create_hit_with_hit_type(params = {}) ⇒ Types::CreateHITWithHITTypeResponse
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
.
1162 1163 1164 1165 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1162 def create_hit_with_hit_type(params = {}, = {}) req = build_request(:create_hit_with_hit_type, params) req.send_request() end |
#create_qualification_type(params = {}) ⇒ Types::CreateQualificationTypeResponse
The CreateQualificationType
operation creates a new Qualification
type, which is represented by a QualificationType
data structure.
1280 1281 1282 1283 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1280 def create_qualification_type(params = {}, = {}) req = build_request(:create_qualification_type, params) req.send_request() end |
#create_worker_block(params = {}) ⇒ Struct
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.
1310 1311 1312 1313 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1310 def create_worker_block(params = {}, = {}) req = build_request(:create_worker_block, params) req.send_request() end |
#delete_hit(params = {}) ⇒ Struct
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.
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.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1354 def delete_hit(params = {}, = {}) req = build_request(:delete_hit, params) req.send_request() end |
#delete_qualification_type(params = {}) ⇒ Struct
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.
1392 1393 1394 1395 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1392 def delete_qualification_type(params = {}, = {}) req = build_request(:delete_qualification_type, params) req.send_request() end |
#delete_worker_block(params = {}) ⇒ Struct
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.
1424 1425 1426 1427 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1424 def delete_worker_block(params = {}, = {}) req = build_request(:delete_worker_block, params) req.send_request() end |
#disassociate_qualification_from_worker(params = {}) ⇒ Struct
The DisassociateQualificationFromWorker
revokes a previously granted
Qualification from a user.
You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1459 def disassociate_qualification_from_worker(params = {}, = {}) req = build_request(:disassociate_qualification_from_worker, params) req.send_request() end |
#get_account_balance(params = {}) ⇒ Types::GetAccountBalanceResponse
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.
1486 1487 1488 1489 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1486 def get_account_balance(params = {}, = {}) req = build_request(:get_account_balance, params) req.send_request() end |
#get_assignment(params = {}) ⇒ Types::GetAssignmentResponse
The GetAssignment
operation retrieves the details of the specified
Assignment.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1557 def get_assignment(params = {}, = {}) req = build_request(:get_assignment, params) req.send_request() end |
#get_file_upload_url(params = {}) ⇒ Types::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.
1602 1603 1604 1605 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1602 def get_file_upload_url(params = {}, = {}) req = build_request(:get_file_upload_url, params) req.send_request() end |
#get_hit(params = {}) ⇒ Types::GetHITResponse
The GetHIT
operation retrieves the details of the specified HIT.
1659 1660 1661 1662 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1659 def get_hit(params = {}, = {}) req = build_request(:get_hit, params) req.send_request() end |
#get_qualification_score(params = {}) ⇒ Types::GetQualificationScoreResponse
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.
Only the owner of a Qualification type can query the value of a Worker's Qualification of that type.
1705 1706 1707 1708 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1705 def get_qualification_score(params = {}, = {}) req = build_request(:get_qualification_score, params) req.send_request() end |
#get_qualification_type(params = {}) ⇒ Types::GetQualificationTypeResponse
The GetQualificationType
operation retrieves information about a
Qualification type using its ID.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1746 def get_qualification_type(params = {}, = {}) req = build_request(:get_qualification_type, params) req.send_request() end |
#list_assignments_for_hit(params = {}) ⇒ Types::ListAssignmentsForHITResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1825 def list_assignments_for_hit(params = {}, = {}) req = build_request(:list_assignments_for_hit, params) req.send_request() end |
#list_bonus_payments(params = {}) ⇒ Types::ListBonusPaymentsResponse
The ListBonusPayments
operation retrieves the amounts of bonuses you
have paid to Workers for a given HIT or assignment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1882 1883 1884 1885 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1882 def list_bonus_payments(params = {}, = {}) req = build_request(:list_bonus_payments, params) req.send_request() end |
#list_hits(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1952 1953 1954 1955 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 1952 def list_hits(params = {}, = {}) req = build_request(:list_hits, params) req.send_request() end |
#list_hits_for_qualification_type(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2027 2028 2029 2030 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2027 def list_hits_for_qualification_type(params = {}, = {}) req = build_request(:list_hits_for_qualification_type, params) req.send_request() end |
#list_qualification_requests(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2081 2082 2083 2084 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2081 def list_qualification_requests(params = {}, = {}) req = build_request(:list_qualification_requests, params) req.send_request() end |
#list_qualification_types(params = {}) ⇒ Types::ListQualificationTypesResponse
The ListQualificationTypes
operation returns a list of Qualification
types, filtered by an optional search term.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2156 2157 2158 2159 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2156 def list_qualification_types(params = {}, = {}) req = build_request(:list_qualification_types, params) req.send_request() end |
#list_review_policy_results_for_hit(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2272 2273 2274 2275 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2272 def list_review_policy_results_for_hit(params = {}, = {}) req = build_request(:list_review_policy_results_for_hit, params) req.send_request() end |
#list_reviewable_hits(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2352 2353 2354 2355 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2352 def list_reviewable_hits(params = {}, = {}) req = build_request(:list_reviewable_hits, params) req.send_request() end |
#list_worker_blocks(params = {}) ⇒ Types::ListWorkerBlocksResponse
The ListWorkersBlocks
operation retrieves a list of Workers who are
blocked from working on your HITs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2392 2393 2394 2395 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2392 def list_worker_blocks(params = {}, = {}) req = build_request(:list_worker_blocks, params) req.send_request() end |
#list_workers_with_qualification_type(params = {}) ⇒ Types::ListWorkersWithQualificationTypeResponse
The ListWorkersWithQualificationType
operation returns all of the
Workers that have been associated with a given Qualification type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2447 2448 2449 2450 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2447 def list_workers_with_qualification_type(params = {}, = {}) req = build_request(:list_workers_with_qualification_type, params) req.send_request() end |
#notify_workers(params = {}) ⇒ Types::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.
2494 2495 2496 2497 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2494 def notify_workers(params = {}, = {}) req = build_request(:notify_workers, params) req.send_request() end |
#reject_assignment(params = {}) ⇒ Struct
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.
2532 2533 2534 2535 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2532 def reject_assignment(params = {}, = {}) req = build_request(:reject_assignment, params) req.send_request() end |
#reject_qualification_request(params = {}) ⇒ Struct
The RejectQualificationRequest
operation rejects a user's request
for a Qualification.
You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message.
2564 2565 2566 2567 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2564 def reject_qualification_request(params = {}, = {}) req = build_request(:reject_qualification_request, params) req.send_request() end |
#send_bonus(params = {}) ⇒ Struct
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.
2620 2621 2622 2623 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2620 def send_bonus(params = {}, = {}) req = build_request(:send_bonus, params) req.send_request() end |
#send_test_event_notification(params = {}) ⇒ Struct
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.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2662 def send_test_event_notification(params = {}, = {}) req = build_request(:send_test_event_notification, params) req.send_request() end |
#update_expiration_for_hit(params = {}) ⇒ Struct
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.
2690 2691 2692 2693 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2690 def update_expiration_for_hit(params = {}, = {}) req = build_request(:update_expiration_for_hit, params) req.send_request() end |
#update_hit_review_status(params = {}) ⇒ Struct
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.
2725 2726 2727 2728 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2725 def update_hit_review_status(params = {}, = {}) req = build_request(:update_hit_review_status, params) req.send_request() end |
#update_hit_type_of_hit(params = {}) ⇒ Struct
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.
2755 2756 2757 2758 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2755 def update_hit_type_of_hit(params = {}, = {}) req = build_request(:update_hit_type_of_hit, params) req.send_request() end |
#update_notification_settings(params = {}) ⇒ Struct
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
.
2805 2806 2807 2808 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2805 def update_notification_settings(params = {}, = {}) req = build_request(:update_notification_settings, params) req.send_request() end |
#update_qualification_type(params = {}) ⇒ Types::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.
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.
2935 2936 2937 2938 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/client.rb', line 2935 def update_qualification_type(params = {}, = {}) req = build_request(:update_qualification_type, params) req.send_request() end |