MTurk
Service object for interacting with AWS MTurk service.
public struct MTurk: AWSService
Inheritance
AWSService
Initializers
init(client:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the MTurk client
public init(
client: AWSClient,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: MTurk, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
acceptQualificationRequest(_:logger:on:)
public func acceptQualificationRequest(_ input: AcceptQualificationRequestRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AcceptQualificationRequestResponse>
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.
approveAssignment(_:logger:on:)
public func approveAssignment(_ input: ApproveAssignmentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ApproveAssignmentResponse>
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.
associateQualificationWithWorker(_:logger:on:)
public func associateQualificationWithWorker(_ input: AssociateQualificationWithWorkerRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AssociateQualificationWithWorkerResponse>
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).
Note: 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.
createAdditionalAssignmentsForHIT(_:logger:on:)
public func createAdditionalAssignmentsForHIT(_ input: CreateAdditionalAssignmentsForHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateAdditionalAssignmentsForHITResponse>
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. -
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.
createHIT(_:logger:on:)
public func createHIT(_ input: CreateHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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
.
If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
createHITType(_:logger:on:)
public func createHITType(_ input: CreateHITTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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(_:logger:on:)
public func createHITWithHITType(_ input: CreateHITWithHITTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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
.
If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
createQualificationType(_:logger:on:)
public func createQualificationType(_ input: CreateQualificationTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateQualificationTypeResponse>
The
CreateQualificationType
operation creates a new Qualification type, which is represented by a
QualificationType
data structure.
createWorkerBlock(_:logger:on:)
public func createWorkerBlock(_ input: CreateWorkerBlockRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateWorkerBlockResponse>
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(_:logger:on:)
public func deleteHIT(_ input: DeleteHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteHITResponse>
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.
deleteQualificationType(_:logger:on:)
public func deleteQualificationType(_ input: DeleteQualificationTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteQualificationTypeResponse>
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.
deleteWorkerBlock(_:logger:on:)
public func deleteWorkerBlock(_ input: DeleteWorkerBlockRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteWorkerBlockResponse>
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(_:logger:on:)
public func disassociateQualificationFromWorker(_ input: DisassociateQualificationFromWorkerRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DisassociateQualificationFromWorkerResponse>
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.
getAccountBalance(_:logger:on:)
public func getAccountBalance(_ input: GetAccountBalanceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
getAssignment(_:logger:on:)
public func getAssignment(_ input: GetAssignmentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAssignmentResponse>
The GetAssignment
operation retrieves the details of the specified Assignment.
getFileUploadURL(_:logger:on:)
public func getFileUploadURL(_ input: GetFileUploadURLRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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 <code>FileUploadAnswer</code>
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.
</p>
getHIT(_:logger:on:)
public func getHIT(_ input: GetHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetHITResponse>
The GetHIT
operation retrieves the details of the specified HIT.
getQualificationScore(_:logger:on:)
public func getQualificationScore(_ input: GetQualificationScoreRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
getQualificationType(_:logger:on:)
public func getQualificationType(_ input: GetQualificationTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetQualificationTypeResponse>
The GetQualificationType
operation retrieves information about a Qualification type using its ID.
listAssignmentsForHIT(_:logger:on:)
public func listAssignmentsForHIT(_ input: ListAssignmentsForHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
listBonusPayments(_:logger:on:)
public func listBonusPayments(_ input: ListBonusPaymentsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListBonusPaymentsResponse>
The
ListBonusPayments
operation retrieves the amounts of bonuses you have paid to Workers
for a given HIT or assignment.
listHITs(_:logger:on:)
public func listHITs(_ input: ListHITsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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(_:logger:on:)
public func listHITsForQualificationType(_ input: ListHITsForQualificationTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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(_:logger:on:)
public func listQualificationRequests(_ input: ListQualificationRequestsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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(_:logger:on:)
public func listQualificationTypes(_ input: ListQualificationTypesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListQualificationTypesResponse>
The
ListQualificationTypes
operation returns a list of Qualification types, filtered by
an optional search term.
listReviewPolicyResultsForHIT(_:logger:on:)
public func listReviewPolicyResultsForHIT(_ input: ListReviewPolicyResultsForHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
listReviewableHITs(_:logger:on:)
public func listReviewableHITs(_ input: ListReviewableHITsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
listWorkerBlocks(_:logger:on:)
public func listWorkerBlocks(_ input: ListWorkerBlocksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListWorkerBlocksResponse>
The ListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs.
listWorkersWithQualificationType(_:logger:on:)
public func listWorkersWithQualificationType(_ input: ListWorkersWithQualificationTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListWorkersWithQualificationTypeResponse>
The ListWorkersWithQualificationType
operation returns all of the Workers
that have been associated with a given Qualification type.
notifyWorkers(_:logger:on:)
public func notifyWorkers(_ input: NotifyWorkersRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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(_:logger:on:)
public func rejectAssignment(_ input: RejectAssignmentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RejectAssignmentResponse>
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.
rejectQualificationRequest(_:logger:on:)
public func rejectQualificationRequest(_ input: RejectQualificationRequestRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RejectQualificationRequestResponse>
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.
sendBonus(_:logger:on:)
public func sendBonus(_ input: SendBonusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
sendTestEventNotification(_:logger:on:)
public func sendTestEventNotification(_ input: SendTestEventNotificationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<SendTestEventNotificationResponse>
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.
updateExpirationForHIT(_:logger:on:)
public func updateExpirationForHIT(_ input: UpdateExpirationForHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateExpirationForHITResponse>
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(_:logger:on:)
public func updateHITReviewStatus(_ input: UpdateHITReviewStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateHITReviewStatusResponse>
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(_:logger:on:)
public func updateHITTypeOfHIT(_ input: UpdateHITTypeOfHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateHITTypeOfHITResponse>
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(_:logger:on:)
public func updateNotificationSettings(_ input: UpdateNotificationSettingsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateNotificationSettingsResponse>
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(_:logger:on:)
public func updateQualificationType(_ input: UpdateQualificationTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
listAssignmentsForHITPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listAssignmentsForHITPaginator( _ input: ListAssignmentsForHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListAssignmentsForHITRequest, 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.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listBonusPaymentsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listBonusPaymentsPaginator( _ input: ListBonusPaymentsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListBonusPaymentsRequest, ListBonusPaymentsResponse>
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onListBonusPayments
operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.
listHITsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listHITsPaginator( _ input: ListHITsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListHITsRequest, ListHITsResponse>
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onListHITs
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.
listHITsForQualificationTypePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listHITsForQualificationTypePaginator( _ input: ListHITsForQualificationTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListHITsForQualificationTypeRequest, ListHITsForQualificationTypeResponse>
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onListHITsForQualificationType
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 theDeleteHIT
operation or that have been auto-deleted.
listQualificationRequestsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listQualificationRequestsPaginator( _ input: ListQualificationRequestsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListQualificationRequestsRequest, ListQualificationRequestsResponse>
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onListQualificationRequests
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.
listQualificationTypesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listQualificationTypesPaginator( _ input: ListQualificationTypesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListQualificationTypesRequest, ListQualificationTypesResponse>
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onListQualificationTypes
operation returns a list of Qualification types, filtered by an optional search term.
listReviewPolicyResultsForHITPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listReviewPolicyResultsForHITPaginator( _ input: ListReviewPolicyResultsForHITRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListReviewPolicyResultsForHITRequest, ListReviewPolicyResultsForHITResponse>
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onListReviewPolicyResultsForHIT
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.
listReviewableHITsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listReviewableHITsPaginator( _ input: ListReviewableHITsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListReviewableHITsRequest, ListReviewableHITsResponse>
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onListReviewableHITs
operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.
listWorkerBlocksPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listWorkerBlocksPaginator( _ input: ListWorkerBlocksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListWorkerBlocksRequest, ListWorkerBlocksResponse>
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs.
listWorkersWithQualificationTypePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listWorkersWithQualificationTypePaginator( _ input: ListWorkersWithQualificationTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListWorkersWithQualificationTypeRequest, ListWorkersWithQualificationTypeResponse>
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onListWorkersWithQualificationType
operation returns all of the Workers that have been associated with a given Qualification type.
listAssignmentsForHITPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listAssignmentsForHITPaginator<Result>(
_ input: ListAssignmentsForHITRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListAssignmentsForHITResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.listAssignmentsForHITPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listAssignmentsForHITPaginator(
_ input: ListAssignmentsForHITRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListAssignmentsForHITResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listBonusPaymentsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listBonusPaymentsPaginator<Result>(
_ input: ListBonusPaymentsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListBonusPaymentsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
The
ListBonusPayments
operation retrieves the amounts of bonuses you have paid to Workers
for a given HIT or assignment.
listBonusPaymentsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listBonusPaymentsPaginator(
_ input: ListBonusPaymentsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListBonusPaymentsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listHITsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listHITsPaginator<Result>(
_ input: ListHITsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListHITsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
listHITsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listHITsPaginator(
_ input: ListHITsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListHITsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listHITsForQualificationTypePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listHITsForQualificationTypePaginator<Result>(
_ input: ListHITsForQualificationTypeRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListHITsForQualificationTypeResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
listHITsForQualificationTypePaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listHITsForQualificationTypePaginator(
_ input: ListHITsForQualificationTypeRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListHITsForQualificationTypeResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listQualificationRequestsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listQualificationRequestsPaginator<Result>(
_ input: ListQualificationRequestsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListQualificationRequestsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
listQualificationRequestsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listQualificationRequestsPaginator(
_ input: ListQualificationRequestsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListQualificationRequestsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listQualificationTypesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listQualificationTypesPaginator<Result>(
_ input: ListQualificationTypesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListQualificationTypesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
The
ListQualificationTypes
operation returns a list of Qualification types, filtered by
an optional search term.
listQualificationTypesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listQualificationTypesPaginator(
_ input: ListQualificationTypesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListQualificationTypesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listReviewPolicyResultsForHITPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listReviewPolicyResultsForHITPaginator<Result>(
_ input: ListReviewPolicyResultsForHITRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListReviewPolicyResultsForHITResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
listReviewPolicyResultsForHITPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listReviewPolicyResultsForHITPaginator(
_ input: ListReviewPolicyResultsForHITRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListReviewPolicyResultsForHITResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listReviewableHITsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listReviewableHITsPaginator<Result>(
_ input: ListReviewableHITsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListReviewableHITsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
The ListReviewableHITs
operation retrieves the HITs with Status equal to
Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.
listReviewableHITsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listReviewableHITsPaginator(
_ input: ListReviewableHITsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListReviewableHITsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listWorkerBlocksPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listWorkerBlocksPaginator<Result>(
_ input: ListWorkerBlocksRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListWorkerBlocksResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
The ListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs.
listWorkerBlocksPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listWorkerBlocksPaginator(
_ input: ListWorkerBlocksRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListWorkerBlocksResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listWorkersWithQualificationTypePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listWorkersWithQualificationTypePaginator<Result>(
_ input: ListWorkersWithQualificationTypeRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListWorkersWithQualificationTypeResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
The ListWorkersWithQualificationType
operation returns all of the Workers
that have been associated with a given Qualification type.
listWorkersWithQualificationTypePaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listWorkersWithQualificationTypePaginator(
_ input: ListWorkersWithQualificationTypeRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListWorkersWithQualificationTypeResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>