com.amazonaws.services.cleanroomsml

Class AWSCleanRoomsMLClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cleanroomsml.AWSCleanRoomsMLClient

All Implemented Interfaces:

AWSCleanRoomsML

Direct Known Subclasses:

AWSCleanRoomsMLAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCleanRoomsMLClient
extends AmazonWebServiceClient
implements AWSCleanRoomsML

Client for accessing AWS Clean Rooms ML. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.cleanroomsml.AWSCleanRoomsML

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSCleanRoomsMLClientBuilder	builder()
CreateAudienceModelResult	createAudienceModel(CreateAudienceModelRequest request) Defines the information necessary to create an audience model.
CreateConfiguredAudienceModelResult	createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest request) Defines the information necessary to create a configured audience model.
CreateTrainingDatasetResult	createTrainingDataset(CreateTrainingDatasetRequest request) Defines the information necessary to create a training dataset.
DeleteAudienceGenerationJobResult	deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest request) Deletes the specified audience generation job, and removes all data associated with the job.
DeleteAudienceModelResult	deleteAudienceModel(DeleteAudienceModelRequest request) Specifies an audience model that you want to delete.
DeleteConfiguredAudienceModelResult	deleteConfiguredAudienceModel(DeleteConfiguredAudienceModelRequest request) Deletes the specified configured audience model.
DeleteConfiguredAudienceModelPolicyResult	deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest request) Deletes the specified configured audience model policy.
DeleteTrainingDatasetResult	deleteTrainingDataset(DeleteTrainingDatasetRequest request) Specifies a training dataset that you want to delete.
GetAudienceGenerationJobResult	getAudienceGenerationJob(GetAudienceGenerationJobRequest request) Returns information about an audience generation job.
GetAudienceModelResult	getAudienceModel(GetAudienceModelRequest request) 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 request) Returns information about a specified configured audience model.
GetConfiguredAudienceModelPolicyResult	getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest request) Returns information about a configured audience model policy.
GetTrainingDatasetResult	getTrainingDataset(GetTrainingDatasetRequest request) Returns information about a training dataset.
ListAudienceExportJobsResult	listAudienceExportJobs(ListAudienceExportJobsRequest request) Returns a list of the audience export jobs.
ListAudienceGenerationJobsResult	listAudienceGenerationJobs(ListAudienceGenerationJobsRequest request) Returns a list of audience generation jobs.
ListAudienceModelsResult	listAudienceModels(ListAudienceModelsRequest request) Returns a list of audience models.
ListConfiguredAudienceModelsResult	listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest request) Returns a list of the configured audience models.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of tags for a provided resource.
ListTrainingDatasetsResult	listTrainingDatasets(ListTrainingDatasetsRequest request) Returns a list of training datasets.
PutConfiguredAudienceModelPolicyResult	putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest request) 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 request) Export an audience of a specified size after you have generated an audience.
StartAudienceGenerationJobResult	startAudienceGenerationJob(StartAudienceGenerationJobRequest request) Information necessary to start the audience generation job.
TagResourceResult	tagResource(TagResourceRequest request) Adds metadata tags to a specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes metadata tags from a specified resource.
UpdateConfiguredAudienceModelResult	updateConfiguredAudienceModel(UpdateConfiguredAudienceModelRequest request) Provides the information necessary to update a configured audience model.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSCleanRoomsMLClientBuilder builder()

createAudienceModel

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.

Specified by:

createAudienceModel in interface AWSCleanRoomsML

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

public CreateConfiguredAudienceModelResult createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest request)

Defines the information necessary to create a configured audience model.

Specified by:

createConfiguredAudienceModel in interface AWSCleanRoomsML

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

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.

Specified by:

createTrainingDataset in interface AWSCleanRoomsML

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

public DeleteAudienceGenerationJobResult deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest request)

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

Specified by:

deleteAudienceGenerationJob in interface AWSCleanRoomsML

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

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.

Specified by:

deleteAudienceModel in interface AWSCleanRoomsML

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

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.

Specified by:

deleteConfiguredAudienceModel in interface AWSCleanRoomsML

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

public DeleteConfiguredAudienceModelPolicyResult deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest request)

Deletes the specified configured audience model policy.

Specified by:

deleteConfiguredAudienceModelPolicy in interface AWSCleanRoomsML

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

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.

Specified by:

deleteTrainingDataset in interface AWSCleanRoomsML

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

public GetAudienceGenerationJobResult getAudienceGenerationJob(GetAudienceGenerationJobRequest request)

Returns information about an audience generation job.

Specified by:

getAudienceGenerationJob in interface AWSCleanRoomsML

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

public GetAudienceModelResult getAudienceModel(GetAudienceModelRequest request)

Returns information about an audience model

Specified by:

getAudienceModel in interface AWSCleanRoomsML

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

public GetConfiguredAudienceModelResult getConfiguredAudienceModel(GetConfiguredAudienceModelRequest request)

Returns information about a specified configured audience model.

Specified by:

getConfiguredAudienceModel in interface AWSCleanRoomsML

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

public GetConfiguredAudienceModelPolicyResult getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest request)

Returns information about a configured audience model policy.

Specified by:

getConfiguredAudienceModelPolicy in interface AWSCleanRoomsML

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

public GetTrainingDatasetResult getTrainingDataset(GetTrainingDatasetRequest request)

Returns information about a training dataset.

Specified by:

getTrainingDataset in interface AWSCleanRoomsML

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

public ListAudienceExportJobsResult listAudienceExportJobs(ListAudienceExportJobsRequest request)

Returns a list of the audience export jobs.

Specified by:

listAudienceExportJobs in interface AWSCleanRoomsML

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

public ListAudienceGenerationJobsResult listAudienceGenerationJobs(ListAudienceGenerationJobsRequest request)

Returns a list of audience generation jobs.

Specified by:

listAudienceGenerationJobs in interface AWSCleanRoomsML

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

public ListAudienceModelsResult listAudienceModels(ListAudienceModelsRequest request)

Returns a list of audience models.

Specified by:

listAudienceModels in interface AWSCleanRoomsML

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

public ListConfiguredAudienceModelsResult listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest request)

Returns a list of the configured audience models.

Specified by:

listConfiguredAudienceModels in interface AWSCleanRoomsML

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns a list of tags for a provided resource.

Specified by:

listTagsForResource in interface AWSCleanRoomsML

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

public ListTrainingDatasetsResult listTrainingDatasets(ListTrainingDatasetsRequest request)

Returns a list of training datasets.

Specified by:

listTrainingDatasets in interface AWSCleanRoomsML

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

public PutConfiguredAudienceModelPolicyResult putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest request)

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

Specified by:

putConfiguredAudienceModelPolicy in interface AWSCleanRoomsML

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

public StartAudienceExportJobResult startAudienceExportJob(StartAudienceExportJobRequest request)

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

Specified by:

startAudienceExportJob in interface AWSCleanRoomsML

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

public StartAudienceGenerationJobResult startAudienceGenerationJob(StartAudienceGenerationJobRequest request)

Information necessary to start the audience generation job.

Specified by:

startAudienceGenerationJob in interface AWSCleanRoomsML

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

public TagResourceResult tagResource(TagResourceRequest request)

Adds metadata tags to a specified resource.

Specified by:

tagResource in interface AWSCleanRoomsML

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes metadata tags from a specified resource.

Specified by:

untagResource in interface AWSCleanRoomsML

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

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.

Specified by:

updateConfiguredAudienceModel in interface AWSCleanRoomsML

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSCleanRoomsML

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSCleanRoomsML

Overrides:

shutdown in class AmazonWebServiceClient