Package software.amazon.awssdk.services.mturk

Interface MTurkClient

    • Method Detail

      • approveAssignment

        default ApproveAssignmentResponse approveAssignment​(ApproveAssignmentRequest approveAssignmentRequest)
                                             throws ServiceException,
                                                    RequestErrorException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MTurkException

        The ApproveAssignment operation approves the results of a completed assignment.

        Approving an assignment initiates two payments from the Requester's Amazon.com account

        • The Worker who submitted the results is paid the reward specified in the HIT.

        • Amazon Mechanical Turk fees are debited.

        If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns an exception, and the approval is not processed. You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site.

        You can also call this operation for assignments that were previous rejected and approve them by explicitly overriding the previous rejection. This only works on rejected assignments that were submitted within the previous 30 days and only if the assignment's related HIT has not been deleted.

        Parameters:
        approveAssignmentRequest -
        Returns:
        Result of the ApproveAssignment operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • approveAssignment

        default ApproveAssignmentResponse approveAssignment​(Consumer<ApproveAssignmentRequest.Builder> approveAssignmentRequest)
                                             throws ServiceException,
                                                    RequestErrorException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MTurkException

        The ApproveAssignment operation approves the results of a completed assignment.

        Approving an assignment initiates two payments from the Requester's Amazon.com account

        • The Worker who submitted the results is paid the reward specified in the HIT.

        • Amazon Mechanical Turk fees are debited.

        If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns an exception, and the approval is not processed. You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site.

        You can also call this operation for assignments that were previous rejected and approve them by explicitly overriding the previous rejection. This only works on rejected assignments that were submitted within the previous 30 days and only if the assignment's related HIT has not been deleted.


        This is a convenience which creates an instance of the ApproveAssignmentRequest.Builder avoiding the need to create one manually via ApproveAssignmentRequest.builder()

        Parameters:
        approveAssignmentRequest - A Consumer that will call methods on ApproveAssignmentRequest.Builder to create a request.
        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.
        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
        See Also:
        AWS API Documentation

      • associateQualificationWithWorker

        default AssociateQualificationWithWorkerResponse associateQualificationWithWorker​(AssociateQualificationWithWorkerRequest associateQualificationWithWorkerRequest)
                                                                           throws ServiceException,
                                                                                  RequestErrorException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  MTurkException

        The AssociateQualificationWithWorker operation gives a Worker a Qualification. AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It gives the Qualification directly to the Worker.

        You can only assign a Qualification of a Qualification type that you created (using the CreateQualificationType operation).

        Note: AssociateQualificationWithWorker does not affect any pending Qualification requests for the Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending Qualification request without affecting the Qualification the Worker already has, reject the request with the RejectQualificationRequest operation.

        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.
        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
        See Also:
        AWS API Documentation

      • createAdditionalAssignmentsForHIT

        default CreateAdditionalAssignmentsForHitResponse createAdditionalAssignmentsForHIT​(CreateAdditionalAssignmentsForHitRequest createAdditionalAssignmentsForHitRequest)
                                                                             throws ServiceException,
                                                                                    RequestErrorException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    MTurkException

        The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT.

        To extend the maximum number of assignments, specify the number of additional assignments.

        • HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease exception.

        • HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an AWS.MechanicalTurk.HITTooOldForExtension exception.

        Parameters:
        createAdditionalAssignmentsForHitRequest -
        Returns:
        Result of the CreateAdditionalAssignmentsForHIT operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • createHIT

        default CreateHitResponse createHIT​(CreateHitRequest createHitRequest)
                             throws ServiceException,
                                    RequestErrorException,
                                    AwsServiceException,
                                    SdkClientException,
                                    MTurkException

        The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available for Workers to find and accept on the Amazon Mechanical Turk website.

        This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to CreateHIT, a new HIT is created for you, with a 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.

        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.
        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
        See Also:
        AWS API Documentation

      • createHIT

        default CreateHitResponse createHIT​(Consumer<CreateHitRequest.Builder> createHitRequest)
                             throws ServiceException,
                                    RequestErrorException,
                                    AwsServiceException,
                                    SdkClientException,
                                    MTurkException

        The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available for Workers to find and accept on the Amazon Mechanical Turk website.

        This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to CreateHIT, a new HIT is created for you, with a 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()

        Parameters:
        createHitRequest - A Consumer that will call methods on CreateHitRequest.Builder to create a request.
        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.
        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
        See Also:
        AWS API Documentation

      • createHITWithHITType

        default CreateHitWithHitTypeResponse createHITWithHITType​(CreateHitWithHitTypeRequest createHitWithHitTypeRequest)
                                                   throws ServiceException,
                                                          RequestErrorException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          MTurkException

        The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by 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.

        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.
        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
        See Also:
        AWS API Documentation

      • deleteHIT

        default DeleteHitResponse deleteHIT​(DeleteHitRequest deleteHitRequest)
                             throws ServiceException,
                                    RequestErrorException,
                                    AwsServiceException,
                                    SdkClientException,
                                    MTurkException

        The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it.

        You can only dispose of HITs that are in the Reviewable state, with all of their submitted assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in 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.

        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.
        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
        See Also:
        AWS API Documentation

      • deleteHIT

        default DeleteHitResponse deleteHIT​(Consumer<DeleteHitRequest.Builder> deleteHitRequest)
                             throws ServiceException,
                                    RequestErrorException,
                                    AwsServiceException,
                                    SdkClientException,
                                    MTurkException

        The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it.

        You can only dispose of HITs that are in the Reviewable state, with all of their submitted assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in 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()

        Parameters:
        deleteHitRequest - A Consumer that will call methods on DeleteHitRequest.Builder to create a request.
        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.
        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
        See Also:
        AWS API Documentation

      • deleteQualificationType

        default DeleteQualificationTypeResponse deleteQualificationType​(DeleteQualificationTypeRequest deleteQualificationTypeRequest)
                                                         throws ServiceException,
                                                                RequestErrorException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                MTurkException

        The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type.

        This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types.

        DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType.

        Parameters:
        deleteQualificationTypeRequest -
        Returns:
        Result of the DeleteQualificationType operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • deleteQualificationType

        default DeleteQualificationTypeResponse deleteQualificationType​(Consumer<DeleteQualificationTypeRequest.Builder> deleteQualificationTypeRequest)
                                                         throws ServiceException,
                                                                RequestErrorException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                MTurkException

        The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type.

        This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types.

        DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType.


        This is a convenience which creates an instance of the DeleteQualificationTypeRequest.Builder avoiding the need to create one manually via DeleteQualificationTypeRequest.builder()

        Parameters:
        deleteQualificationTypeRequest - A Consumer that will call methods on DeleteQualificationTypeRequest.Builder to create a request.
        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.
        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
        See Also:
        AWS API Documentation

      • deleteWorkerBlock

        default DeleteWorkerBlockResponse deleteWorkerBlock​(DeleteWorkerBlockRequest deleteWorkerBlockRequest)
                                             throws ServiceException,
                                                    RequestErrorException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MTurkException

        The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully.

        Parameters:
        deleteWorkerBlockRequest -
        Returns:
        Result of the DeleteWorkerBlock operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • getAccountBalance

        default GetAccountBalanceResponse getAccountBalance​(GetAccountBalanceRequest getAccountBalanceRequest)
                                             throws ServiceException,
                                                    RequestErrorException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MTurkException

        The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester. Alternatively, this operation will retrieve the remaining available AWS Billing usage if you have enabled AWS Billing. Note: If you have enabled AWS Billing and still have a remaining Prepaid HITs balance, this balance can be viewed on the My Account page in the Requester console.

        Parameters:
        getAccountBalanceRequest -
        Returns:
        Result of the GetAccountBalance operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • getFileUploadURL

        default GetFileUploadUrlResponse getFileUploadURL​(GetFileUploadUrlRequest getFileUploadUrlRequest)
                                           throws ServiceException,
                                                  RequestErrorException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  MTurkException

        The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure will no longer support 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.

        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.
        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
        See Also:
        AWS API Documentation

      • getFileUploadURL

        default GetFileUploadUrlResponse getFileUploadURL​(Consumer<GetFileUploadUrlRequest.Builder> getFileUploadUrlRequest)
                                           throws ServiceException,
                                                  RequestErrorException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  MTurkException

        The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure will no longer support 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.


        This is a convenience which creates an instance of the GetFileUploadUrlRequest.Builder avoiding the need to create one manually via GetFileUploadUrlRequest.builder()

        Parameters:
        getFileUploadUrlRequest - A Consumer that will call methods on GetFileUploadUrlRequest.Builder to create a request.
        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.
        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
        See Also:
        AWS API Documentation

      • getQualificationScore

        default GetQualificationScoreResponse getQualificationScore​(GetQualificationScoreRequest getQualificationScoreRequest)
                                                     throws ServiceException,
                                                            RequestErrorException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            MTurkException

        The GetQualificationScore operation returns the value of a Worker's Qualification for a given Qualification type.

        To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is included in the assignment data returned by the ListAssignmentsForHIT operation.

        Only the owner of a Qualification type can query the value of a Worker's Qualification of that type.

        Parameters:
        getQualificationScoreRequest -
        Returns:
        Result of the GetQualificationScore operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listAssignmentsForHIT

        default ListAssignmentsForHitResponse listAssignmentsForHIT​(ListAssignmentsForHitRequest listAssignmentsForHitRequest)
                                                     throws ServiceException,
                                                            RequestErrorException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            MTurkException

        The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT.

        You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation.

        Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set.

        Only the Requester who created the HIT can retrieve the assignments for that HIT.

        Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination.

        Parameters:
        listAssignmentsForHitRequest -
        Returns:
        Result of the ListAssignmentsForHIT operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listAssignmentsForHIT

        default ListAssignmentsForHitResponse listAssignmentsForHIT​(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest)
                                                     throws ServiceException,
                                                            RequestErrorException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            MTurkException

        The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT.

        You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation.

        Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set.

        Only the Requester who created the HIT can retrieve the assignments for that HIT.

        Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination.


        This is a convenience which creates an instance of the ListAssignmentsForHitRequest.Builder avoiding the need to create one manually via ListAssignmentsForHitRequest.builder()

        Parameters:
        listAssignmentsForHitRequest - A Consumer that will call methods on ListAssignmentsForHitRequest.Builder to create a request.
        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.
        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
        See Also:
        AWS API Documentation

      • listAssignmentsForHITPaginator

        default ListAssignmentsForHITIterable listAssignmentsForHITPaginator​(ListAssignmentsForHitRequest listAssignmentsForHitRequest)
                                                              throws ServiceException,
                                                                     RequestErrorException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     MTurkException

        This is a variant of listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest) operation.

        Parameters:
        listAssignmentsForHitRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listAssignmentsForHITPaginator

        default ListAssignmentsForHITIterable listAssignmentsForHITPaginator​(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest)
                                                              throws ServiceException,
                                                                     RequestErrorException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     MTurkException

        This is a variant of listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest) operation.


        This is a convenience which creates an instance of the ListAssignmentsForHitRequest.Builder avoiding the need to create one manually via ListAssignmentsForHitRequest.builder()

        Parameters:
        listAssignmentsForHitRequest - A Consumer that will call methods on ListAssignmentsForHitRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listBonusPaymentsPaginator

        default ListBonusPaymentsIterable listBonusPaymentsPaginator​(ListBonusPaymentsRequest listBonusPaymentsRequest)
                                                      throws ServiceException,
                                                             RequestErrorException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             MTurkException

        This is a variant of listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest) operation.

        Parameters:
        listBonusPaymentsRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listBonusPaymentsPaginator

        default ListBonusPaymentsIterable listBonusPaymentsPaginator​(Consumer<ListBonusPaymentsRequest.Builder> listBonusPaymentsRequest)
                                                      throws ServiceException,
                                                             RequestErrorException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             MTurkException

        This is a variant of listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest) operation.


        This is a convenience which creates an instance of the ListBonusPaymentsRequest.Builder avoiding the need to create one manually via ListBonusPaymentsRequest.builder()

        Parameters:
        listBonusPaymentsRequest - A Consumer that will call methods on ListBonusPaymentsRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listHITsPaginator

        default ListHITsIterable listHITsPaginator()
                                    throws ServiceException,
                                           RequestErrorException,
                                           AwsServiceException,
                                           SdkClientException,
                                           MTurkException

        This is a variant of listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest) operation.

        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        listHITsPaginator(ListHiTsRequest), AWS API Documentation

      • listHITsPaginator

        default ListHITsIterable listHITsPaginator​(ListHiTsRequest listHiTsRequest)
                                    throws ServiceException,
                                           RequestErrorException,
                                           AwsServiceException,
                                           SdkClientException,
                                           MTurkException

        This is a variant of listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest) operation.

        Parameters:
        listHiTsRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listHITsPaginator

        default ListHITsIterable listHITsPaginator​(Consumer<ListHiTsRequest.Builder> listHiTsRequest)
                                    throws ServiceException,
                                           RequestErrorException,
                                           AwsServiceException,
                                           SdkClientException,
                                           MTurkException

        This is a variant of listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest) operation.


        This is a convenience which creates an instance of the ListHiTsRequest.Builder avoiding the need to create one manually via ListHiTsRequest.builder()

        Parameters:
        listHiTsRequest - A Consumer that will call methods on ListHiTsRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listHITsForQualificationTypePaginator

        default ListHITsForQualificationTypeIterable listHITsForQualificationTypePaginator​(ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest)
                                                                            throws ServiceException,
                                                                                   RequestErrorException,
                                                                                   AwsServiceException,
                                                                                   SdkClientException,
                                                                                   MTurkException

        This is a variant of listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest) operation.

        Parameters:
        listHiTsForQualificationTypeRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listHITsForQualificationTypePaginator

        default ListHITsForQualificationTypeIterable listHITsForQualificationTypePaginator​(Consumer<ListHiTsForQualificationTypeRequest.Builder> listHiTsForQualificationTypeRequest)
                                                                            throws ServiceException,
                                                                                   RequestErrorException,
                                                                                   AwsServiceException,
                                                                                   SdkClientException,
                                                                                   MTurkException

        This is a variant of listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest) operation.


        This is a convenience which creates an instance of the ListHiTsForQualificationTypeRequest.Builder avoiding the need to create one manually via ListHiTsForQualificationTypeRequest.builder()

        Parameters:
        listHiTsForQualificationTypeRequest - A Consumer that will call methods on ListHiTsForQualificationTypeRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listQualificationRequestsPaginator

        default ListQualificationRequestsIterable listQualificationRequestsPaginator()
                                                                      throws ServiceException,
                                                                             RequestErrorException,
                                                                             AwsServiceException,
                                                                             SdkClientException,
                                                                             MTurkException

        This is a variant of listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest) operation.

        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        listQualificationRequestsPaginator(ListQualificationRequestsRequest), AWS API Documentation

      • listQualificationRequestsPaginator

        default ListQualificationRequestsIterable listQualificationRequestsPaginator​(ListQualificationRequestsRequest listQualificationRequestsRequest)
                                                                      throws ServiceException,
                                                                             RequestErrorException,
                                                                             AwsServiceException,
                                                                             SdkClientException,
                                                                             MTurkException

        This is a variant of listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest) operation.

        Parameters:
        listQualificationRequestsRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listQualificationRequestsPaginator

        default ListQualificationRequestsIterable listQualificationRequestsPaginator​(Consumer<ListQualificationRequestsRequest.Builder> listQualificationRequestsRequest)
                                                                      throws ServiceException,
                                                                             RequestErrorException,
                                                                             AwsServiceException,
                                                                             SdkClientException,
                                                                             MTurkException

        This is a variant of listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest) operation.


        This is a convenience which creates an instance of the ListQualificationRequestsRequest.Builder avoiding the need to create one manually via ListQualificationRequestsRequest.builder()

        Parameters:
        listQualificationRequestsRequest - A Consumer that will call methods on ListQualificationRequestsRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listQualificationTypesPaginator

        default ListQualificationTypesIterable listQualificationTypesPaginator​(ListQualificationTypesRequest listQualificationTypesRequest)
                                                                throws ServiceException,
                                                                       RequestErrorException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       MTurkException

        This is a variant of listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest) operation.

        Parameters:
        listQualificationTypesRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listQualificationTypesPaginator

        default ListQualificationTypesIterable listQualificationTypesPaginator​(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest)
                                                                throws ServiceException,
                                                                       RequestErrorException,
                                                                       AwsServiceException,
                                                                       SdkClientException,
                                                                       MTurkException

        This is a variant of listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest) operation.


        This is a convenience which creates an instance of the ListQualificationTypesRequest.Builder avoiding the need to create one manually via ListQualificationTypesRequest.builder()

        Parameters:
        listQualificationTypesRequest - A Consumer that will call methods on ListQualificationTypesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listReviewPolicyResultsForHIT

        default ListReviewPolicyResultsForHitResponse listReviewPolicyResultsForHIT​(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest)
                                                                     throws ServiceException,
                                                                            RequestErrorException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            MTurkException

        The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. For information about how to specify Review Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and HIT-level review results.

        Parameters:
        listReviewPolicyResultsForHitRequest -
        Returns:
        Result of the ListReviewPolicyResultsForHIT operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listReviewPolicyResultsForHITPaginator

        default ListReviewPolicyResultsForHITIterable listReviewPolicyResultsForHITPaginator​(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest)
                                                                              throws ServiceException,
                                                                                     RequestErrorException,
                                                                                     AwsServiceException,
                                                                                     SdkClientException,
                                                                                     MTurkException

        This is a variant of listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest) operation.

        Parameters:
        listReviewPolicyResultsForHitRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listReviewableHITsPaginator

        default ListReviewableHITsIterable listReviewableHITsPaginator()
                                                        throws ServiceException,
                                                               RequestErrorException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               MTurkException

        This is a variant of listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest) operation.

        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        listReviewableHITsPaginator(ListReviewableHiTsRequest), AWS API Documentation

      • listReviewableHITsPaginator

        default ListReviewableHITsIterable listReviewableHITsPaginator​(ListReviewableHiTsRequest listReviewableHiTsRequest)
                                                        throws ServiceException,
                                                               RequestErrorException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               MTurkException

        This is a variant of listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest) operation.

        Parameters:
        listReviewableHiTsRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listReviewableHITsPaginator

        default ListReviewableHITsIterable listReviewableHITsPaginator​(Consumer<ListReviewableHiTsRequest.Builder> listReviewableHiTsRequest)
                                                        throws ServiceException,
                                                               RequestErrorException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               MTurkException

        This is a variant of listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest) operation.


        This is a convenience which creates an instance of the ListReviewableHiTsRequest.Builder avoiding the need to create one manually via ListReviewableHiTsRequest.builder()

        Parameters:
        listReviewableHiTsRequest - A Consumer that will call methods on ListReviewableHiTsRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listWorkerBlocksPaginator

        default ListWorkerBlocksIterable listWorkerBlocksPaginator()
                                                    throws ServiceException,
                                                           RequestErrorException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           MTurkException

        This is a variant of listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest) operation.

        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        listWorkerBlocksPaginator(ListWorkerBlocksRequest), AWS API Documentation

      • listWorkerBlocksPaginator

        default ListWorkerBlocksIterable listWorkerBlocksPaginator​(ListWorkerBlocksRequest listWorkerBlocksRequest)
                                                    throws ServiceException,
                                                           RequestErrorException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           MTurkException

        This is a variant of listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest) operation.

        Parameters:
        listWorkerBlocksRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listWorkerBlocksPaginator

        default ListWorkerBlocksIterable listWorkerBlocksPaginator​(Consumer<ListWorkerBlocksRequest.Builder> listWorkerBlocksRequest)
                                                    throws ServiceException,
                                                           RequestErrorException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           MTurkException

        This is a variant of listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest) operation.


        This is a convenience which creates an instance of the ListWorkerBlocksRequest.Builder avoiding the need to create one manually via ListWorkerBlocksRequest.builder()

        Parameters:
        listWorkerBlocksRequest - A Consumer that will call methods on ListWorkerBlocksRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • listWorkersWithQualificationTypePaginator

        default ListWorkersWithQualificationTypeIterable listWorkersWithQualificationTypePaginator​(ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest)
                                                                                    throws ServiceException,
                                                                                           RequestErrorException,
                                                                                           AwsServiceException,
                                                                                           SdkClientException,
                                                                                           MTurkException

        This is a variant of listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a 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(....);

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest) operation.

        Parameters:
        listWorkersWithQualificationTypeRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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
        See Also:
        AWS API Documentation

      • notifyWorkers

        default NotifyWorkersResponse notifyWorkers​(NotifyWorkersRequest notifyWorkersRequest)
                                     throws ServiceException,
                                            RequestErrorException,
                                            AwsServiceException,
                                            SdkClientException,
                                            MTurkException

        The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker.

        Parameters:
        notifyWorkersRequest -
        Returns:
        Result of the NotifyWorkers operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • rejectAssignment

        default RejectAssignmentResponse rejectAssignment​(RejectAssignmentRequest rejectAssignmentRequest)
                                           throws ServiceException,
                                                  RequestErrorException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  MTurkException

        The RejectAssignment operation rejects the results of a completed assignment.

        You can include an optional feedback message with the rejection, which the Worker can see in the Status section of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the assignment was rejected, and can improve the quality of the results the Worker submits in the future.

        Only the Requester who created the HIT can reject an assignment for the HIT.

        Parameters:
        rejectAssignmentRequest -
        Returns:
        Result of the RejectAssignment operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • sendBonus

        default SendBonusResponse sendBonus​(SendBonusRequest sendBonusRequest)
                             throws ServiceException,
                                    RequestErrorException,
                                    AwsServiceException,
                                    SdkClientException,
                                    MTurkException

        The SendBonus operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if your account does not have enough funds to pay for both the bonus and the fees.

        Parameters:
        sendBonusRequest -
        Returns:
        Result of the SendBonus operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • sendBonus

        default SendBonusResponse sendBonus​(Consumer<SendBonusRequest.Builder> sendBonusRequest)
                             throws ServiceException,
                                    RequestErrorException,
                                    AwsServiceException,
                                    SdkClientException,
                                    MTurkException

        The SendBonus operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if your account does not have enough funds to pay for both the bonus and the fees.


        This is a convenience which creates an instance of the SendBonusRequest.Builder avoiding the need to create one manually via SendBonusRequest.builder()

        Parameters:
        sendBonusRequest - A Consumer that will call methods on SendBonusRequest.Builder to create a request.
        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.
        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
        See Also:
        AWS API Documentation

      • sendTestEventNotification

        default SendTestEventNotificationResponse sendTestEventNotification​(SendTestEventNotificationRequest sendTestEventNotificationRequest)
                                                             throws ServiceException,
                                                                    RequestErrorException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    MTurkException

        The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. This allows you to test notifications without setting up notifications for a real HIT type and trying to trigger them using the website. When you call this operation, the service attempts to send the test notification immediately.

        Parameters:
        sendTestEventNotificationRequest -
        Returns:
        Result of the SendTestEventNotification operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • updateNotificationSettings

        default UpdateNotificationSettingsResponse updateNotificationSettings​(UpdateNotificationSettingsRequest updateNotificationSettingsRequest)
                                                               throws ServiceException,
                                                                      RequestErrorException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      MTurkException

        The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification specification, the operation replaces the old specification with a new one. You can call the UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to modify the notification specification itself by providing updates to the Active status without specifying a new notification specification. To change the Active status of a HIT type's notifications, the HIT type must already have a notification specification, or one must be provided in the same call to UpdateNotificationSettings.

        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.
        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
        See Also:
        AWS API Documentation

      • updateQualificationType

        default UpdateQualificationTypeResponse updateQualificationType​(UpdateQualificationTypeRequest updateQualificationTypeRequest)
                                                         throws ServiceException,
                                                                RequestErrorException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                MTurkException

        The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes.

        Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries.

        You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.

        If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test.

        If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values.

        If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually.

        You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.

        Parameters:
        updateQualificationTypeRequest -
        Returns:
        Result of the UpdateQualificationType operation returned by the service.
        Throws:
        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
        See Also:
        AWS API Documentation

      • updateQualificationType

        default UpdateQualificationTypeResponse updateQualificationType​(Consumer<UpdateQualificationTypeRequest.Builder> updateQualificationTypeRequest)
                                                         throws ServiceException,
                                                                RequestErrorException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                MTurkException

        The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes.

        Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries.

        You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.

        If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test.

        If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values.

        If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually.

        You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.


        This is a convenience which creates an instance of the UpdateQualificationTypeRequest.Builder avoiding the need to create one manually via UpdateQualificationTypeRequest.builder()

        Parameters:
        updateQualificationTypeRequest - A Consumer that will call methods on UpdateQualificationTypeRequest.Builder to create a request.
        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.
        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
        See Also:
        AWS API Documentation