@Generated(value="software.amazon.awssdk:codegen") public interface MTurkClient extends SdkClient
builder()
method.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AcceptQualificationRequestResponse |
acceptQualificationRequest(AcceptQualificationRequestRequest acceptQualificationRequestRequest)
The
AcceptQualificationRequest operation approves a Worker's request for a Qualification. |
default AcceptQualificationRequestResponse |
acceptQualificationRequest(Consumer<AcceptQualificationRequestRequest.Builder> acceptQualificationRequestRequest)
The
AcceptQualificationRequest operation approves a Worker's request for a Qualification. |
default ApproveAssignmentResponse |
approveAssignment(ApproveAssignmentRequest approveAssignmentRequest)
The
ApproveAssignment operation approves the results of a completed assignment. |
default ApproveAssignmentResponse |
approveAssignment(Consumer<ApproveAssignmentRequest.Builder> approveAssignmentRequest)
The
ApproveAssignment operation approves the results of a completed assignment. |
default AssociateQualificationWithWorkerResponse |
associateQualificationWithWorker(AssociateQualificationWithWorkerRequest associateQualificationWithWorkerRequest)
The
AssociateQualificationWithWorker operation gives a Worker a Qualification. |
default AssociateQualificationWithWorkerResponse |
associateQualificationWithWorker(Consumer<AssociateQualificationWithWorkerRequest.Builder> associateQualificationWithWorkerRequest)
The
AssociateQualificationWithWorker operation gives a Worker a Qualification. |
static MTurkClientBuilder |
builder()
Create a builder that can be used to configure and create a
MTurkClient . |
static MTurkClient |
create()
Create a
MTurkClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateAdditionalAssignmentsForHitResponse |
createAdditionalAssignmentsForHIT(Consumer<CreateAdditionalAssignmentsForHitRequest.Builder> createAdditionalAssignmentsForHitRequest)
The
CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an
existing HIT. |
default CreateAdditionalAssignmentsForHitResponse |
createAdditionalAssignmentsForHIT(CreateAdditionalAssignmentsForHitRequest createAdditionalAssignmentsForHitRequest)
The
CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an
existing HIT. |
default CreateHitResponse |
createHIT(Consumer<CreateHitRequest.Builder> createHitRequest)
The
CreateHIT operation creates a new Human Intelligence Task (HIT). |
default CreateHitResponse |
createHIT(CreateHitRequest createHitRequest)
The
CreateHIT operation creates a new Human Intelligence Task (HIT). |
default CreateHitTypeResponse |
createHITType(Consumer<CreateHitTypeRequest.Builder> createHitTypeRequest)
The
CreateHITType operation creates a new HIT type. |
default CreateHitTypeResponse |
createHITType(CreateHitTypeRequest createHitTypeRequest)
The
CreateHITType operation creates a new HIT type. |
default CreateHitWithHitTypeResponse |
createHITWithHITType(Consumer<CreateHitWithHitTypeRequest.Builder> createHitWithHitTypeRequest)
The
CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing
HITTypeID generated by the CreateHITType operation. |
default CreateHitWithHitTypeResponse |
createHITWithHITType(CreateHitWithHitTypeRequest createHitWithHitTypeRequest)
The
CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing
HITTypeID generated by the CreateHITType operation. |
default CreateQualificationTypeResponse |
createQualificationType(Consumer<CreateQualificationTypeRequest.Builder> createQualificationTypeRequest)
The
CreateQualificationType operation creates a new Qualification type, which is represented by a
QualificationType data structure. |
default CreateQualificationTypeResponse |
createQualificationType(CreateQualificationTypeRequest createQualificationTypeRequest)
The
CreateQualificationType operation creates a new Qualification type, which is represented by a
QualificationType data structure. |
default CreateWorkerBlockResponse |
createWorkerBlock(Consumer<CreateWorkerBlockRequest.Builder> createWorkerBlockRequest)
The
CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. |
default CreateWorkerBlockResponse |
createWorkerBlock(CreateWorkerBlockRequest createWorkerBlockRequest)
The
CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. |
default DeleteHitResponse |
deleteHIT(Consumer<DeleteHitRequest.Builder> deleteHitRequest)
The
DeleteHIT operation is used to delete HIT that is no longer needed. |
default DeleteHitResponse |
deleteHIT(DeleteHitRequest deleteHitRequest)
The
DeleteHIT operation is used to delete HIT that is no longer needed. |
default DeleteQualificationTypeResponse |
deleteQualificationType(Consumer<DeleteQualificationTypeRequest.Builder> deleteQualificationTypeRequest)
The
DeleteQualificationType deletes a Qualification type and deletes any HIT types that are
associated with the Qualification type. |
default DeleteQualificationTypeResponse |
deleteQualificationType(DeleteQualificationTypeRequest deleteQualificationTypeRequest)
The
DeleteQualificationType deletes a Qualification type and deletes any HIT types that are
associated with the Qualification type. |
default DeleteWorkerBlockResponse |
deleteWorkerBlock(Consumer<DeleteWorkerBlockRequest.Builder> deleteWorkerBlockRequest)
The
DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. |
default DeleteWorkerBlockResponse |
deleteWorkerBlock(DeleteWorkerBlockRequest deleteWorkerBlockRequest)
The
DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. |
default DisassociateQualificationFromWorkerResponse |
disassociateQualificationFromWorker(Consumer<DisassociateQualificationFromWorkerRequest.Builder> disassociateQualificationFromWorkerRequest)
The
DisassociateQualificationFromWorker revokes a previously granted Qualification from a user. |
default DisassociateQualificationFromWorkerResponse |
disassociateQualificationFromWorker(DisassociateQualificationFromWorkerRequest disassociateQualificationFromWorkerRequest)
The
DisassociateQualificationFromWorker revokes a previously granted Qualification from a user. |
default GetAccountBalanceResponse |
getAccountBalance()
The
GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk
account. |
default GetAccountBalanceResponse |
getAccountBalance(Consumer<GetAccountBalanceRequest.Builder> getAccountBalanceRequest)
The
GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk
account. |
default GetAccountBalanceResponse |
getAccountBalance(GetAccountBalanceRequest getAccountBalanceRequest)
The
GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk
account. |
default GetAssignmentResponse |
getAssignment(Consumer<GetAssignmentRequest.Builder> getAssignmentRequest)
The
GetAssignment operation retrieves the details of the specified Assignment. |
default GetAssignmentResponse |
getAssignment(GetAssignmentRequest getAssignmentRequest)
The
GetAssignment operation retrieves the details of the specified Assignment. |
default GetFileUploadUrlResponse |
getFileUploadURL(Consumer<GetFileUploadUrlRequest.Builder> getFileUploadUrlRequest)
The
GetFileUploadURL operation generates and returns a temporary URL. |
default GetFileUploadUrlResponse |
getFileUploadURL(GetFileUploadUrlRequest getFileUploadUrlRequest)
The
GetFileUploadURL operation generates and returns a temporary URL. |
default GetHitResponse |
getHIT(Consumer<GetHitRequest.Builder> getHitRequest)
The
GetHIT operation retrieves the details of the specified HIT. |
default GetHitResponse |
getHIT(GetHitRequest getHitRequest)
The
GetHIT operation retrieves the details of the specified HIT. |
default GetQualificationScoreResponse |
getQualificationScore(Consumer<GetQualificationScoreRequest.Builder> getQualificationScoreRequest)
The
GetQualificationScore operation returns the value of a Worker's Qualification for a given
Qualification type. |
default GetQualificationScoreResponse |
getQualificationScore(GetQualificationScoreRequest getQualificationScoreRequest)
The
GetQualificationScore operation returns the value of a Worker's Qualification for a given
Qualification type. |
default GetQualificationTypeResponse |
getQualificationType(Consumer<GetQualificationTypeRequest.Builder> getQualificationTypeRequest)
The
GetQualificationType operation retrieves information about a Qualification type using its ID. |
default GetQualificationTypeResponse |
getQualificationType(GetQualificationTypeRequest getQualificationTypeRequest)
The
GetQualificationType operation retrieves information about a Qualification type using its ID. |
default ListAssignmentsForHitResponse |
listAssignmentsForHIT(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest)
The
ListAssignmentsForHIT operation retrieves completed assignments for a HIT. |
default ListAssignmentsForHitResponse |
listAssignmentsForHIT(ListAssignmentsForHitRequest listAssignmentsForHitRequest)
The
ListAssignmentsForHIT operation retrieves completed assignments for a HIT. |
default ListAssignmentsForHITIterable |
listAssignmentsForHITPaginator(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest)
The
ListAssignmentsForHIT operation retrieves completed assignments for a HIT. |
default ListAssignmentsForHITIterable |
listAssignmentsForHITPaginator(ListAssignmentsForHitRequest listAssignmentsForHitRequest)
The
ListAssignmentsForHIT operation retrieves completed assignments for a HIT. |
default ListBonusPaymentsResponse |
listBonusPayments(Consumer<ListBonusPaymentsRequest.Builder> listBonusPaymentsRequest)
The
ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a
given HIT or assignment. |
default ListBonusPaymentsResponse |
listBonusPayments(ListBonusPaymentsRequest listBonusPaymentsRequest)
The
ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a
given HIT or assignment. |
default ListBonusPaymentsIterable |
listBonusPaymentsPaginator(Consumer<ListBonusPaymentsRequest.Builder> listBonusPaymentsRequest)
The
ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a
given HIT or assignment. |
default ListBonusPaymentsIterable |
listBonusPaymentsPaginator(ListBonusPaymentsRequest listBonusPaymentsRequest)
The
ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a
given HIT or assignment. |
default ListHiTsResponse |
listHITs()
The
ListHITs operation returns all of a Requester's HITs. |
default ListHiTsResponse |
listHITs(Consumer<ListHiTsRequest.Builder> listHiTsRequest)
The
ListHITs operation returns all of a Requester's HITs. |
default ListHiTsResponse |
listHITs(ListHiTsRequest listHiTsRequest)
The
ListHITs operation returns all of a Requester's HITs. |
default ListHiTsForQualificationTypeResponse |
listHITsForQualificationType(Consumer<ListHiTsForQualificationTypeRequest.Builder> listHiTsForQualificationTypeRequest)
The
ListHITsForQualificationType operation returns the HITs that use the given Qualification type
for a Qualification requirement. |
default ListHiTsForQualificationTypeResponse |
listHITsForQualificationType(ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest)
The
ListHITsForQualificationType operation returns the HITs that use the given Qualification type
for a Qualification requirement. |
default ListHITsForQualificationTypeIterable |
listHITsForQualificationTypePaginator(Consumer<ListHiTsForQualificationTypeRequest.Builder> listHiTsForQualificationTypeRequest)
The
ListHITsForQualificationType operation returns the HITs that use the given Qualification type
for a Qualification requirement. |
default ListHITsForQualificationTypeIterable |
listHITsForQualificationTypePaginator(ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest)
The
ListHITsForQualificationType operation returns the HITs that use the given Qualification type
for a Qualification requirement. |
default ListHITsIterable |
listHITsPaginator()
The
ListHITs operation returns all of a Requester's HITs. |
default ListHITsIterable |
listHITsPaginator(Consumer<ListHiTsRequest.Builder> listHiTsRequest)
The
ListHITs operation returns all of a Requester's HITs. |
default ListHITsIterable |
listHITsPaginator(ListHiTsRequest listHiTsRequest)
The
ListHITs operation returns all of a Requester's HITs. |
default ListQualificationRequestsResponse |
listQualificationRequests()
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListQualificationRequestsResponse |
listQualificationRequests(Consumer<ListQualificationRequestsRequest.Builder> listQualificationRequestsRequest)
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListQualificationRequestsResponse |
listQualificationRequests(ListQualificationRequestsRequest listQualificationRequestsRequest)
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListQualificationRequestsIterable |
listQualificationRequestsPaginator()
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListQualificationRequestsIterable |
listQualificationRequestsPaginator(Consumer<ListQualificationRequestsRequest.Builder> listQualificationRequestsRequest)
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListQualificationRequestsIterable |
listQualificationRequestsPaginator(ListQualificationRequestsRequest listQualificationRequestsRequest)
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListQualificationTypesResponse |
listQualificationTypes(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest)
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListQualificationTypesResponse |
listQualificationTypes(ListQualificationTypesRequest listQualificationTypesRequest)
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListQualificationTypesIterable |
listQualificationTypesPaginator(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest)
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListQualificationTypesIterable |
listQualificationTypesPaginator(ListQualificationTypesRequest listQualificationTypesRequest)
The
ListQualificationRequests operation retrieves requests for Qualifications of a particular
Qualification type. |
default ListReviewableHiTsResponse |
listReviewableHITs()
The
ListReviewableHITs 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)
The
ListReviewableHITs 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)
The
ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
to Reviewing that belong to the Requester calling the operation. |
default ListReviewableHITsIterable |
listReviewableHITsPaginator()
The
ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
to Reviewing that belong to the Requester calling the operation. |
default ListReviewableHITsIterable |
listReviewableHITsPaginator(Consumer<ListReviewableHiTsRequest.Builder> listReviewableHiTsRequest)
The
ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
to Reviewing that belong to the Requester calling the operation. |
default ListReviewableHITsIterable |
listReviewableHITsPaginator(ListReviewableHiTsRequest listReviewableHiTsRequest)
The
ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
to Reviewing that belong to the Requester calling the operation. |
default ListReviewPolicyResultsForHitResponse |
listReviewPolicyResultsForHIT(Consumer<ListReviewPolicyResultsForHitRequest.Builder> listReviewPolicyResultsForHitRequest)
The
ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in
the course of executing your Review Policies for a given HIT. |
default ListReviewPolicyResultsForHitResponse |
listReviewPolicyResultsForHIT(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest)
The
ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in
the course of executing your Review Policies for a given HIT. |
default ListReviewPolicyResultsForHITIterable |
listReviewPolicyResultsForHITPaginator(Consumer<ListReviewPolicyResultsForHitRequest.Builder> listReviewPolicyResultsForHitRequest)
The
ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in
the course of executing your Review Policies for a given HIT. |
default ListReviewPolicyResultsForHITIterable |
listReviewPolicyResultsForHITPaginator(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest)
The
ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in
the course of executing your Review Policies for a given HIT. |
default ListWorkerBlocksResponse |
listWorkerBlocks()
The
ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
HITs. |
default ListWorkerBlocksResponse |
listWorkerBlocks(Consumer<ListWorkerBlocksRequest.Builder> listWorkerBlocksRequest)
The
ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
HITs. |
default ListWorkerBlocksResponse |
listWorkerBlocks(ListWorkerBlocksRequest listWorkerBlocksRequest)
The
ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
HITs. |
default ListWorkerBlocksIterable |
listWorkerBlocksPaginator()
The
ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
HITs. |
default ListWorkerBlocksIterable |
listWorkerBlocksPaginator(Consumer<ListWorkerBlocksRequest.Builder> listWorkerBlocksRequest)
The
ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
HITs. |
default ListWorkerBlocksIterable |
listWorkerBlocksPaginator(ListWorkerBlocksRequest listWorkerBlocksRequest)
The
ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
HITs. |
default ListWorkersWithQualificationTypeResponse |
listWorkersWithQualificationType(Consumer<ListWorkersWithQualificationTypeRequest.Builder> listWorkersWithQualificationTypeRequest)
The
ListWorkersWithQualificationType operation returns all of the Workers that have been associated
with a given Qualification type. |
default ListWorkersWithQualificationTypeResponse |
listWorkersWithQualificationType(ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest)
The
ListWorkersWithQualificationType operation returns all of the Workers that have been associated
with a given Qualification type. |
default ListWorkersWithQualificationTypeIterable |
listWorkersWithQualificationTypePaginator(Consumer<ListWorkersWithQualificationTypeRequest.Builder> listWorkersWithQualificationTypeRequest)
The
ListWorkersWithQualificationType operation returns all of the Workers that have been associated
with a given Qualification type. |
default ListWorkersWithQualificationTypeIterable |
listWorkersWithQualificationTypePaginator(ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest)
The
ListWorkersWithQualificationType operation returns all of the Workers that have been associated
with a given Qualification type. |
default NotifyWorkersResponse |
notifyWorkers(Consumer<NotifyWorkersRequest.Builder> notifyWorkersRequest)
The
NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker
ID. |
default NotifyWorkersResponse |
notifyWorkers(NotifyWorkersRequest notifyWorkersRequest)
The
NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker
ID. |
default RejectAssignmentResponse |
rejectAssignment(Consumer<RejectAssignmentRequest.Builder> rejectAssignmentRequest)
The
RejectAssignment operation rejects the results of a completed assignment. |
default RejectAssignmentResponse |
rejectAssignment(RejectAssignmentRequest rejectAssignmentRequest)
The
RejectAssignment operation rejects the results of a completed assignment. |
default RejectQualificationRequestResponse |
rejectQualificationRequest(Consumer<RejectQualificationRequestRequest.Builder> rejectQualificationRequestRequest)
The
RejectQualificationRequest operation rejects a user's request for a Qualification. |
default RejectQualificationRequestResponse |
rejectQualificationRequest(RejectQualificationRequestRequest rejectQualificationRequestRequest)
The
RejectQualificationRequest operation rejects a user's request for a Qualification. |
default SendBonusResponse |
sendBonus(Consumer<SendBonusRequest.Builder> sendBonusRequest)
The
SendBonus operation issues a payment of money from your account to a Worker. |
default SendBonusResponse |
sendBonus(SendBonusRequest sendBonusRequest)
The
SendBonus operation issues a payment of money from your account to a Worker. |
default SendTestEventNotificationResponse |
sendTestEventNotification(Consumer<SendTestEventNotificationRequest.Builder> sendTestEventNotificationRequest)
The
SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message
as if a HIT event occurred, according to the provided notification specification. |
default SendTestEventNotificationResponse |
sendTestEventNotification(SendTestEventNotificationRequest sendTestEventNotificationRequest)
The
SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message
as if a HIT event occurred, according to the provided notification specification. |
static ServiceMetadata |
serviceMetadata() |
default UpdateExpirationForHitResponse |
updateExpirationForHIT(Consumer<UpdateExpirationForHitRequest.Builder> updateExpirationForHitRequest)
The
UpdateExpirationForHIT operation allows you update the expiration time of a HIT. |
default UpdateExpirationForHitResponse |
updateExpirationForHIT(UpdateExpirationForHitRequest updateExpirationForHitRequest)
The
UpdateExpirationForHIT operation allows you update the expiration time of a HIT. |
default UpdateHitReviewStatusResponse |
updateHITReviewStatus(Consumer<UpdateHitReviewStatusRequest.Builder> updateHitReviewStatusRequest)
The
UpdateHITReviewStatus operation updates the status of a HIT. |
default UpdateHitReviewStatusResponse |
updateHITReviewStatus(UpdateHitReviewStatusRequest updateHitReviewStatusRequest)
The
UpdateHITReviewStatus operation updates the status of a HIT. |
default UpdateHitTypeOfHitResponse |
updateHITTypeOfHIT(Consumer<UpdateHitTypeOfHitRequest.Builder> updateHitTypeOfHitRequest)
The
UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. |
default UpdateHitTypeOfHitResponse |
updateHITTypeOfHIT(UpdateHitTypeOfHitRequest updateHitTypeOfHitRequest)
The
UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. |
default UpdateNotificationSettingsResponse |
updateNotificationSettings(Consumer<UpdateNotificationSettingsRequest.Builder> updateNotificationSettingsRequest)
The
UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for
a HIT type. |
default UpdateNotificationSettingsResponse |
updateNotificationSettings(UpdateNotificationSettingsRequest updateNotificationSettingsRequest)
The
UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for
a HIT type. |
default UpdateQualificationTypeResponse |
updateQualificationType(Consumer<UpdateQualificationTypeRequest.Builder> updateQualificationTypeRequest)
The
UpdateQualificationType operation modifies the attributes of an existing Qualification type,
which is represented by a QualificationType data structure. |
default UpdateQualificationTypeResponse |
updateQualificationType(UpdateQualificationTypeRequest updateQualificationTypeRequest)
The
UpdateQualificationType operation modifies the attributes of an existing Qualification type,
which is represented by a QualificationType data structure. |
serviceName
close
static final String SERVICE_NAME
static MTurkClient create()
MTurkClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static MTurkClientBuilder builder()
MTurkClient
.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.
acceptQualificationRequestRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via AcceptQualificationRequestRequest.builder()
acceptQualificationRequestRequest
- A Consumer
that will call methods on AcceptQualificationRequestRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
approveAssignmentRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ApproveAssignmentRequest.builder()
approveAssignmentRequest
- A Consumer
that will call methods on ApproveAssignmentRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
RejectQualificationRequest
operation.
associateQualificationWithWorkerRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
RejectQualificationRequest
operation.
This is a convenience which creates an instance of the AssociateQualificationWithWorkerRequest.Builder
avoiding the need to create one manually via AssociateQualificationWithWorkerRequest.builder()
associateQualificationWithWorkerRequest
- A Consumer
that will call methods on AssociateQualificationWithWorkerRequest.Builder
to
create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createAdditionalAssignmentsForHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateAdditionalAssignmentsForHitRequest.builder()
createAdditionalAssignmentsForHitRequest
- A Consumer
that will call methods on CreateAdditionalAssignmentsForHITRequest.Builder
to
create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 new HITTypeID
. The HITTypeID can be used to create additional HITs in the
future without needing to specify common parameters such as the title, description and reward amount each time.
An alternative way to create HITs is to first generate a HITTypeID using the CreateHITType
operation
and then call the CreateHITWithHITType
operation. This is the recommended best practice for
Requesters who are creating large numbers of HITs.
CreateHIT also supports several ways to provide question data: by providing a value for the Question
parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId
and associated
HitLayoutParameters
.
If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
createHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 new HITTypeID
. The HITTypeID can be used to create additional HITs in the
future without needing to specify common parameters such as the title, description and reward amount each time.
An alternative way to create HITs is to first generate a HITTypeID using the CreateHITType
operation
and then call the CreateHITWithHITType
operation. This is the recommended best practice for
Requesters who are creating large numbers of HITs.
CreateHIT also supports several ways to provide question data: by providing a value for the Question
parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId
and associated
HitLayoutParameters
.
If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
This is a convenience which creates an instance of the CreateHitRequest.Builder
avoiding the need to
create one manually via CreateHitRequest.builder()
createHitRequest
- A Consumer
that will call methods on CreateHITRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createHitTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateHitTypeRequest.builder()
createHitTypeRequest
- A Consumer
that will call methods on CreateHITTypeRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the CreateHITType
operation.
This is an alternative way to create HITs from the CreateHIT
operation. This is the recommended best
practice for Requesters who are creating large numbers of HITs.
CreateHITWithHITType also supports several ways to provide question data: by providing a value for the
Question
parameter that fully specifies the contents of the HIT, or by providing a
HitLayoutId
and associated HitLayoutParameters
.
If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
createHitWithHitTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the CreateHITType
operation.
This is an alternative way to create HITs from the CreateHIT
operation. This is the recommended best
practice for Requesters who are creating large numbers of HITs.
CreateHITWithHITType also supports several ways to provide question data: by providing a value for the
Question
parameter that fully specifies the contents of the HIT, or by providing a
HitLayoutId
and associated HitLayoutParameters
.
If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
This is a convenience which creates an instance of the CreateHitWithHitTypeRequest.Builder
avoiding the
need to create one manually via CreateHitWithHitTypeRequest.builder()
createHitWithHitTypeRequest
- A Consumer
that will call methods on CreateHITWithHITTypeRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateQualificationTypeResponse createQualificationType(CreateQualificationTypeRequest createQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException
The CreateQualificationType
operation creates a new Qualification type, which is represented by a
QualificationType
data structure.
createQualificationTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 a
QualificationType
data structure.
This is a convenience which creates an instance of the CreateQualificationTypeRequest.Builder
avoiding
the need to create one manually via CreateQualificationTypeRequest.builder()
createQualificationTypeRequest
- A Consumer
that will call methods on CreateQualificationTypeRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createWorkerBlockRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateWorkerBlockRequest.builder()
createWorkerBlockRequest
- A Consumer
that will call methods on CreateWorkerBlockRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
Reviewable
state (for example, that has not expired, or still has active assignments), or on a HIT
that is Reviewable but without all of its submitted assignments already approved or rejected, the service will
return an error.
HITs are automatically disposed of after 120 days.
After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.
Disposed HITs are not returned in results for the ListHITs operation.
Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs.
deleteHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
Reviewable
state (for example, that has not expired, or still has active assignments), or on a HIT
that is Reviewable but without all of its submitted assignments already approved or rejected, the service will
return an error.
HITs are automatically disposed of after 120 days.
After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.
Disposed HITs are not returned in results for the ListHITs operation.
Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs.
This is a convenience which creates an instance of the DeleteHitRequest.Builder
avoiding the need to
create one manually via DeleteHitRequest.builder()
deleteHitRequest
- A Consumer
that will call methods on DeleteHITRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteQualificationTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteQualificationTypeRequest.builder()
deleteQualificationTypeRequest
- A Consumer
that will call methods on DeleteQualificationTypeRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteWorkerBlockRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteWorkerBlockRequest.builder()
deleteWorkerBlockRequest
- A Consumer
that will call methods on DeleteWorkerBlockRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
disassociateQualificationFromWorkerRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DisassociateQualificationFromWorkerRequest.builder()
disassociateQualificationFromWorkerRequest
- A Consumer
that will call methods on DisassociateQualificationFromWorkerRequest.Builder
to
create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccountBalanceResponse getAccountBalance() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException
The GetAccountBalance
operation retrieves the amount of money in your Amazon Mechanical Turk
account.
ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getAccountBalance(GetAccountBalanceRequest)
,
AWS API Documentationdefault GetAccountBalanceResponse getAccountBalance(GetAccountBalanceRequest getAccountBalanceRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException
The GetAccountBalance
operation retrieves the amount of money in your Amazon Mechanical Turk
account.
getAccountBalanceRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAccountBalanceResponse getAccountBalance(Consumer<GetAccountBalanceRequest.Builder> getAccountBalanceRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException
The GetAccountBalance
operation retrieves the amount of money in your Amazon Mechanical Turk
account.
This is a convenience which creates an instance of the GetAccountBalanceRequest.Builder
avoiding the need
to create one manually via GetAccountBalanceRequest.builder()
getAccountBalanceRequest
- A Consumer
that will call methods on GetAccountBalanceRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAssignmentResponse getAssignment(GetAssignmentRequest getAssignmentRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException
The GetAssignment
operation retrieves the details of the specified Assignment.
getAssignmentRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetAssignmentRequest.builder()
getAssignmentRequest
- A Consumer
that will call methods on GetAssignmentRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getFileUploadUrlRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
This is a convenience which creates an instance of the GetFileUploadUrlRequest.Builder
avoiding the need
to create one manually via GetFileUploadUrlRequest.builder()
getFileUploadUrlRequest
- A Consumer
that will call methods on GetFileUploadURLRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetHitResponse getHIT(GetHitRequest getHitRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException
The GetHIT
operation retrieves the details of the specified HIT.
getHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetHitRequest.builder()
getHitRequest
- A Consumer
that will call methods on GetHITRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getQualificationScoreRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetQualificationScoreRequest.builder()
getQualificationScoreRequest
- A Consumer
that will call methods on GetQualificationScoreRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetQualificationTypeResponse getQualificationType(GetQualificationTypeRequest getQualificationTypeRequest) throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException
The GetQualificationType
operation retrieves information about a Qualification type using its ID.
getQualificationTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetQualificationTypeRequest.builder()
getQualificationTypeRequest
- A Consumer
that will call methods on GetQualificationTypeRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listAssignmentsForHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListAssignmentsForHitRequest.builder()
listAssignmentsForHitRequest
- A Consumer
that will call methods on ListAssignmentsForHITRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAssignmentsForHITIterable listAssignmentsForHITPaginator(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.
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 Stream
software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client.listAssignmentsForHITPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client.listAssignmentsForHITPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)
operation.
listAssignmentsForHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAssignmentsForHITIterable listAssignmentsForHITPaginator(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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client.listAssignmentsForHITPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITIterable responses = client.listAssignmentsForHITPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListAssignmentsForHitRequest.builder()
listAssignmentsForHitRequest
- A Consumer
that will call methods on ListAssignmentsForHITRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listBonusPaymentsRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListBonusPaymentsRequest.builder()
listBonusPaymentsRequest
- A Consumer
that will call methods on ListBonusPaymentsRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBonusPaymentsIterable listBonusPaymentsPaginator(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.
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 Stream
software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client.listBonusPaymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client.listBonusPaymentsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)
operation.
listBonusPaymentsRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBonusPaymentsIterable listBonusPaymentsPaginator(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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client.listBonusPaymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsIterable responses = client.listBonusPaymentsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListBonusPaymentsRequest.builder()
listBonusPaymentsRequest
- A Consumer
that will call methods on ListBonusPaymentsRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListHiTsResponse listHITs() 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.
ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listHITs(ListHiTsRequest)
,
AWS API
Documentationdefault 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.
listHiTsRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListHiTsRequest.builder()
listHiTsRequest
- A Consumer
that will call methods on ListHITsRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListHITsIterable listHITsPaginator() 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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation.
ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listHITsPaginator(ListHiTsRequest)
,
AWS API
Documentationdefault ListHITsIterable listHITsPaginator(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.
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 Stream
software.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)
operation.
listHiTsRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListHITsIterable listHITsPaginator(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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListHITsIterable responses = client.listHITsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListHiTsRequest.builder()
listHiTsRequest
- A Consumer
that will call methods on ListHITsRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the DeleteHIT
operation or that have been auto-deleted.
listHiTsForQualificationTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the DeleteHIT
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 via ListHiTsForQualificationTypeRequest.builder()
listHiTsForQualificationTypeRequest
- A Consumer
that will call methods on ListHITsForQualificationTypeRequest.Builder
to create
a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListHITsForQualificationTypeIterable listHITsForQualificationTypePaginator(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 the DeleteHIT
operation or that have been auto-deleted.
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 Stream
software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client.listHITsForQualificationTypePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client.listHITsForQualificationTypePaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)
operation.
listHiTsForQualificationTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListHITsForQualificationTypeIterable listHITsForQualificationTypePaginator(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 the DeleteHIT
operation or that have been auto-deleted.
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 Stream
software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client.listHITsForQualificationTypePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypeIterable responses = client.listHITsForQualificationTypePaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListHiTsForQualificationTypeRequest.builder()
listHiTsForQualificationTypeRequest
- A Consumer
that will call methods on ListHITsForQualificationTypeRequest.Builder
to create
a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListQualificationRequestsResponse listQualificationRequests() 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.
ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listQualificationRequests(ListQualificationRequestsRequest)
,
AWS API Documentationdefault 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.
listQualificationRequestsRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListQualificationRequestsRequest.builder()
listQualificationRequestsRequest
- A Consumer
that will call methods on ListQualificationRequestsRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListQualificationRequestsIterable listQualificationRequestsPaginator() 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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation.
ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listQualificationRequestsPaginator(ListQualificationRequestsRequest)
,
AWS API Documentationdefault ListQualificationRequestsIterable listQualificationRequestsPaginator(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.
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 Stream
software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)
operation.
listQualificationRequestsRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListQualificationRequestsIterable listQualificationRequestsPaginator(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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsIterable responses = client.listQualificationRequestsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListQualificationRequestsRequest.builder()
listQualificationRequestsRequest
- A Consumer
that will call methods on ListQualificationRequestsRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListQualificationTypesResponse listQualificationTypes(ListQualificationTypesRequest listQualificationTypesRequest) 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.
listQualificationTypesRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListQualificationTypesResponse listQualificationTypes(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest) 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 ListQualificationTypesRequest.Builder
avoiding the
need to create one manually via ListQualificationTypesRequest.builder()
listQualificationTypesRequest
- A Consumer
that will call methods on ListQualificationTypesRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListQualificationTypesIterable listQualificationTypesPaginator(ListQualificationTypesRequest listQualificationTypesRequest) 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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client.listQualificationTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client.listQualificationTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)
operation.
listQualificationTypesRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListQualificationTypesIterable listQualificationTypesPaginator(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest) 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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client.listQualificationTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesIterable responses = client.listQualificationTypesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListQualificationTypesRequest.builder()
listQualificationTypesRequest
- A Consumer
that will call methods on ListQualificationTypesRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listReviewPolicyResultsForHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListReviewPolicyResultsForHitRequest.builder()
listReviewPolicyResultsForHitRequest
- A Consumer
that will call methods on ListReviewPolicyResultsForHITRequest.Builder
to
create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListReviewPolicyResultsForHITIterable listReviewPolicyResultsForHITPaginator(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.
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 Stream
software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client.listReviewPolicyResultsForHITPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client.listReviewPolicyResultsForHITPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)
operation.
listReviewPolicyResultsForHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListReviewPolicyResultsForHITIterable listReviewPolicyResultsForHITPaginator(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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client.listReviewPolicyResultsForHITPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITIterable responses = client.listReviewPolicyResultsForHITPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListReviewPolicyResultsForHitRequest.builder()
listReviewPolicyResultsForHitRequest
- A Consumer
that will call methods on ListReviewPolicyResultsForHITRequest.Builder
to
create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListReviewableHiTsResponse listReviewableHITs() 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.
ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listReviewableHITs(ListReviewableHiTsRequest)
,
AWS API Documentationdefault 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.
listReviewableHiTsRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListReviewableHiTsRequest.builder()
listReviewableHiTsRequest
- A Consumer
that will call methods on ListReviewableHITsRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListReviewableHITsIterable listReviewableHITsPaginator() 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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation.
ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listReviewableHITsPaginator(ListReviewableHiTsRequest)
,
AWS API Documentationdefault ListReviewableHITsIterable listReviewableHITsPaginator(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.
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 Stream
software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)
operation.
listReviewableHiTsRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListReviewableHITsIterable listReviewableHITsPaginator(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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsIterable responses = client.listReviewableHITsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListReviewableHiTsRequest.builder()
listReviewableHiTsRequest
- A Consumer
that will call methods on ListReviewableHITsRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkerBlocksResponse listWorkerBlocks() throws ServiceException, RequestErrorException, AwsServiceException, SdkClientException, MTurkException
The ListWorkersBlocks
operation retrieves a list of Workers who are blocked from working on your
HITs.
ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listWorkerBlocks(ListWorkerBlocksRequest)
,
AWS API Documentationdefault 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.
listWorkerBlocksRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListWorkerBlocksRequest.builder()
listWorkerBlocksRequest
- A Consumer
that will call methods on ListWorkerBlocksRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkerBlocksIterable listWorkerBlocksPaginator() 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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation.
ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listWorkerBlocksPaginator(ListWorkerBlocksRequest)
,
AWS API Documentationdefault ListWorkerBlocksIterable listWorkerBlocksPaginator(ListWorkerBlocksRequest 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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)
operation.
listWorkerBlocksRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkerBlocksIterable listWorkerBlocksPaginator(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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksIterable responses = client.listWorkerBlocksPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListWorkerBlocksRequest.builder()
listWorkerBlocksRequest
- A Consumer
that will call methods on ListWorkerBlocksRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listWorkersWithQualificationTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListWorkersWithQualificationTypeRequest.builder()
listWorkersWithQualificationTypeRequest
- A Consumer
that will call methods on ListWorkersWithQualificationTypeRequest.Builder
to
create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkersWithQualificationTypeIterable listWorkersWithQualificationTypePaginator(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.
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 Stream
software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client.listWorkersWithQualificationTypePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client.listWorkersWithQualificationTypePaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)
operation.
listWorkersWithQualificationTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkersWithQualificationTypeIterable listWorkersWithQualificationTypePaginator(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 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 Stream
software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client.listWorkersWithQualificationTypePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypeIterable responses = client.listWorkersWithQualificationTypePaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListWorkersWithQualificationTypeRequest.builder()
listWorkersWithQualificationTypeRequest
- A Consumer
that will call methods on ListWorkersWithQualificationTypeRequest.Builder
to
create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
notifyWorkersRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via NotifyWorkersRequest.builder()
notifyWorkersRequest
- A Consumer
that will call methods on NotifyWorkersRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
rejectAssignmentRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via RejectAssignmentRequest.builder()
rejectAssignmentRequest
- A Consumer
that will call methods on RejectAssignmentRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
rejectQualificationRequestRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via RejectQualificationRequestRequest.builder()
rejectQualificationRequestRequest
- A Consumer
that will call methods on RejectQualificationRequestRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
sendBonusRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via SendBonusRequest.builder()
sendBonusRequest
- A Consumer
that will call methods on SendBonusRequest.Builder
to create a request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
sendTestEventNotificationRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via SendTestEventNotificationRequest.builder()
sendTestEventNotificationRequest
- A Consumer
that will call methods on SendTestEventNotificationRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
updateExpirationForHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via UpdateExpirationForHitRequest.builder()
updateExpirationForHitRequest
- A Consumer
that will call methods on UpdateExpirationForHITRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
updateHitReviewStatusRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via UpdateHitReviewStatusRequest.builder()
updateHitReviewStatusRequest
- A Consumer
that will call methods on UpdateHITReviewStatusRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
updateHitTypeOfHitRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via UpdateHitTypeOfHitRequest.builder()
updateHitTypeOfHitRequest
- A Consumer
that will call methods on UpdateHITTypeOfHITRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 to
UpdateNotificationSettings
.
updateNotificationSettingsRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 to
UpdateNotificationSettings
.
This is a convenience which creates an instance of the UpdateNotificationSettingsRequest.Builder
avoiding
the need to create one manually via UpdateNotificationSettingsRequest.builder()
updateNotificationSettingsRequest
- A Consumer
that will call methods on UpdateNotificationSettingsRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
updateQualificationTypeRequest
- ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via UpdateQualificationTypeRequest.builder()
updateQualificationTypeRequest
- A Consumer
that will call methods on UpdateQualificationTypeRequest.Builder
to create a
request.ServiceException
- Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.RequestErrorException
- Your request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MTurkException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.