com.amazonaws.services.cleanroomsml

Interface AWSCleanRoomsML

All Known Subinterfaces:

AWSCleanRoomsMLAsync

All Known Implementing Classes:

AbstractAWSCleanRoomsML, AbstractAWSCleanRoomsMLAsync, AWSCleanRoomsMLAsyncClient, AWSCleanRoomsMLClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCleanRoomsML

Interface for accessing AWS Clean Rooms ML.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCleanRoomsML 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateAudienceModelResult	createAudienceModel(CreateAudienceModelRequest createAudienceModelRequest) Defines the information necessary to create an audience model.
CreateConfiguredAudienceModelResult	createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest createConfiguredAudienceModelRequest) Defines the information necessary to create a configured audience model.
CreateTrainingDatasetResult	createTrainingDataset(CreateTrainingDatasetRequest createTrainingDatasetRequest) Defines the information necessary to create a training dataset.
DeleteAudienceGenerationJobResult	deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest deleteAudienceGenerationJobRequest) Deletes the specified audience generation job, and removes all data associated with the job.
DeleteAudienceModelResult	deleteAudienceModel(DeleteAudienceModelRequest deleteAudienceModelRequest) Specifies an audience model that you want to delete.
DeleteConfiguredAudienceModelResult	deleteConfiguredAudienceModel(DeleteConfiguredAudienceModelRequest deleteConfiguredAudienceModelRequest) Deletes the specified configured audience model.
DeleteConfiguredAudienceModelPolicyResult	deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest deleteConfiguredAudienceModelPolicyRequest) Deletes the specified configured audience model policy.
DeleteTrainingDatasetResult	deleteTrainingDataset(DeleteTrainingDatasetRequest deleteTrainingDatasetRequest) Specifies a training dataset that you want to delete.
GetAudienceGenerationJobResult	getAudienceGenerationJob(GetAudienceGenerationJobRequest getAudienceGenerationJobRequest) Returns information about an audience generation job.
GetAudienceModelResult	getAudienceModel(GetAudienceModelRequest getAudienceModelRequest) Returns information about an audience model
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetConfiguredAudienceModelResult	getConfiguredAudienceModel(GetConfiguredAudienceModelRequest getConfiguredAudienceModelRequest) Returns information about a specified configured audience model.
GetConfiguredAudienceModelPolicyResult	getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest getConfiguredAudienceModelPolicyRequest) Returns information about a configured audience model policy.
GetTrainingDatasetResult	getTrainingDataset(GetTrainingDatasetRequest getTrainingDatasetRequest) Returns information about a training dataset.
ListAudienceExportJobsResult	listAudienceExportJobs(ListAudienceExportJobsRequest listAudienceExportJobsRequest) Returns a list of the audience export jobs.
ListAudienceGenerationJobsResult	listAudienceGenerationJobs(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest) Returns a list of audience generation jobs.
ListAudienceModelsResult	listAudienceModels(ListAudienceModelsRequest listAudienceModelsRequest) Returns a list of audience models.
ListConfiguredAudienceModelsResult	listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest) Returns a list of the configured audience models.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a provided resource.
ListTrainingDatasetsResult	listTrainingDatasets(ListTrainingDatasetsRequest listTrainingDatasetsRequest) Returns a list of training datasets.
PutConfiguredAudienceModelPolicyResult	putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest putConfiguredAudienceModelPolicyRequest) Create or update the resource policy for a configured audience model.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartAudienceExportJobResult	startAudienceExportJob(StartAudienceExportJobRequest startAudienceExportJobRequest) Export an audience of a specified size after you have generated an audience.
StartAudienceGenerationJobResult	startAudienceGenerationJob(StartAudienceGenerationJobRequest startAudienceGenerationJobRequest) Information necessary to start the audience generation job.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds metadata tags to a specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes metadata tags from a specified resource.
UpdateConfiguredAudienceModelResult	updateConfiguredAudienceModel(UpdateConfiguredAudienceModelRequest updateConfiguredAudienceModelRequest) Provides the information necessary to update a configured audience model.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createAudienceModel

CreateAudienceModelResult 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:

Result of the CreateAudienceModel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createConfiguredAudienceModel

CreateConfiguredAudienceModelResult createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest createConfiguredAudienceModelRequest)

Defines the information necessary to create a configured audience model.

Parameters:

createConfiguredAudienceModelRequest -

Returns:

Result of the CreateConfiguredAudienceModel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createTrainingDataset

CreateTrainingDatasetResult createTrainingDataset(CreateTrainingDatasetRequest createTrainingDatasetRequest)

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

Parameters:

createTrainingDatasetRequest -

Returns:

Result of the CreateTrainingDataset operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteAudienceGenerationJob

DeleteAudienceGenerationJobResult deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest deleteAudienceGenerationJobRequest)

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

Parameters:

deleteAudienceGenerationJobRequest -

Returns:

Result of the DeleteAudienceGenerationJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteAudienceModel

DeleteAudienceModelResult 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:

Result of the DeleteAudienceModel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteConfiguredAudienceModel

DeleteConfiguredAudienceModelResult 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:

Result of the DeleteConfiguredAudienceModel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteConfiguredAudienceModelPolicy

DeleteConfiguredAudienceModelPolicyResult deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest deleteConfiguredAudienceModelPolicyRequest)

Deletes the specified configured audience model policy.

Parameters:

deleteConfiguredAudienceModelPolicyRequest -

Returns:

Result of the DeleteConfiguredAudienceModelPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteTrainingDataset

DeleteTrainingDatasetResult deleteTrainingDataset(DeleteTrainingDatasetRequest deleteTrainingDatasetRequest)

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

Parameters:

deleteTrainingDatasetRequest -

Returns:

Result of the DeleteTrainingDataset operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAudienceGenerationJob

GetAudienceGenerationJobResult getAudienceGenerationJob(GetAudienceGenerationJobRequest getAudienceGenerationJobRequest)

Returns information about an audience generation job.

Parameters:

getAudienceGenerationJobRequest -

Returns:

Result of the GetAudienceGenerationJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAudienceModel

GetAudienceModelResult getAudienceModel(GetAudienceModelRequest getAudienceModelRequest)

Returns information about an audience model

Parameters:

getAudienceModelRequest -

Returns:

Result of the GetAudienceModel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getConfiguredAudienceModel

GetConfiguredAudienceModelResult getConfiguredAudienceModel(GetConfiguredAudienceModelRequest getConfiguredAudienceModelRequest)

Returns information about a specified configured audience model.

Parameters:

getConfiguredAudienceModelRequest -

Returns:

Result of the GetConfiguredAudienceModel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getConfiguredAudienceModelPolicy

GetConfiguredAudienceModelPolicyResult getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest getConfiguredAudienceModelPolicyRequest)

Returns information about a configured audience model policy.

Parameters:

getConfiguredAudienceModelPolicyRequest -

Returns:

Result of the GetConfiguredAudienceModelPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getTrainingDataset

GetTrainingDatasetResult getTrainingDataset(GetTrainingDatasetRequest getTrainingDatasetRequest)

Returns information about a training dataset.

Parameters:

getTrainingDatasetRequest -

Returns:

Result of the GetTrainingDataset operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAudienceExportJobs

ListAudienceExportJobsResult listAudienceExportJobs(ListAudienceExportJobsRequest listAudienceExportJobsRequest)

Returns a list of the audience export jobs.

Parameters:

listAudienceExportJobsRequest -

Returns:

Result of the ListAudienceExportJobs operation returned by the service.

Throws:

ValidationException - The request parameters for this request are incorrect.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listAudienceGenerationJobs

ListAudienceGenerationJobsResult listAudienceGenerationJobs(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest)

Returns a list of audience generation jobs.

Parameters:

listAudienceGenerationJobsRequest -

Returns:

Result of the ListAudienceGenerationJobs operation returned by the service.

Throws:

ValidationException - The request parameters for this request are incorrect.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listAudienceModels

ListAudienceModelsResult listAudienceModels(ListAudienceModelsRequest listAudienceModelsRequest)

Returns a list of audience models.

Parameters:

listAudienceModelsRequest -

Returns:

Result of the ListAudienceModels operation returned by the service.

Throws:

ValidationException - The request parameters for this request are incorrect.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listConfiguredAudienceModels

ListConfiguredAudienceModelsResult listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest)

Returns a list of the configured audience models.

Parameters:

listConfiguredAudienceModelsRequest -

Returns:

Result of the ListConfiguredAudienceModels operation returned by the service.

Throws:

ValidationException - The request parameters for this request are incorrect.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns a list of tags for a provided resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTrainingDatasets

ListTrainingDatasetsResult listTrainingDatasets(ListTrainingDatasetsRequest listTrainingDatasetsRequest)

Returns a list of training datasets.

Parameters:

listTrainingDatasetsRequest -

Returns:

Result of the ListTrainingDatasets operation returned by the service.

Throws:

ValidationException - The request parameters for this request are incorrect.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

putConfiguredAudienceModelPolicy

PutConfiguredAudienceModelPolicyResult putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest putConfiguredAudienceModelPolicyRequest)

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

Parameters:

putConfiguredAudienceModelPolicyRequest -

Returns:

Result of the PutConfiguredAudienceModelPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startAudienceExportJob

StartAudienceExportJobResult startAudienceExportJob(StartAudienceExportJobRequest startAudienceExportJobRequest)

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

Parameters:

startAudienceExportJobRequest -

Returns:

Result of the StartAudienceExportJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startAudienceGenerationJob

StartAudienceGenerationJobResult startAudienceGenerationJob(StartAudienceGenerationJobRequest startAudienceGenerationJobRequest)

Information necessary to start the audience generation job.

Parameters:

startAudienceGenerationJobRequest -

Returns:

Result of the StartAudienceGenerationJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds metadata tags to a specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes metadata tags from a specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateConfiguredAudienceModel

UpdateConfiguredAudienceModelResult 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:

Result of the UpdateConfiguredAudienceModel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.