Interface CleanRoomsMlAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aCleanRoomsMlAsyncClient.cancelTrainedModel(Consumer<CancelTrainedModelRequest.Builder> cancelTrainedModelRequest) Submits a request to cancel the trained model job.cancelTrainedModel(CancelTrainedModelRequest cancelTrainedModelRequest) Submits a request to cancel the trained model job.cancelTrainedModelInferenceJob(Consumer<CancelTrainedModelInferenceJobRequest.Builder> cancelTrainedModelInferenceJobRequest) Submits a request to cancel a trained model inference job.cancelTrainedModelInferenceJob(CancelTrainedModelInferenceJobRequest cancelTrainedModelInferenceJobRequest) Submits a request to cancel a trained model inference job.static CleanRoomsMlAsyncClientcreate()Create aCleanRoomsMlAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createAudienceModel(Consumer<CreateAudienceModelRequest.Builder> createAudienceModelRequest) Defines the information necessary to create an audience model.createAudienceModel(CreateAudienceModelRequest createAudienceModelRequest) Defines the information necessary to create an audience model.createConfiguredAudienceModel(Consumer<CreateConfiguredAudienceModelRequest.Builder> createConfiguredAudienceModelRequest) Defines the information necessary to create a configured audience model.createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest createConfiguredAudienceModelRequest) Defines the information necessary to create a configured audience model.createConfiguredModelAlgorithm(Consumer<CreateConfiguredModelAlgorithmRequest.Builder> createConfiguredModelAlgorithmRequest) Creates a configured model algorithm using a container image stored in an ECR repository.createConfiguredModelAlgorithm(CreateConfiguredModelAlgorithmRequest createConfiguredModelAlgorithmRequest) Creates a configured model algorithm using a container image stored in an ECR repository.createConfiguredModelAlgorithmAssociation(Consumer<CreateConfiguredModelAlgorithmAssociationRequest.Builder> createConfiguredModelAlgorithmAssociationRequest) Associates a configured model algorithm to a collaboration for use by any member of the collaboration.createConfiguredModelAlgorithmAssociation(CreateConfiguredModelAlgorithmAssociationRequest createConfiguredModelAlgorithmAssociationRequest) Associates a configured model algorithm to a collaboration for use by any member of the collaboration.createMLInputChannel(Consumer<CreateMlInputChannelRequest.Builder> createMlInputChannelRequest) Provides the information to create an ML input channel.createMLInputChannel(CreateMlInputChannelRequest createMlInputChannelRequest) Provides the information to create an ML input channel.createTrainedModel(Consumer<CreateTrainedModelRequest.Builder> createTrainedModelRequest) Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.createTrainedModel(CreateTrainedModelRequest createTrainedModelRequest) Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.createTrainingDataset(Consumer<CreateTrainingDatasetRequest.Builder> createTrainingDatasetRequest) Defines the information necessary to create a training dataset.createTrainingDataset(CreateTrainingDatasetRequest createTrainingDatasetRequest) Defines the information necessary to create a training dataset.deleteAudienceGenerationJob(Consumer<DeleteAudienceGenerationJobRequest.Builder> deleteAudienceGenerationJobRequest) Deletes the specified audience generation job, and removes all data associated with the job.deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest deleteAudienceGenerationJobRequest) Deletes the specified audience generation job, and removes all data associated with the job.deleteAudienceModel(Consumer<DeleteAudienceModelRequest.Builder> deleteAudienceModelRequest) Specifies an audience model that you want to delete.deleteAudienceModel(DeleteAudienceModelRequest deleteAudienceModelRequest) Specifies an audience model that you want to delete.deleteConfiguredAudienceModel(Consumer<DeleteConfiguredAudienceModelRequest.Builder> deleteConfiguredAudienceModelRequest) Deletes the specified configured audience model.deleteConfiguredAudienceModel(DeleteConfiguredAudienceModelRequest deleteConfiguredAudienceModelRequest) Deletes the specified configured audience model.deleteConfiguredAudienceModelPolicy(Consumer<DeleteConfiguredAudienceModelPolicyRequest.Builder> deleteConfiguredAudienceModelPolicyRequest) Deletes the specified configured audience model policy.deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest deleteConfiguredAudienceModelPolicyRequest) Deletes the specified configured audience model policy.deleteConfiguredModelAlgorithm(Consumer<DeleteConfiguredModelAlgorithmRequest.Builder> deleteConfiguredModelAlgorithmRequest) Deletes a configured model algorithm.deleteConfiguredModelAlgorithm(DeleteConfiguredModelAlgorithmRequest deleteConfiguredModelAlgorithmRequest) Deletes a configured model algorithm.deleteConfiguredModelAlgorithmAssociation(Consumer<DeleteConfiguredModelAlgorithmAssociationRequest.Builder> deleteConfiguredModelAlgorithmAssociationRequest) Deletes a configured model algorithm association.deleteConfiguredModelAlgorithmAssociation(DeleteConfiguredModelAlgorithmAssociationRequest deleteConfiguredModelAlgorithmAssociationRequest) Deletes a configured model algorithm association.deleteMLConfiguration(Consumer<DeleteMlConfigurationRequest.Builder> deleteMlConfigurationRequest) Deletes a ML modeling configuration.deleteMLConfiguration(DeleteMlConfigurationRequest deleteMlConfigurationRequest) Deletes a ML modeling configuration.deleteMLInputChannelData(Consumer<DeleteMlInputChannelDataRequest.Builder> deleteMlInputChannelDataRequest) Provides the information necessary to delete an ML input channel.deleteMLInputChannelData(DeleteMlInputChannelDataRequest deleteMlInputChannelDataRequest) Provides the information necessary to delete an ML input channel.deleteTrainedModelOutput(Consumer<DeleteTrainedModelOutputRequest.Builder> deleteTrainedModelOutputRequest) Deletes the output of a trained model.deleteTrainedModelOutput(DeleteTrainedModelOutputRequest deleteTrainedModelOutputRequest) Deletes the output of a trained model.deleteTrainingDataset(Consumer<DeleteTrainingDatasetRequest.Builder> deleteTrainingDatasetRequest) Specifies a training dataset that you want to delete.deleteTrainingDataset(DeleteTrainingDatasetRequest deleteTrainingDatasetRequest) Specifies a training dataset that you want to delete.getAudienceGenerationJob(Consumer<GetAudienceGenerationJobRequest.Builder> getAudienceGenerationJobRequest) Returns information about an audience generation job.getAudienceGenerationJob(GetAudienceGenerationJobRequest getAudienceGenerationJobRequest) Returns information about an audience generation job.getAudienceModel(Consumer<GetAudienceModelRequest.Builder> getAudienceModelRequest) Returns information about an audience modelgetAudienceModel(GetAudienceModelRequest getAudienceModelRequest) Returns information about an audience modelgetCollaborationConfiguredModelAlgorithmAssociation(Consumer<GetCollaborationConfiguredModelAlgorithmAssociationRequest.Builder> getCollaborationConfiguredModelAlgorithmAssociationRequest) Returns information about the configured model algorithm association in a collaboration.getCollaborationConfiguredModelAlgorithmAssociation(GetCollaborationConfiguredModelAlgorithmAssociationRequest getCollaborationConfiguredModelAlgorithmAssociationRequest) Returns information about the configured model algorithm association in a collaboration.getCollaborationMLInputChannel(Consumer<GetCollaborationMlInputChannelRequest.Builder> getCollaborationMlInputChannelRequest) Returns information about a specific ML input channel in a collaboration.getCollaborationMLInputChannel(GetCollaborationMlInputChannelRequest getCollaborationMlInputChannelRequest) Returns information about a specific ML input channel in a collaboration.getCollaborationTrainedModel(Consumer<GetCollaborationTrainedModelRequest.Builder> getCollaborationTrainedModelRequest) Returns information about a trained model in a collaboration.getCollaborationTrainedModel(GetCollaborationTrainedModelRequest getCollaborationTrainedModelRequest) Returns information about a trained model in a collaboration.getConfiguredAudienceModel(Consumer<GetConfiguredAudienceModelRequest.Builder> getConfiguredAudienceModelRequest) Returns information about a specified configured audience model.getConfiguredAudienceModel(GetConfiguredAudienceModelRequest getConfiguredAudienceModelRequest) Returns information about a specified configured audience model.getConfiguredAudienceModelPolicy(Consumer<GetConfiguredAudienceModelPolicyRequest.Builder> getConfiguredAudienceModelPolicyRequest) Returns information about a configured audience model policy.getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest getConfiguredAudienceModelPolicyRequest) Returns information about a configured audience model policy.getConfiguredModelAlgorithm(Consumer<GetConfiguredModelAlgorithmRequest.Builder> getConfiguredModelAlgorithmRequest) Returns information about a configured model algorithm.getConfiguredModelAlgorithm(GetConfiguredModelAlgorithmRequest getConfiguredModelAlgorithmRequest) Returns information about a configured model algorithm.getConfiguredModelAlgorithmAssociation(Consumer<GetConfiguredModelAlgorithmAssociationRequest.Builder> getConfiguredModelAlgorithmAssociationRequest) Returns information about a configured model algorithm association.getConfiguredModelAlgorithmAssociation(GetConfiguredModelAlgorithmAssociationRequest getConfiguredModelAlgorithmAssociationRequest) Returns information about a configured model algorithm association.getMLConfiguration(Consumer<GetMlConfigurationRequest.Builder> getMlConfigurationRequest) Returns information about a specific ML configuration.getMLConfiguration(GetMlConfigurationRequest getMlConfigurationRequest) Returns information about a specific ML configuration.getMLInputChannel(Consumer<GetMlInputChannelRequest.Builder> getMlInputChannelRequest) Returns information about an ML input channel.getMLInputChannel(GetMlInputChannelRequest getMlInputChannelRequest) Returns information about an ML input channel.default CompletableFuture<GetTrainedModelResponse> getTrainedModel(Consumer<GetTrainedModelRequest.Builder> getTrainedModelRequest) Returns information about a trained model.default CompletableFuture<GetTrainedModelResponse> getTrainedModel(GetTrainedModelRequest getTrainedModelRequest) Returns information about a trained model.getTrainedModelInferenceJob(Consumer<GetTrainedModelInferenceJobRequest.Builder> getTrainedModelInferenceJobRequest) Returns information about a trained model inference job.getTrainedModelInferenceJob(GetTrainedModelInferenceJobRequest getTrainedModelInferenceJobRequest) Returns information about a trained model inference job.getTrainingDataset(Consumer<GetTrainingDatasetRequest.Builder> getTrainingDatasetRequest) Returns information about a training dataset.getTrainingDataset(GetTrainingDatasetRequest getTrainingDatasetRequest) Returns information about a training dataset.listAudienceExportJobs(Consumer<ListAudienceExportJobsRequest.Builder> listAudienceExportJobsRequest) Returns a list of the audience export jobs.listAudienceExportJobs(ListAudienceExportJobsRequest listAudienceExportJobsRequest) Returns a list of the audience export jobs.default ListAudienceExportJobsPublisherlistAudienceExportJobsPaginator(Consumer<ListAudienceExportJobsRequest.Builder> listAudienceExportJobsRequest) This is a variant oflistAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest)operation.default ListAudienceExportJobsPublisherlistAudienceExportJobsPaginator(ListAudienceExportJobsRequest listAudienceExportJobsRequest) This is a variant oflistAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest)operation.listAudienceGenerationJobs(Consumer<ListAudienceGenerationJobsRequest.Builder> listAudienceGenerationJobsRequest) Returns a list of audience generation jobs.listAudienceGenerationJobs(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest) Returns a list of audience generation jobs.listAudienceGenerationJobsPaginator(Consumer<ListAudienceGenerationJobsRequest.Builder> listAudienceGenerationJobsRequest) This is a variant oflistAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest)operation.listAudienceGenerationJobsPaginator(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest) This is a variant oflistAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest)operation.listAudienceModels(Consumer<ListAudienceModelsRequest.Builder> listAudienceModelsRequest) Returns a list of audience models.listAudienceModels(ListAudienceModelsRequest listAudienceModelsRequest) Returns a list of audience models.default ListAudienceModelsPublisherlistAudienceModelsPaginator(Consumer<ListAudienceModelsRequest.Builder> listAudienceModelsRequest) This is a variant oflistAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest)operation.default ListAudienceModelsPublisherlistAudienceModelsPaginator(ListAudienceModelsRequest listAudienceModelsRequest) This is a variant oflistAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest)operation.listCollaborationConfiguredModelAlgorithmAssociations(Consumer<ListCollaborationConfiguredModelAlgorithmAssociationsRequest.Builder> listCollaborationConfiguredModelAlgorithmAssociationsRequest) Returns a list of the configured model algorithm associations in a collaboration.listCollaborationConfiguredModelAlgorithmAssociations(ListCollaborationConfiguredModelAlgorithmAssociationsRequest listCollaborationConfiguredModelAlgorithmAssociationsRequest) Returns a list of the configured model algorithm associations in a collaboration.listCollaborationConfiguredModelAlgorithmAssociationsPaginator(Consumer<ListCollaborationConfiguredModelAlgorithmAssociationsRequest.Builder> listCollaborationConfiguredModelAlgorithmAssociationsRequest) listCollaborationConfiguredModelAlgorithmAssociationsPaginator(ListCollaborationConfiguredModelAlgorithmAssociationsRequest listCollaborationConfiguredModelAlgorithmAssociationsRequest) listCollaborationMLInputChannels(Consumer<ListCollaborationMlInputChannelsRequest.Builder> listCollaborationMlInputChannelsRequest) Returns a list of the ML input channels in a collaboration.listCollaborationMLInputChannels(ListCollaborationMlInputChannelsRequest listCollaborationMlInputChannelsRequest) Returns a list of the ML input channels in a collaboration.listCollaborationMLInputChannelsPaginator(Consumer<ListCollaborationMlInputChannelsRequest.Builder> listCollaborationMlInputChannelsRequest) This is a variant oflistCollaborationMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsRequest)operation.listCollaborationMLInputChannelsPaginator(ListCollaborationMlInputChannelsRequest listCollaborationMlInputChannelsRequest) This is a variant oflistCollaborationMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsRequest)operation.listCollaborationTrainedModelExportJobs(Consumer<ListCollaborationTrainedModelExportJobsRequest.Builder> listCollaborationTrainedModelExportJobsRequest) Returns a list of the export jobs for a trained model in a collaboration.listCollaborationTrainedModelExportJobs(ListCollaborationTrainedModelExportJobsRequest listCollaborationTrainedModelExportJobsRequest) Returns a list of the export jobs for a trained model in a collaboration.listCollaborationTrainedModelExportJobsPaginator(Consumer<ListCollaborationTrainedModelExportJobsRequest.Builder> listCollaborationTrainedModelExportJobsRequest) listCollaborationTrainedModelExportJobsPaginator(ListCollaborationTrainedModelExportJobsRequest listCollaborationTrainedModelExportJobsRequest) listCollaborationTrainedModelInferenceJobs(Consumer<ListCollaborationTrainedModelInferenceJobsRequest.Builder> listCollaborationTrainedModelInferenceJobsRequest) Returns a list of trained model inference jobs in a specified collaboration.listCollaborationTrainedModelInferenceJobs(ListCollaborationTrainedModelInferenceJobsRequest listCollaborationTrainedModelInferenceJobsRequest) Returns a list of trained model inference jobs in a specified collaboration.listCollaborationTrainedModelInferenceJobsPaginator(Consumer<ListCollaborationTrainedModelInferenceJobsRequest.Builder> listCollaborationTrainedModelInferenceJobsRequest) listCollaborationTrainedModelInferenceJobsPaginator(ListCollaborationTrainedModelInferenceJobsRequest listCollaborationTrainedModelInferenceJobsRequest) listCollaborationTrainedModels(Consumer<ListCollaborationTrainedModelsRequest.Builder> listCollaborationTrainedModelsRequest) Returns a list of the trained models in a collaboration.listCollaborationTrainedModels(ListCollaborationTrainedModelsRequest listCollaborationTrainedModelsRequest) Returns a list of the trained models in a collaboration.listCollaborationTrainedModelsPaginator(Consumer<ListCollaborationTrainedModelsRequest.Builder> listCollaborationTrainedModelsRequest) This is a variant oflistCollaborationTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsRequest)operation.listCollaborationTrainedModelsPaginator(ListCollaborationTrainedModelsRequest listCollaborationTrainedModelsRequest) This is a variant oflistCollaborationTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsRequest)operation.listConfiguredAudienceModels(Consumer<ListConfiguredAudienceModelsRequest.Builder> listConfiguredAudienceModelsRequest) Returns a list of the configured audience models.listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest) Returns a list of the configured audience models.listConfiguredAudienceModelsPaginator(Consumer<ListConfiguredAudienceModelsRequest.Builder> listConfiguredAudienceModelsRequest) This is a variant oflistConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest)operation.listConfiguredAudienceModelsPaginator(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest) This is a variant oflistConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest)operation.listConfiguredModelAlgorithmAssociations(Consumer<ListConfiguredModelAlgorithmAssociationsRequest.Builder> listConfiguredModelAlgorithmAssociationsRequest) Returns a list of configured model algorithm associations.listConfiguredModelAlgorithmAssociations(ListConfiguredModelAlgorithmAssociationsRequest listConfiguredModelAlgorithmAssociationsRequest) Returns a list of configured model algorithm associations.listConfiguredModelAlgorithmAssociationsPaginator(Consumer<ListConfiguredModelAlgorithmAssociationsRequest.Builder> listConfiguredModelAlgorithmAssociationsRequest) listConfiguredModelAlgorithmAssociationsPaginator(ListConfiguredModelAlgorithmAssociationsRequest listConfiguredModelAlgorithmAssociationsRequest) listConfiguredModelAlgorithms(Consumer<ListConfiguredModelAlgorithmsRequest.Builder> listConfiguredModelAlgorithmsRequest) Returns a list of configured model algorithms.listConfiguredModelAlgorithms(ListConfiguredModelAlgorithmsRequest listConfiguredModelAlgorithmsRequest) Returns a list of configured model algorithms.listConfiguredModelAlgorithmsPaginator(Consumer<ListConfiguredModelAlgorithmsRequest.Builder> listConfiguredModelAlgorithmsRequest) This is a variant oflistConfiguredModelAlgorithms(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsRequest)operation.listConfiguredModelAlgorithmsPaginator(ListConfiguredModelAlgorithmsRequest listConfiguredModelAlgorithmsRequest) This is a variant oflistConfiguredModelAlgorithms(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsRequest)operation.listMLInputChannels(Consumer<ListMlInputChannelsRequest.Builder> listMlInputChannelsRequest) Returns a list of ML input channels.listMLInputChannels(ListMlInputChannelsRequest listMlInputChannelsRequest) Returns a list of ML input channels.default ListMLInputChannelsPublisherlistMLInputChannelsPaginator(Consumer<ListMlInputChannelsRequest.Builder> listMlInputChannelsRequest) This is a variant oflistMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsRequest)operation.default ListMLInputChannelsPublisherlistMLInputChannelsPaginator(ListMlInputChannelsRequest listMlInputChannelsRequest) This is a variant oflistMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for a provided resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a provided resource.listTrainedModelInferenceJobs(Consumer<ListTrainedModelInferenceJobsRequest.Builder> listTrainedModelInferenceJobsRequest) Returns a list of trained model inference jobs that match the request parameters.listTrainedModelInferenceJobs(ListTrainedModelInferenceJobsRequest listTrainedModelInferenceJobsRequest) Returns a list of trained model inference jobs that match the request parameters.listTrainedModelInferenceJobsPaginator(Consumer<ListTrainedModelInferenceJobsRequest.Builder> listTrainedModelInferenceJobsRequest) This is a variant oflistTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsRequest)operation.listTrainedModelInferenceJobsPaginator(ListTrainedModelInferenceJobsRequest listTrainedModelInferenceJobsRequest) This is a variant oflistTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsRequest)operation.listTrainedModels(Consumer<ListTrainedModelsRequest.Builder> listTrainedModelsRequest) Returns a list of trained models.listTrainedModels(ListTrainedModelsRequest listTrainedModelsRequest) Returns a list of trained models.default ListTrainedModelsPublisherlistTrainedModelsPaginator(Consumer<ListTrainedModelsRequest.Builder> listTrainedModelsRequest) This is a variant oflistTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsRequest)operation.default ListTrainedModelsPublisherlistTrainedModelsPaginator(ListTrainedModelsRequest listTrainedModelsRequest) This is a variant oflistTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsRequest)operation.listTrainingDatasets(Consumer<ListTrainingDatasetsRequest.Builder> listTrainingDatasetsRequest) Returns a list of training datasets.listTrainingDatasets(ListTrainingDatasetsRequest listTrainingDatasetsRequest) Returns a list of training datasets.default ListTrainingDatasetsPublisherlistTrainingDatasetsPaginator(Consumer<ListTrainingDatasetsRequest.Builder> listTrainingDatasetsRequest) This is a variant oflistTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest)operation.default ListTrainingDatasetsPublisherlistTrainingDatasetsPaginator(ListTrainingDatasetsRequest listTrainingDatasetsRequest) This is a variant oflistTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest)operation.putConfiguredAudienceModelPolicy(Consumer<PutConfiguredAudienceModelPolicyRequest.Builder> putConfiguredAudienceModelPolicyRequest) Create or update the resource policy for a configured audience model.putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest putConfiguredAudienceModelPolicyRequest) Create or update the resource policy for a configured audience model.putMLConfiguration(Consumer<PutMlConfigurationRequest.Builder> putMlConfigurationRequest) Assigns information about an ML configuration.putMLConfiguration(PutMlConfigurationRequest putMlConfigurationRequest) Assigns information about an ML configuration.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartAudienceExportJob(Consumer<StartAudienceExportJobRequest.Builder> startAudienceExportJobRequest) Export an audience of a specified size after you have generated an audience.startAudienceExportJob(StartAudienceExportJobRequest startAudienceExportJobRequest) Export an audience of a specified size after you have generated an audience.startAudienceGenerationJob(Consumer<StartAudienceGenerationJobRequest.Builder> startAudienceGenerationJobRequest) Information necessary to start the audience generation job.startAudienceGenerationJob(StartAudienceGenerationJobRequest startAudienceGenerationJobRequest) Information necessary to start the audience generation job.startTrainedModelExportJob(Consumer<StartTrainedModelExportJobRequest.Builder> startTrainedModelExportJobRequest) Provides the information necessary to start a trained model export job.startTrainedModelExportJob(StartTrainedModelExportJobRequest startTrainedModelExportJobRequest) Provides the information necessary to start a trained model export job.startTrainedModelInferenceJob(Consumer<StartTrainedModelInferenceJobRequest.Builder> startTrainedModelInferenceJobRequest) Defines the information necessary to begin a trained model inference job.startTrainedModelInferenceJob(StartTrainedModelInferenceJobRequest startTrainedModelInferenceJobRequest) Defines the information necessary to begin a trained model inference job.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds metadata tags to a specified resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds metadata tags to a specified resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes metadata tags from a specified resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes metadata tags from a specified resource.updateConfiguredAudienceModel(Consumer<UpdateConfiguredAudienceModelRequest.Builder> updateConfiguredAudienceModelRequest) Provides the information necessary to update a configured audience model.updateConfiguredAudienceModel(UpdateConfiguredAudienceModelRequest updateConfiguredAudienceModelRequest) Provides the information necessary to update a configured audience model.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
cancelTrainedModel
default CompletableFuture<CancelTrainedModelResponse> cancelTrainedModel(CancelTrainedModelRequest cancelTrainedModelRequest) Submits a request to cancel the trained model job.
- Parameters:
cancelTrainedModelRequest-- Returns:
- A Java Future containing the result of the CancelTrainedModel 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 invokeThrowable.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:
-
cancelTrainedModel
default CompletableFuture<CancelTrainedModelResponse> cancelTrainedModel(Consumer<CancelTrainedModelRequest.Builder> cancelTrainedModelRequest) Submits a request to cancel the trained model job.
This is a convenience which creates an instance of the
CancelTrainedModelRequest.Builderavoiding the need to create one manually viaCancelTrainedModelRequest.builder()- Parameters:
cancelTrainedModelRequest- AConsumerthat will call methods onCancelTrainedModelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelTrainedModel 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 invokeThrowable.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:
-
cancelTrainedModelInferenceJob
default CompletableFuture<CancelTrainedModelInferenceJobResponse> cancelTrainedModelInferenceJob(CancelTrainedModelInferenceJobRequest cancelTrainedModelInferenceJobRequest) Submits a request to cancel a trained model inference job.
- Parameters:
cancelTrainedModelInferenceJobRequest-- Returns:
- A Java Future containing the result of the CancelTrainedModelInferenceJob 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 invokeThrowable.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:
-
cancelTrainedModelInferenceJob
default CompletableFuture<CancelTrainedModelInferenceJobResponse> cancelTrainedModelInferenceJob(Consumer<CancelTrainedModelInferenceJobRequest.Builder> cancelTrainedModelInferenceJobRequest) Submits a request to cancel a trained model inference job.
This is a convenience which creates an instance of the
CancelTrainedModelInferenceJobRequest.Builderavoiding the need to create one manually viaCancelTrainedModelInferenceJobRequest.builder()- Parameters:
cancelTrainedModelInferenceJobRequest- AConsumerthat will call methods onCancelTrainedModelInferenceJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelTrainedModelInferenceJob 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 invokeThrowable.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:
-
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 invokeThrowable.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.Builderavoiding the need to create one manually viaCreateAudienceModelRequest.builder()- Parameters:
createAudienceModelRequest- AConsumerthat will call methods onCreateAudienceModelRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaCreateConfiguredAudienceModelRequest.builder()- Parameters:
createConfiguredAudienceModelRequest- AConsumerthat will call methods onCreateConfiguredAudienceModelRequest.Builderto 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 invokeThrowable.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:
-
createConfiguredModelAlgorithm
default CompletableFuture<CreateConfiguredModelAlgorithmResponse> createConfiguredModelAlgorithm(CreateConfiguredModelAlgorithmRequest createConfiguredModelAlgorithmRequest) Creates a configured model algorithm using a container image stored in an ECR repository.
- Parameters:
createConfiguredModelAlgorithmRequest-- Returns:
- A Java Future containing the result of the CreateConfiguredModelAlgorithm 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 invokeThrowable.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.
- 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:
-
createConfiguredModelAlgorithm
default CompletableFuture<CreateConfiguredModelAlgorithmResponse> createConfiguredModelAlgorithm(Consumer<CreateConfiguredModelAlgorithmRequest.Builder> createConfiguredModelAlgorithmRequest) Creates a configured model algorithm using a container image stored in an ECR repository.
This is a convenience which creates an instance of the
CreateConfiguredModelAlgorithmRequest.Builderavoiding the need to create one manually viaCreateConfiguredModelAlgorithmRequest.builder()- Parameters:
createConfiguredModelAlgorithmRequest- AConsumerthat will call methods onCreateConfiguredModelAlgorithmRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateConfiguredModelAlgorithm 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 invokeThrowable.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.
- 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:
-
createConfiguredModelAlgorithmAssociation
default CompletableFuture<CreateConfiguredModelAlgorithmAssociationResponse> createConfiguredModelAlgorithmAssociation(CreateConfiguredModelAlgorithmAssociationRequest createConfiguredModelAlgorithmAssociationRequest) Associates a configured model algorithm to a collaboration for use by any member of the collaboration.
- Parameters:
createConfiguredModelAlgorithmAssociationRequest-- Returns:
- A Java Future containing the result of the CreateConfiguredModelAlgorithmAssociation 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 invokeThrowable.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:
-
createConfiguredModelAlgorithmAssociation
default CompletableFuture<CreateConfiguredModelAlgorithmAssociationResponse> createConfiguredModelAlgorithmAssociation(Consumer<CreateConfiguredModelAlgorithmAssociationRequest.Builder> createConfiguredModelAlgorithmAssociationRequest) Associates a configured model algorithm to a collaboration for use by any member of the collaboration.
This is a convenience which creates an instance of the
CreateConfiguredModelAlgorithmAssociationRequest.Builderavoiding the need to create one manually viaCreateConfiguredModelAlgorithmAssociationRequest.builder()- Parameters:
createConfiguredModelAlgorithmAssociationRequest- AConsumerthat will call methods onCreateConfiguredModelAlgorithmAssociationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateConfiguredModelAlgorithmAssociation 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 invokeThrowable.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:
-
createMLInputChannel
default CompletableFuture<CreateMlInputChannelResponse> createMLInputChannel(CreateMlInputChannelRequest createMlInputChannelRequest) Provides the information to create an ML input channel. An ML input channel is the result of a query that can be used for ML modeling.
- Parameters:
createMlInputChannelRequest-- Returns:
- A Java Future containing the result of the CreateMLInputChannel 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 invokeThrowable.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:
-
createMLInputChannel
default CompletableFuture<CreateMlInputChannelResponse> createMLInputChannel(Consumer<CreateMlInputChannelRequest.Builder> createMlInputChannelRequest) Provides the information to create an ML input channel. An ML input channel is the result of a query that can be used for ML modeling.
This is a convenience which creates an instance of the
CreateMlInputChannelRequest.Builderavoiding the need to create one manually viaCreateMlInputChannelRequest.builder()- Parameters:
createMlInputChannelRequest- AConsumerthat will call methods onCreateMlInputChannelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateMLInputChannel 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 invokeThrowable.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:
-
createTrainedModel
default CompletableFuture<CreateTrainedModelResponse> createTrainedModel(CreateTrainedModelRequest createTrainedModelRequest) Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.
- Parameters:
createTrainedModelRequest-- Returns:
- A Java Future containing the result of the CreateTrainedModel 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 invokeThrowable.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:
-
createTrainedModel
default CompletableFuture<CreateTrainedModelResponse> createTrainedModel(Consumer<CreateTrainedModelRequest.Builder> createTrainedModelRequest) Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.
This is a convenience which creates an instance of the
CreateTrainedModelRequest.Builderavoiding the need to create one manually viaCreateTrainedModelRequest.builder()- Parameters:
createTrainedModelRequest- AConsumerthat will call methods onCreateTrainedModelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateTrainedModel 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 invokeThrowable.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
TrainingDatasetis metadata that points to a Glue table, which is read only duringAudienceModelcreation.- 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 invokeThrowable.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
TrainingDatasetis metadata that points to a Glue table, which is read only duringAudienceModelcreation.
This is a convenience which creates an instance of the
CreateTrainingDatasetRequest.Builderavoiding the need to create one manually viaCreateTrainingDatasetRequest.builder()- Parameters:
createTrainingDatasetRequest- AConsumerthat will call methods onCreateTrainingDatasetRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaDeleteAudienceGenerationJobRequest.builder()- Parameters:
deleteAudienceGenerationJobRequest- AConsumerthat will call methods onDeleteAudienceGenerationJobRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaDeleteAudienceModelRequest.builder()- Parameters:
deleteAudienceModelRequest- AConsumerthat will call methods onDeleteAudienceModelRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaDeleteConfiguredAudienceModelRequest.builder()- Parameters:
deleteConfiguredAudienceModelRequest- AConsumerthat will call methods onDeleteConfiguredAudienceModelRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaDeleteConfiguredAudienceModelPolicyRequest.builder()- Parameters:
deleteConfiguredAudienceModelPolicyRequest- AConsumerthat will call methods onDeleteConfiguredAudienceModelPolicyRequest.Builderto 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 invokeThrowable.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:
-
deleteConfiguredModelAlgorithm
default CompletableFuture<DeleteConfiguredModelAlgorithmResponse> deleteConfiguredModelAlgorithm(DeleteConfiguredModelAlgorithmRequest deleteConfiguredModelAlgorithmRequest) Deletes a configured model algorithm.
- Parameters:
deleteConfiguredModelAlgorithmRequest-- Returns:
- A Java Future containing the result of the DeleteConfiguredModelAlgorithm 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 invokeThrowable.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:
-
deleteConfiguredModelAlgorithm
default CompletableFuture<DeleteConfiguredModelAlgorithmResponse> deleteConfiguredModelAlgorithm(Consumer<DeleteConfiguredModelAlgorithmRequest.Builder> deleteConfiguredModelAlgorithmRequest) Deletes a configured model algorithm.
This is a convenience which creates an instance of the
DeleteConfiguredModelAlgorithmRequest.Builderavoiding the need to create one manually viaDeleteConfiguredModelAlgorithmRequest.builder()- Parameters:
deleteConfiguredModelAlgorithmRequest- AConsumerthat will call methods onDeleteConfiguredModelAlgorithmRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteConfiguredModelAlgorithm 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 invokeThrowable.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:
-
deleteConfiguredModelAlgorithmAssociation
default CompletableFuture<DeleteConfiguredModelAlgorithmAssociationResponse> deleteConfiguredModelAlgorithmAssociation(DeleteConfiguredModelAlgorithmAssociationRequest deleteConfiguredModelAlgorithmAssociationRequest) Deletes a configured model algorithm association.
- Parameters:
deleteConfiguredModelAlgorithmAssociationRequest-- Returns:
- A Java Future containing the result of the DeleteConfiguredModelAlgorithmAssociation 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 invokeThrowable.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:
-
deleteConfiguredModelAlgorithmAssociation
default CompletableFuture<DeleteConfiguredModelAlgorithmAssociationResponse> deleteConfiguredModelAlgorithmAssociation(Consumer<DeleteConfiguredModelAlgorithmAssociationRequest.Builder> deleteConfiguredModelAlgorithmAssociationRequest) Deletes a configured model algorithm association.
This is a convenience which creates an instance of the
DeleteConfiguredModelAlgorithmAssociationRequest.Builderavoiding the need to create one manually viaDeleteConfiguredModelAlgorithmAssociationRequest.builder()- Parameters:
deleteConfiguredModelAlgorithmAssociationRequest- AConsumerthat will call methods onDeleteConfiguredModelAlgorithmAssociationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteConfiguredModelAlgorithmAssociation 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 invokeThrowable.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:
-
deleteMLConfiguration
default CompletableFuture<DeleteMlConfigurationResponse> deleteMLConfiguration(DeleteMlConfigurationRequest deleteMlConfigurationRequest) Deletes a ML modeling configuration.
- Parameters:
deleteMlConfigurationRequest-- Returns:
- A Java Future containing the result of the DeleteMLConfiguration 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 invokeThrowable.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:
-
deleteMLConfiguration
default CompletableFuture<DeleteMlConfigurationResponse> deleteMLConfiguration(Consumer<DeleteMlConfigurationRequest.Builder> deleteMlConfigurationRequest) Deletes a ML modeling configuration.
This is a convenience which creates an instance of the
DeleteMlConfigurationRequest.Builderavoiding the need to create one manually viaDeleteMlConfigurationRequest.builder()- Parameters:
deleteMlConfigurationRequest- AConsumerthat will call methods onDeleteMlConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteMLConfiguration 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 invokeThrowable.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:
-
deleteMLInputChannelData
default CompletableFuture<DeleteMlInputChannelDataResponse> deleteMLInputChannelData(DeleteMlInputChannelDataRequest deleteMlInputChannelDataRequest) Provides the information necessary to delete an ML input channel.
- Parameters:
deleteMlInputChannelDataRequest-- Returns:
- A Java Future containing the result of the DeleteMLInputChannelData 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 invokeThrowable.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:
-
deleteMLInputChannelData
default CompletableFuture<DeleteMlInputChannelDataResponse> deleteMLInputChannelData(Consumer<DeleteMlInputChannelDataRequest.Builder> deleteMlInputChannelDataRequest) Provides the information necessary to delete an ML input channel.
This is a convenience which creates an instance of the
DeleteMlInputChannelDataRequest.Builderavoiding the need to create one manually viaDeleteMlInputChannelDataRequest.builder()- Parameters:
deleteMlInputChannelDataRequest- AConsumerthat will call methods onDeleteMlInputChannelDataRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteMLInputChannelData 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 invokeThrowable.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:
-
deleteTrainedModelOutput
default CompletableFuture<DeleteTrainedModelOutputResponse> deleteTrainedModelOutput(DeleteTrainedModelOutputRequest deleteTrainedModelOutputRequest) Deletes the output of a trained model.
- Parameters:
deleteTrainedModelOutputRequest-- Returns:
- A Java Future containing the result of the DeleteTrainedModelOutput 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 invokeThrowable.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:
-
deleteTrainedModelOutput
default CompletableFuture<DeleteTrainedModelOutputResponse> deleteTrainedModelOutput(Consumer<DeleteTrainedModelOutputRequest.Builder> deleteTrainedModelOutputRequest) Deletes the output of a trained model.
This is a convenience which creates an instance of the
DeleteTrainedModelOutputRequest.Builderavoiding the need to create one manually viaDeleteTrainedModelOutputRequest.builder()- Parameters:
deleteTrainedModelOutputRequest- AConsumerthat will call methods onDeleteTrainedModelOutputRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTrainedModelOutput 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 invokeThrowable.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(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
TrainingDatasetis metadata that points to a Glue table, which is read only duringAudienceModelcreation. 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 invokeThrowable.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
TrainingDatasetis metadata that points to a Glue table, which is read only duringAudienceModelcreation. This action deletes the metadata.
This is a convenience which creates an instance of the
DeleteTrainingDatasetRequest.Builderavoiding the need to create one manually viaDeleteTrainingDatasetRequest.builder()- Parameters:
deleteTrainingDatasetRequest- AConsumerthat will call methods onDeleteTrainingDatasetRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaGetAudienceGenerationJobRequest.builder()- Parameters:
getAudienceGenerationJobRequest- AConsumerthat will call methods onGetAudienceGenerationJobRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaGetAudienceModelRequest.builder()- Parameters:
getAudienceModelRequest- AConsumerthat will call methods onGetAudienceModelRequest.Builderto 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 invokeThrowable.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:
-
getCollaborationConfiguredModelAlgorithmAssociation
default CompletableFuture<GetCollaborationConfiguredModelAlgorithmAssociationResponse> getCollaborationConfiguredModelAlgorithmAssociation(GetCollaborationConfiguredModelAlgorithmAssociationRequest getCollaborationConfiguredModelAlgorithmAssociationRequest) Returns information about the configured model algorithm association in a collaboration.
- Parameters:
getCollaborationConfiguredModelAlgorithmAssociationRequest-- Returns:
- A Java Future containing the result of the GetCollaborationConfiguredModelAlgorithmAssociation 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 invokeThrowable.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:
-
getCollaborationConfiguredModelAlgorithmAssociation
default CompletableFuture<GetCollaborationConfiguredModelAlgorithmAssociationResponse> getCollaborationConfiguredModelAlgorithmAssociation(Consumer<GetCollaborationConfiguredModelAlgorithmAssociationRequest.Builder> getCollaborationConfiguredModelAlgorithmAssociationRequest) Returns information about the configured model algorithm association in a collaboration.
This is a convenience which creates an instance of the
GetCollaborationConfiguredModelAlgorithmAssociationRequest.Builderavoiding the need to create one manually viaGetCollaborationConfiguredModelAlgorithmAssociationRequest.builder()- Parameters:
getCollaborationConfiguredModelAlgorithmAssociationRequest- AConsumerthat will call methods onGetCollaborationConfiguredModelAlgorithmAssociationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetCollaborationConfiguredModelAlgorithmAssociation 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 invokeThrowable.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:
-
getCollaborationMLInputChannel
default CompletableFuture<GetCollaborationMlInputChannelResponse> getCollaborationMLInputChannel(GetCollaborationMlInputChannelRequest getCollaborationMlInputChannelRequest) Returns information about a specific ML input channel in a collaboration.
- Parameters:
getCollaborationMlInputChannelRequest-- Returns:
- A Java Future containing the result of the GetCollaborationMLInputChannel 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 invokeThrowable.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:
-
getCollaborationMLInputChannel
default CompletableFuture<GetCollaborationMlInputChannelResponse> getCollaborationMLInputChannel(Consumer<GetCollaborationMlInputChannelRequest.Builder> getCollaborationMlInputChannelRequest) Returns information about a specific ML input channel in a collaboration.
This is a convenience which creates an instance of the
GetCollaborationMlInputChannelRequest.Builderavoiding the need to create one manually viaGetCollaborationMlInputChannelRequest.builder()- Parameters:
getCollaborationMlInputChannelRequest- AConsumerthat will call methods onGetCollaborationMlInputChannelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetCollaborationMLInputChannel 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 invokeThrowable.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:
-
getCollaborationTrainedModel
default CompletableFuture<GetCollaborationTrainedModelResponse> getCollaborationTrainedModel(GetCollaborationTrainedModelRequest getCollaborationTrainedModelRequest) Returns information about a trained model in a collaboration.
- Parameters:
getCollaborationTrainedModelRequest-- Returns:
- A Java Future containing the result of the GetCollaborationTrainedModel 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 invokeThrowable.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:
-
getCollaborationTrainedModel
default CompletableFuture<GetCollaborationTrainedModelResponse> getCollaborationTrainedModel(Consumer<GetCollaborationTrainedModelRequest.Builder> getCollaborationTrainedModelRequest) Returns information about a trained model in a collaboration.
This is a convenience which creates an instance of the
GetCollaborationTrainedModelRequest.Builderavoiding the need to create one manually viaGetCollaborationTrainedModelRequest.builder()- Parameters:
getCollaborationTrainedModelRequest- AConsumerthat will call methods onGetCollaborationTrainedModelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetCollaborationTrainedModel 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaGetConfiguredAudienceModelRequest.builder()- Parameters:
getConfiguredAudienceModelRequest- AConsumerthat will call methods onGetConfiguredAudienceModelRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaGetConfiguredAudienceModelPolicyRequest.builder()- Parameters:
getConfiguredAudienceModelPolicyRequest- AConsumerthat will call methods onGetConfiguredAudienceModelPolicyRequest.Builderto 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 invokeThrowable.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:
-
getConfiguredModelAlgorithm
default CompletableFuture<GetConfiguredModelAlgorithmResponse> getConfiguredModelAlgorithm(GetConfiguredModelAlgorithmRequest getConfiguredModelAlgorithmRequest) Returns information about a configured model algorithm.
- Parameters:
getConfiguredModelAlgorithmRequest-- Returns:
- A Java Future containing the result of the GetConfiguredModelAlgorithm 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 invokeThrowable.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:
-
getConfiguredModelAlgorithm
default CompletableFuture<GetConfiguredModelAlgorithmResponse> getConfiguredModelAlgorithm(Consumer<GetConfiguredModelAlgorithmRequest.Builder> getConfiguredModelAlgorithmRequest) Returns information about a configured model algorithm.
This is a convenience which creates an instance of the
GetConfiguredModelAlgorithmRequest.Builderavoiding the need to create one manually viaGetConfiguredModelAlgorithmRequest.builder()- Parameters:
getConfiguredModelAlgorithmRequest- AConsumerthat will call methods onGetConfiguredModelAlgorithmRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetConfiguredModelAlgorithm 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 invokeThrowable.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:
-
getConfiguredModelAlgorithmAssociation
default CompletableFuture<GetConfiguredModelAlgorithmAssociationResponse> getConfiguredModelAlgorithmAssociation(GetConfiguredModelAlgorithmAssociationRequest getConfiguredModelAlgorithmAssociationRequest) Returns information about a configured model algorithm association.
- Parameters:
getConfiguredModelAlgorithmAssociationRequest-- Returns:
- A Java Future containing the result of the GetConfiguredModelAlgorithmAssociation 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 invokeThrowable.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:
-
getConfiguredModelAlgorithmAssociation
default CompletableFuture<GetConfiguredModelAlgorithmAssociationResponse> getConfiguredModelAlgorithmAssociation(Consumer<GetConfiguredModelAlgorithmAssociationRequest.Builder> getConfiguredModelAlgorithmAssociationRequest) Returns information about a configured model algorithm association.
This is a convenience which creates an instance of the
GetConfiguredModelAlgorithmAssociationRequest.Builderavoiding the need to create one manually viaGetConfiguredModelAlgorithmAssociationRequest.builder()- Parameters:
getConfiguredModelAlgorithmAssociationRequest- AConsumerthat will call methods onGetConfiguredModelAlgorithmAssociationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetConfiguredModelAlgorithmAssociation 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 invokeThrowable.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:
-
getMLConfiguration
default CompletableFuture<GetMlConfigurationResponse> getMLConfiguration(GetMlConfigurationRequest getMlConfigurationRequest) Returns information about a specific ML configuration.
- Parameters:
getMlConfigurationRequest-- Returns:
- A Java Future containing the result of the GetMLConfiguration 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 invokeThrowable.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:
-
getMLConfiguration
default CompletableFuture<GetMlConfigurationResponse> getMLConfiguration(Consumer<GetMlConfigurationRequest.Builder> getMlConfigurationRequest) Returns information about a specific ML configuration.
This is a convenience which creates an instance of the
GetMlConfigurationRequest.Builderavoiding the need to create one manually viaGetMlConfigurationRequest.builder()- Parameters:
getMlConfigurationRequest- AConsumerthat will call methods onGetMlConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetMLConfiguration 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 invokeThrowable.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:
-
getMLInputChannel
default CompletableFuture<GetMlInputChannelResponse> getMLInputChannel(GetMlInputChannelRequest getMlInputChannelRequest) Returns information about an ML input channel.
- Parameters:
getMlInputChannelRequest-- Returns:
- A Java Future containing the result of the GetMLInputChannel 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 invokeThrowable.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:
-
getMLInputChannel
default CompletableFuture<GetMlInputChannelResponse> getMLInputChannel(Consumer<GetMlInputChannelRequest.Builder> getMlInputChannelRequest) Returns information about an ML input channel.
This is a convenience which creates an instance of the
GetMlInputChannelRequest.Builderavoiding the need to create one manually viaGetMlInputChannelRequest.builder()- Parameters:
getMlInputChannelRequest- AConsumerthat will call methods onGetMlInputChannelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetMLInputChannel 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 invokeThrowable.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:
-
getTrainedModel
default CompletableFuture<GetTrainedModelResponse> getTrainedModel(GetTrainedModelRequest getTrainedModelRequest) Returns information about a trained model.
- Parameters:
getTrainedModelRequest-- Returns:
- A Java Future containing the result of the GetTrainedModel 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 invokeThrowable.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:
-
getTrainedModel
default CompletableFuture<GetTrainedModelResponse> getTrainedModel(Consumer<GetTrainedModelRequest.Builder> getTrainedModelRequest) Returns information about a trained model.
This is a convenience which creates an instance of the
GetTrainedModelRequest.Builderavoiding the need to create one manually viaGetTrainedModelRequest.builder()- Parameters:
getTrainedModelRequest- AConsumerthat will call methods onGetTrainedModelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTrainedModel 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 invokeThrowable.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:
-
getTrainedModelInferenceJob
default CompletableFuture<GetTrainedModelInferenceJobResponse> getTrainedModelInferenceJob(GetTrainedModelInferenceJobRequest getTrainedModelInferenceJobRequest) Returns information about a trained model inference job.
- Parameters:
getTrainedModelInferenceJobRequest-- Returns:
- A Java Future containing the result of the GetTrainedModelInferenceJob 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 invokeThrowable.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:
-
getTrainedModelInferenceJob
default CompletableFuture<GetTrainedModelInferenceJobResponse> getTrainedModelInferenceJob(Consumer<GetTrainedModelInferenceJobRequest.Builder> getTrainedModelInferenceJobRequest) Returns information about a trained model inference job.
This is a convenience which creates an instance of the
GetTrainedModelInferenceJobRequest.Builderavoiding the need to create one manually viaGetTrainedModelInferenceJobRequest.builder()- Parameters:
getTrainedModelInferenceJobRequest- AConsumerthat will call methods onGetTrainedModelInferenceJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTrainedModelInferenceJob 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaGetTrainingDatasetRequest.builder()- Parameters:
getTrainingDatasetRequest- AConsumerthat will call methods onGetTrainingDatasetRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaListAudienceExportJobsRequest.builder()- Parameters:
listAudienceExportJobsRequest- AConsumerthat will call methods onListAudienceExportJobsRequest.Builderto 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsPublisher publisher = client.listAudienceExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsPublisher publisher = client.listAudienceExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAudienceExportJobsRequest.builder()- Parameters:
listAudienceExportJobsRequest- AConsumerthat will call methods onListAudienceExportJobsRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaListAudienceGenerationJobsRequest.builder()- Parameters:
listAudienceGenerationJobsRequest- AConsumerthat will call methods onListAudienceGenerationJobsRequest.Builderto 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsPublisher publisher = client.listAudienceGenerationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsPublisher publisher = client.listAudienceGenerationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAudienceGenerationJobsRequest.builder()- Parameters:
listAudienceGenerationJobsRequest- AConsumerthat will call methods onListAudienceGenerationJobsRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaListAudienceModelsRequest.builder()- Parameters:
listAudienceModelsRequest- AConsumerthat will call methods onListAudienceModelsRequest.Builderto 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsPublisher publisher = client.listAudienceModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsPublisher publisher = client.listAudienceModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAudienceModelsRequest.builder()- Parameters:
listAudienceModelsRequest- AConsumerthat will call methods onListAudienceModelsRequest.Builderto 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 invokeThrowable.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:
-
listCollaborationConfiguredModelAlgorithmAssociations
default CompletableFuture<ListCollaborationConfiguredModelAlgorithmAssociationsResponse> listCollaborationConfiguredModelAlgorithmAssociations(ListCollaborationConfiguredModelAlgorithmAssociationsRequest listCollaborationConfiguredModelAlgorithmAssociationsRequest) Returns a list of the configured model algorithm associations in a collaboration.
- Parameters:
listCollaborationConfiguredModelAlgorithmAssociationsRequest-- Returns:
- A Java Future containing the result of the ListCollaborationConfiguredModelAlgorithmAssociations
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 invokeThrowable.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:
-
listCollaborationConfiguredModelAlgorithmAssociations
default CompletableFuture<ListCollaborationConfiguredModelAlgorithmAssociationsResponse> listCollaborationConfiguredModelAlgorithmAssociations(Consumer<ListCollaborationConfiguredModelAlgorithmAssociationsRequest.Builder> listCollaborationConfiguredModelAlgorithmAssociationsRequest) Returns a list of the configured model algorithm associations in a collaboration.
This is a convenience which creates an instance of the
ListCollaborationConfiguredModelAlgorithmAssociationsRequest.Builderavoiding the need to create one manually viaListCollaborationConfiguredModelAlgorithmAssociationsRequest.builder()- Parameters:
listCollaborationConfiguredModelAlgorithmAssociationsRequest- AConsumerthat will call methods onListCollaborationConfiguredModelAlgorithmAssociationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListCollaborationConfiguredModelAlgorithmAssociations
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 invokeThrowable.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:
-
listCollaborationConfiguredModelAlgorithmAssociationsPaginator
default ListCollaborationConfiguredModelAlgorithmAssociationsPublisher listCollaborationConfiguredModelAlgorithmAssociationsPaginator(ListCollaborationConfiguredModelAlgorithmAssociationsRequest listCollaborationConfiguredModelAlgorithmAssociationsRequest) This is a variant of
listCollaborationConfiguredModelAlgorithmAssociations(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationConfiguredModelAlgorithmAssociationsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationConfiguredModelAlgorithmAssociationsPublisher publisher = client.listCollaborationConfiguredModelAlgorithmAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationConfiguredModelAlgorithmAssociationsPublisher publisher = client.listCollaborationConfiguredModelAlgorithmAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationConfiguredModelAlgorithmAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationConfiguredModelAlgorithmAssociationsResponse response) { //... }; });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
listCollaborationConfiguredModelAlgorithmAssociations(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationConfiguredModelAlgorithmAssociationsRequest)operation.- Parameters:
listCollaborationConfiguredModelAlgorithmAssociationsRequest-- 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 invokeThrowable.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:
-
listCollaborationConfiguredModelAlgorithmAssociationsPaginator
default ListCollaborationConfiguredModelAlgorithmAssociationsPublisher listCollaborationConfiguredModelAlgorithmAssociationsPaginator(Consumer<ListCollaborationConfiguredModelAlgorithmAssociationsRequest.Builder> listCollaborationConfiguredModelAlgorithmAssociationsRequest) This is a variant of
listCollaborationConfiguredModelAlgorithmAssociations(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationConfiguredModelAlgorithmAssociationsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationConfiguredModelAlgorithmAssociationsPublisher publisher = client.listCollaborationConfiguredModelAlgorithmAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationConfiguredModelAlgorithmAssociationsPublisher publisher = client.listCollaborationConfiguredModelAlgorithmAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationConfiguredModelAlgorithmAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationConfiguredModelAlgorithmAssociationsResponse response) { //... }; });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
listCollaborationConfiguredModelAlgorithmAssociations(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationConfiguredModelAlgorithmAssociationsRequest)operation.
This is a convenience which creates an instance of the
ListCollaborationConfiguredModelAlgorithmAssociationsRequest.Builderavoiding the need to create one manually viaListCollaborationConfiguredModelAlgorithmAssociationsRequest.builder()- Parameters:
listCollaborationConfiguredModelAlgorithmAssociationsRequest- AConsumerthat will call methods onListCollaborationConfiguredModelAlgorithmAssociationsRequest.Builderto 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 invokeThrowable.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:
-
listCollaborationMLInputChannels
default CompletableFuture<ListCollaborationMlInputChannelsResponse> listCollaborationMLInputChannels(ListCollaborationMlInputChannelsRequest listCollaborationMlInputChannelsRequest) Returns a list of the ML input channels in a collaboration.
- Parameters:
listCollaborationMlInputChannelsRequest-- Returns:
- A Java Future containing the result of the ListCollaborationMLInputChannels 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 invokeThrowable.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:
-
listCollaborationMLInputChannels
default CompletableFuture<ListCollaborationMlInputChannelsResponse> listCollaborationMLInputChannels(Consumer<ListCollaborationMlInputChannelsRequest.Builder> listCollaborationMlInputChannelsRequest) Returns a list of the ML input channels in a collaboration.
This is a convenience which creates an instance of the
ListCollaborationMlInputChannelsRequest.Builderavoiding the need to create one manually viaListCollaborationMlInputChannelsRequest.builder()- Parameters:
listCollaborationMlInputChannelsRequest- AConsumerthat will call methods onListCollaborationMlInputChannelsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListCollaborationMLInputChannels 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 invokeThrowable.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:
-
listCollaborationMLInputChannelsPaginator
default ListCollaborationMLInputChannelsPublisher listCollaborationMLInputChannelsPaginator(ListCollaborationMlInputChannelsRequest listCollaborationMlInputChannelsRequest) This is a variant of
listCollaborationMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationMLInputChannelsPublisher publisher = client.listCollaborationMLInputChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationMLInputChannelsPublisher publisher = client.listCollaborationMLInputChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsResponse response) { //... }; });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
listCollaborationMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsRequest)operation.- Parameters:
listCollaborationMlInputChannelsRequest-- 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 invokeThrowable.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:
-
listCollaborationMLInputChannelsPaginator
default ListCollaborationMLInputChannelsPublisher listCollaborationMLInputChannelsPaginator(Consumer<ListCollaborationMlInputChannelsRequest.Builder> listCollaborationMlInputChannelsRequest) This is a variant of
listCollaborationMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationMLInputChannelsPublisher publisher = client.listCollaborationMLInputChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationMLInputChannelsPublisher publisher = client.listCollaborationMLInputChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsResponse response) { //... }; });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
listCollaborationMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationMlInputChannelsRequest)operation.
This is a convenience which creates an instance of the
ListCollaborationMlInputChannelsRequest.Builderavoiding the need to create one manually viaListCollaborationMlInputChannelsRequest.builder()- Parameters:
listCollaborationMlInputChannelsRequest- AConsumerthat will call methods onListCollaborationMlInputChannelsRequest.Builderto 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 invokeThrowable.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:
-
listCollaborationTrainedModelExportJobs
default CompletableFuture<ListCollaborationTrainedModelExportJobsResponse> listCollaborationTrainedModelExportJobs(ListCollaborationTrainedModelExportJobsRequest listCollaborationTrainedModelExportJobsRequest) Returns a list of the export jobs for a trained model in a collaboration.
- Parameters:
listCollaborationTrainedModelExportJobsRequest-- Returns:
- A Java Future containing the result of the ListCollaborationTrainedModelExportJobs 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 invokeThrowable.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:
-
listCollaborationTrainedModelExportJobs
default CompletableFuture<ListCollaborationTrainedModelExportJobsResponse> listCollaborationTrainedModelExportJobs(Consumer<ListCollaborationTrainedModelExportJobsRequest.Builder> listCollaborationTrainedModelExportJobsRequest) Returns a list of the export jobs for a trained model in a collaboration.
This is a convenience which creates an instance of the
ListCollaborationTrainedModelExportJobsRequest.Builderavoiding the need to create one manually viaListCollaborationTrainedModelExportJobsRequest.builder()- Parameters:
listCollaborationTrainedModelExportJobsRequest- AConsumerthat will call methods onListCollaborationTrainedModelExportJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListCollaborationTrainedModelExportJobs 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 invokeThrowable.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:
-
listCollaborationTrainedModelExportJobsPaginator
default ListCollaborationTrainedModelExportJobsPublisher listCollaborationTrainedModelExportJobsPaginator(ListCollaborationTrainedModelExportJobsRequest listCollaborationTrainedModelExportJobsRequest) This is a variant of
listCollaborationTrainedModelExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelExportJobsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelExportJobsPublisher publisher = client.listCollaborationTrainedModelExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelExportJobsPublisher publisher = client.listCollaborationTrainedModelExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelExportJobsResponse response) { //... }; });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
listCollaborationTrainedModelExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelExportJobsRequest)operation.- Parameters:
listCollaborationTrainedModelExportJobsRequest-- 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 invokeThrowable.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:
-
listCollaborationTrainedModelExportJobsPaginator
default ListCollaborationTrainedModelExportJobsPublisher listCollaborationTrainedModelExportJobsPaginator(Consumer<ListCollaborationTrainedModelExportJobsRequest.Builder> listCollaborationTrainedModelExportJobsRequest) This is a variant of
listCollaborationTrainedModelExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelExportJobsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelExportJobsPublisher publisher = client.listCollaborationTrainedModelExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelExportJobsPublisher publisher = client.listCollaborationTrainedModelExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelExportJobsResponse response) { //... }; });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
listCollaborationTrainedModelExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelExportJobsRequest)operation.
This is a convenience which creates an instance of the
ListCollaborationTrainedModelExportJobsRequest.Builderavoiding the need to create one manually viaListCollaborationTrainedModelExportJobsRequest.builder()- Parameters:
listCollaborationTrainedModelExportJobsRequest- AConsumerthat will call methods onListCollaborationTrainedModelExportJobsRequest.Builderto 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 invokeThrowable.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:
-
listCollaborationTrainedModelInferenceJobs
default CompletableFuture<ListCollaborationTrainedModelInferenceJobsResponse> listCollaborationTrainedModelInferenceJobs(ListCollaborationTrainedModelInferenceJobsRequest listCollaborationTrainedModelInferenceJobsRequest) Returns a list of trained model inference jobs in a specified collaboration.
- Parameters:
listCollaborationTrainedModelInferenceJobsRequest-- Returns:
- A Java Future containing the result of the ListCollaborationTrainedModelInferenceJobs 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 invokeThrowable.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:
-
listCollaborationTrainedModelInferenceJobs
default CompletableFuture<ListCollaborationTrainedModelInferenceJobsResponse> listCollaborationTrainedModelInferenceJobs(Consumer<ListCollaborationTrainedModelInferenceJobsRequest.Builder> listCollaborationTrainedModelInferenceJobsRequest) Returns a list of trained model inference jobs in a specified collaboration.
This is a convenience which creates an instance of the
ListCollaborationTrainedModelInferenceJobsRequest.Builderavoiding the need to create one manually viaListCollaborationTrainedModelInferenceJobsRequest.builder()- Parameters:
listCollaborationTrainedModelInferenceJobsRequest- AConsumerthat will call methods onListCollaborationTrainedModelInferenceJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListCollaborationTrainedModelInferenceJobs 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 invokeThrowable.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:
-
listCollaborationTrainedModelInferenceJobsPaginator
default ListCollaborationTrainedModelInferenceJobsPublisher listCollaborationTrainedModelInferenceJobsPaginator(ListCollaborationTrainedModelInferenceJobsRequest listCollaborationTrainedModelInferenceJobsRequest) This is a variant of
listCollaborationTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelInferenceJobsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelInferenceJobsPublisher publisher = client.listCollaborationTrainedModelInferenceJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelInferenceJobsPublisher publisher = client.listCollaborationTrainedModelInferenceJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelInferenceJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelInferenceJobsResponse response) { //... }; });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
listCollaborationTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelInferenceJobsRequest)operation.- Parameters:
listCollaborationTrainedModelInferenceJobsRequest-- 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 invokeThrowable.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:
-
listCollaborationTrainedModelInferenceJobsPaginator
default ListCollaborationTrainedModelInferenceJobsPublisher listCollaborationTrainedModelInferenceJobsPaginator(Consumer<ListCollaborationTrainedModelInferenceJobsRequest.Builder> listCollaborationTrainedModelInferenceJobsRequest) This is a variant of
listCollaborationTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelInferenceJobsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelInferenceJobsPublisher publisher = client.listCollaborationTrainedModelInferenceJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelInferenceJobsPublisher publisher = client.listCollaborationTrainedModelInferenceJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelInferenceJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelInferenceJobsResponse response) { //... }; });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
listCollaborationTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelInferenceJobsRequest)operation.
This is a convenience which creates an instance of the
ListCollaborationTrainedModelInferenceJobsRequest.Builderavoiding the need to create one manually viaListCollaborationTrainedModelInferenceJobsRequest.builder()- Parameters:
listCollaborationTrainedModelInferenceJobsRequest- AConsumerthat will call methods onListCollaborationTrainedModelInferenceJobsRequest.Builderto 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 invokeThrowable.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:
-
listCollaborationTrainedModels
default CompletableFuture<ListCollaborationTrainedModelsResponse> listCollaborationTrainedModels(ListCollaborationTrainedModelsRequest listCollaborationTrainedModelsRequest) Returns a list of the trained models in a collaboration.
- Parameters:
listCollaborationTrainedModelsRequest-- Returns:
- A Java Future containing the result of the ListCollaborationTrainedModels 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 invokeThrowable.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:
-
listCollaborationTrainedModels
default CompletableFuture<ListCollaborationTrainedModelsResponse> listCollaborationTrainedModels(Consumer<ListCollaborationTrainedModelsRequest.Builder> listCollaborationTrainedModelsRequest) Returns a list of the trained models in a collaboration.
This is a convenience which creates an instance of the
ListCollaborationTrainedModelsRequest.Builderavoiding the need to create one manually viaListCollaborationTrainedModelsRequest.builder()- Parameters:
listCollaborationTrainedModelsRequest- AConsumerthat will call methods onListCollaborationTrainedModelsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListCollaborationTrainedModels 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 invokeThrowable.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:
-
listCollaborationTrainedModelsPaginator
default ListCollaborationTrainedModelsPublisher listCollaborationTrainedModelsPaginator(ListCollaborationTrainedModelsRequest listCollaborationTrainedModelsRequest) This is a variant of
listCollaborationTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelsPublisher publisher = client.listCollaborationTrainedModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelsPublisher publisher = client.listCollaborationTrainedModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsResponse response) { //... }; });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
listCollaborationTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsRequest)operation.- Parameters:
listCollaborationTrainedModelsRequest-- 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 invokeThrowable.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:
-
listCollaborationTrainedModelsPaginator
default ListCollaborationTrainedModelsPublisher listCollaborationTrainedModelsPaginator(Consumer<ListCollaborationTrainedModelsRequest.Builder> listCollaborationTrainedModelsRequest) This is a variant of
listCollaborationTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelsPublisher publisher = client.listCollaborationTrainedModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListCollaborationTrainedModelsPublisher publisher = client.listCollaborationTrainedModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsResponse response) { //... }; });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
listCollaborationTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListCollaborationTrainedModelsRequest)operation.
This is a convenience which creates an instance of the
ListCollaborationTrainedModelsRequest.Builderavoiding the need to create one manually viaListCollaborationTrainedModelsRequest.builder()- Parameters:
listCollaborationTrainedModelsRequest- AConsumerthat will call methods onListCollaborationTrainedModelsRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaListConfiguredAudienceModelsRequest.builder()- Parameters:
listConfiguredAudienceModelsRequest- AConsumerthat will call methods onListConfiguredAudienceModelsRequest.Builderto 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsPublisher publisher = client.listConfiguredAudienceModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsPublisher publisher = client.listConfiguredAudienceModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListConfiguredAudienceModelsRequest.builder()- Parameters:
listConfiguredAudienceModelsRequest- AConsumerthat will call methods onListConfiguredAudienceModelsRequest.Builderto 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 invokeThrowable.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:
-
listConfiguredModelAlgorithmAssociations
default CompletableFuture<ListConfiguredModelAlgorithmAssociationsResponse> listConfiguredModelAlgorithmAssociations(ListConfiguredModelAlgorithmAssociationsRequest listConfiguredModelAlgorithmAssociationsRequest) Returns a list of configured model algorithm associations.
- Parameters:
listConfiguredModelAlgorithmAssociationsRequest-- Returns:
- A Java Future containing the result of the ListConfiguredModelAlgorithmAssociations 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 invokeThrowable.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:
-
listConfiguredModelAlgorithmAssociations
default CompletableFuture<ListConfiguredModelAlgorithmAssociationsResponse> listConfiguredModelAlgorithmAssociations(Consumer<ListConfiguredModelAlgorithmAssociationsRequest.Builder> listConfiguredModelAlgorithmAssociationsRequest) Returns a list of configured model algorithm associations.
This is a convenience which creates an instance of the
ListConfiguredModelAlgorithmAssociationsRequest.Builderavoiding the need to create one manually viaListConfiguredModelAlgorithmAssociationsRequest.builder()- Parameters:
listConfiguredModelAlgorithmAssociationsRequest- AConsumerthat will call methods onListConfiguredModelAlgorithmAssociationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListConfiguredModelAlgorithmAssociations 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 invokeThrowable.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:
-
listConfiguredModelAlgorithmAssociationsPaginator
default ListConfiguredModelAlgorithmAssociationsPublisher listConfiguredModelAlgorithmAssociationsPaginator(ListConfiguredModelAlgorithmAssociationsRequest listConfiguredModelAlgorithmAssociationsRequest) This is a variant of
listConfiguredModelAlgorithmAssociations(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmAssociationsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredModelAlgorithmAssociationsPublisher publisher = client.listConfiguredModelAlgorithmAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredModelAlgorithmAssociationsPublisher publisher = client.listConfiguredModelAlgorithmAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmAssociationsResponse response) { //... }; });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
listConfiguredModelAlgorithmAssociations(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmAssociationsRequest)operation.- Parameters:
listConfiguredModelAlgorithmAssociationsRequest-- 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 invokeThrowable.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:
-
listConfiguredModelAlgorithmAssociationsPaginator
default ListConfiguredModelAlgorithmAssociationsPublisher listConfiguredModelAlgorithmAssociationsPaginator(Consumer<ListConfiguredModelAlgorithmAssociationsRequest.Builder> listConfiguredModelAlgorithmAssociationsRequest) This is a variant of
listConfiguredModelAlgorithmAssociations(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmAssociationsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredModelAlgorithmAssociationsPublisher publisher = client.listConfiguredModelAlgorithmAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredModelAlgorithmAssociationsPublisher publisher = client.listConfiguredModelAlgorithmAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmAssociationsResponse response) { //... }; });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
listConfiguredModelAlgorithmAssociations(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmAssociationsRequest)operation.
This is a convenience which creates an instance of the
ListConfiguredModelAlgorithmAssociationsRequest.Builderavoiding the need to create one manually viaListConfiguredModelAlgorithmAssociationsRequest.builder()- Parameters:
listConfiguredModelAlgorithmAssociationsRequest- AConsumerthat will call methods onListConfiguredModelAlgorithmAssociationsRequest.Builderto 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 invokeThrowable.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:
-
listConfiguredModelAlgorithms
default CompletableFuture<ListConfiguredModelAlgorithmsResponse> listConfiguredModelAlgorithms(ListConfiguredModelAlgorithmsRequest listConfiguredModelAlgorithmsRequest) Returns a list of configured model algorithms.
- Parameters:
listConfiguredModelAlgorithmsRequest-- Returns:
- A Java Future containing the result of the ListConfiguredModelAlgorithms 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 invokeThrowable.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:
-
listConfiguredModelAlgorithms
default CompletableFuture<ListConfiguredModelAlgorithmsResponse> listConfiguredModelAlgorithms(Consumer<ListConfiguredModelAlgorithmsRequest.Builder> listConfiguredModelAlgorithmsRequest) Returns a list of configured model algorithms.
This is a convenience which creates an instance of the
ListConfiguredModelAlgorithmsRequest.Builderavoiding the need to create one manually viaListConfiguredModelAlgorithmsRequest.builder()- Parameters:
listConfiguredModelAlgorithmsRequest- AConsumerthat will call methods onListConfiguredModelAlgorithmsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListConfiguredModelAlgorithms 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 invokeThrowable.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:
-
listConfiguredModelAlgorithmsPaginator
default ListConfiguredModelAlgorithmsPublisher listConfiguredModelAlgorithmsPaginator(ListConfiguredModelAlgorithmsRequest listConfiguredModelAlgorithmsRequest) This is a variant of
listConfiguredModelAlgorithms(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredModelAlgorithmsPublisher publisher = client.listConfiguredModelAlgorithmsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredModelAlgorithmsPublisher publisher = client.listConfiguredModelAlgorithmsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsResponse response) { //... }; });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
listConfiguredModelAlgorithms(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsRequest)operation.- Parameters:
listConfiguredModelAlgorithmsRequest-- 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 invokeThrowable.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:
-
listConfiguredModelAlgorithmsPaginator
default ListConfiguredModelAlgorithmsPublisher listConfiguredModelAlgorithmsPaginator(Consumer<ListConfiguredModelAlgorithmsRequest.Builder> listConfiguredModelAlgorithmsRequest) This is a variant of
listConfiguredModelAlgorithms(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredModelAlgorithmsPublisher publisher = client.listConfiguredModelAlgorithmsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredModelAlgorithmsPublisher publisher = client.listConfiguredModelAlgorithmsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsResponse response) { //... }; });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
listConfiguredModelAlgorithms(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredModelAlgorithmsRequest)operation.
This is a convenience which creates an instance of the
ListConfiguredModelAlgorithmsRequest.Builderavoiding the need to create one manually viaListConfiguredModelAlgorithmsRequest.builder()- Parameters:
listConfiguredModelAlgorithmsRequest- AConsumerthat will call methods onListConfiguredModelAlgorithmsRequest.Builderto 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 invokeThrowable.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:
-
listMLInputChannels
default CompletableFuture<ListMlInputChannelsResponse> listMLInputChannels(ListMlInputChannelsRequest listMlInputChannelsRequest) Returns a list of ML input channels.
- Parameters:
listMlInputChannelsRequest-- Returns:
- A Java Future containing the result of the ListMLInputChannels 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 invokeThrowable.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:
-
listMLInputChannels
default CompletableFuture<ListMlInputChannelsResponse> listMLInputChannels(Consumer<ListMlInputChannelsRequest.Builder> listMlInputChannelsRequest) Returns a list of ML input channels.
This is a convenience which creates an instance of the
ListMlInputChannelsRequest.Builderavoiding the need to create one manually viaListMlInputChannelsRequest.builder()- Parameters:
listMlInputChannelsRequest- AConsumerthat will call methods onListMlInputChannelsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListMLInputChannels 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 invokeThrowable.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:
-
listMLInputChannelsPaginator
default ListMLInputChannelsPublisher listMLInputChannelsPaginator(ListMlInputChannelsRequest listMlInputChannelsRequest) This is a variant of
listMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListMLInputChannelsPublisher publisher = client.listMLInputChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListMLInputChannelsPublisher publisher = client.listMLInputChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsResponse response) { //... }; });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
listMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsRequest)operation.- Parameters:
listMlInputChannelsRequest-- 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 invokeThrowable.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:
-
listMLInputChannelsPaginator
default ListMLInputChannelsPublisher listMLInputChannelsPaginator(Consumer<ListMlInputChannelsRequest.Builder> listMlInputChannelsRequest) This is a variant of
listMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListMLInputChannelsPublisher publisher = client.listMLInputChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListMLInputChannelsPublisher publisher = client.listMLInputChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsResponse response) { //... }; });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
listMLInputChannels(software.amazon.awssdk.services.cleanroomsml.model.ListMlInputChannelsRequest)operation.
This is a convenience which creates an instance of the
ListMlInputChannelsRequest.Builderavoiding the need to create one manually viaListMlInputChannelsRequest.builder()- Parameters:
listMlInputChannelsRequest- AConsumerthat will call methods onListMlInputChannelsRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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 invokeThrowable.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:
-
listTrainedModelInferenceJobs
default CompletableFuture<ListTrainedModelInferenceJobsResponse> listTrainedModelInferenceJobs(ListTrainedModelInferenceJobsRequest listTrainedModelInferenceJobsRequest) Returns a list of trained model inference jobs that match the request parameters.
- Parameters:
listTrainedModelInferenceJobsRequest-- Returns:
- A Java Future containing the result of the ListTrainedModelInferenceJobs 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 invokeThrowable.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:
-
listTrainedModelInferenceJobs
default CompletableFuture<ListTrainedModelInferenceJobsResponse> listTrainedModelInferenceJobs(Consumer<ListTrainedModelInferenceJobsRequest.Builder> listTrainedModelInferenceJobsRequest) Returns a list of trained model inference jobs that match the request parameters.
This is a convenience which creates an instance of the
ListTrainedModelInferenceJobsRequest.Builderavoiding the need to create one manually viaListTrainedModelInferenceJobsRequest.builder()- Parameters:
listTrainedModelInferenceJobsRequest- AConsumerthat will call methods onListTrainedModelInferenceJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTrainedModelInferenceJobs 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 invokeThrowable.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:
-
listTrainedModelInferenceJobsPaginator
default ListTrainedModelInferenceJobsPublisher listTrainedModelInferenceJobsPaginator(ListTrainedModelInferenceJobsRequest listTrainedModelInferenceJobsRequest) This is a variant of
listTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListTrainedModelInferenceJobsPublisher publisher = client.listTrainedModelInferenceJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainedModelInferenceJobsPublisher publisher = client.listTrainedModelInferenceJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsResponse response) { //... }; });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
listTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsRequest)operation.- Parameters:
listTrainedModelInferenceJobsRequest-- 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 invokeThrowable.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:
-
listTrainedModelInferenceJobsPaginator
default ListTrainedModelInferenceJobsPublisher listTrainedModelInferenceJobsPaginator(Consumer<ListTrainedModelInferenceJobsRequest.Builder> listTrainedModelInferenceJobsRequest) This is a variant of
listTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListTrainedModelInferenceJobsPublisher publisher = client.listTrainedModelInferenceJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainedModelInferenceJobsPublisher publisher = client.listTrainedModelInferenceJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsResponse response) { //... }; });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
listTrainedModelInferenceJobs(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelInferenceJobsRequest)operation.
This is a convenience which creates an instance of the
ListTrainedModelInferenceJobsRequest.Builderavoiding the need to create one manually viaListTrainedModelInferenceJobsRequest.builder()- Parameters:
listTrainedModelInferenceJobsRequest- AConsumerthat will call methods onListTrainedModelInferenceJobsRequest.Builderto 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 invokeThrowable.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:
-
listTrainedModels
default CompletableFuture<ListTrainedModelsResponse> listTrainedModels(ListTrainedModelsRequest listTrainedModelsRequest) Returns a list of trained models.
- Parameters:
listTrainedModelsRequest-- Returns:
- A Java Future containing the result of the ListTrainedModels 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 invokeThrowable.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:
-
listTrainedModels
default CompletableFuture<ListTrainedModelsResponse> listTrainedModels(Consumer<ListTrainedModelsRequest.Builder> listTrainedModelsRequest) Returns a list of trained models.
This is a convenience which creates an instance of the
ListTrainedModelsRequest.Builderavoiding the need to create one manually viaListTrainedModelsRequest.builder()- Parameters:
listTrainedModelsRequest- AConsumerthat will call methods onListTrainedModelsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTrainedModels 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 invokeThrowable.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:
-
listTrainedModelsPaginator
default ListTrainedModelsPublisher listTrainedModelsPaginator(ListTrainedModelsRequest listTrainedModelsRequest) This is a variant of
listTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListTrainedModelsPublisher publisher = client.listTrainedModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainedModelsPublisher publisher = client.listTrainedModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsResponse response) { //... }; });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
listTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsRequest)operation.- Parameters:
listTrainedModelsRequest-- 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 invokeThrowable.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:
-
listTrainedModelsPaginator
default ListTrainedModelsPublisher listTrainedModelsPaginator(Consumer<ListTrainedModelsRequest.Builder> listTrainedModelsRequest) This is a variant of
listTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListTrainedModelsPublisher publisher = client.listTrainedModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainedModelsPublisher publisher = client.listTrainedModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsResponse response) { //... }; });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
listTrainedModels(software.amazon.awssdk.services.cleanroomsml.model.ListTrainedModelsRequest)operation.
This is a convenience which creates an instance of the
ListTrainedModelsRequest.Builderavoiding the need to create one manually viaListTrainedModelsRequest.builder()- Parameters:
listTrainedModelsRequest- AConsumerthat will call methods onListTrainedModelsRequest.Builderto 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 invokeThrowable.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(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 invokeThrowable.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.Builderavoiding the need to create one manually viaListTrainingDatasetsRequest.builder()- Parameters:
listTrainingDatasetsRequest- AConsumerthat will call methods onListTrainingDatasetsRequest.Builderto 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsPublisher publisher = client.listTrainingDatasetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsPublisher publisher = client.listTrainingDatasetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListTrainingDatasetsRequest.builder()- Parameters:
listTrainingDatasetsRequest- AConsumerthat will call methods onListTrainingDatasetsRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaPutConfiguredAudienceModelPolicyRequest.builder()- Parameters:
putConfiguredAudienceModelPolicyRequest- AConsumerthat will call methods onPutConfiguredAudienceModelPolicyRequest.Builderto 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 invokeThrowable.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:
-
putMLConfiguration
default CompletableFuture<PutMlConfigurationResponse> putMLConfiguration(PutMlConfigurationRequest putMlConfigurationRequest) Assigns information about an ML configuration.
- Parameters:
putMlConfigurationRequest-- Returns:
- A Java Future containing the result of the PutMLConfiguration 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 invokeThrowable.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:
-
putMLConfiguration
default CompletableFuture<PutMlConfigurationResponse> putMLConfiguration(Consumer<PutMlConfigurationRequest.Builder> putMlConfigurationRequest) Assigns information about an ML configuration.
This is a convenience which creates an instance of the
PutMlConfigurationRequest.Builderavoiding the need to create one manually viaPutMlConfigurationRequest.builder()- Parameters:
putMlConfigurationRequest- AConsumerthat will call methods onPutMlConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutMLConfiguration 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 invokeThrowable.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:
-
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 invokeThrowable.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.Builderavoiding the need to create one manually viaStartAudienceExportJobRequest.builder()- Parameters:
startAudienceExportJobRequest- AConsumerthat will call methods onStartAudienceExportJobRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaStartAudienceGenerationJobRequest.builder()- Parameters:
startAudienceGenerationJobRequest- AConsumerthat will call methods onStartAudienceGenerationJobRequest.Builderto 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 invokeThrowable.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:
-
startTrainedModelExportJob
default CompletableFuture<StartTrainedModelExportJobResponse> startTrainedModelExportJob(StartTrainedModelExportJobRequest startTrainedModelExportJobRequest) Provides the information necessary to start a trained model export job.
- Parameters:
startTrainedModelExportJobRequest-- Returns:
- A Java Future containing the result of the StartTrainedModelExportJob 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 invokeThrowable.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:
-
startTrainedModelExportJob
default CompletableFuture<StartTrainedModelExportJobResponse> startTrainedModelExportJob(Consumer<StartTrainedModelExportJobRequest.Builder> startTrainedModelExportJobRequest) Provides the information necessary to start a trained model export job.
This is a convenience which creates an instance of the
StartTrainedModelExportJobRequest.Builderavoiding the need to create one manually viaStartTrainedModelExportJobRequest.builder()- Parameters:
startTrainedModelExportJobRequest- AConsumerthat will call methods onStartTrainedModelExportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartTrainedModelExportJob 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 invokeThrowable.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:
-
startTrainedModelInferenceJob
default CompletableFuture<StartTrainedModelInferenceJobResponse> startTrainedModelInferenceJob(StartTrainedModelInferenceJobRequest startTrainedModelInferenceJobRequest) Defines the information necessary to begin a trained model inference job.
- Parameters:
startTrainedModelInferenceJobRequest-- Returns:
- A Java Future containing the result of the StartTrainedModelInferenceJob 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 invokeThrowable.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:
-
startTrainedModelInferenceJob
default CompletableFuture<StartTrainedModelInferenceJobResponse> startTrainedModelInferenceJob(Consumer<StartTrainedModelInferenceJobRequest.Builder> startTrainedModelInferenceJobRequest) Defines the information necessary to begin a trained model inference job.
This is a convenience which creates an instance of the
StartTrainedModelInferenceJobRequest.Builderavoiding the need to create one manually viaStartTrainedModelInferenceJobRequest.builder()- Parameters:
startTrainedModelInferenceJobRequest- AConsumerthat will call methods onStartTrainedModelInferenceJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartTrainedModelInferenceJob 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 invokeThrowable.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
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 invokeThrowable.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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaUpdateConfiguredAudienceModelRequest.builder()- Parameters:
updateConfiguredAudienceModelRequest- AConsumerthat will call methods onUpdateConfiguredAudienceModelRequest.Builderto 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 invokeThrowable.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
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aCleanRoomsMlAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aCleanRoomsMlAsyncClient.
-