@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCleanRoomsMLClient extends AmazonWebServiceClient implements AWSCleanRoomsML
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.
LOGGING_AWS_REQUEST_METRIC ENDPOINT_PREFIX addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset public static AWSCleanRoomsMLClientBuilder builder()
public CreateAudienceModelResult createAudienceModel(CreateAudienceModelRequest request)
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.
createAudienceModel in interface AWSCleanRoomsML createAudienceModelRequest - 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.public CreateConfiguredAudienceModelResult createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest request)
Defines the information necessary to create a configured audience model.
createConfiguredAudienceModel in interface AWSCleanRoomsML createConfiguredAudienceModelRequest - 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.public CreateTrainingDatasetResult createTrainingDataset(CreateTrainingDatasetRequest request)
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.
createTrainingDataset in interface AWSCleanRoomsML createTrainingDatasetRequest - 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.public DeleteAudienceGenerationJobResult deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest request)
Deletes the specified audience generation job, and removes all data associated with the job.
deleteAudienceGenerationJob in interface AWSCleanRoomsML deleteAudienceGenerationJobRequest - 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.public DeleteAudienceModelResult deleteAudienceModel(DeleteAudienceModelRequest request)
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.
deleteAudienceModel in interface AWSCleanRoomsML deleteAudienceModelRequest - 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.public DeleteConfiguredAudienceModelResult deleteConfiguredAudienceModel(DeleteConfiguredAudienceModelRequest request)
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.
deleteConfiguredAudienceModel in interface AWSCleanRoomsML deleteConfiguredAudienceModelRequest - 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.public DeleteConfiguredAudienceModelPolicyResult deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest request)
Deletes the specified configured audience model policy.
deleteConfiguredAudienceModelPolicy in interface AWSCleanRoomsML deleteConfiguredAudienceModelPolicyRequest - 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.public DeleteTrainingDatasetResult deleteTrainingDataset(DeleteTrainingDatasetRequest request)
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.
deleteTrainingDataset in interface AWSCleanRoomsML deleteTrainingDatasetRequest - 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.public GetAudienceGenerationJobResult getAudienceGenerationJob(GetAudienceGenerationJobRequest request)
Returns information about an audience generation job.
getAudienceGenerationJob in interface AWSCleanRoomsML getAudienceGenerationJobRequest - 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.public GetAudienceModelResult getAudienceModel(GetAudienceModelRequest request)
Returns information about an audience model
getAudienceModel in interface AWSCleanRoomsML getAudienceModelRequest - 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.public GetConfiguredAudienceModelResult getConfiguredAudienceModel(GetConfiguredAudienceModelRequest request)
Returns information about a specified configured audience model.
getConfiguredAudienceModel in interface AWSCleanRoomsML getConfiguredAudienceModelRequest - 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.public GetConfiguredAudienceModelPolicyResult getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest request)
Returns information about a configured audience model policy.
getConfiguredAudienceModelPolicy in interface AWSCleanRoomsML getConfiguredAudienceModelPolicyRequest - 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.public GetTrainingDatasetResult getTrainingDataset(GetTrainingDatasetRequest request)
Returns information about a training dataset.
getTrainingDataset in interface AWSCleanRoomsML getTrainingDatasetRequest - 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.public ListAudienceExportJobsResult listAudienceExportJobs(ListAudienceExportJobsRequest request)
Returns a list of the audience export jobs.
listAudienceExportJobs in interface AWSCleanRoomsML listAudienceExportJobsRequest - ValidationException - The request parameters for this request are incorrect.AccessDeniedException - You do not have sufficient access to perform this action.public ListAudienceGenerationJobsResult listAudienceGenerationJobs(ListAudienceGenerationJobsRequest request)
Returns a list of audience generation jobs.
listAudienceGenerationJobs in interface AWSCleanRoomsML listAudienceGenerationJobsRequest - ValidationException - The request parameters for this request are incorrect.AccessDeniedException - You do not have sufficient access to perform this action.public ListAudienceModelsResult listAudienceModels(ListAudienceModelsRequest request)
Returns a list of audience models.
listAudienceModels in interface AWSCleanRoomsML listAudienceModelsRequest - ValidationException - The request parameters for this request are incorrect.AccessDeniedException - You do not have sufficient access to perform this action.public ListConfiguredAudienceModelsResult listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest request)
Returns a list of the configured audience models.
listConfiguredAudienceModels in interface AWSCleanRoomsML listConfiguredAudienceModelsRequest - ValidationException - The request parameters for this request are incorrect.AccessDeniedException - You do not have sufficient access to perform this action.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags for a provided resource.
listTagsForResource in interface AWSCleanRoomsML listTagsForResourceRequest - 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.public ListTrainingDatasetsResult listTrainingDatasets(ListTrainingDatasetsRequest request)
Returns a list of training datasets.
listTrainingDatasets in interface AWSCleanRoomsML listTrainingDatasetsRequest - ValidationException - The request parameters for this request are incorrect.AccessDeniedException - You do not have sufficient access to perform this action.public PutConfiguredAudienceModelPolicyResult putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest request)
Create or update the resource policy for a configured audience model.
putConfiguredAudienceModelPolicy in interface AWSCleanRoomsML putConfiguredAudienceModelPolicyRequest - 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.public StartAudienceExportJobResult startAudienceExportJob(StartAudienceExportJobRequest request)
Export an audience of a specified size after you have generated an audience.
startAudienceExportJob in interface AWSCleanRoomsML startAudienceExportJobRequest - 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.public StartAudienceGenerationJobResult startAudienceGenerationJob(StartAudienceGenerationJobRequest request)
Information necessary to start the audience generation job.
startAudienceGenerationJob in interface AWSCleanRoomsML startAudienceGenerationJobRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
Adds metadata tags to a specified resource.
tagResource in interface AWSCleanRoomsML tagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes metadata tags from a specified resource.
untagResource in interface AWSCleanRoomsML untagResourceRequest - 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.public UpdateConfiguredAudienceModelResult updateConfiguredAudienceModel(UpdateConfiguredAudienceModelRequest request)
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.
updateConfiguredAudienceModel in interface AWSCleanRoomsML updateConfiguredAudienceModelRequest - 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSCleanRoomsML request - The originally executed requestpublic void shutdown()
AmazonWebServiceClient shutdown in interface AWSCleanRoomsML shutdown in class AmazonWebServiceClient