AmazonMTurkClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.mturk.AmazonMTurkClient

All Implemented Interfaces:

AmazonMTurk

Direct Known Subclasses:

AmazonMTurkAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonMTurkClient
extends AmazonWebServiceClient
implements AmazonMTurk
```
Client for accessing Amazon MTurk. All service calls made using this client are blocking, and will not return until the service call completes.
Amazon Mechanical Turk API Reference

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.mturk.AmazonMTurk
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcceptQualificationRequestResult`	`acceptQualificationRequest(AcceptQualificationRequestRequest request)` The `AcceptQualificationRequest` operation approves a Worker's request for a Qualification.
`ApproveAssignmentResult`	`approveAssignment(ApproveAssignmentRequest request)` The `ApproveAssignment` operation approves the results of a completed assignment.
`AssociateQualificationWithWorkerResult`	`associateQualificationWithWorker(AssociateQualificationWithWorkerRequest request)` The `AssociateQualificationWithWorker` operation gives a Worker a Qualification.
`static AmazonMTurkClientBuilder`	`builder()`
`CreateAdditionalAssignmentsForHITResult`	`createAdditionalAssignmentsForHIT(CreateAdditionalAssignmentsForHITRequest request)` The `CreateAdditionalAssignmentsForHIT` operation increases the maximum number of assignments of an existing HIT.
`CreateHITResult`	`createHIT(CreateHITRequest request)` The `CreateHIT` operation creates a new Human Intelligence Task (HIT).
`CreateHITTypeResult`	`createHITType(CreateHITTypeRequest request)` The `CreateHITType` operation creates a new HIT type.
`CreateHITWithHITTypeResult`	`createHITWithHITType(CreateHITWithHITTypeRequest request)` The `CreateHITWithHITType` operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the `CreateHITType` operation.
`CreateQualificationTypeResult`	`createQualificationType(CreateQualificationTypeRequest request)` The `CreateQualificationType` operation creates a new Qualification type, which is represented by a `QualificationType` data structure.
`CreateWorkerBlockResult`	`createWorkerBlock(CreateWorkerBlockRequest request)` The `CreateWorkerBlock` operation allows you to prevent a Worker from working on your HITs.
`DeleteHITResult`	`deleteHIT(DeleteHITRequest request)` The `DeleteHIT` operation is used to delete HIT that is no longer needed.
`DeleteQualificationTypeResult`	`deleteQualificationType(DeleteQualificationTypeRequest request)` The `DeleteQualificationType` deletes a Qualification type and deletes any HIT types that are associated with the Qualification type.
`DeleteWorkerBlockResult`	`deleteWorkerBlock(DeleteWorkerBlockRequest request)` The `DeleteWorkerBlock` operation allows you to reinstate a blocked Worker to work on your HITs.
`DisassociateQualificationFromWorkerResult`	`disassociateQualificationFromWorker(DisassociateQualificationFromWorkerRequest request)` The `DisassociateQualificationFromWorker` revokes a previously granted Qualification from a user.
`GetAccountBalanceResult`	`getAccountBalance(GetAccountBalanceRequest request)` The `GetAccountBalance` operation retrieves the amount of money in your Amazon Mechanical Turk account.
`GetAssignmentResult`	`getAssignment(GetAssignmentRequest request)` The `GetAssignment` operation retrieves the details of the specified Assignment.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetFileUploadURLResult`	`getFileUploadURL(GetFileUploadURLRequest request)` The `GetFileUploadURL` operation generates and returns a temporary URL.
`GetHITResult`	`getHIT(GetHITRequest request)` The `GetHIT` operation retrieves the details of the specified HIT.
`GetQualificationScoreResult`	`getQualificationScore(GetQualificationScoreRequest request)` The `GetQualificationScore` operation returns the value of a Worker's Qualification for a given Qualification type.
`GetQualificationTypeResult`	`getQualificationType(GetQualificationTypeRequest request)` The `GetQualificationType`operation retrieves information about a Qualification type using its ID.
`ListAssignmentsForHITResult`	`listAssignmentsForHIT(ListAssignmentsForHITRequest request)` The `ListAssignmentsForHIT` operation retrieves completed assignments for a HIT.
`ListBonusPaymentsResult`	`listBonusPayments(ListBonusPaymentsRequest request)` The `ListBonusPayments` operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.
`ListHITsResult`	`listHITs(ListHITsRequest request)` The `ListHITs` operation returns all of a Requester's HITs.
`ListHITsForQualificationTypeResult`	`listHITsForQualificationType(ListHITsForQualificationTypeRequest request)` The `ListHITsForQualificationType` operation returns the HITs that use the given Qualification type for a Qualification requirement.
`ListQualificationRequestsResult`	`listQualificationRequests(ListQualificationRequestsRequest request)` The `ListQualificationRequests` operation retrieves requests for Qualifications of a particular Qualification type.
`ListQualificationTypesResult`	`listQualificationTypes(ListQualificationTypesRequest request)` The `ListQualificationTypes` operation returns a list of Qualification types, filtered by an optional search term.
`ListReviewableHITsResult`	`listReviewableHITs(ListReviewableHITsRequest request)` The `ListReviewableHITs` operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.
`ListReviewPolicyResultsForHITResult`	`listReviewPolicyResultsForHIT(ListReviewPolicyResultsForHITRequest request)` The `ListReviewPolicyResultsForHIT` operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT.
`ListWorkerBlocksResult`	`listWorkerBlocks(ListWorkerBlocksRequest request)` The `ListWorkersBlocks` operation retrieves a list of Workers who are blocked from working on your HITs.
`ListWorkersWithQualificationTypeResult`	`listWorkersWithQualificationType(ListWorkersWithQualificationTypeRequest request)` The `ListWorkersWithQualificationType` operation returns all of the Workers that have been associated with a given Qualification type.
`NotifyWorkersResult`	`notifyWorkers(NotifyWorkersRequest request)` The `NotifyWorkers` operation sends an email to one or more Workers that you specify with the Worker ID.
`RejectAssignmentResult`	`rejectAssignment(RejectAssignmentRequest request)` The `RejectAssignment` operation rejects the results of a completed assignment.
`RejectQualificationRequestResult`	`rejectQualificationRequest(RejectQualificationRequestRequest request)` The `RejectQualificationRequest` operation rejects a user's request for a Qualification.
`SendBonusResult`	`sendBonus(SendBonusRequest request)` The `SendBonus` operation issues a payment of money from your account to a Worker.
`SendTestEventNotificationResult`	`sendTestEventNotification(SendTestEventNotificationRequest request)` The `SendTestEventNotification` operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateExpirationForHITResult`	`updateExpirationForHIT(UpdateExpirationForHITRequest request)` The `UpdateExpirationForHIT` operation allows you update the expiration time of a HIT.
`UpdateHITReviewStatusResult`	`updateHITReviewStatus(UpdateHITReviewStatusRequest request)` The `UpdateHITReviewStatus` operation updates the status of a HIT.
`UpdateHITTypeOfHITResult`	`updateHITTypeOfHIT(UpdateHITTypeOfHITRequest request)` The `UpdateHITTypeOfHIT` operation allows you to change the HITType properties of a HIT.
`UpdateNotificationSettingsResult`	`updateNotificationSettings(UpdateNotificationSettingsRequest request)` The `UpdateNotificationSettings` operation creates, updates, disables or re-enables notifications for a HIT type.
`UpdateQualificationTypeResult`	`updateQualificationType(UpdateQualificationTypeRequest request)` The `UpdateQualificationType` operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonMTurkClientBuilder builder()
```
  - acceptQualificationRequest
```
public AcceptQualificationRequestResult acceptQualificationRequest(AcceptQualificationRequestRequest request)
```
    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.
    
    Specified by:
    
    acceptQualificationRequest in interface AmazonMTurk
    
    Parameters:
    
    acceptQualificationRequestRequest -
    
    Returns:
    
    Result of the AcceptQualificationRequest operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - approveAssignment
```
public ApproveAssignmentResult approveAssignment(ApproveAssignmentRequest request)
```
    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.
    Specified by:
    
    approveAssignment in interface AmazonMTurk
    
    Parameters:
    
    approveAssignmentRequest -
    
    Returns:
    
    Result of the ApproveAssignment operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - associateQualificationWithWorker
```
public AssociateQualificationWithWorkerResult associateQualificationWithWorker(AssociateQualificationWithWorkerRequest request)
```
    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.
    
    Specified by:
    
    associateQualificationWithWorker in interface AmazonMTurk
    
    Parameters:
    
    associateQualificationWithWorkerRequest -
    
    Returns:
    
    Result of the AssociateQualificationWithWorker operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - createAdditionalAssignmentsForHIT
```
public CreateAdditionalAssignmentsForHITResult createAdditionalAssignmentsForHIT(CreateAdditionalAssignmentsForHITRequest request)
```
    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.
    Specified by:
    
    createAdditionalAssignmentsForHIT in interface AmazonMTurk
    
    Parameters:
    
    createAdditionalAssignmentsForHITRequest -
    
    Returns:
    
    Result of the CreateAdditionalAssignmentsForHIT operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - createHIT
```
public CreateHITResult createHIT(CreateHITRequest request)
```
    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.
    
    Specified by:
    
    createHIT in interface AmazonMTurk
    
    Parameters:
    
    createHITRequest -
    
    Returns:
    
    Result of the CreateHIT operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - createHITType
```
public CreateHITTypeResult createHITType(CreateHITTypeRequest request)
```
    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.
    
    Specified by:
    
    createHITType in interface AmazonMTurk
    
    Parameters:
    
    createHITTypeRequest -
    
    Returns:
    
    Result of the CreateHITType operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - createHITWithHITType
```
public CreateHITWithHITTypeResult createHITWithHITType(CreateHITWithHITTypeRequest request)
```
    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.
    
    Specified by:
    
    createHITWithHITType in interface AmazonMTurk
    
    Parameters:
    
    createHITWithHITTypeRequest -
    
    Returns:
    
    Result of the CreateHITWithHITType operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - createQualificationType
```
public CreateQualificationTypeResult createQualificationType(CreateQualificationTypeRequest request)
```
    The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.
    
    Specified by:
    
    createQualificationType in interface AmazonMTurk
    
    Parameters:
    
    createQualificationTypeRequest -
    
    Returns:
    
    Result of the CreateQualificationType operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - createWorkerBlock
```
public CreateWorkerBlockResult createWorkerBlock(CreateWorkerBlockRequest request)
```
    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.
    
    Specified by:
    
    createWorkerBlock in interface AmazonMTurk
    
    Parameters:
    
    createWorkerBlockRequest -
    
    Returns:
    
    Result of the CreateWorkerBlock operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - deleteHIT
```
public DeleteHITResult deleteHIT(DeleteHITRequest request)
```
    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.
    Specified by:
    
    deleteHIT in interface AmazonMTurk
    
    Parameters:
    
    deleteHITRequest -
    
    Returns:
    
    Result of the DeleteHIT operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - deleteQualificationType
```
public DeleteQualificationTypeResult deleteQualificationType(DeleteQualificationTypeRequest request)
```
    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.
    
    Specified by:
    
    deleteQualificationType in interface AmazonMTurk
    
    Parameters:
    
    deleteQualificationTypeRequest -
    
    Returns:
    
    Result of the DeleteQualificationType operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkerBlock
```
public DeleteWorkerBlockResult deleteWorkerBlock(DeleteWorkerBlockRequest request)
```
    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.
    
    Specified by:
    
    deleteWorkerBlock in interface AmazonMTurk
    
    Parameters:
    
    deleteWorkerBlockRequest -
    
    Returns:
    
    Result of the DeleteWorkerBlock operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - disassociateQualificationFromWorker
```
public DisassociateQualificationFromWorkerResult disassociateQualificationFromWorker(DisassociateQualificationFromWorkerRequest request)
```
    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.
    
    Specified by:
    
    disassociateQualificationFromWorker in interface AmazonMTurk
    
    Parameters:
    
    disassociateQualificationFromWorkerRequest -
    
    Returns:
    
    Result of the DisassociateQualificationFromWorker operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - getAccountBalance
```
public GetAccountBalanceResult getAccountBalance(GetAccountBalanceRequest request)
```
    The GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk account.
    
    Specified by:
    
    getAccountBalance in interface AmazonMTurk
    
    Parameters:
    
    getAccountBalanceRequest -
    
    Returns:
    
    Result of the GetAccountBalance operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - getAssignment
```
public GetAssignmentResult getAssignment(GetAssignmentRequest request)
```
    The GetAssignment operation retrieves the details of the specified Assignment.
    
    Specified by:
    
    getAssignment in interface AmazonMTurk
    
    Parameters:
    
    getAssignmentRequest -
    
    Returns:
    
    Result of the GetAssignment operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - getFileUploadURL
```
public GetFileUploadURLResult getFileUploadURL(GetFileUploadURLRequest request)
```
    The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure will no longer support the FileUploadAnswer element to be used for the QuestionForm data structure. Instead, we recommend that Requesters who want to create HITs asking Workers to upload files to use Amazon S3.
    
    Specified by:
    
    getFileUploadURL in interface AmazonMTurk
    
    Parameters:
    
    getFileUploadURLRequest -
    
    Returns:
    
    Result of the GetFileUploadURL operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - getHIT
```
public GetHITResult getHIT(GetHITRequest request)
```
    The GetHIT operation retrieves the details of the specified HIT.
    
    Specified by:
    
    getHIT in interface AmazonMTurk
    
    Parameters:
    
    getHITRequest -
    
    Returns:
    
    Result of the GetHIT operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - getQualificationScore
```
public GetQualificationScoreResult getQualificationScore(GetQualificationScoreRequest request)
```
    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.
    
    Specified by:
    
    getQualificationScore in interface AmazonMTurk
    
    Parameters:
    
    getQualificationScoreRequest -
    
    Returns:
    
    Result of the GetQualificationScore operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - getQualificationType
```
public GetQualificationTypeResult getQualificationType(GetQualificationTypeRequest request)
```
    The GetQualificationTypeoperation retrieves information about a Qualification type using its ID.
    
    Specified by:
    
    getQualificationType in interface AmazonMTurk
    
    Parameters:
    
    getQualificationTypeRequest -
    
    Returns:
    
    Result of the GetQualificationType operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listAssignmentsForHIT
```
public ListAssignmentsForHITResult listAssignmentsForHIT(ListAssignmentsForHITRequest request)
```
    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.
    
    Specified by:
    
    listAssignmentsForHIT in interface AmazonMTurk
    
    Parameters:
    
    listAssignmentsForHITRequest -
    
    Returns:
    
    Result of the ListAssignmentsForHIT operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listBonusPayments
```
public ListBonusPaymentsResult listBonusPayments(ListBonusPaymentsRequest request)
```
    The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.
    
    Specified by:
    
    listBonusPayments in interface AmazonMTurk
    
    Parameters:
    
    listBonusPaymentsRequest -
    
    Returns:
    
    Result of the ListBonusPayments operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listHITs
```
public ListHITsResult listHITs(ListHITsRequest request)
```
    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.
    
    Specified by:
    
    listHITs in interface AmazonMTurk
    
    Parameters:
    
    listHITsRequest -
    
    Returns:
    
    Result of the ListHITs operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listHITsForQualificationType
```
public ListHITsForQualificationTypeResult listHITsForQualificationType(ListHITsForQualificationTypeRequest request)
```
    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.
    
    Specified by:
    
    listHITsForQualificationType in interface AmazonMTurk
    
    Parameters:
    
    listHITsForQualificationTypeRequest -
    
    Returns:
    
    Result of the ListHITsForQualificationType operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listQualificationRequests
```
public ListQualificationRequestsResult listQualificationRequests(ListQualificationRequestsRequest request)
```
    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.
    
    Specified by:
    
    listQualificationRequests in interface AmazonMTurk
    
    Parameters:
    
    listQualificationRequestsRequest -
    
    Returns:
    
    Result of the ListQualificationRequests operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listQualificationTypes
```
public ListQualificationTypesResult listQualificationTypes(ListQualificationTypesRequest request)
```
    The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.
    
    Specified by:
    
    listQualificationTypes in interface AmazonMTurk
    
    Parameters:
    
    listQualificationTypesRequest -
    
    Returns:
    
    Result of the ListQualificationTypes operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listReviewPolicyResultsForHIT
```
public ListReviewPolicyResultsForHITResult listReviewPolicyResultsForHIT(ListReviewPolicyResultsForHITRequest request)
```
    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.
    
    Specified by:
    
    listReviewPolicyResultsForHIT in interface AmazonMTurk
    
    Parameters:
    
    listReviewPolicyResultsForHITRequest -
    
    Returns:
    
    Result of the ListReviewPolicyResultsForHIT operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listReviewableHITs
```
public ListReviewableHITsResult listReviewableHITs(ListReviewableHITsRequest request)
```
    The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.
    
    Specified by:
    
    listReviewableHITs in interface AmazonMTurk
    
    Parameters:
    
    listReviewableHITsRequest -
    
    Returns:
    
    Result of the ListReviewableHITs operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listWorkerBlocks
```
public ListWorkerBlocksResult listWorkerBlocks(ListWorkerBlocksRequest request)
```
    The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.
    
    Specified by:
    
    listWorkerBlocks in interface AmazonMTurk
    
    Parameters:
    
    listWorkerBlocksRequest -
    
    Returns:
    
    Result of the ListWorkerBlocks operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - listWorkersWithQualificationType
```
public ListWorkersWithQualificationTypeResult listWorkersWithQualificationType(ListWorkersWithQualificationTypeRequest request)
```
    The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type.
    
    Specified by:
    
    listWorkersWithQualificationType in interface AmazonMTurk
    
    Parameters:
    
    listWorkersWithQualificationTypeRequest -
    
    Returns:
    
    Result of the ListWorkersWithQualificationType operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - notifyWorkers
```
public NotifyWorkersResult notifyWorkers(NotifyWorkersRequest request)
```
    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.
    
    Specified by:
    
    notifyWorkers in interface AmazonMTurk
    
    Parameters:
    
    notifyWorkersRequest -
    
    Returns:
    
    Result of the NotifyWorkers operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - rejectAssignment
```
public RejectAssignmentResult rejectAssignment(RejectAssignmentRequest request)
```
    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.
    
    Specified by:
    
    rejectAssignment in interface AmazonMTurk
    
    Parameters:
    
    rejectAssignmentRequest -
    
    Returns:
    
    Result of the RejectAssignment operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - rejectQualificationRequest
```
public RejectQualificationRequestResult rejectQualificationRequest(RejectQualificationRequestRequest request)
```
    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.
    
    Specified by:
    
    rejectQualificationRequest in interface AmazonMTurk
    
    Parameters:
    
    rejectQualificationRequestRequest -
    
    Returns:
    
    Result of the RejectQualificationRequest operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - sendBonus
```
public SendBonusResult sendBonus(SendBonusRequest request)
```
    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.
    
    Specified by:
    
    sendBonus in interface AmazonMTurk
    
    Parameters:
    
    sendBonusRequest -
    
    Returns:
    
    Result of the SendBonus operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - sendTestEventNotification
```
public SendTestEventNotificationResult sendTestEventNotification(SendTestEventNotificationRequest request)
```
    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.
    
    Specified by:
    
    sendTestEventNotification in interface AmazonMTurk
    
    Parameters:
    
    sendTestEventNotificationRequest -
    
    Returns:
    
    Result of the SendTestEventNotification operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - updateExpirationForHIT
```
public UpdateExpirationForHITResult updateExpirationForHIT(UpdateExpirationForHITRequest request)
```
    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.
    
    Specified by:
    
    updateExpirationForHIT in interface AmazonMTurk
    
    Parameters:
    
    updateExpirationForHITRequest -
    
    Returns:
    
    Result of the UpdateExpirationForHIT operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - updateHITReviewStatus
```
public UpdateHITReviewStatusResult updateHITReviewStatus(UpdateHITReviewStatusRequest request)
```
    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.
    
    Specified by:
    
    updateHITReviewStatus in interface AmazonMTurk
    
    Parameters:
    
    updateHITReviewStatusRequest -
    
    Returns:
    
    Result of the UpdateHITReviewStatus operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - updateHITTypeOfHIT
```
public UpdateHITTypeOfHITResult updateHITTypeOfHIT(UpdateHITTypeOfHITRequest request)
```
    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.
    
    Specified by:
    
    updateHITTypeOfHIT in interface AmazonMTurk
    
    Parameters:
    
    updateHITTypeOfHITRequest -
    
    Returns:
    
    Result of the UpdateHITTypeOfHIT operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - updateNotificationSettings
```
public UpdateNotificationSettingsResult updateNotificationSettings(UpdateNotificationSettingsRequest request)
```
    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.
    
    Specified by:
    
    updateNotificationSettings in interface AmazonMTurk
    
    Parameters:
    
    updateNotificationSettingsRequest -
    
    Returns:
    
    Result of the UpdateNotificationSettings operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - updateQualificationType
```
public UpdateQualificationTypeResult updateQualificationType(UpdateQualificationTypeRequest request)
```
    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.
    
    Specified by:
    
    updateQualificationType in interface AmazonMTurk
    
    Parameters:
    
    updateQualificationTypeRequest -
    
    Returns:
    
    Result of the UpdateQualificationType operation returned by the service.
    
    Throws:
    
    ServiceException - Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
    
    RequestErrorException - Your request is invalid.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonMTurk
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonMTurk
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonMTurkClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.mturk.AmazonMTurk

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

acceptQualificationRequest

approveAssignment

associateQualificationWithWorker

createAdditionalAssignmentsForHIT

createHIT

createHITType

createHITWithHITType

createQualificationType

createWorkerBlock

deleteHIT

deleteQualificationType

deleteWorkerBlock

disassociateQualificationFromWorker

getAccountBalance

getAssignment

getFileUploadURL

getHIT

getQualificationScore

getQualificationType

listAssignmentsForHIT

listBonusPayments

listHITs

listHITsForQualificationType

listQualificationRequests

listQualificationTypes

listReviewPolicyResultsForHIT

listReviewableHITs

listWorkerBlocks

listWorkersWithQualificationType

notifyWorkers

rejectAssignment

rejectQualificationRequest

sendBonus

sendTestEventNotification

updateExpirationForHIT

updateHITReviewStatus

updateHITTypeOfHIT

updateNotificationSettings

updateQualificationType

getCachedResponseMetadata

shutdown