@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCleanRoomsML
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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.
|
static final String ENDPOINT_PREFIX
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.
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.CreateConfiguredAudienceModelResult createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest createConfiguredAudienceModelRequest)
Defines the information necessary to create a configured audience model.
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.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.
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.DeleteAudienceGenerationJobResult deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest deleteAudienceGenerationJobRequest)
Deletes the specified audience generation job, and removes all data associated with the job.
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.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.
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.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.
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.DeleteConfiguredAudienceModelPolicyResult deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest deleteConfiguredAudienceModelPolicyRequest)
Deletes the specified configured audience model policy.
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.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.
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.GetAudienceGenerationJobResult getAudienceGenerationJob(GetAudienceGenerationJobRequest getAudienceGenerationJobRequest)
Returns information about an audience generation job.
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.GetAudienceModelResult getAudienceModel(GetAudienceModelRequest getAudienceModelRequest)
Returns information about an audience model
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.GetConfiguredAudienceModelResult getConfiguredAudienceModel(GetConfiguredAudienceModelRequest getConfiguredAudienceModelRequest)
Returns information about a specified configured audience model.
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.GetConfiguredAudienceModelPolicyResult getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest getConfiguredAudienceModelPolicyRequest)
Returns information about a configured audience model policy.
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.GetTrainingDatasetResult getTrainingDataset(GetTrainingDatasetRequest getTrainingDatasetRequest)
Returns information about a training dataset.
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.ListAudienceExportJobsResult listAudienceExportJobs(ListAudienceExportJobsRequest listAudienceExportJobsRequest)
Returns a list of the audience export jobs.
listAudienceExportJobsRequest
- ValidationException
- The request parameters for this request are incorrect.AccessDeniedException
- You do not have sufficient access to perform this action.ListAudienceGenerationJobsResult listAudienceGenerationJobs(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest)
Returns a list of audience generation jobs.
listAudienceGenerationJobsRequest
- ValidationException
- The request parameters for this request are incorrect.AccessDeniedException
- You do not have sufficient access to perform this action.ListAudienceModelsResult listAudienceModels(ListAudienceModelsRequest listAudienceModelsRequest)
Returns a list of audience models.
listAudienceModelsRequest
- ValidationException
- The request parameters for this request are incorrect.AccessDeniedException
- You do not have sufficient access to perform this action.ListConfiguredAudienceModelsResult listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest)
Returns a list of the configured audience models.
listConfiguredAudienceModelsRequest
- ValidationException
- The request parameters for this request are incorrect.AccessDeniedException
- You do not have sufficient access to perform this action.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a provided resource.
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.ListTrainingDatasetsResult listTrainingDatasets(ListTrainingDatasetsRequest listTrainingDatasetsRequest)
Returns a list of training datasets.
listTrainingDatasetsRequest
- ValidationException
- The request parameters for this request are incorrect.AccessDeniedException
- You do not have sufficient access to perform this action.PutConfiguredAudienceModelPolicyResult putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest putConfiguredAudienceModelPolicyRequest)
Create or update the resource policy for a configured audience model.
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.StartAudienceExportJobResult startAudienceExportJob(StartAudienceExportJobRequest startAudienceExportJobRequest)
Export an audience of a specified size after you have generated an audience.
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.StartAudienceGenerationJobResult startAudienceGenerationJob(StartAudienceGenerationJobRequest startAudienceGenerationJobRequest)
Information necessary to start the audience generation job.
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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a specified resource.
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a specified resource.
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.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.
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.void shutdown()
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 a request.
request
- The originally executed request.