Interface MTurkClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacceptQualificationRequest
(Consumer<AcceptQualificationRequestRequest.Builder> acceptQualificationRequestRequest) TheAcceptQualificationRequest
operation approves a Worker's request for a Qualification.acceptQualificationRequest
(AcceptQualificationRequestRequest acceptQualificationRequestRequest) TheAcceptQualificationRequest
operation approves a Worker's request for a Qualification.default ApproveAssignmentResponse
approveAssignment
(Consumer<ApproveAssignmentRequest.Builder> approveAssignmentRequest) TheApproveAssignment
operation approves the results of a completed assignment.default ApproveAssignmentResponse
approveAssignment
(ApproveAssignmentRequest approveAssignmentRequest) TheApproveAssignment
operation approves the results of a completed assignment.associateQualificationWithWorker
(Consumer<AssociateQualificationWithWorkerRequest.Builder> associateQualificationWithWorkerRequest) TheAssociateQualificationWithWorker
operation gives a Worker a Qualification.associateQualificationWithWorker
(AssociateQualificationWithWorkerRequest associateQualificationWithWorkerRequest) TheAssociateQualificationWithWorker
operation gives a Worker a Qualification.static MTurkClientBuilder
builder()
Create a builder that can be used to configure and create aMTurkClient
.static MTurkClient
create()
Create aMTurkClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAdditionalAssignmentsForHIT
(Consumer<CreateAdditionalAssignmentsForHitRequest.Builder> createAdditionalAssignmentsForHitRequest) TheCreateAdditionalAssignmentsForHIT
operation increases the maximum number of assignments of an existing HIT.createAdditionalAssignmentsForHIT
(CreateAdditionalAssignmentsForHitRequest createAdditionalAssignmentsForHitRequest) TheCreateAdditionalAssignmentsForHIT
operation increases the maximum number of assignments of an existing HIT.default CreateHitResponse
createHIT
(Consumer<CreateHitRequest.Builder> createHitRequest) TheCreateHIT
operation creates a new Human Intelligence Task (HIT).default CreateHitResponse
createHIT
(CreateHitRequest createHitRequest) TheCreateHIT
operation creates a new Human Intelligence Task (HIT).default CreateHitTypeResponse
createHITType
(Consumer<CreateHitTypeRequest.Builder> createHitTypeRequest) TheCreateHITType
operation creates a new HIT type.default CreateHitTypeResponse
createHITType
(CreateHitTypeRequest createHitTypeRequest) TheCreateHITType
operation creates a new HIT type.default CreateHitWithHitTypeResponse
createHITWithHITType
(Consumer<CreateHitWithHitTypeRequest.Builder> createHitWithHitTypeRequest) TheCreateHITWithHITType
operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by theCreateHITType
operation.default CreateHitWithHitTypeResponse
createHITWithHITType
(CreateHitWithHitTypeRequest createHitWithHitTypeRequest) TheCreateHITWithHITType
operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by theCreateHITType
operation.default CreateQualificationTypeResponse
createQualificationType
(Consumer<CreateQualificationTypeRequest.Builder> createQualificationTypeRequest) TheCreateQualificationType
operation creates a new Qualification type, which is represented by aQualificationType
data structure.default CreateQualificationTypeResponse
createQualificationType
(CreateQualificationTypeRequest createQualificationTypeRequest) TheCreateQualificationType
operation creates a new Qualification type, which is represented by aQualificationType
data structure.default CreateWorkerBlockResponse
createWorkerBlock
(Consumer<CreateWorkerBlockRequest.Builder> createWorkerBlockRequest) TheCreateWorkerBlock
operation allows you to prevent a Worker from working on your HITs.default CreateWorkerBlockResponse
createWorkerBlock
(CreateWorkerBlockRequest createWorkerBlockRequest) TheCreateWorkerBlock
operation allows you to prevent a Worker from working on your HITs.default DeleteHitResponse
deleteHIT
(Consumer<DeleteHitRequest.Builder> deleteHitRequest) TheDeleteHIT
operation is used to delete HIT that is no longer needed.default DeleteHitResponse
deleteHIT
(DeleteHitRequest deleteHitRequest) TheDeleteHIT
operation is used to delete HIT that is no longer needed.default DeleteQualificationTypeResponse
deleteQualificationType
(Consumer<DeleteQualificationTypeRequest.Builder> deleteQualificationTypeRequest) TheDeleteQualificationType
deletes a Qualification type and deletes any HIT types that are associated with the Qualification type.default DeleteQualificationTypeResponse
deleteQualificationType
(DeleteQualificationTypeRequest deleteQualificationTypeRequest) TheDeleteQualificationType
deletes a Qualification type and deletes any HIT types that are associated with the Qualification type.default DeleteWorkerBlockResponse
deleteWorkerBlock
(Consumer<DeleteWorkerBlockRequest.Builder> deleteWorkerBlockRequest) TheDeleteWorkerBlock
operation allows you to reinstate a blocked Worker to work on your HITs.default DeleteWorkerBlockResponse
deleteWorkerBlock
(DeleteWorkerBlockRequest deleteWorkerBlockRequest) TheDeleteWorkerBlock
operation allows you to reinstate a blocked Worker to work on your HITs.disassociateQualificationFromWorker
(Consumer<DisassociateQualificationFromWorkerRequest.Builder> disassociateQualificationFromWorkerRequest) TheDisassociateQualificationFromWorker
revokes a previously granted Qualification from a user.disassociateQualificationFromWorker
(DisassociateQualificationFromWorkerRequest disassociateQualificationFromWorkerRequest) TheDisassociateQualificationFromWorker
revokes a previously granted Qualification from a user.default GetAccountBalanceResponse
TheGetAccountBalance
operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester.default GetAccountBalanceResponse
getAccountBalance
(Consumer<GetAccountBalanceRequest.Builder> getAccountBalanceRequest) TheGetAccountBalance
operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester.default GetAccountBalanceResponse
getAccountBalance
(GetAccountBalanceRequest getAccountBalanceRequest) TheGetAccountBalance
operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester.default GetAssignmentResponse
getAssignment
(Consumer<GetAssignmentRequest.Builder> getAssignmentRequest) TheGetAssignment
operation retrieves the details of the specified Assignment.default GetAssignmentResponse
getAssignment
(GetAssignmentRequest getAssignmentRequest) TheGetAssignment
operation retrieves the details of the specified Assignment.default GetFileUploadUrlResponse
getFileUploadURL
(Consumer<GetFileUploadUrlRequest.Builder> getFileUploadUrlRequest) TheGetFileUploadURL
operation generates and returns a temporary URL.default GetFileUploadUrlResponse
getFileUploadURL
(GetFileUploadUrlRequest getFileUploadUrlRequest) TheGetFileUploadURL
operation generates and returns a temporary URL.default GetHitResponse
getHIT
(Consumer<GetHitRequest.Builder> getHitRequest) TheGetHIT
operation retrieves the details of the specified HIT.default GetHitResponse
getHIT
(GetHitRequest getHitRequest) TheGetHIT
operation retrieves the details of the specified HIT.default GetQualificationScoreResponse
getQualificationScore
(Consumer<GetQualificationScoreRequest.Builder> getQualificationScoreRequest) TheGetQualificationScore
operation returns the value of a Worker's Qualification for a given Qualification type.default GetQualificationScoreResponse
getQualificationScore
(GetQualificationScoreRequest getQualificationScoreRequest) TheGetQualificationScore
operation returns the value of a Worker's Qualification for a given Qualification type.default GetQualificationTypeResponse
getQualificationType
(Consumer<GetQualificationTypeRequest.Builder> getQualificationTypeRequest) TheGetQualificationType
operation retrieves information about a Qualification type using its ID.default GetQualificationTypeResponse
getQualificationType
(GetQualificationTypeRequest getQualificationTypeRequest) TheGetQualificationType
operation retrieves information about a Qualification type using its ID.default ListAssignmentsForHitResponse
listAssignmentsForHIT
(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest) TheListAssignmentsForHIT
operation retrieves completed assignments for a HIT.default ListAssignmentsForHitResponse
listAssignmentsForHIT
(ListAssignmentsForHitRequest listAssignmentsForHitRequest) TheListAssignmentsForHIT
operation retrieves completed assignments for a HIT.default ListAssignmentsForHITIterable
listAssignmentsForHITPaginator
(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest) This is a variant oflistAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)
operation.default ListAssignmentsForHITIterable
listAssignmentsForHITPaginator
(ListAssignmentsForHitRequest listAssignmentsForHitRequest) This is a variant oflistAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)
operation.default ListBonusPaymentsResponse
listBonusPayments
(Consumer<ListBonusPaymentsRequest.Builder> listBonusPaymentsRequest) TheListBonusPayments
operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.default ListBonusPaymentsResponse
listBonusPayments
(ListBonusPaymentsRequest listBonusPaymentsRequest) TheListBonusPayments
operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.default ListBonusPaymentsIterable
listBonusPaymentsPaginator
(Consumer<ListBonusPaymentsRequest.Builder> listBonusPaymentsRequest) This is a variant oflistBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)
operation.default ListBonusPaymentsIterable
listBonusPaymentsPaginator
(ListBonusPaymentsRequest listBonusPaymentsRequest) This is a variant oflistBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)
operation.default ListHiTsResponse
listHITs()
TheListHITs
operation returns all of a Requester's HITs.default ListHiTsResponse
listHITs
(Consumer<ListHiTsRequest.Builder> listHiTsRequest) TheListHITs
operation returns all of a Requester's HITs.default ListHiTsResponse
listHITs
(ListHiTsRequest listHiTsRequest) TheListHITs
operation returns all of a Requester's HITs.listHITsForQualificationType
(Consumer<ListHiTsForQualificationTypeRequest.Builder> listHiTsForQualificationTypeRequest) TheListHITsForQualificationType
operation returns the HITs that use the given Qualification type for a Qualification requirement.listHITsForQualificationType
(ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest) TheListHITsForQualificationType
operation returns the HITs that use the given Qualification type for a Qualification requirement.listHITsForQualificationTypePaginator
(Consumer<ListHiTsForQualificationTypeRequest.Builder> listHiTsForQualificationTypeRequest) This is a variant oflistHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)
operation.listHITsForQualificationTypePaginator
(ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest) This is a variant oflistHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)
operation.default ListHITsIterable
This is a variant oflistHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation.default ListHITsIterable
listHITsPaginator
(Consumer<ListHiTsRequest.Builder> listHiTsRequest) This is a variant oflistHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation.default ListHITsIterable
listHITsPaginator
(ListHiTsRequest listHiTsRequest) This is a variant oflistHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation.TheListQualificationRequests
operation retrieves requests for Qualifications of a particular Qualification type.listQualificationRequests
(Consumer<ListQualificationRequestsRequest.Builder> listQualificationRequestsRequest) TheListQualificationRequests
operation retrieves requests for Qualifications of a particular Qualification type.listQualificationRequests
(ListQualificationRequestsRequest listQualificationRequestsRequest) TheListQualificationRequests
operation retrieves requests for Qualifications of a particular Qualification type.This is a variant oflistQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation.listQualificationRequestsPaginator
(Consumer<ListQualificationRequestsRequest.Builder> listQualificationRequestsRequest) This is a variant oflistQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation.listQualificationRequestsPaginator
(ListQualificationRequestsRequest listQualificationRequestsRequest) This is a variant oflistQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation.default ListQualificationTypesResponse
listQualificationTypes
(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest) TheListQualificationTypes
operation returns a list of Qualification types, filtered by an optional search term.default ListQualificationTypesResponse
listQualificationTypes
(ListQualificationTypesRequest listQualificationTypesRequest) TheListQualificationTypes
operation returns a list of Qualification types, filtered by an optional search term.default ListQualificationTypesIterable
listQualificationTypesPaginator
(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest) This is a variant oflistQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)
operation.default ListQualificationTypesIterable
listQualificationTypesPaginator
(ListQualificationTypesRequest listQualificationTypesRequest) This is a variant oflistQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)
operation.default ListReviewableHiTsResponse
TheListReviewableHITs
operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.default ListReviewableHiTsResponse
listReviewableHITs
(Consumer<ListReviewableHiTsRequest.Builder> listReviewableHiTsRequest) TheListReviewableHITs
operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.default ListReviewableHiTsResponse
listReviewableHITs
(ListReviewableHiTsRequest listReviewableHiTsRequest) TheListReviewableHITs
operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.default ListReviewableHITsIterable
This is a variant oflistReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation.default ListReviewableHITsIterable
listReviewableHITsPaginator
(Consumer<ListReviewableHiTsRequest.Builder> listReviewableHiTsRequest) This is a variant oflistReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation.default ListReviewableHITsIterable
listReviewableHITsPaginator
(ListReviewableHiTsRequest listReviewableHiTsRequest) This is a variant oflistReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation.listReviewPolicyResultsForHIT
(Consumer<ListReviewPolicyResultsForHitRequest.Builder> listReviewPolicyResultsForHitRequest) TheListReviewPolicyResultsForHIT
operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT.listReviewPolicyResultsForHIT
(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest) TheListReviewPolicyResultsForHIT
operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT.listReviewPolicyResultsForHITPaginator
(Consumer<ListReviewPolicyResultsForHitRequest.Builder> listReviewPolicyResultsForHitRequest) This is a variant oflistReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)
operation.listReviewPolicyResultsForHITPaginator
(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest) This is a variant oflistReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)
operation.default ListWorkerBlocksResponse
TheListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs.default ListWorkerBlocksResponse
listWorkerBlocks
(Consumer<ListWorkerBlocksRequest.Builder> listWorkerBlocksRequest) TheListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs.default ListWorkerBlocksResponse
listWorkerBlocks
(ListWorkerBlocksRequest listWorkerBlocksRequest) TheListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs.default ListWorkerBlocksIterable
This is a variant oflistWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation.default ListWorkerBlocksIterable
listWorkerBlocksPaginator
(Consumer<ListWorkerBlocksRequest.Builder> listWorkerBlocksRequest) This is a variant oflistWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation.default ListWorkerBlocksIterable
listWorkerBlocksPaginator
(ListWorkerBlocksRequest listWorkerBlocksRequest) This is a variant oflistWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation.listWorkersWithQualificationType
(Consumer<ListWorkersWithQualificationTypeRequest.Builder> listWorkersWithQualificationTypeRequest) TheListWorkersWithQualificationType
operation returns all of the Workers that have been associated with a given Qualification type.listWorkersWithQualificationType
(ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest) TheListWorkersWithQualificationType
operation returns all of the Workers that have been associated with a given Qualification type.listWorkersWithQualificationTypePaginator
(Consumer<ListWorkersWithQualificationTypeRequest.Builder> listWorkersWithQualificationTypeRequest) This is a variant oflistWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)
operation.listWorkersWithQualificationTypePaginator
(ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest) This is a variant oflistWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)
operation.default NotifyWorkersResponse
notifyWorkers
(Consumer<NotifyWorkersRequest.Builder> notifyWorkersRequest) TheNotifyWorkers
operation sends an email to one or more Workers that you specify with the Worker ID.default NotifyWorkersResponse
notifyWorkers
(NotifyWorkersRequest notifyWorkersRequest) TheNotifyWorkers
operation sends an email to one or more Workers that you specify with the Worker ID.default RejectAssignmentResponse
rejectAssignment
(Consumer<RejectAssignmentRequest.Builder> rejectAssignmentRequest) TheRejectAssignment
operation rejects the results of a completed assignment.default RejectAssignmentResponse
rejectAssignment
(RejectAssignmentRequest rejectAssignmentRequest) TheRejectAssignment
operation rejects the results of a completed assignment.rejectQualificationRequest
(Consumer<RejectQualificationRequestRequest.Builder> rejectQualificationRequestRequest) TheRejectQualificationRequest
operation rejects a user's request for a Qualification.rejectQualificationRequest
(RejectQualificationRequestRequest rejectQualificationRequestRequest) TheRejectQualificationRequest
operation rejects a user's request for a Qualification.default SendBonusResponse
sendBonus
(Consumer<SendBonusRequest.Builder> sendBonusRequest) TheSendBonus
operation issues a payment of money from your account to a Worker.default SendBonusResponse
sendBonus
(SendBonusRequest sendBonusRequest) TheSendBonus
operation issues a payment of money from your account to a Worker.sendTestEventNotification
(Consumer<SendTestEventNotificationRequest.Builder> sendTestEventNotificationRequest) TheSendTestEventNotification
operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification.sendTestEventNotification
(SendTestEventNotificationRequest sendTestEventNotificationRequest) TheSendTestEventNotification
operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification.default MTurkServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default UpdateExpirationForHitResponse
updateExpirationForHIT
(Consumer<UpdateExpirationForHitRequest.Builder> updateExpirationForHitRequest) TheUpdateExpirationForHIT
operation allows you update the expiration time of a HIT.default UpdateExpirationForHitResponse
updateExpirationForHIT
(UpdateExpirationForHitRequest updateExpirationForHitRequest) TheUpdateExpirationForHIT
operation allows you update the expiration time of a HIT.default UpdateHitReviewStatusResponse
updateHITReviewStatus
(Consumer<UpdateHitReviewStatusRequest.Builder> updateHitReviewStatusRequest) TheUpdateHITReviewStatus
operation updates the status of a HIT.default UpdateHitReviewStatusResponse
updateHITReviewStatus
(UpdateHitReviewStatusRequest updateHitReviewStatusRequest) TheUpdateHITReviewStatus
operation updates the status of a HIT.default UpdateHitTypeOfHitResponse
updateHITTypeOfHIT
(Consumer<UpdateHitTypeOfHitRequest.Builder> updateHitTypeOfHitRequest) TheUpdateHITTypeOfHIT
operation allows you to change the HITType properties of a HIT.default UpdateHitTypeOfHitResponse
updateHITTypeOfHIT
(UpdateHitTypeOfHitRequest updateHitTypeOfHitRequest) TheUpdateHITTypeOfHIT
operation allows you to change the HITType properties of a HIT.updateNotificationSettings
(Consumer<UpdateNotificationSettingsRequest.Builder> updateNotificationSettingsRequest) TheUpdateNotificationSettings
operation creates, updates, disables or re-enables notifications for a HIT type.updateNotificationSettings
(UpdateNotificationSettingsRequest updateNotificationSettingsRequest) TheUpdateNotificationSettings
operation creates, updates, disables or re-enables notifications for a HIT type.default UpdateQualificationTypeResponse
updateQualificationType
(Consumer<UpdateQualificationTypeRequest.Builder> updateQualificationTypeRequest) TheUpdateQualificationType
operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure.default UpdateQualificationTypeResponse
updateQualificationType
(UpdateQualificationTypeRequest updateQualificationTypeRequest) TheUpdateQualificationType
operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acceptQualificationRequest
default AcceptQualificationRequestResponse acceptQualificationRequest(AcceptQualificationRequestRequest acceptQualificationRequestRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
acceptQualificationRequestRequest
-- Returns:
- Result of the AcceptQualificationRequest operation returned by the service.
- See Also:
-
acceptQualificationRequest
default AcceptQualificationRequestResponse acceptQualificationRequest(Consumer<AcceptQualificationRequestRequest.Builder> acceptQualificationRequestRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
AcceptQualificationRequestRequest.Builder
avoiding the need to create one manually viaAcceptQualificationRequestRequest.builder()
- Parameters:
acceptQualificationRequestRequest
- AConsumer
that will call methods onAcceptQualificationRequestRequest.Builder
to create a request.- Returns:
- Result of the AcceptQualificationRequest operation returned by the service.
- See Also:
-
approveAssignment
default ApproveAssignmentResponse approveAssignment(ApproveAssignmentRequest approveAssignmentRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
- Parameters:
approveAssignmentRequest
-- Returns:
- Result of the ApproveAssignment operation returned by the service.
- See Also:
-
-
approveAssignment
default ApproveAssignmentResponse approveAssignment(Consumer<ApproveAssignmentRequest.Builder> approveAssignmentRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
ApproveAssignmentRequest.Builder
avoiding the need to create one manually viaApproveAssignmentRequest.builder()
- Parameters:
approveAssignmentRequest
- AConsumer
that will call methods onApproveAssignmentRequest.Builder
to create a request.- Returns:
- Result of the ApproveAssignment operation returned by the service.
- See Also:
-
-
associateQualificationWithWorker
default AssociateQualificationWithWorkerResponse associateQualificationWithWorker(AssociateQualificationWithWorkerRequest associateQualificationWithWorkerRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 theRejectQualificationRequest
operation.- Parameters:
associateQualificationWithWorkerRequest
-- Returns:
- Result of the AssociateQualificationWithWorker operation returned by the service.
- See Also:
-
associateQualificationWithWorker
default AssociateQualificationWithWorkerResponse associateQualificationWithWorker(Consumer<AssociateQualificationWithWorkerRequest.Builder> associateQualificationWithWorkerRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 theRejectQualificationRequest
operation.
This is a convenience which creates an instance of the
AssociateQualificationWithWorkerRequest.Builder
avoiding the need to create one manually viaAssociateQualificationWithWorkerRequest.builder()
- Parameters:
associateQualificationWithWorkerRequest
- AConsumer
that will call methods onAssociateQualificationWithWorkerRequest.Builder
to create a request.- Returns:
- Result of the AssociateQualificationWithWorker operation returned by the service.
- See Also:
-
createAdditionalAssignmentsForHIT
default CreateAdditionalAssignmentsForHitResponse createAdditionalAssignmentsForHIT(CreateAdditionalAssignmentsForHitRequest createAdditionalAssignmentsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
- Parameters:
createAdditionalAssignmentsForHitRequest
-- Returns:
- Result of the CreateAdditionalAssignmentsForHIT operation returned by the service.
- See Also:
-
-
createAdditionalAssignmentsForHIT
default CreateAdditionalAssignmentsForHitResponse createAdditionalAssignmentsForHIT(Consumer<CreateAdditionalAssignmentsForHitRequest.Builder> createAdditionalAssignmentsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
CreateAdditionalAssignmentsForHitRequest.Builder
avoiding the need to create one manually viaCreateAdditionalAssignmentsForHitRequest.builder()
- Parameters:
createAdditionalAssignmentsForHitRequest
- AConsumer
that will call methods onCreateAdditionalAssignmentsForHitRequest.Builder
to create a request.- Returns:
- Result of the CreateAdditionalAssignmentsForHIT operation returned by the service.
- See Also:
-
-
createHIT
default CreateHitResponse createHIT(CreateHitRequest createHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 newHITTypeID
. 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 theCreateHITWithHITType
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 aHitLayoutId
and associatedHitLayoutParameters
.If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
- Parameters:
createHitRequest
-- Returns:
- Result of the CreateHIT operation returned by the service.
- See Also:
-
createHIT
default CreateHitResponse createHIT(Consumer<CreateHitRequest.Builder> createHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 newHITTypeID
. 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 theCreateHITWithHITType
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 aHitLayoutId
and associatedHitLayoutParameters
.If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
This is a convenience which creates an instance of the
CreateHitRequest.Builder
avoiding the need to create one manually viaCreateHitRequest.builder()
- Parameters:
createHitRequest
- AConsumer
that will call methods onCreateHitRequest.Builder
to create a request.- Returns:
- Result of the CreateHIT operation returned by the service.
- See Also:
-
createHITType
default CreateHitTypeResponse createHITType(CreateHitTypeRequest createHitTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
createHitTypeRequest
-- Returns:
- Result of the CreateHITType operation returned by the service.
- See Also:
-
createHITType
default CreateHitTypeResponse createHITType(Consumer<CreateHitTypeRequest.Builder> createHitTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
CreateHitTypeRequest.Builder
avoiding the need to create one manually viaCreateHitTypeRequest.builder()
- Parameters:
createHitTypeRequest
- AConsumer
that will call methods onCreateHitTypeRequest.Builder
to create a request.- Returns:
- Result of the CreateHITType operation returned by the service.
- See Also:
-
createHITWithHITType
default CreateHitWithHitTypeResponse createHITWithHITType(CreateHitWithHitTypeRequest createHitWithHitTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
CreateHITWithHITType
operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by theCreateHITType
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 aHitLayoutId
and associatedHitLayoutParameters
.If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
- Parameters:
createHitWithHitTypeRequest
-- Returns:
- Result of the CreateHITWithHITType operation returned by the service.
- See Also:
-
createHITWithHITType
default CreateHitWithHitTypeResponse createHITWithHITType(Consumer<CreateHitWithHitTypeRequest.Builder> createHitWithHitTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
CreateHITWithHITType
operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by theCreateHITType
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 aHitLayoutId
and associatedHitLayoutParameters
.If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
This is a convenience which creates an instance of the
CreateHitWithHitTypeRequest.Builder
avoiding the need to create one manually viaCreateHitWithHitTypeRequest.builder()
- Parameters:
createHitWithHitTypeRequest
- AConsumer
that will call methods onCreateHitWithHitTypeRequest.Builder
to create a request.- Returns:
- Result of the CreateHITWithHITType operation returned by the service.
- See Also:
-
createQualificationType
default CreateQualificationTypeResponse createQualificationType(CreateQualificationTypeRequest createQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
CreateQualificationType
operation creates a new Qualification type, which is represented by aQualificationType
data structure.- Parameters:
createQualificationTypeRequest
-- Returns:
- Result of the CreateQualificationType operation returned by the service.
- See Also:
-
createQualificationType
default CreateQualificationTypeResponse createQualificationType(Consumer<CreateQualificationTypeRequest.Builder> createQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
CreateQualificationType
operation creates a new Qualification type, which is represented by aQualificationType
data structure.
This is a convenience which creates an instance of the
CreateQualificationTypeRequest.Builder
avoiding the need to create one manually viaCreateQualificationTypeRequest.builder()
- Parameters:
createQualificationTypeRequest
- AConsumer
that will call methods onCreateQualificationTypeRequest.Builder
to create a request.- Returns:
- Result of the CreateQualificationType operation returned by the service.
- See Also:
-
createWorkerBlock
default CreateWorkerBlockResponse createWorkerBlock(CreateWorkerBlockRequest createWorkerBlockRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
createWorkerBlockRequest
-- Returns:
- Result of the CreateWorkerBlock operation returned by the service.
- See Also:
-
createWorkerBlock
default CreateWorkerBlockResponse createWorkerBlock(Consumer<CreateWorkerBlockRequest.Builder> createWorkerBlockRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
CreateWorkerBlockRequest.Builder
avoiding the need to create one manually viaCreateWorkerBlockRequest.builder()
- Parameters:
createWorkerBlockRequest
- AConsumer
that will call methods onCreateWorkerBlockRequest.Builder
to create a request.- Returns:
- Result of the CreateWorkerBlock operation returned by the service.
- See Also:
-
deleteHIT
default DeleteHitResponse deleteHIT(DeleteHitRequest deleteHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 theReviewable
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.
- Parameters:
deleteHitRequest
-- Returns:
- Result of the DeleteHIT operation returned by the service.
- See Also:
-
-
deleteHIT
default DeleteHitResponse deleteHIT(Consumer<DeleteHitRequest.Builder> deleteHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 theReviewable
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.
This is a convenience which creates an instance of the
DeleteHitRequest.Builder
avoiding the need to create one manually viaDeleteHitRequest.builder()
- Parameters:
deleteHitRequest
- AConsumer
that will call methods onDeleteHitRequest.Builder
to create a request.- Returns:
- Result of the DeleteHIT operation returned by the service.
- See Also:
-
-
deleteQualificationType
default DeleteQualificationTypeResponse deleteQualificationType(DeleteQualificationTypeRequest deleteQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
- Parameters:
deleteQualificationTypeRequest
-- Returns:
- Result of the DeleteQualificationType operation returned by the service.
- See Also:
-
deleteQualificationType
default DeleteQualificationTypeResponse deleteQualificationType(Consumer<DeleteQualificationTypeRequest.Builder> deleteQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
DeleteQualificationTypeRequest.Builder
avoiding the need to create one manually viaDeleteQualificationTypeRequest.builder()
- Parameters:
deleteQualificationTypeRequest
- AConsumer
that will call methods onDeleteQualificationTypeRequest.Builder
to create a request.- Returns:
- Result of the DeleteQualificationType operation returned by the service.
- See Also:
-
deleteWorkerBlock
default DeleteWorkerBlockResponse deleteWorkerBlock(DeleteWorkerBlockRequest deleteWorkerBlockRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
deleteWorkerBlockRequest
-- Returns:
- Result of the DeleteWorkerBlock operation returned by the service.
- See Also:
-
deleteWorkerBlock
default DeleteWorkerBlockResponse deleteWorkerBlock(Consumer<DeleteWorkerBlockRequest.Builder> deleteWorkerBlockRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
DeleteWorkerBlockRequest.Builder
avoiding the need to create one manually viaDeleteWorkerBlockRequest.builder()
- Parameters:
deleteWorkerBlockRequest
- AConsumer
that will call methods onDeleteWorkerBlockRequest.Builder
to create a request.- Returns:
- Result of the DeleteWorkerBlock operation returned by the service.
- See Also:
-
disassociateQualificationFromWorker
default DisassociateQualificationFromWorkerResponse disassociateQualificationFromWorker(DisassociateQualificationFromWorkerRequest disassociateQualificationFromWorkerRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
- Parameters:
disassociateQualificationFromWorkerRequest
-- Returns:
- Result of the DisassociateQualificationFromWorker operation returned by the service.
- See Also:
-
disassociateQualificationFromWorker
default DisassociateQualificationFromWorkerResponse disassociateQualificationFromWorker(Consumer<DisassociateQualificationFromWorkerRequest.Builder> disassociateQualificationFromWorkerRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
DisassociateQualificationFromWorkerRequest.Builder
avoiding the need to create one manually viaDisassociateQualificationFromWorkerRequest.builder()
- Parameters:
disassociateQualificationFromWorkerRequest
- AConsumer
that will call methods onDisassociateQualificationFromWorkerRequest.Builder
to create a request.- Returns:
- Result of the DisassociateQualificationFromWorker operation returned by the service.
- See Also:
-
getAccountBalance
default GetAccountBalanceResponse getAccountBalance(GetAccountBalanceRequest getAccountBalanceRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
getAccountBalanceRequest
-- Returns:
- Result of the GetAccountBalance operation returned by the service.
- See Also:
-
getAccountBalance
default GetAccountBalanceResponse getAccountBalance(Consumer<GetAccountBalanceRequest.Builder> getAccountBalanceRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
GetAccountBalanceRequest.Builder
avoiding the need to create one manually viaGetAccountBalanceRequest.builder()
- Parameters:
getAccountBalanceRequest
- AConsumer
that will call methods onGetAccountBalanceRequest.Builder
to create a request.- Returns:
- Result of the GetAccountBalance operation returned by the service.
- See Also:
-
getAccountBalance
default GetAccountBalanceResponse getAccountBalance() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkExceptionThe
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.- Returns:
- Result of the GetAccountBalance operation returned by the service.
- See Also:
-
getAssignment
default GetAssignmentResponse getAssignment(GetAssignmentRequest getAssignmentRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
GetAssignment
operation retrieves the details of the specified Assignment.- Parameters:
getAssignmentRequest
-- Returns:
- Result of the GetAssignment operation returned by the service.
- See Also:
-
getAssignment
default GetAssignmentResponse getAssignment(Consumer<GetAssignmentRequest.Builder> getAssignmentRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
GetAssignment
operation retrieves the details of the specified Assignment.
This is a convenience which creates an instance of the
GetAssignmentRequest.Builder
avoiding the need to create one manually viaGetAssignmentRequest.builder()
- Parameters:
getAssignmentRequest
- AConsumer
that will call methods onGetAssignmentRequest.Builder
to create a request.- Returns:
- Result of the GetAssignment operation returned by the service.
- See Also:
-
getFileUploadURL
default GetFileUploadUrlResponse getFileUploadURL(GetFileUploadUrlRequest getFileUploadUrlRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 theFileUploadAnswer
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.- Parameters:
getFileUploadUrlRequest
-- Returns:
- Result of the GetFileUploadURL operation returned by the service.
- See Also:
-
getFileUploadURL
default GetFileUploadUrlResponse getFileUploadURL(Consumer<GetFileUploadUrlRequest.Builder> getFileUploadUrlRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 theFileUploadAnswer
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.
This is a convenience which creates an instance of the
GetFileUploadUrlRequest.Builder
avoiding the need to create one manually viaGetFileUploadUrlRequest.builder()
- Parameters:
getFileUploadUrlRequest
- AConsumer
that will call methods onGetFileUploadUrlRequest.Builder
to create a request.- Returns:
- Result of the GetFileUploadURL operation returned by the service.
- See Also:
-
getHIT
default GetHitResponse getHIT(GetHitRequest getHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
GetHIT
operation retrieves the details of the specified HIT.- Parameters:
getHitRequest
-- Returns:
- Result of the GetHIT operation returned by the service.
- See Also:
-
getHIT
default GetHitResponse getHIT(Consumer<GetHitRequest.Builder> getHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
GetHIT
operation retrieves the details of the specified HIT.
This is a convenience which creates an instance of the
GetHitRequest.Builder
avoiding the need to create one manually viaGetHitRequest.builder()
- Parameters:
getHitRequest
- AConsumer
that will call methods onGetHitRequest.Builder
to create a request.- Returns:
- Result of the GetHIT operation returned by the service.
- See Also:
-
getQualificationScore
default GetQualificationScoreResponse getQualificationScore(GetQualificationScoreRequest getQualificationScoreRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
- Parameters:
getQualificationScoreRequest
-- Returns:
- Result of the GetQualificationScore operation returned by the service.
- See Also:
-
getQualificationScore
default GetQualificationScoreResponse getQualificationScore(Consumer<GetQualificationScoreRequest.Builder> getQualificationScoreRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
GetQualificationScoreRequest.Builder
avoiding the need to create one manually viaGetQualificationScoreRequest.builder()
- Parameters:
getQualificationScoreRequest
- AConsumer
that will call methods onGetQualificationScoreRequest.Builder
to create a request.- Returns:
- Result of the GetQualificationScore operation returned by the service.
- See Also:
-
getQualificationType
default GetQualificationTypeResponse getQualificationType(GetQualificationTypeRequest getQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
GetQualificationType
operation retrieves information about a Qualification type using its ID.- Parameters:
getQualificationTypeRequest
-- Returns:
- Result of the GetQualificationType operation returned by the service.
- See Also:
-
getQualificationType
default GetQualificationTypeResponse getQualificationType(Consumer<GetQualificationTypeRequest.Builder> getQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
GetQualificationType
operation retrieves information about a Qualification type using its ID.
This is a convenience which creates an instance of the
GetQualificationTypeRequest.Builder
avoiding the need to create one manually viaGetQualificationTypeRequest.builder()
- Parameters:
getQualificationTypeRequest
- AConsumer
that will call methods onGetQualificationTypeRequest.Builder
to create a request.- Returns:
- Result of the GetQualificationType operation returned by the service.
- See Also:
-
listAssignmentsForHIT
default ListAssignmentsForHitResponse listAssignmentsForHIT(ListAssignmentsForHitRequest listAssignmentsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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:
listAssignmentsForHitRequest
-- Returns:
- Result of the ListAssignmentsForHIT operation returned by the service.
- See Also:
-
listAssignmentsForHIT
default ListAssignmentsForHitResponse listAssignmentsForHIT(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
ListAssignmentsForHitRequest.Builder
avoiding the need to create one manually viaListAssignmentsForHitRequest.builder()
- Parameters:
listAssignmentsForHitRequest
- AConsumer
that will call methods onListAssignmentsForHitRequest.Builder
to create a request.- Returns:
- Result of the ListAssignmentsForHIT operation returned by the service.
- See Also:
-
listAssignmentsForHITPaginator
default ListAssignmentsForHITIterable listAssignmentsForHITPaginator(ListAssignmentsForHitRequest listAssignmentsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client.listAssignmentsForHITPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client .listAssignmentsForHITPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client.listAssignmentsForHITPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)
operation.- Parameters:
listAssignmentsForHitRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAssignmentsForHITPaginator
default ListAssignmentsForHITIterable listAssignmentsForHITPaginator(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client.listAssignmentsForHITPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client .listAssignmentsForHITPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client.listAssignmentsForHITPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)
operation.
This is a convenience which creates an instance of the
ListAssignmentsForHitRequest.Builder
avoiding the need to create one manually viaListAssignmentsForHitRequest.builder()
- Parameters:
listAssignmentsForHitRequest
- AConsumer
that will call methods onListAssignmentsForHitRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBonusPayments
default ListBonusPaymentsResponse listBonusPayments(ListBonusPaymentsRequest listBonusPaymentsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListBonusPayments
operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.- Parameters:
listBonusPaymentsRequest
-- Returns:
- Result of the ListBonusPayments operation returned by the service.
- See Also:
-
listBonusPayments
default ListBonusPaymentsResponse listBonusPayments(Consumer<ListBonusPaymentsRequest.Builder> listBonusPaymentsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListBonusPayments
operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.
This is a convenience which creates an instance of the
ListBonusPaymentsRequest.Builder
avoiding the need to create one manually viaListBonusPaymentsRequest.builder()
- Parameters:
listBonusPaymentsRequest
- AConsumer
that will call methods onListBonusPaymentsRequest.Builder
to create a request.- Returns:
- Result of the ListBonusPayments operation returned by the service.
- See Also:
-
listBonusPaymentsPaginator
default ListBonusPaymentsIterable listBonusPaymentsPaginator(ListBonusPaymentsRequest listBonusPaymentsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client.listBonusPaymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client .listBonusPaymentsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListBonusPaymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client.listBonusPaymentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)
operation.- Parameters:
listBonusPaymentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBonusPaymentsPaginator
default ListBonusPaymentsIterable listBonusPaymentsPaginator(Consumer<ListBonusPaymentsRequest.Builder> listBonusPaymentsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client.listBonusPaymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client .listBonusPaymentsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListBonusPaymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client.listBonusPaymentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)
operation.
This is a convenience which creates an instance of the
ListBonusPaymentsRequest.Builder
avoiding the need to create one manually viaListBonusPaymentsRequest.builder()
- Parameters:
listBonusPaymentsRequest
- AConsumer
that will call methods onListBonusPaymentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listHITs
default ListHiTsResponse listHITs(ListHiTsRequest listHiTsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
listHiTsRequest
-- Returns:
- Result of the ListHITs operation returned by the service.
- See Also:
-
listHITs
default ListHiTsResponse listHITs(Consumer<ListHiTsRequest.Builder> listHiTsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
ListHiTsRequest.Builder
avoiding the need to create one manually viaListHiTsRequest.builder()
- Parameters:
listHiTsRequest
- AConsumer
that will call methods onListHiTsRequest.Builder
to create a request.- Returns:
- Result of the ListHITs operation returned by the service.
- See Also:
-
listHITs
default ListHiTsResponse listHITs() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkExceptionThe
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.- Returns:
- Result of the ListHITs operation returned by the service.
- See Also:
-
listHITsPaginator
default ListHITsIterable listHITsPaginator() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkExceptionThis is a variant of
listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListHiTsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listHITsPaginator
default ListHITsIterable listHITsPaginator(ListHiTsRequest listHiTsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListHiTsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation.- Parameters:
listHiTsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listHITsPaginator
default ListHITsIterable listHITsPaginator(Consumer<ListHiTsRequest.Builder> listHiTsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListHiTsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation.
This is a convenience which creates an instance of the
ListHiTsRequest.Builder
avoiding the need to create one manually viaListHiTsRequest.builder()
- Parameters:
listHiTsRequest
- AConsumer
that will call methods onListHiTsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listHITsForQualificationType
default ListHiTsForQualificationTypeResponse listHITsForQualificationType(ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 theDeleteHIT
operation or that have been auto-deleted.- Parameters:
listHiTsForQualificationTypeRequest
-- Returns:
- Result of the ListHITsForQualificationType operation returned by the service.
- See Also:
-
listHITsForQualificationType
default ListHiTsForQualificationTypeResponse listHITsForQualificationType(Consumer<ListHiTsForQualificationTypeRequest.Builder> listHiTsForQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 theDeleteHIT
operation or that have been auto-deleted.
This is a convenience which creates an instance of the
ListHiTsForQualificationTypeRequest.Builder
avoiding the need to create one manually viaListHiTsForQualificationTypeRequest.builder()
- Parameters:
listHiTsForQualificationTypeRequest
- AConsumer
that will call methods onListHiTsForQualificationTypeRequest.Builder
to create a request.- Returns:
- Result of the ListHITsForQualificationType operation returned by the service.
- See Also:
-
listHITsForQualificationTypePaginator
default ListHITsForQualificationTypeIterable listHITsForQualificationTypePaginator(ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client.listHITsForQualificationTypePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client .listHITsForQualificationTypePaginator(request); for (software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client.listHITsForQualificationTypePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)
operation.- Parameters:
listHiTsForQualificationTypeRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listHITsForQualificationTypePaginator
default ListHITsForQualificationTypeIterable listHITsForQualificationTypePaginator(Consumer<ListHiTsForQualificationTypeRequest.Builder> listHiTsForQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client.listHITsForQualificationTypePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client .listHITsForQualificationTypePaginator(request); for (software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client.listHITsForQualificationTypePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)
operation.
This is a convenience which creates an instance of the
ListHiTsForQualificationTypeRequest.Builder
avoiding the need to create one manually viaListHiTsForQualificationTypeRequest.builder()
- Parameters:
listHiTsForQualificationTypeRequest
- AConsumer
that will call methods onListHiTsForQualificationTypeRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQualificationRequests
default ListQualificationRequestsResponse listQualificationRequests(ListQualificationRequestsRequest listQualificationRequestsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
listQualificationRequestsRequest
-- Returns:
- Result of the ListQualificationRequests operation returned by the service.
- See Also:
-
listQualificationRequests
default ListQualificationRequestsResponse listQualificationRequests(Consumer<ListQualificationRequestsRequest.Builder> listQualificationRequestsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
ListQualificationRequestsRequest.Builder
avoiding the need to create one manually viaListQualificationRequestsRequest.builder()
- Parameters:
listQualificationRequestsRequest
- AConsumer
that will call methods onListQualificationRequestsRequest.Builder
to create a request.- Returns:
- Result of the ListQualificationRequests operation returned by the service.
- See Also:
-
listQualificationRequests
default ListQualificationRequestsResponse listQualificationRequests() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkExceptionThe
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.- Returns:
- Result of the ListQualificationRequests operation returned by the service.
- See Also:
-
listQualificationRequestsPaginator
default ListQualificationRequestsIterable listQualificationRequestsPaginator() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkExceptionThis is a variant of
listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client .listQualificationRequestsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQualificationRequestsPaginator
default ListQualificationRequestsIterable listQualificationRequestsPaginator(ListQualificationRequestsRequest listQualificationRequestsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client .listQualificationRequestsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation.- Parameters:
listQualificationRequestsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQualificationRequestsPaginator
default ListQualificationRequestsIterable listQualificationRequestsPaginator(Consumer<ListQualificationRequestsRequest.Builder> listQualificationRequestsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client .listQualificationRequestsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation.
This is a convenience which creates an instance of the
ListQualificationRequestsRequest.Builder
avoiding the need to create one manually viaListQualificationRequestsRequest.builder()
- Parameters:
listQualificationRequestsRequest
- AConsumer
that will call methods onListQualificationRequestsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQualificationTypes
default ListQualificationTypesResponse listQualificationTypes(ListQualificationTypesRequest listQualificationTypesRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListQualificationTypes
operation returns a list of Qualification types, filtered by an optional search term.- Parameters:
listQualificationTypesRequest
-- Returns:
- Result of the ListQualificationTypes operation returned by the service.
- See Also:
-
listQualificationTypes
default ListQualificationTypesResponse listQualificationTypes(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListQualificationTypes
operation returns a list of Qualification types, filtered by an optional search term.
This is a convenience which creates an instance of the
ListQualificationTypesRequest.Builder
avoiding the need to create one manually viaListQualificationTypesRequest.builder()
- Parameters:
listQualificationTypesRequest
- AConsumer
that will call methods onListQualificationTypesRequest.Builder
to create a request.- Returns:
- Result of the ListQualificationTypes operation returned by the service.
- See Also:
-
listQualificationTypesPaginator
default ListQualificationTypesIterable listQualificationTypesPaginator(ListQualificationTypesRequest listQualificationTypesRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client.listQualificationTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client .listQualificationTypesPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListQualificationTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client.listQualificationTypesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)
operation.- Parameters:
listQualificationTypesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQualificationTypesPaginator
default ListQualificationTypesIterable listQualificationTypesPaginator(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client.listQualificationTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client .listQualificationTypesPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListQualificationTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client.listQualificationTypesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)
operation.
This is a convenience which creates an instance of the
ListQualificationTypesRequest.Builder
avoiding the need to create one manually viaListQualificationTypesRequest.builder()
- Parameters:
listQualificationTypesRequest
- AConsumer
that will call methods onListQualificationTypesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReviewPolicyResultsForHIT
default ListReviewPolicyResultsForHitResponse listReviewPolicyResultsForHIT(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
listReviewPolicyResultsForHitRequest
-- Returns:
- Result of the ListReviewPolicyResultsForHIT operation returned by the service.
- See Also:
-
listReviewPolicyResultsForHIT
default ListReviewPolicyResultsForHitResponse listReviewPolicyResultsForHIT(Consumer<ListReviewPolicyResultsForHitRequest.Builder> listReviewPolicyResultsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
ListReviewPolicyResultsForHitRequest.Builder
avoiding the need to create one manually viaListReviewPolicyResultsForHitRequest.builder()
- Parameters:
listReviewPolicyResultsForHitRequest
- AConsumer
that will call methods onListReviewPolicyResultsForHitRequest.Builder
to create a request.- Returns:
- Result of the ListReviewPolicyResultsForHIT operation returned by the service.
- See Also:
-
listReviewPolicyResultsForHITPaginator
default ListReviewPolicyResultsForHITIterable listReviewPolicyResultsForHITPaginator(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client.listReviewPolicyResultsForHITPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client .listReviewPolicyResultsForHITPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client.listReviewPolicyResultsForHITPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)
operation.- Parameters:
listReviewPolicyResultsForHitRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReviewPolicyResultsForHITPaginator
default ListReviewPolicyResultsForHITIterable listReviewPolicyResultsForHITPaginator(Consumer<ListReviewPolicyResultsForHitRequest.Builder> listReviewPolicyResultsForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client.listReviewPolicyResultsForHITPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client .listReviewPolicyResultsForHITPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client.listReviewPolicyResultsForHITPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)
operation.
This is a convenience which creates an instance of the
ListReviewPolicyResultsForHitRequest.Builder
avoiding the need to create one manually viaListReviewPolicyResultsForHitRequest.builder()
- Parameters:
listReviewPolicyResultsForHitRequest
- AConsumer
that will call methods onListReviewPolicyResultsForHitRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReviewableHITs
default ListReviewableHiTsResponse listReviewableHITs(ListReviewableHiTsRequest listReviewableHiTsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListReviewableHITs
operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.- Parameters:
listReviewableHiTsRequest
-- Returns:
- Result of the ListReviewableHITs operation returned by the service.
- See Also:
-
listReviewableHITs
default ListReviewableHiTsResponse listReviewableHITs(Consumer<ListReviewableHiTsRequest.Builder> listReviewableHiTsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListReviewableHITs
operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.
This is a convenience which creates an instance of the
ListReviewableHiTsRequest.Builder
avoiding the need to create one manually viaListReviewableHiTsRequest.builder()
- Parameters:
listReviewableHiTsRequest
- AConsumer
that will call methods onListReviewableHiTsRequest.Builder
to create a request.- Returns:
- Result of the ListReviewableHITs operation returned by the service.
- See Also:
-
listReviewableHITs
default ListReviewableHiTsResponse listReviewableHITs() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkExceptionThe
ListReviewableHITs
operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.- Returns:
- Result of the ListReviewableHITs operation returned by the service.
- See Also:
-
listReviewableHITsPaginator
default ListReviewableHITsIterable listReviewableHITsPaginator() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkExceptionThis is a variant of
listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client .listReviewableHITsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReviewableHITsPaginator
default ListReviewableHITsIterable listReviewableHITsPaginator(ListReviewableHiTsRequest listReviewableHiTsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client .listReviewableHITsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation.- Parameters:
listReviewableHiTsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReviewableHITsPaginator
default ListReviewableHITsIterable listReviewableHITsPaginator(Consumer<ListReviewableHiTsRequest.Builder> listReviewableHiTsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client .listReviewableHITsPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation.
This is a convenience which creates an instance of the
ListReviewableHiTsRequest.Builder
avoiding the need to create one manually viaListReviewableHiTsRequest.builder()
- Parameters:
listReviewableHiTsRequest
- AConsumer
that will call methods onListReviewableHiTsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWorkerBlocks
default ListWorkerBlocksResponse listWorkerBlocks(ListWorkerBlocksRequest listWorkerBlocksRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs.- Parameters:
listWorkerBlocksRequest
-- Returns:
- Result of the ListWorkerBlocks operation returned by the service.
- See Also:
-
listWorkerBlocks
default ListWorkerBlocksResponse listWorkerBlocks(Consumer<ListWorkerBlocksRequest.Builder> listWorkerBlocksRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs.
This is a convenience which creates an instance of the
ListWorkerBlocksRequest.Builder
avoiding the need to create one manually viaListWorkerBlocksRequest.builder()
- Parameters:
listWorkerBlocksRequest
- AConsumer
that will call methods onListWorkerBlocksRequest.Builder
to create a request.- Returns:
- Result of the ListWorkerBlocks operation returned by the service.
- See Also:
-
listWorkerBlocks
default ListWorkerBlocksResponse listWorkerBlocks() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkExceptionThe
ListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your HITs.- Returns:
- Result of the ListWorkerBlocks operation returned by the service.
- See Also:
-
listWorkerBlocksPaginator
default ListWorkerBlocksIterable listWorkerBlocksPaginator() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkExceptionThis is a variant of
listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client .listWorkerBlocksPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWorkerBlocksPaginator
default ListWorkerBlocksIterable listWorkerBlocksPaginator(ListWorkerBlocksRequest listWorkerBlocksRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client .listWorkerBlocksPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation.- Parameters:
listWorkerBlocksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWorkerBlocksPaginator
default ListWorkerBlocksIterable listWorkerBlocksPaginator(Consumer<ListWorkerBlocksRequest.Builder> listWorkerBlocksRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client .listWorkerBlocksPaginator(request); for (software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation.
This is a convenience which creates an instance of the
ListWorkerBlocksRequest.Builder
avoiding the need to create one manually viaListWorkerBlocksRequest.builder()
- Parameters:
listWorkerBlocksRequest
- AConsumer
that will call methods onListWorkerBlocksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWorkersWithQualificationType
default ListWorkersWithQualificationTypeResponse listWorkersWithQualificationType(ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListWorkersWithQualificationType
operation returns all of the Workers that have been associated with a given Qualification type.- Parameters:
listWorkersWithQualificationTypeRequest
-- Returns:
- Result of the ListWorkersWithQualificationType operation returned by the service.
- See Also:
-
listWorkersWithQualificationType
default ListWorkersWithQualificationTypeResponse listWorkersWithQualificationType(Consumer<ListWorkersWithQualificationTypeRequest.Builder> listWorkersWithQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException The
ListWorkersWithQualificationType
operation returns all of the Workers that have been associated with a given Qualification type.
This is a convenience which creates an instance of the
ListWorkersWithQualificationTypeRequest.Builder
avoiding the need to create one manually viaListWorkersWithQualificationTypeRequest.builder()
- Parameters:
listWorkersWithQualificationTypeRequest
- AConsumer
that will call methods onListWorkersWithQualificationTypeRequest.Builder
to create a request.- Returns:
- Result of the ListWorkersWithQualificationType operation returned by the service.
- See Also:
-
listWorkersWithQualificationTypePaginator
default ListWorkersWithQualificationTypeIterable listWorkersWithQualificationTypePaginator(ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client.listWorkersWithQualificationTypePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client .listWorkersWithQualificationTypePaginator(request); for (software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client.listWorkersWithQualificationTypePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)
operation.- Parameters:
listWorkersWithQualificationTypeRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWorkersWithQualificationTypePaginator
default ListWorkersWithQualificationTypeIterable listWorkersWithQualificationTypePaginator(Consumer<ListWorkersWithQualificationTypeRequest.Builder> listWorkersWithQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException This is a variant of
listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client.listWorkersWithQualificationTypePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client .listWorkersWithQualificationTypePaginator(request); for (software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client.listWorkersWithQualificationTypePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)
operation.
This is a convenience which creates an instance of the
ListWorkersWithQualificationTypeRequest.Builder
avoiding the need to create one manually viaListWorkersWithQualificationTypeRequest.builder()
- Parameters:
listWorkersWithQualificationTypeRequest
- AConsumer
that will call methods onListWorkersWithQualificationTypeRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
notifyWorkers
default NotifyWorkersResponse notifyWorkers(NotifyWorkersRequest notifyWorkersRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
notifyWorkersRequest
-- Returns:
- Result of the NotifyWorkers operation returned by the service.
- See Also:
-
notifyWorkers
default NotifyWorkersResponse notifyWorkers(Consumer<NotifyWorkersRequest.Builder> notifyWorkersRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
NotifyWorkersRequest.Builder
avoiding the need to create one manually viaNotifyWorkersRequest.builder()
- Parameters:
notifyWorkersRequest
- AConsumer
that will call methods onNotifyWorkersRequest.Builder
to create a request.- Returns:
- Result of the NotifyWorkers operation returned by the service.
- See Also:
-
rejectAssignment
default RejectAssignmentResponse rejectAssignment(RejectAssignmentRequest rejectAssignmentRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
- Parameters:
rejectAssignmentRequest
-- Returns:
- Result of the RejectAssignment operation returned by the service.
- See Also:
-
rejectAssignment
default RejectAssignmentResponse rejectAssignment(Consumer<RejectAssignmentRequest.Builder> rejectAssignmentRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
RejectAssignmentRequest.Builder
avoiding the need to create one manually viaRejectAssignmentRequest.builder()
- Parameters:
rejectAssignmentRequest
- AConsumer
that will call methods onRejectAssignmentRequest.Builder
to create a request.- Returns:
- Result of the RejectAssignment operation returned by the service.
- See Also:
-
rejectQualificationRequest
default RejectQualificationRequestResponse rejectQualificationRequest(RejectQualificationRequestRequest rejectQualificationRequestRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
- Parameters:
rejectQualificationRequestRequest
-- Returns:
- Result of the RejectQualificationRequest operation returned by the service.
- See Also:
-
rejectQualificationRequest
default RejectQualificationRequestResponse rejectQualificationRequest(Consumer<RejectQualificationRequestRequest.Builder> rejectQualificationRequestRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
RejectQualificationRequestRequest.Builder
avoiding the need to create one manually viaRejectQualificationRequestRequest.builder()
- Parameters:
rejectQualificationRequestRequest
- AConsumer
that will call methods onRejectQualificationRequestRequest.Builder
to create a request.- Returns:
- Result of the RejectQualificationRequest operation returned by the service.
- See Also:
-
sendBonus
default SendBonusResponse sendBonus(SendBonusRequest sendBonusRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
sendBonusRequest
-- Returns:
- Result of the SendBonus operation returned by the service.
- See Also:
-
sendBonus
default SendBonusResponse sendBonus(Consumer<SendBonusRequest.Builder> sendBonusRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
SendBonusRequest.Builder
avoiding the need to create one manually viaSendBonusRequest.builder()
- Parameters:
sendBonusRequest
- AConsumer
that will call methods onSendBonusRequest.Builder
to create a request.- Returns:
- Result of the SendBonus operation returned by the service.
- See Also:
-
sendTestEventNotification
default SendTestEventNotificationResponse sendTestEventNotification(SendTestEventNotificationRequest sendTestEventNotificationRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
sendTestEventNotificationRequest
-- Returns:
- Result of the SendTestEventNotification operation returned by the service.
- See Also:
-
sendTestEventNotification
default SendTestEventNotificationResponse sendTestEventNotification(Consumer<SendTestEventNotificationRequest.Builder> sendTestEventNotificationRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
SendTestEventNotificationRequest.Builder
avoiding the need to create one manually viaSendTestEventNotificationRequest.builder()
- Parameters:
sendTestEventNotificationRequest
- AConsumer
that will call methods onSendTestEventNotificationRequest.Builder
to create a request.- Returns:
- Result of the SendTestEventNotification operation returned by the service.
- See Also:
-
updateExpirationForHIT
default UpdateExpirationForHitResponse updateExpirationForHIT(UpdateExpirationForHitRequest updateExpirationForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
updateExpirationForHitRequest
-- Returns:
- Result of the UpdateExpirationForHIT operation returned by the service.
- See Also:
-
updateExpirationForHIT
default UpdateExpirationForHitResponse updateExpirationForHIT(Consumer<UpdateExpirationForHitRequest.Builder> updateExpirationForHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
UpdateExpirationForHitRequest.Builder
avoiding the need to create one manually viaUpdateExpirationForHitRequest.builder()
- Parameters:
updateExpirationForHitRequest
- AConsumer
that will call methods onUpdateExpirationForHitRequest.Builder
to create a request.- Returns:
- Result of the UpdateExpirationForHIT operation returned by the service.
- See Also:
-
updateHITReviewStatus
default UpdateHitReviewStatusResponse updateHITReviewStatus(UpdateHitReviewStatusRequest updateHitReviewStatusRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
updateHitReviewStatusRequest
-- Returns:
- Result of the UpdateHITReviewStatus operation returned by the service.
- See Also:
-
updateHITReviewStatus
default UpdateHitReviewStatusResponse updateHITReviewStatus(Consumer<UpdateHitReviewStatusRequest.Builder> updateHitReviewStatusRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
UpdateHitReviewStatusRequest.Builder
avoiding the need to create one manually viaUpdateHitReviewStatusRequest.builder()
- Parameters:
updateHitReviewStatusRequest
- AConsumer
that will call methods onUpdateHitReviewStatusRequest.Builder
to create a request.- Returns:
- Result of the UpdateHITReviewStatus operation returned by the service.
- See Also:
-
updateHITTypeOfHIT
default UpdateHitTypeOfHitResponse updateHITTypeOfHIT(UpdateHitTypeOfHitRequest updateHitTypeOfHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.- Parameters:
updateHitTypeOfHitRequest
-- Returns:
- Result of the UpdateHITTypeOfHIT operation returned by the service.
- See Also:
-
updateHITTypeOfHIT
default UpdateHitTypeOfHitResponse updateHITTypeOfHIT(Consumer<UpdateHitTypeOfHitRequest.Builder> updateHitTypeOfHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
UpdateHitTypeOfHitRequest.Builder
avoiding the need to create one manually viaUpdateHitTypeOfHitRequest.builder()
- Parameters:
updateHitTypeOfHitRequest
- AConsumer
that will call methods onUpdateHitTypeOfHitRequest.Builder
to create a request.- Returns:
- Result of the UpdateHITTypeOfHIT operation returned by the service.
- See Also:
-
updateNotificationSettings
default UpdateNotificationSettingsResponse updateNotificationSettings(UpdateNotificationSettingsRequest updateNotificationSettingsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 toUpdateNotificationSettings
.- Parameters:
updateNotificationSettingsRequest
-- Returns:
- Result of the UpdateNotificationSettings operation returned by the service.
- See Also:
-
updateNotificationSettings
default UpdateNotificationSettingsResponse updateNotificationSettings(Consumer<UpdateNotificationSettingsRequest.Builder> updateNotificationSettingsRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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 toUpdateNotificationSettings
.
This is a convenience which creates an instance of the
UpdateNotificationSettingsRequest.Builder
avoiding the need to create one manually viaUpdateNotificationSettingsRequest.builder()
- Parameters:
updateNotificationSettingsRequest
- AConsumer
that will call methods onUpdateNotificationSettingsRequest.Builder
to create a request.- Returns:
- Result of the UpdateNotificationSettings operation returned by the service.
- See Also:
-
updateQualificationType
default UpdateQualificationTypeResponse updateQualificationType(UpdateQualificationTypeRequest updateQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
- Parameters:
updateQualificationTypeRequest
-- Returns:
- Result of the UpdateQualificationType operation returned by the service.
- See Also:
-
updateQualificationType
default UpdateQualificationTypeResponse updateQualificationType(Consumer<UpdateQualificationTypeRequest.Builder> updateQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException 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.
This is a convenience which creates an instance of the
UpdateQualificationTypeRequest.Builder
avoiding the need to create one manually viaUpdateQualificationTypeRequest.builder()
- Parameters:
updateQualificationTypeRequest
- AConsumer
that will call methods onUpdateQualificationTypeRequest.Builder
to create a request.- Returns:
- Result of the UpdateQualificationType operation returned by the service.
- See Also:
-
create
Create aMTurkClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMTurkClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-