Interface CleanRoomsMlAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CleanRoomsMlAsyncClient extends AwsClient
Service client for accessing AWS Clean Rooms ML 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.

Welcome to the Amazon Web Services Clean Rooms ML API Reference.

Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms and generates an audience (lookalike segment) that resembles the training data.

To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the Clean Rooms User Guide.

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.

  • Field Details

  • Method Details

    • createAudienceModel

      default CompletableFuture<CreateAudienceModelResponse> createAudienceModel(CreateAudienceModelRequest createAudienceModelRequest)

      Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.

      Parameters:
      createAudienceModelRequest -
      Returns:
      A Java Future containing the result of the CreateAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • ServiceQuotaExceededException You have exceeded your service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAudienceModel

      default CompletableFuture<CreateAudienceModelResponse> createAudienceModel(Consumer<CreateAudienceModelRequest.Builder> createAudienceModelRequest)

      Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.


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

      Parameters:
      createAudienceModelRequest - A Consumer that will call methods on CreateAudienceModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • ServiceQuotaExceededException You have exceeded your service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConfiguredAudienceModel

      default CompletableFuture<CreateConfiguredAudienceModelResponse> createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest createConfiguredAudienceModelRequest)

      Defines the information necessary to create a configured audience model.

      Parameters:
      createConfiguredAudienceModelRequest -
      Returns:
      A Java Future containing the result of the CreateConfiguredAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • ServiceQuotaExceededException You have exceeded your service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConfiguredAudienceModel

      default CompletableFuture<CreateConfiguredAudienceModelResponse> createConfiguredAudienceModel(Consumer<CreateConfiguredAudienceModelRequest.Builder> createConfiguredAudienceModelRequest)

      Defines the information necessary to create a configured audience model.


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

      Parameters:
      createConfiguredAudienceModelRequest - A Consumer that will call methods on CreateConfiguredAudienceModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateConfiguredAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • ServiceQuotaExceededException You have exceeded your service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrainingDataset

      default CompletableFuture<CreateTrainingDatasetResponse> createTrainingDataset(CreateTrainingDatasetRequest createTrainingDatasetRequest)

      Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.

      Parameters:
      createTrainingDatasetRequest -
      Returns:
      A Java Future containing the result of the CreateTrainingDataset 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrainingDataset

      default CompletableFuture<CreateTrainingDatasetResponse> createTrainingDataset(Consumer<CreateTrainingDatasetRequest.Builder> createTrainingDatasetRequest)

      Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.


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

      Parameters:
      createTrainingDatasetRequest - A Consumer that will call methods on CreateTrainingDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTrainingDataset 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAudienceGenerationJob

      default CompletableFuture<DeleteAudienceGenerationJobResponse> deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest deleteAudienceGenerationJobRequest)

      Deletes the specified audience generation job, and removes all data associated with the job.

      Parameters:
      deleteAudienceGenerationJobRequest -
      Returns:
      A Java Future containing the result of the DeleteAudienceGenerationJob 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAudienceGenerationJob

      default CompletableFuture<DeleteAudienceGenerationJobResponse> deleteAudienceGenerationJob(Consumer<DeleteAudienceGenerationJobRequest.Builder> deleteAudienceGenerationJobRequest)

      Deletes the specified audience generation job, and removes all data associated with the job.


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

      Parameters:
      deleteAudienceGenerationJobRequest - A Consumer that will call methods on DeleteAudienceGenerationJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAudienceGenerationJob 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAudienceModel

      default CompletableFuture<DeleteAudienceModelResponse> deleteAudienceModel(DeleteAudienceModelRequest deleteAudienceModelRequest)

      Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.

      Parameters:
      deleteAudienceModelRequest -
      Returns:
      A Java Future containing the result of the DeleteAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAudienceModel

      default CompletableFuture<DeleteAudienceModelResponse> deleteAudienceModel(Consumer<DeleteAudienceModelRequest.Builder> deleteAudienceModelRequest)

      Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.


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

      Parameters:
      deleteAudienceModelRequest - A Consumer that will call methods on DeleteAudienceModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConfiguredAudienceModel

      default CompletableFuture<DeleteConfiguredAudienceModelResponse> deleteConfiguredAudienceModel(DeleteConfiguredAudienceModelRequest deleteConfiguredAudienceModelRequest)

      Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.

      Parameters:
      deleteConfiguredAudienceModelRequest -
      Returns:
      A Java Future containing the result of the DeleteConfiguredAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConfiguredAudienceModel

      default CompletableFuture<DeleteConfiguredAudienceModelResponse> deleteConfiguredAudienceModel(Consumer<DeleteConfiguredAudienceModelRequest.Builder> deleteConfiguredAudienceModelRequest)

      Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.


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

      Parameters:
      deleteConfiguredAudienceModelRequest - A Consumer that will call methods on DeleteConfiguredAudienceModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteConfiguredAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConfiguredAudienceModelPolicy

      default CompletableFuture<DeleteConfiguredAudienceModelPolicyResponse> deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest deleteConfiguredAudienceModelPolicyRequest)

      Deletes the specified configured audience model policy.

      Parameters:
      deleteConfiguredAudienceModelPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteConfiguredAudienceModelPolicy 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConfiguredAudienceModelPolicy

      default CompletableFuture<DeleteConfiguredAudienceModelPolicyResponse> deleteConfiguredAudienceModelPolicy(Consumer<DeleteConfiguredAudienceModelPolicyRequest.Builder> deleteConfiguredAudienceModelPolicyRequest)

      Deletes the specified configured audience model policy.


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

      Parameters:
      deleteConfiguredAudienceModelPolicyRequest - A Consumer that will call methods on DeleteConfiguredAudienceModelPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteConfiguredAudienceModelPolicy 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTrainingDataset

      default CompletableFuture<DeleteTrainingDatasetResponse> deleteTrainingDataset(DeleteTrainingDatasetRequest deleteTrainingDatasetRequest)

      Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.

      Parameters:
      deleteTrainingDatasetRequest -
      Returns:
      A Java Future containing the result of the DeleteTrainingDataset 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTrainingDataset

      default CompletableFuture<DeleteTrainingDatasetResponse> deleteTrainingDataset(Consumer<DeleteTrainingDatasetRequest.Builder> deleteTrainingDatasetRequest)

      Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.


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

      Parameters:
      deleteTrainingDatasetRequest - A Consumer that will call methods on DeleteTrainingDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTrainingDataset 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAudienceGenerationJob

      default CompletableFuture<GetAudienceGenerationJobResponse> getAudienceGenerationJob(GetAudienceGenerationJobRequest getAudienceGenerationJobRequest)

      Returns information about an audience generation job.

      Parameters:
      getAudienceGenerationJobRequest -
      Returns:
      A Java Future containing the result of the GetAudienceGenerationJob 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAudienceGenerationJob

      default CompletableFuture<GetAudienceGenerationJobResponse> getAudienceGenerationJob(Consumer<GetAudienceGenerationJobRequest.Builder> getAudienceGenerationJobRequest)

      Returns information about an audience generation job.


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

      Parameters:
      getAudienceGenerationJobRequest - A Consumer that will call methods on GetAudienceGenerationJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAudienceGenerationJob 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAudienceModel

      default CompletableFuture<GetAudienceModelResponse> getAudienceModel(GetAudienceModelRequest getAudienceModelRequest)

      Returns information about an audience model

      Parameters:
      getAudienceModelRequest -
      Returns:
      A Java Future containing the result of the GetAudienceModel 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAudienceModel

      default CompletableFuture<GetAudienceModelResponse> getAudienceModel(Consumer<GetAudienceModelRequest.Builder> getAudienceModelRequest)

      Returns information about an audience model


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

      Parameters:
      getAudienceModelRequest - A Consumer that will call methods on GetAudienceModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAudienceModel 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConfiguredAudienceModel

      default CompletableFuture<GetConfiguredAudienceModelResponse> getConfiguredAudienceModel(GetConfiguredAudienceModelRequest getConfiguredAudienceModelRequest)

      Returns information about a specified configured audience model.

      Parameters:
      getConfiguredAudienceModelRequest -
      Returns:
      A Java Future containing the result of the GetConfiguredAudienceModel 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConfiguredAudienceModel

      default CompletableFuture<GetConfiguredAudienceModelResponse> getConfiguredAudienceModel(Consumer<GetConfiguredAudienceModelRequest.Builder> getConfiguredAudienceModelRequest)

      Returns information about a specified configured audience model.


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

      Parameters:
      getConfiguredAudienceModelRequest - A Consumer that will call methods on GetConfiguredAudienceModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetConfiguredAudienceModel 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConfiguredAudienceModelPolicy

      default CompletableFuture<GetConfiguredAudienceModelPolicyResponse> getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest getConfiguredAudienceModelPolicyRequest)

      Returns information about a configured audience model policy.

      Parameters:
      getConfiguredAudienceModelPolicyRequest -
      Returns:
      A Java Future containing the result of the GetConfiguredAudienceModelPolicy 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConfiguredAudienceModelPolicy

      default CompletableFuture<GetConfiguredAudienceModelPolicyResponse> getConfiguredAudienceModelPolicy(Consumer<GetConfiguredAudienceModelPolicyRequest.Builder> getConfiguredAudienceModelPolicyRequest)

      Returns information about a configured audience model policy.


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

      Parameters:
      getConfiguredAudienceModelPolicyRequest - A Consumer that will call methods on GetConfiguredAudienceModelPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetConfiguredAudienceModelPolicy 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTrainingDataset

      default CompletableFuture<GetTrainingDatasetResponse> getTrainingDataset(GetTrainingDatasetRequest getTrainingDatasetRequest)

      Returns information about a training dataset.

      Parameters:
      getTrainingDatasetRequest -
      Returns:
      A Java Future containing the result of the GetTrainingDataset 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTrainingDataset

      default CompletableFuture<GetTrainingDatasetResponse> getTrainingDataset(Consumer<GetTrainingDatasetRequest.Builder> getTrainingDatasetRequest)

      Returns information about a training dataset.


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

      Parameters:
      getTrainingDatasetRequest - A Consumer that will call methods on GetTrainingDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTrainingDataset 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceExportJobs

      default CompletableFuture<ListAudienceExportJobsResponse> listAudienceExportJobs(ListAudienceExportJobsRequest listAudienceExportJobsRequest)

      Returns a list of the audience export jobs.

      Parameters:
      listAudienceExportJobsRequest -
      Returns:
      A Java Future containing the result of the ListAudienceExportJobs 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceExportJobs

      default CompletableFuture<ListAudienceExportJobsResponse> listAudienceExportJobs(Consumer<ListAudienceExportJobsRequest.Builder> listAudienceExportJobsRequest)

      Returns a list of the audience export jobs.


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

      Parameters:
      listAudienceExportJobsRequest - A Consumer that will call methods on ListAudienceExportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAudienceExportJobs 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceExportJobsPaginator

      default ListAudienceExportJobsPublisher listAudienceExportJobsPaginator(ListAudienceExportJobsRequest listAudienceExportJobsRequest)

      This is a variant of listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) 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.cleanroomsml.paginators.ListAudienceExportJobsPublisher publisher = client.listAudienceExportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsPublisher publisher = client.listAudienceExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsResponse 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 listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) operation.

      Parameters:
      listAudienceExportJobsRequest -
      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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceExportJobsPaginator

      default ListAudienceExportJobsPublisher listAudienceExportJobsPaginator(Consumer<ListAudienceExportJobsRequest.Builder> listAudienceExportJobsRequest)

      This is a variant of listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) 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.cleanroomsml.paginators.ListAudienceExportJobsPublisher publisher = client.listAudienceExportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsPublisher publisher = client.listAudienceExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsResponse 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 listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) operation.


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

      Parameters:
      listAudienceExportJobsRequest - A Consumer that will call methods on ListAudienceExportJobsRequest.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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceGenerationJobs

      default CompletableFuture<ListAudienceGenerationJobsResponse> listAudienceGenerationJobs(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest)

      Returns a list of audience generation jobs.

      Parameters:
      listAudienceGenerationJobsRequest -
      Returns:
      A Java Future containing the result of the ListAudienceGenerationJobs 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceGenerationJobs

      default CompletableFuture<ListAudienceGenerationJobsResponse> listAudienceGenerationJobs(Consumer<ListAudienceGenerationJobsRequest.Builder> listAudienceGenerationJobsRequest)

      Returns a list of audience generation jobs.


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

      Parameters:
      listAudienceGenerationJobsRequest - A Consumer that will call methods on ListAudienceGenerationJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAudienceGenerationJobs 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceGenerationJobsPaginator

      default ListAudienceGenerationJobsPublisher listAudienceGenerationJobsPaginator(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest)

      This is a variant of listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) 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.cleanroomsml.paginators.ListAudienceGenerationJobsPublisher publisher = client.listAudienceGenerationJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsPublisher publisher = client.listAudienceGenerationJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsResponse 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 listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) operation.

      Parameters:
      listAudienceGenerationJobsRequest -
      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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceGenerationJobsPaginator

      default ListAudienceGenerationJobsPublisher listAudienceGenerationJobsPaginator(Consumer<ListAudienceGenerationJobsRequest.Builder> listAudienceGenerationJobsRequest)

      This is a variant of listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) 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.cleanroomsml.paginators.ListAudienceGenerationJobsPublisher publisher = client.listAudienceGenerationJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsPublisher publisher = client.listAudienceGenerationJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsResponse 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 listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) operation.


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

      Parameters:
      listAudienceGenerationJobsRequest - A Consumer that will call methods on ListAudienceGenerationJobsRequest.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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceModels

      default CompletableFuture<ListAudienceModelsResponse> listAudienceModels(ListAudienceModelsRequest listAudienceModelsRequest)

      Returns a list of audience models.

      Parameters:
      listAudienceModelsRequest -
      Returns:
      A Java Future containing the result of the ListAudienceModels 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceModels

      default CompletableFuture<ListAudienceModelsResponse> listAudienceModels(Consumer<ListAudienceModelsRequest.Builder> listAudienceModelsRequest)

      Returns a list of audience models.


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

      Parameters:
      listAudienceModelsRequest - A Consumer that will call methods on ListAudienceModelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAudienceModels 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceModelsPaginator

      default ListAudienceModelsPublisher listAudienceModelsPaginator(ListAudienceModelsRequest listAudienceModelsRequest)

      This is a variant of listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) 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.cleanroomsml.paginators.ListAudienceModelsPublisher publisher = client.listAudienceModelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsPublisher publisher = client.listAudienceModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsResponse 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 listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) operation.

      Parameters:
      listAudienceModelsRequest -
      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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAudienceModelsPaginator

      default ListAudienceModelsPublisher listAudienceModelsPaginator(Consumer<ListAudienceModelsRequest.Builder> listAudienceModelsRequest)

      This is a variant of listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) 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.cleanroomsml.paginators.ListAudienceModelsPublisher publisher = client.listAudienceModelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsPublisher publisher = client.listAudienceModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsResponse 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 listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) operation.


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

      Parameters:
      listAudienceModelsRequest - A Consumer that will call methods on ListAudienceModelsRequest.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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConfiguredAudienceModels

      default CompletableFuture<ListConfiguredAudienceModelsResponse> listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest)

      Returns a list of the configured audience models.

      Parameters:
      listConfiguredAudienceModelsRequest -
      Returns:
      A Java Future containing the result of the ListConfiguredAudienceModels 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConfiguredAudienceModels

      default CompletableFuture<ListConfiguredAudienceModelsResponse> listConfiguredAudienceModels(Consumer<ListConfiguredAudienceModelsRequest.Builder> listConfiguredAudienceModelsRequest)

      Returns a list of the configured audience models.


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

      Parameters:
      listConfiguredAudienceModelsRequest - A Consumer that will call methods on ListConfiguredAudienceModelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListConfiguredAudienceModels 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConfiguredAudienceModelsPaginator

      default ListConfiguredAudienceModelsPublisher listConfiguredAudienceModelsPaginator(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest)

      This is a variant of listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) 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.cleanroomsml.paginators.ListConfiguredAudienceModelsPublisher publisher = client.listConfiguredAudienceModelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsPublisher publisher = client.listConfiguredAudienceModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsResponse 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 listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) operation.

      Parameters:
      listConfiguredAudienceModelsRequest -
      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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConfiguredAudienceModelsPaginator

      default ListConfiguredAudienceModelsPublisher listConfiguredAudienceModelsPaginator(Consumer<ListConfiguredAudienceModelsRequest.Builder> listConfiguredAudienceModelsRequest)

      This is a variant of listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) 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.cleanroomsml.paginators.ListConfiguredAudienceModelsPublisher publisher = client.listConfiguredAudienceModelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsPublisher publisher = client.listConfiguredAudienceModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsResponse 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 listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) operation.


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

      Parameters:
      listConfiguredAudienceModelsRequest - A Consumer that will call methods on ListConfiguredAudienceModelsRequest.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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns a list of tags for a provided resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Returns a list of tags for a provided resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingDatasets

      default CompletableFuture<ListTrainingDatasetsResponse> listTrainingDatasets(ListTrainingDatasetsRequest listTrainingDatasetsRequest)

      Returns a list of training datasets.

      Parameters:
      listTrainingDatasetsRequest -
      Returns:
      A Java Future containing the result of the ListTrainingDatasets 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingDatasets

      default CompletableFuture<ListTrainingDatasetsResponse> listTrainingDatasets(Consumer<ListTrainingDatasetsRequest.Builder> listTrainingDatasetsRequest)

      Returns a list of training datasets.


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

      Parameters:
      listTrainingDatasetsRequest - A Consumer that will call methods on ListTrainingDatasetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTrainingDatasets 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingDatasetsPaginator

      default ListTrainingDatasetsPublisher listTrainingDatasetsPaginator(ListTrainingDatasetsRequest listTrainingDatasetsRequest)

      This is a variant of listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) 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.cleanroomsml.paginators.ListTrainingDatasetsPublisher publisher = client.listTrainingDatasetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsPublisher publisher = client.listTrainingDatasetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsResponse 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 listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) operation.

      Parameters:
      listTrainingDatasetsRequest -
      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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingDatasetsPaginator

      default ListTrainingDatasetsPublisher listTrainingDatasetsPaginator(Consumer<ListTrainingDatasetsRequest.Builder> listTrainingDatasetsRequest)

      This is a variant of listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) 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.cleanroomsml.paginators.ListTrainingDatasetsPublisher publisher = client.listTrainingDatasetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsPublisher publisher = client.listTrainingDatasetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsResponse 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 listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) operation.


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

      Parameters:
      listTrainingDatasetsRequest - A Consumer that will call methods on ListTrainingDatasetsRequest.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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putConfiguredAudienceModelPolicy

      default CompletableFuture<PutConfiguredAudienceModelPolicyResponse> putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest putConfiguredAudienceModelPolicyRequest)

      Create or update the resource policy for a configured audience model.

      Parameters:
      putConfiguredAudienceModelPolicyRequest -
      Returns:
      A Java Future containing the result of the PutConfiguredAudienceModelPolicy 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putConfiguredAudienceModelPolicy

      default CompletableFuture<PutConfiguredAudienceModelPolicyResponse> putConfiguredAudienceModelPolicy(Consumer<PutConfiguredAudienceModelPolicyRequest.Builder> putConfiguredAudienceModelPolicyRequest)

      Create or update the resource policy for a configured audience model.


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

      Parameters:
      putConfiguredAudienceModelPolicyRequest - A Consumer that will call methods on PutConfiguredAudienceModelPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutConfiguredAudienceModelPolicy 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAudienceExportJob

      default CompletableFuture<StartAudienceExportJobResponse> startAudienceExportJob(StartAudienceExportJobRequest startAudienceExportJobRequest)

      Export an audience of a specified size after you have generated an audience.

      Parameters:
      startAudienceExportJobRequest -
      Returns:
      A Java Future containing the result of the StartAudienceExportJob 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • ServiceQuotaExceededException You have exceeded your service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAudienceExportJob

      default CompletableFuture<StartAudienceExportJobResponse> startAudienceExportJob(Consumer<StartAudienceExportJobRequest.Builder> startAudienceExportJobRequest)

      Export an audience of a specified size after you have generated an audience.


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

      Parameters:
      startAudienceExportJobRequest - A Consumer that will call methods on StartAudienceExportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartAudienceExportJob 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • ServiceQuotaExceededException You have exceeded your service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAudienceGenerationJob

      default CompletableFuture<StartAudienceGenerationJobResponse> startAudienceGenerationJob(StartAudienceGenerationJobRequest startAudienceGenerationJobRequest)

      Information necessary to start the audience generation job.

      Parameters:
      startAudienceGenerationJobRequest -
      Returns:
      A Java Future containing the result of the StartAudienceGenerationJob 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • ServiceQuotaExceededException You have exceeded your service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAudienceGenerationJob

      default CompletableFuture<StartAudienceGenerationJobResponse> startAudienceGenerationJob(Consumer<StartAudienceGenerationJobRequest.Builder> startAudienceGenerationJobRequest)

      Information necessary to start the audience generation job.


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

      Parameters:
      startAudienceGenerationJobRequest - A Consumer that will call methods on StartAudienceGenerationJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartAudienceGenerationJob 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • ServiceQuotaExceededException You have exceeded your service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds metadata tags to a specified resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds metadata tags to a specified resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes metadata tags from a specified resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes metadata tags from a specified resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource 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.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConfiguredAudienceModel

      default CompletableFuture<UpdateConfiguredAudienceModelResponse> updateConfiguredAudienceModel(UpdateConfiguredAudienceModelRequest updateConfiguredAudienceModelRequest)

      Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.

      Parameters:
      updateConfiguredAudienceModelRequest -
      Returns:
      A Java Future containing the result of the UpdateConfiguredAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConfiguredAudienceModel

      default CompletableFuture<UpdateConfiguredAudienceModelResponse> updateConfiguredAudienceModel(Consumer<UpdateConfiguredAudienceModelRequest.Builder> updateConfiguredAudienceModelRequest)

      Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.


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

      Parameters:
      updateConfiguredAudienceModelRequest - A Consumer that will call methods on UpdateConfiguredAudienceModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateConfiguredAudienceModel 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.
      • ConflictException You can't complete this action because another resource depends on this resource.
      • ValidationException The request parameters for this request are incorrect.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The resource you are requesting does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CleanRoomsMlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default CleanRoomsMlServiceClientConfiguration 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 CleanRoomsMlAsyncClient create()
      Create a CleanRoomsMlAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static CleanRoomsMlAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a CleanRoomsMlAsyncClient.