Interface MTurkAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface MTurkAsyncClient extends AwsClient
Service client for accessing Amazon MTurk asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. Amazon Mechanical Turk API Reference

  • Field Details

  • Method Details

    • acceptQualificationRequest

      default CompletableFuture<AcceptQualificationRequestResponse> acceptQualificationRequest(AcceptQualificationRequestRequest acceptQualificationRequestRequest)

      The AcceptQualificationRequest operation approves a Worker's request for a Qualification.

      Only the owner of the Qualification type can grant a Qualification request for that type.

      A successful request for the AcceptQualificationRequest operation returns with no errors and an empty body.

      Parameters:
      acceptQualificationRequestRequest -
      Returns:
      A Java Future containing the result of the AcceptQualificationRequest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • acceptQualificationRequest

      default CompletableFuture<AcceptQualificationRequestResponse> acceptQualificationRequest(Consumer<AcceptQualificationRequestRequest.Builder> acceptQualificationRequestRequest)

      The AcceptQualificationRequest operation approves a Worker's request for a Qualification.

      Only the owner of the Qualification type can grant a Qualification request for that type.

      A successful request for the AcceptQualificationRequest operation returns with no errors and an empty body.


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

      Parameters:
      acceptQualificationRequestRequest - A Consumer that will call methods on AcceptQualificationRequestRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AcceptQualificationRequest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • approveAssignment

      default CompletableFuture<ApproveAssignmentResponse> approveAssignment(ApproveAssignmentRequest approveAssignmentRequest)

      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:
      A Java Future containing the result of the ApproveAssignment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • approveAssignment

      default CompletableFuture<ApproveAssignmentResponse> approveAssignment(Consumer<ApproveAssignmentRequest.Builder> approveAssignmentRequest)

      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:
      A Java Future containing the result of the ApproveAssignment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • associateQualificationWithWorker

      default CompletableFuture<AssociateQualificationWithWorkerResponse> associateQualificationWithWorker(AssociateQualificationWithWorkerRequest associateQualificationWithWorkerRequest)

      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:
      A Java Future containing the result of the AssociateQualificationWithWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • associateQualificationWithWorker

      default CompletableFuture<AssociateQualificationWithWorkerResponse> associateQualificationWithWorker(Consumer<AssociateQualificationWithWorkerRequest.Builder> associateQualificationWithWorkerRequest)

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

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

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


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

      Parameters:
      associateQualificationWithWorkerRequest - A Consumer that will call methods on AssociateQualificationWithWorkerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateQualificationWithWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createAdditionalAssignmentsForHIT

      default CompletableFuture<CreateAdditionalAssignmentsForHitResponse> createAdditionalAssignmentsForHIT(CreateAdditionalAssignmentsForHitRequest createAdditionalAssignmentsForHitRequest)

      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:
      A Java Future containing the result of the CreateAdditionalAssignmentsForHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createAdditionalAssignmentsForHIT

      default CompletableFuture<CreateAdditionalAssignmentsForHitResponse> createAdditionalAssignmentsForHIT(Consumer<CreateAdditionalAssignmentsForHitRequest.Builder> createAdditionalAssignmentsForHitRequest)

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

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

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

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


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

      Parameters:
      createAdditionalAssignmentsForHitRequest - A Consumer that will call methods on CreateAdditionalAssignmentsForHitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAdditionalAssignmentsForHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createHIT

      default CompletableFuture<CreateHitResponse> createHIT(CreateHitRequest createHitRequest)

      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:
      A Java Future containing the result of the CreateHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createHIT

      default CompletableFuture<CreateHitResponse> createHIT(Consumer<CreateHitRequest.Builder> createHitRequest)

      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:
      A Java Future containing the result of the CreateHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createHITType

      default CompletableFuture<CreateHitTypeResponse> createHITType(CreateHitTypeRequest createHitTypeRequest)

      The CreateHITType operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned.

      Parameters:
      createHitTypeRequest -
      Returns:
      A Java Future containing the result of the CreateHITType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createHITType

      default CompletableFuture<CreateHitTypeResponse> createHITType(Consumer<CreateHitTypeRequest.Builder> createHitTypeRequest)

      The CreateHITType operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned.


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

      Parameters:
      createHitTypeRequest - A Consumer that will call methods on CreateHitTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateHITType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createHITWithHITType

      default CompletableFuture<CreateHitWithHitTypeResponse> createHITWithHITType(CreateHitWithHitTypeRequest createHitWithHitTypeRequest)

      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:
      A Java Future containing the result of the CreateHITWithHITType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createHITWithHITType

      default CompletableFuture<CreateHitWithHitTypeResponse> createHITWithHITType(Consumer<CreateHitWithHitTypeRequest.Builder> createHitWithHitTypeRequest)

      The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation.

      This is an alternative way to create HITs from the CreateHIT operation. This is the recommended best practice for Requesters who are creating large numbers of HITs.

      CreateHITWithHITType also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters.

      If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.


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

      Parameters:
      createHitWithHitTypeRequest - A Consumer that will call methods on CreateHitWithHitTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateHITWithHITType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createQualificationType

      default CompletableFuture<CreateQualificationTypeResponse> createQualificationType(CreateQualificationTypeRequest createQualificationTypeRequest)

      The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.

      Parameters:
      createQualificationTypeRequest -
      Returns:
      A Java Future containing the result of the CreateQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createQualificationType

      default CompletableFuture<CreateQualificationTypeResponse> createQualificationType(Consumer<CreateQualificationTypeRequest.Builder> createQualificationTypeRequest)

      The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.


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

      Parameters:
      createQualificationTypeRequest - A Consumer that will call methods on CreateQualificationTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createWorkerBlock

      default CompletableFuture<CreateWorkerBlockResponse> createWorkerBlock(CreateWorkerBlockRequest createWorkerBlockRequest)

      The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.

      Parameters:
      createWorkerBlockRequest -
      Returns:
      A Java Future containing the result of the CreateWorkerBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createWorkerBlock

      default CompletableFuture<CreateWorkerBlockResponse> createWorkerBlock(Consumer<CreateWorkerBlockRequest.Builder> createWorkerBlockRequest)

      The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.


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

      Parameters:
      createWorkerBlockRequest - A Consumer that will call methods on CreateWorkerBlockRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkerBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteHIT

      default CompletableFuture<DeleteHitResponse> deleteHIT(DeleteHitRequest deleteHitRequest)

      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:
      A Java Future containing the result of the DeleteHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteHIT

      default CompletableFuture<DeleteHitResponse> deleteHIT(Consumer<DeleteHitRequest.Builder> deleteHitRequest)

      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:
      A Java Future containing the result of the DeleteHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteQualificationType

      default CompletableFuture<DeleteQualificationTypeResponse> deleteQualificationType(DeleteQualificationTypeRequest deleteQualificationTypeRequest)

      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:
      A Java Future containing the result of the DeleteQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteQualificationType

      default CompletableFuture<DeleteQualificationTypeResponse> deleteQualificationType(Consumer<DeleteQualificationTypeRequest.Builder> deleteQualificationTypeRequest)

      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:
      A Java Future containing the result of the DeleteQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteWorkerBlock

      default CompletableFuture<DeleteWorkerBlockResponse> deleteWorkerBlock(DeleteWorkerBlockRequest deleteWorkerBlockRequest)

      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:
      A Java Future containing the result of the DeleteWorkerBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteWorkerBlock

      default CompletableFuture<DeleteWorkerBlockResponse> deleteWorkerBlock(Consumer<DeleteWorkerBlockRequest.Builder> deleteWorkerBlockRequest)

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


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

      Parameters:
      deleteWorkerBlockRequest - A Consumer that will call methods on DeleteWorkerBlockRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkerBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • disassociateQualificationFromWorker

      default CompletableFuture<DisassociateQualificationFromWorkerResponse> disassociateQualificationFromWorker(DisassociateQualificationFromWorkerRequest disassociateQualificationFromWorkerRequest)

      The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user.

      You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message.

      Parameters:
      disassociateQualificationFromWorkerRequest -
      Returns:
      A Java Future containing the result of the DisassociateQualificationFromWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • disassociateQualificationFromWorker

      default CompletableFuture<DisassociateQualificationFromWorkerResponse> disassociateQualificationFromWorker(Consumer<DisassociateQualificationFromWorkerRequest.Builder> disassociateQualificationFromWorkerRequest)

      The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user.

      You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message.


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

      Parameters:
      disassociateQualificationFromWorkerRequest - A Consumer that will call methods on DisassociateQualificationFromWorkerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateQualificationFromWorker operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getAccountBalance

      default CompletableFuture<GetAccountBalanceResponse> getAccountBalance(GetAccountBalanceRequest getAccountBalanceRequest)

      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:
      A Java Future containing the result of the GetAccountBalance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getAccountBalance

      default CompletableFuture<GetAccountBalanceResponse> getAccountBalance(Consumer<GetAccountBalanceRequest.Builder> getAccountBalanceRequest)

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


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

      Parameters:
      getAccountBalanceRequest - A Consumer that will call methods on GetAccountBalanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccountBalance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getAccountBalance

      default CompletableFuture<GetAccountBalanceResponse> getAccountBalance()

      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.

      Returns:
      A Java Future containing the result of the GetAccountBalance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getAssignment

      default CompletableFuture<GetAssignmentResponse> getAssignment(GetAssignmentRequest getAssignmentRequest)

      The GetAssignment operation retrieves the details of the specified Assignment.

      Parameters:
      getAssignmentRequest -
      Returns:
      A Java Future containing the result of the GetAssignment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getAssignment

      default CompletableFuture<GetAssignmentResponse> getAssignment(Consumer<GetAssignmentRequest.Builder> getAssignmentRequest)

      The GetAssignment operation retrieves the details of the specified Assignment.


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

      Parameters:
      getAssignmentRequest - A Consumer that will call methods on GetAssignmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAssignment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getFileUploadURL

      default CompletableFuture<GetFileUploadUrlResponse> getFileUploadURL(GetFileUploadUrlRequest getFileUploadUrlRequest)

      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:
      A Java Future containing the result of the GetFileUploadURL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getFileUploadURL

      default CompletableFuture<GetFileUploadUrlResponse> getFileUploadURL(Consumer<GetFileUploadUrlRequest.Builder> getFileUploadUrlRequest)

      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:
      A Java Future containing the result of the GetFileUploadURL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getHIT

      default CompletableFuture<GetHitResponse> getHIT(GetHitRequest getHitRequest)

      The GetHIT operation retrieves the details of the specified HIT.

      Parameters:
      getHitRequest -
      Returns:
      A Java Future containing the result of the GetHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getHIT

      default CompletableFuture<GetHitResponse> getHIT(Consumer<GetHitRequest.Builder> getHitRequest)

      The GetHIT operation retrieves the details of the specified HIT.


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

      Parameters:
      getHitRequest - A Consumer that will call methods on GetHitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getQualificationScore

      default CompletableFuture<GetQualificationScoreResponse> getQualificationScore(GetQualificationScoreRequest getQualificationScoreRequest)

      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:
      A Java Future containing the result of the GetQualificationScore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getQualificationScore

      default CompletableFuture<GetQualificationScoreResponse> getQualificationScore(Consumer<GetQualificationScoreRequest.Builder> getQualificationScoreRequest)

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

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

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


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

      Parameters:
      getQualificationScoreRequest - A Consumer that will call methods on GetQualificationScoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQualificationScore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getQualificationType

      default CompletableFuture<GetQualificationTypeResponse> getQualificationType(GetQualificationTypeRequest getQualificationTypeRequest)

      The GetQualificationTypeoperation retrieves information about a Qualification type using its ID.

      Parameters:
      getQualificationTypeRequest -
      Returns:
      A Java Future containing the result of the GetQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getQualificationType

      default CompletableFuture<GetQualificationTypeResponse> getQualificationType(Consumer<GetQualificationTypeRequest.Builder> getQualificationTypeRequest)

      The GetQualificationTypeoperation retrieves information about a Qualification type using its ID.


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

      Parameters:
      getQualificationTypeRequest - A Consumer that will call methods on GetQualificationTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAssignmentsForHIT

      default CompletableFuture<ListAssignmentsForHitResponse> listAssignmentsForHIT(ListAssignmentsForHitRequest listAssignmentsForHitRequest)

      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:
      A Java Future containing the result of the ListAssignmentsForHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAssignmentsForHIT

      default CompletableFuture<ListAssignmentsForHitResponse> listAssignmentsForHIT(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest)

      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:
      A Java Future containing the result of the ListAssignmentsForHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAssignmentsForHITPaginator

      default ListAssignmentsForHITPublisher listAssignmentsForHITPaginator(ListAssignmentsForHitRequest listAssignmentsForHitRequest)

      This is a variant of listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITPublisher publisher = client.listAssignmentsForHITPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITPublisher publisher = client.listAssignmentsForHITPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAssignmentsForHITPaginator

      default ListAssignmentsForHITPublisher listAssignmentsForHITPaginator(Consumer<ListAssignmentsForHitRequest.Builder> listAssignmentsForHitRequest)

      This is a variant of listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITPublisher publisher = client.listAssignmentsForHITPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITPublisher publisher = client.listAssignmentsForHITPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBonusPayments

      default CompletableFuture<ListBonusPaymentsResponse> listBonusPayments(ListBonusPaymentsRequest listBonusPaymentsRequest)

      The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.

      Parameters:
      listBonusPaymentsRequest -
      Returns:
      A Java Future containing the result of the ListBonusPayments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBonusPayments

      default CompletableFuture<ListBonusPaymentsResponse> listBonusPayments(Consumer<ListBonusPaymentsRequest.Builder> listBonusPaymentsRequest)

      The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.


      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 Java Future containing the result of the ListBonusPayments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBonusPaymentsPaginator

      default ListBonusPaymentsPublisher listBonusPaymentsPaginator(ListBonusPaymentsRequest listBonusPaymentsRequest)

      This is a variant of listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsPublisher publisher = client.listBonusPaymentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsPublisher publisher = client.listBonusPaymentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListBonusPaymentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBonusPaymentsPaginator

      default ListBonusPaymentsPublisher listBonusPaymentsPaginator(Consumer<ListBonusPaymentsRequest.Builder> listBonusPaymentsRequest)

      This is a variant of listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsPublisher publisher = client.listBonusPaymentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsPublisher publisher = client.listBonusPaymentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListBonusPaymentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITs

      default CompletableFuture<ListHiTsResponse> listHITs(ListHiTsRequest listHiTsRequest)

      The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.

      Parameters:
      listHiTsRequest -
      Returns:
      A Java Future containing the result of the ListHITs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITs

      default CompletableFuture<ListHiTsResponse> listHITs(Consumer<ListHiTsRequest.Builder> listHiTsRequest)

      The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.


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

      Parameters:
      listHiTsRequest - A Consumer that will call methods on ListHiTsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHITs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITs

      default CompletableFuture<ListHiTsResponse> listHITs()

      The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.

      Returns:
      A Java Future containing the result of the ListHITs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITsForQualificationType

      default CompletableFuture<ListHiTsForQualificationTypeResponse> listHITsForQualificationType(ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest)

      The ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted with the DeleteHIT operation or that have been auto-deleted.

      Parameters:
      listHiTsForQualificationTypeRequest -
      Returns:
      A Java Future containing the result of the ListHITsForQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITsForQualificationType

      default CompletableFuture<ListHiTsForQualificationTypeResponse> listHITsForQualificationType(Consumer<ListHiTsForQualificationTypeRequest.Builder> listHiTsForQualificationTypeRequest)

      The ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted with the DeleteHIT operation or that have been auto-deleted.


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

      Parameters:
      listHiTsForQualificationTypeRequest - A Consumer that will call methods on ListHiTsForQualificationTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHITsForQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITsForQualificationTypePaginator

      default ListHITsForQualificationTypePublisher listHITsForQualificationTypePaginator(ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest)

      This is a variant of listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypePublisher publisher = client.listHITsForQualificationTypePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypePublisher publisher = client.listHITsForQualificationTypePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITsForQualificationTypePaginator

      default ListHITsForQualificationTypePublisher listHITsForQualificationTypePaginator(Consumer<ListHiTsForQualificationTypeRequest.Builder> listHiTsForQualificationTypeRequest)

      This is a variant of listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypePublisher publisher = client.listHITsForQualificationTypePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypePublisher publisher = client.listHITsForQualificationTypePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITsPaginator

      default ListHITsPublisher listHITsPaginator()

      This is a variant of listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListHiTsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITsPaginator

      default ListHITsPublisher listHITsPaginator(ListHiTsRequest listHiTsRequest)

      This is a variant of listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListHiTsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listHITsPaginator

      default ListHITsPublisher listHITsPaginator(Consumer<ListHiTsRequest.Builder> listHiTsRequest)

      This is a variant of listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListHiTsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationRequests

      default CompletableFuture<ListQualificationRequestsResponse> listQualificationRequests(ListQualificationRequestsRequest listQualificationRequestsRequest)

      The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation.

      Parameters:
      listQualificationRequestsRequest -
      Returns:
      A Java Future containing the result of the ListQualificationRequests operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationRequests

      default CompletableFuture<ListQualificationRequestsResponse> listQualificationRequests(Consumer<ListQualificationRequestsRequest.Builder> listQualificationRequestsRequest)

      The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation.


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

      Parameters:
      listQualificationRequestsRequest - A Consumer that will call methods on ListQualificationRequestsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQualificationRequests operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationRequests

      default CompletableFuture<ListQualificationRequestsResponse> listQualificationRequests()

      The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation.

      Returns:
      A Java Future containing the result of the ListQualificationRequests operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationRequestsPaginator

      default ListQualificationRequestsPublisher listQualificationRequestsPaginator()

      This is a variant of listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationRequestsPaginator

      default ListQualificationRequestsPublisher listQualificationRequestsPaginator(ListQualificationRequestsRequest listQualificationRequestsRequest)

      This is a variant of listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationRequestsPaginator

      default ListQualificationRequestsPublisher listQualificationRequestsPaginator(Consumer<ListQualificationRequestsRequest.Builder> listQualificationRequestsRequest)

      This is a variant of listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationTypes

      default CompletableFuture<ListQualificationTypesResponse> listQualificationTypes(ListQualificationTypesRequest listQualificationTypesRequest)

      The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.

      Parameters:
      listQualificationTypesRequest -
      Returns:
      A Java Future containing the result of the ListQualificationTypes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationTypes

      default CompletableFuture<ListQualificationTypesResponse> listQualificationTypes(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest)

      The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.


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

      Parameters:
      listQualificationTypesRequest - A Consumer that will call methods on ListQualificationTypesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQualificationTypes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationTypesPaginator

      default ListQualificationTypesPublisher listQualificationTypesPaginator(ListQualificationTypesRequest listQualificationTypesRequest)

      This is a variant of listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesPublisher publisher = client.listQualificationTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesPublisher publisher = client.listQualificationTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListQualificationTypesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationTypesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listQualificationTypesPaginator

      default ListQualificationTypesPublisher listQualificationTypesPaginator(Consumer<ListQualificationTypesRequest.Builder> listQualificationTypesRequest)

      This is a variant of listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesPublisher publisher = client.listQualificationTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesPublisher publisher = client.listQualificationTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListQualificationTypesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationTypesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewPolicyResultsForHIT

      default CompletableFuture<ListReviewPolicyResultsForHitResponse> listReviewPolicyResultsForHIT(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest)

      The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. 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:
      A Java Future containing the result of the ListReviewPolicyResultsForHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewPolicyResultsForHIT

      default CompletableFuture<ListReviewPolicyResultsForHitResponse> listReviewPolicyResultsForHIT(Consumer<ListReviewPolicyResultsForHitRequest.Builder> listReviewPolicyResultsForHitRequest)

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


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

      Parameters:
      listReviewPolicyResultsForHitRequest - A Consumer that will call methods on ListReviewPolicyResultsForHitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListReviewPolicyResultsForHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewPolicyResultsForHITPaginator

      default ListReviewPolicyResultsForHITPublisher listReviewPolicyResultsForHITPaginator(ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest)

      This is a variant of listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITPublisher publisher = client.listReviewPolicyResultsForHITPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITPublisher publisher = client.listReviewPolicyResultsForHITPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewPolicyResultsForHITPaginator

      default ListReviewPolicyResultsForHITPublisher listReviewPolicyResultsForHITPaginator(Consumer<ListReviewPolicyResultsForHitRequest.Builder> listReviewPolicyResultsForHitRequest)

      This is a variant of listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITPublisher publisher = client.listReviewPolicyResultsForHITPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITPublisher publisher = client.listReviewPolicyResultsForHITPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listReviewPolicyResultsForHitRequest - A Consumer that will call methods on ListReviewPolicyResultsForHitRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewableHITs

      default CompletableFuture<ListReviewableHiTsResponse> listReviewableHITs(ListReviewableHiTsRequest listReviewableHiTsRequest)

      The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.

      Parameters:
      listReviewableHiTsRequest -
      Returns:
      A Java Future containing the result of the ListReviewableHITs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewableHITs

      default CompletableFuture<ListReviewableHiTsResponse> listReviewableHITs(Consumer<ListReviewableHiTsRequest.Builder> listReviewableHiTsRequest)

      The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.


      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 Java Future containing the result of the ListReviewableHITs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewableHITs

      default CompletableFuture<ListReviewableHiTsResponse> listReviewableHITs()

      The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.

      Returns:
      A Java Future containing the result of the ListReviewableHITs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewableHITsPaginator

      default ListReviewableHITsPublisher listReviewableHITsPaginator()

      This is a variant of listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewableHITsPaginator

      default ListReviewableHITsPublisher listReviewableHITsPaginator(ListReviewableHiTsRequest listReviewableHiTsRequest)

      This is a variant of listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listReviewableHITsPaginator

      default ListReviewableHITsPublisher listReviewableHITsPaginator(Consumer<ListReviewableHiTsRequest.Builder> listReviewableHiTsRequest)

      This is a variant of listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkerBlocks

      default CompletableFuture<ListWorkerBlocksResponse> listWorkerBlocks(ListWorkerBlocksRequest listWorkerBlocksRequest)

      The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.

      Parameters:
      listWorkerBlocksRequest -
      Returns:
      A Java Future containing the result of the ListWorkerBlocks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkerBlocks

      default CompletableFuture<ListWorkerBlocksResponse> listWorkerBlocks(Consumer<ListWorkerBlocksRequest.Builder> listWorkerBlocksRequest)

      The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.


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

      Parameters:
      listWorkerBlocksRequest - A Consumer that will call methods on ListWorkerBlocksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkerBlocks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkerBlocks

      default CompletableFuture<ListWorkerBlocksResponse> listWorkerBlocks()

      The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.

      Returns:
      A Java Future containing the result of the ListWorkerBlocks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkerBlocksPaginator

      default ListWorkerBlocksPublisher listWorkerBlocksPaginator()

      This is a variant of listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkerBlocksPaginator

      default ListWorkerBlocksPublisher listWorkerBlocksPaginator(ListWorkerBlocksRequest listWorkerBlocksRequest)

      This is a variant of listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkerBlocksPaginator

      default ListWorkerBlocksPublisher listWorkerBlocksPaginator(Consumer<ListWorkerBlocksRequest.Builder> listWorkerBlocksRequest)

      This is a variant of listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkersWithQualificationType

      default CompletableFuture<ListWorkersWithQualificationTypeResponse> listWorkersWithQualificationType(ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest)

      The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type.

      Parameters:
      listWorkersWithQualificationTypeRequest -
      Returns:
      A Java Future containing the result of the ListWorkersWithQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkersWithQualificationType

      default CompletableFuture<ListWorkersWithQualificationTypeResponse> listWorkersWithQualificationType(Consumer<ListWorkersWithQualificationTypeRequest.Builder> listWorkersWithQualificationTypeRequest)

      The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type.


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

      Parameters:
      listWorkersWithQualificationTypeRequest - A Consumer that will call methods on ListWorkersWithQualificationTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkersWithQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkersWithQualificationTypePaginator

      default ListWorkersWithQualificationTypePublisher listWorkersWithQualificationTypePaginator(ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest)

      This is a variant of listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypePublisher publisher = client.listWorkersWithQualificationTypePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypePublisher publisher = client.listWorkersWithQualificationTypePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listWorkersWithQualificationTypePaginator

      default ListWorkersWithQualificationTypePublisher listWorkersWithQualificationTypePaginator(Consumer<ListWorkersWithQualificationTypeRequest.Builder> listWorkersWithQualificationTypeRequest)

      This is a variant of listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypePublisher publisher = client.listWorkersWithQualificationTypePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypePublisher publisher = client.listWorkersWithQualificationTypePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listWorkersWithQualificationTypeRequest - A Consumer that will call methods on ListWorkersWithQualificationTypeRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • notifyWorkers

      default CompletableFuture<NotifyWorkersResponse> notifyWorkers(NotifyWorkersRequest notifyWorkersRequest)

      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:
      A Java Future containing the result of the NotifyWorkers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • notifyWorkers

      default CompletableFuture<NotifyWorkersResponse> notifyWorkers(Consumer<NotifyWorkersRequest.Builder> notifyWorkersRequest)

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


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

      Parameters:
      notifyWorkersRequest - A Consumer that will call methods on NotifyWorkersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the NotifyWorkers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • rejectAssignment

      default CompletableFuture<RejectAssignmentResponse> rejectAssignment(RejectAssignmentRequest rejectAssignmentRequest)

      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:
      A Java Future containing the result of the RejectAssignment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • rejectAssignment

      default CompletableFuture<RejectAssignmentResponse> rejectAssignment(Consumer<RejectAssignmentRequest.Builder> rejectAssignmentRequest)

      The RejectAssignment operation rejects the results of a completed assignment.

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

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


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

      Parameters:
      rejectAssignmentRequest - A Consumer that will call methods on RejectAssignmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RejectAssignment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • rejectQualificationRequest

      default CompletableFuture<RejectQualificationRequestResponse> rejectQualificationRequest(RejectQualificationRequestRequest rejectQualificationRequestRequest)

      The RejectQualificationRequest operation rejects a user's request for a Qualification.

      You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message.

      Parameters:
      rejectQualificationRequestRequest -
      Returns:
      A Java Future containing the result of the RejectQualificationRequest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • rejectQualificationRequest

      default CompletableFuture<RejectQualificationRequestResponse> rejectQualificationRequest(Consumer<RejectQualificationRequestRequest.Builder> rejectQualificationRequestRequest)

      The RejectQualificationRequest operation rejects a user's request for a Qualification.

      You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message.


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

      Parameters:
      rejectQualificationRequestRequest - A Consumer that will call methods on RejectQualificationRequestRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RejectQualificationRequest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • sendBonus

      default CompletableFuture<SendBonusResponse> sendBonus(SendBonusRequest sendBonusRequest)

      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:
      A Java Future containing the result of the SendBonus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • sendBonus

      default CompletableFuture<SendBonusResponse> sendBonus(Consumer<SendBonusRequest.Builder> sendBonusRequest)

      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:
      A Java Future containing the result of the SendBonus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • sendTestEventNotification

      default CompletableFuture<SendTestEventNotificationResponse> sendTestEventNotification(SendTestEventNotificationRequest sendTestEventNotificationRequest)

      The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. 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:
      A Java Future containing the result of the SendTestEventNotification operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • sendTestEventNotification

      default CompletableFuture<SendTestEventNotificationResponse> sendTestEventNotification(Consumer<SendTestEventNotificationRequest.Builder> sendTestEventNotificationRequest)

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


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

      Parameters:
      sendTestEventNotificationRequest - A Consumer that will call methods on SendTestEventNotificationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendTestEventNotification operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateExpirationForHIT

      default CompletableFuture<UpdateExpirationForHitResponse> updateExpirationForHIT(UpdateExpirationForHitRequest updateExpirationForHitRequest)

      The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update it to a time in the past, the HIT will be immediately expired.

      Parameters:
      updateExpirationForHitRequest -
      Returns:
      A Java Future containing the result of the UpdateExpirationForHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateExpirationForHIT

      default CompletableFuture<UpdateExpirationForHitResponse> updateExpirationForHIT(Consumer<UpdateExpirationForHitRequest.Builder> updateExpirationForHitRequest)

      The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update it to a time in the past, the HIT will be immediately expired.


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

      Parameters:
      updateExpirationForHitRequest - A Consumer that will call methods on UpdateExpirationForHitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateExpirationForHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateHITReviewStatus

      default CompletableFuture<UpdateHitReviewStatusResponse> updateHITReviewStatus(UpdateHitReviewStatusRequest updateHitReviewStatusRequest)

      The UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status.

      Parameters:
      updateHitReviewStatusRequest -
      Returns:
      A Java Future containing the result of the UpdateHITReviewStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateHITReviewStatus

      default CompletableFuture<UpdateHitReviewStatusResponse> updateHITReviewStatus(Consumer<UpdateHitReviewStatusRequest.Builder> updateHitReviewStatusRequest)

      The UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status.


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

      Parameters:
      updateHitReviewStatusRequest - A Consumer that will call methods on UpdateHitReviewStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateHITReviewStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateHITTypeOfHIT

      default CompletableFuture<UpdateHitTypeOfHitResponse> updateHITTypeOfHIT(UpdateHitTypeOfHitRequest updateHitTypeOfHitRequest)

      The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties and associates it with the new HITType properties. The HIT takes on the properties of the new HITType in place of the old ones.

      Parameters:
      updateHitTypeOfHitRequest -
      Returns:
      A Java Future containing the result of the UpdateHITTypeOfHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateHITTypeOfHIT

      default CompletableFuture<UpdateHitTypeOfHitResponse> updateHITTypeOfHIT(Consumer<UpdateHitTypeOfHitRequest.Builder> updateHitTypeOfHitRequest)

      The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties and associates it with the new HITType properties. The HIT takes on the properties of the new HITType in place of the old ones.


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

      Parameters:
      updateHitTypeOfHitRequest - A Consumer that will call methods on UpdateHitTypeOfHitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateHITTypeOfHIT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateNotificationSettings

      default CompletableFuture<UpdateNotificationSettingsResponse> updateNotificationSettings(UpdateNotificationSettingsRequest updateNotificationSettingsRequest)

      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:
      A Java Future containing the result of the UpdateNotificationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateNotificationSettings

      default CompletableFuture<UpdateNotificationSettingsResponse> updateNotificationSettings(Consumer<UpdateNotificationSettingsRequest.Builder> updateNotificationSettingsRequest)

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


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

      Parameters:
      updateNotificationSettingsRequest - A Consumer that will call methods on UpdateNotificationSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNotificationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateQualificationType

      default CompletableFuture<UpdateQualificationTypeResponse> updateQualificationType(UpdateQualificationTypeRequest updateQualificationTypeRequest)

      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:
      A Java Future containing the result of the UpdateQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateQualificationType

      default CompletableFuture<UpdateQualificationTypeResponse> updateQualificationType(Consumer<UpdateQualificationTypeRequest.Builder> updateQualificationTypeRequest)

      The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. 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:
      A Java Future containing the result of the UpdateQualificationType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • serviceClientConfiguration

      default MTurkServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static MTurkAsyncClient create()
      Create a MTurkAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static MTurkAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a MTurkAsyncClient.