@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCleanRoomsMLAsync extends AWSCleanRoomsML
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCleanRoomsMLAsync instead.
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.
ENDPOINT_PREFIXcreateAudienceModel, createConfiguredAudienceModel, createTrainingDataset, deleteAudienceGenerationJob, deleteAudienceModel, deleteConfiguredAudienceModel, deleteConfiguredAudienceModelPolicy, deleteTrainingDataset, getAudienceGenerationJob, getAudienceModel, getCachedResponseMetadata, getConfiguredAudienceModel, getConfiguredAudienceModelPolicy, getTrainingDataset, listAudienceExportJobs, listAudienceGenerationJobs, listAudienceModels, listConfiguredAudienceModels, listTagsForResource, listTrainingDatasets, putConfiguredAudienceModelPolicy, shutdown, startAudienceExportJob, startAudienceGenerationJob, tagResource, untagResource, updateConfiguredAudienceModelFuture<CreateAudienceModelResult> createAudienceModelAsync(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.
createAudienceModelRequest - Future<CreateAudienceModelResult> createAudienceModelAsync(CreateAudienceModelRequest createAudienceModelRequest, AsyncHandler<CreateAudienceModelRequest,CreateAudienceModelResult> asyncHandler)
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.
createAudienceModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateConfiguredAudienceModelResult> createConfiguredAudienceModelAsync(CreateConfiguredAudienceModelRequest createConfiguredAudienceModelRequest)
Defines the information necessary to create a configured audience model.
createConfiguredAudienceModelRequest - Future<CreateConfiguredAudienceModelResult> createConfiguredAudienceModelAsync(CreateConfiguredAudienceModelRequest createConfiguredAudienceModelRequest, AsyncHandler<CreateConfiguredAudienceModelRequest,CreateConfiguredAudienceModelResult> asyncHandler)
Defines the information necessary to create a configured audience model.
createConfiguredAudienceModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateTrainingDatasetResult> createTrainingDatasetAsync(CreateTrainingDatasetRequest createTrainingDatasetRequest)
Defines the information necessary to create a training dataset. In Clean Rooms ML, the
TrainingDataset is metadata that points to a Glue table, which is read only during
AudienceModel creation.
createTrainingDatasetRequest - Future<CreateTrainingDatasetResult> createTrainingDatasetAsync(CreateTrainingDatasetRequest createTrainingDatasetRequest, AsyncHandler<CreateTrainingDatasetRequest,CreateTrainingDatasetResult> asyncHandler)
Defines the information necessary to create a training dataset. In Clean Rooms ML, the
TrainingDataset is metadata that points to a Glue table, which is read only during
AudienceModel creation.
createTrainingDatasetRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAudienceGenerationJobResult> deleteAudienceGenerationJobAsync(DeleteAudienceGenerationJobRequest deleteAudienceGenerationJobRequest)
Deletes the specified audience generation job, and removes all data associated with the job.
deleteAudienceGenerationJobRequest - Future<DeleteAudienceGenerationJobResult> deleteAudienceGenerationJobAsync(DeleteAudienceGenerationJobRequest deleteAudienceGenerationJobRequest, AsyncHandler<DeleteAudienceGenerationJobRequest,DeleteAudienceGenerationJobResult> asyncHandler)
Deletes the specified audience generation job, and removes all data associated with the job.
deleteAudienceGenerationJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAudienceModelResult> deleteAudienceModelAsync(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.
deleteAudienceModelRequest - Future<DeleteAudienceModelResult> deleteAudienceModelAsync(DeleteAudienceModelRequest deleteAudienceModelRequest, AsyncHandler<DeleteAudienceModelRequest,DeleteAudienceModelResult> asyncHandler)
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.
deleteAudienceModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteConfiguredAudienceModelResult> deleteConfiguredAudienceModelAsync(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.
deleteConfiguredAudienceModelRequest - Future<DeleteConfiguredAudienceModelResult> deleteConfiguredAudienceModelAsync(DeleteConfiguredAudienceModelRequest deleteConfiguredAudienceModelRequest, AsyncHandler<DeleteConfiguredAudienceModelRequest,DeleteConfiguredAudienceModelResult> asyncHandler)
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.
deleteConfiguredAudienceModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteConfiguredAudienceModelPolicyResult> deleteConfiguredAudienceModelPolicyAsync(DeleteConfiguredAudienceModelPolicyRequest deleteConfiguredAudienceModelPolicyRequest)
Deletes the specified configured audience model policy.
deleteConfiguredAudienceModelPolicyRequest - Future<DeleteConfiguredAudienceModelPolicyResult> deleteConfiguredAudienceModelPolicyAsync(DeleteConfiguredAudienceModelPolicyRequest deleteConfiguredAudienceModelPolicyRequest, AsyncHandler<DeleteConfiguredAudienceModelPolicyRequest,DeleteConfiguredAudienceModelPolicyResult> asyncHandler)
Deletes the specified configured audience model policy.
deleteConfiguredAudienceModelPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTrainingDatasetResult> deleteTrainingDatasetAsync(DeleteTrainingDatasetRequest deleteTrainingDatasetRequest)
Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any
audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is
metadata that points to a Glue table, which is read only during AudienceModel creation. This action
deletes the metadata.
deleteTrainingDatasetRequest - Future<DeleteTrainingDatasetResult> deleteTrainingDatasetAsync(DeleteTrainingDatasetRequest deleteTrainingDatasetRequest, AsyncHandler<DeleteTrainingDatasetRequest,DeleteTrainingDatasetResult> asyncHandler)
Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any
audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is
metadata that points to a Glue table, which is read only during AudienceModel creation. This action
deletes the metadata.
deleteTrainingDatasetRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAudienceGenerationJobResult> getAudienceGenerationJobAsync(GetAudienceGenerationJobRequest getAudienceGenerationJobRequest)
Returns information about an audience generation job.
getAudienceGenerationJobRequest - Future<GetAudienceGenerationJobResult> getAudienceGenerationJobAsync(GetAudienceGenerationJobRequest getAudienceGenerationJobRequest, AsyncHandler<GetAudienceGenerationJobRequest,GetAudienceGenerationJobResult> asyncHandler)
Returns information about an audience generation job.
getAudienceGenerationJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAudienceModelResult> getAudienceModelAsync(GetAudienceModelRequest getAudienceModelRequest)
Returns information about an audience model
getAudienceModelRequest - Future<GetAudienceModelResult> getAudienceModelAsync(GetAudienceModelRequest getAudienceModelRequest, AsyncHandler<GetAudienceModelRequest,GetAudienceModelResult> asyncHandler)
Returns information about an audience model
getAudienceModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetConfiguredAudienceModelResult> getConfiguredAudienceModelAsync(GetConfiguredAudienceModelRequest getConfiguredAudienceModelRequest)
Returns information about a specified configured audience model.
getConfiguredAudienceModelRequest - Future<GetConfiguredAudienceModelResult> getConfiguredAudienceModelAsync(GetConfiguredAudienceModelRequest getConfiguredAudienceModelRequest, AsyncHandler<GetConfiguredAudienceModelRequest,GetConfiguredAudienceModelResult> asyncHandler)
Returns information about a specified configured audience model.
getConfiguredAudienceModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetConfiguredAudienceModelPolicyResult> getConfiguredAudienceModelPolicyAsync(GetConfiguredAudienceModelPolicyRequest getConfiguredAudienceModelPolicyRequest)
Returns information about a configured audience model policy.
getConfiguredAudienceModelPolicyRequest - Future<GetConfiguredAudienceModelPolicyResult> getConfiguredAudienceModelPolicyAsync(GetConfiguredAudienceModelPolicyRequest getConfiguredAudienceModelPolicyRequest, AsyncHandler<GetConfiguredAudienceModelPolicyRequest,GetConfiguredAudienceModelPolicyResult> asyncHandler)
Returns information about a configured audience model policy.
getConfiguredAudienceModelPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTrainingDatasetResult> getTrainingDatasetAsync(GetTrainingDatasetRequest getTrainingDatasetRequest)
Returns information about a training dataset.
getTrainingDatasetRequest - Future<GetTrainingDatasetResult> getTrainingDatasetAsync(GetTrainingDatasetRequest getTrainingDatasetRequest, AsyncHandler<GetTrainingDatasetRequest,GetTrainingDatasetResult> asyncHandler)
Returns information about a training dataset.
getTrainingDatasetRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAudienceExportJobsResult> listAudienceExportJobsAsync(ListAudienceExportJobsRequest listAudienceExportJobsRequest)
Returns a list of the audience export jobs.
listAudienceExportJobsRequest - Future<ListAudienceExportJobsResult> listAudienceExportJobsAsync(ListAudienceExportJobsRequest listAudienceExportJobsRequest, AsyncHandler<ListAudienceExportJobsRequest,ListAudienceExportJobsResult> asyncHandler)
Returns a list of the audience export jobs.
listAudienceExportJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAudienceGenerationJobsResult> listAudienceGenerationJobsAsync(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest)
Returns a list of audience generation jobs.
listAudienceGenerationJobsRequest - Future<ListAudienceGenerationJobsResult> listAudienceGenerationJobsAsync(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest, AsyncHandler<ListAudienceGenerationJobsRequest,ListAudienceGenerationJobsResult> asyncHandler)
Returns a list of audience generation jobs.
listAudienceGenerationJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAudienceModelsResult> listAudienceModelsAsync(ListAudienceModelsRequest listAudienceModelsRequest)
Returns a list of audience models.
listAudienceModelsRequest - Future<ListAudienceModelsResult> listAudienceModelsAsync(ListAudienceModelsRequest listAudienceModelsRequest, AsyncHandler<ListAudienceModelsRequest,ListAudienceModelsResult> asyncHandler)
Returns a list of audience models.
listAudienceModelsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListConfiguredAudienceModelsResult> listConfiguredAudienceModelsAsync(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest)
Returns a list of the configured audience models.
listConfiguredAudienceModelsRequest - Future<ListConfiguredAudienceModelsResult> listConfiguredAudienceModelsAsync(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest, AsyncHandler<ListConfiguredAudienceModelsRequest,ListConfiguredAudienceModelsResult> asyncHandler)
Returns a list of the configured audience models.
listConfiguredAudienceModelsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a provided resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns a list of tags for a provided resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTrainingDatasetsResult> listTrainingDatasetsAsync(ListTrainingDatasetsRequest listTrainingDatasetsRequest)
Returns a list of training datasets.
listTrainingDatasetsRequest - Future<ListTrainingDatasetsResult> listTrainingDatasetsAsync(ListTrainingDatasetsRequest listTrainingDatasetsRequest, AsyncHandler<ListTrainingDatasetsRequest,ListTrainingDatasetsResult> asyncHandler)
Returns a list of training datasets.
listTrainingDatasetsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutConfiguredAudienceModelPolicyResult> putConfiguredAudienceModelPolicyAsync(PutConfiguredAudienceModelPolicyRequest putConfiguredAudienceModelPolicyRequest)
Create or update the resource policy for a configured audience model.
putConfiguredAudienceModelPolicyRequest - Future<PutConfiguredAudienceModelPolicyResult> putConfiguredAudienceModelPolicyAsync(PutConfiguredAudienceModelPolicyRequest putConfiguredAudienceModelPolicyRequest, AsyncHandler<PutConfiguredAudienceModelPolicyRequest,PutConfiguredAudienceModelPolicyResult> asyncHandler)
Create or update the resource policy for a configured audience model.
putConfiguredAudienceModelPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartAudienceExportJobResult> startAudienceExportJobAsync(StartAudienceExportJobRequest startAudienceExportJobRequest)
Export an audience of a specified size after you have generated an audience.
startAudienceExportJobRequest - Future<StartAudienceExportJobResult> startAudienceExportJobAsync(StartAudienceExportJobRequest startAudienceExportJobRequest, AsyncHandler<StartAudienceExportJobRequest,StartAudienceExportJobResult> asyncHandler)
Export an audience of a specified size after you have generated an audience.
startAudienceExportJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartAudienceGenerationJobResult> startAudienceGenerationJobAsync(StartAudienceGenerationJobRequest startAudienceGenerationJobRequest)
Information necessary to start the audience generation job.
startAudienceGenerationJobRequest - Future<StartAudienceGenerationJobResult> startAudienceGenerationJobAsync(StartAudienceGenerationJobRequest startAudienceGenerationJobRequest, AsyncHandler<StartAudienceGenerationJobRequest,StartAudienceGenerationJobResult> asyncHandler)
Information necessary to start the audience generation job.
startAudienceGenerationJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds metadata tags to a specified resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds metadata tags to a specified resource.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a specified resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes metadata tags from a specified resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateConfiguredAudienceModelResult> updateConfiguredAudienceModelAsync(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.
updateConfiguredAudienceModelRequest - Future<UpdateConfiguredAudienceModelResult> updateConfiguredAudienceModelAsync(UpdateConfiguredAudienceModelRequest updateConfiguredAudienceModelRequest, AsyncHandler<UpdateConfiguredAudienceModelRequest,UpdateConfiguredAudienceModelResult> asyncHandler)
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.
updateConfiguredAudienceModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.