View Source aws_cleanroomsml (aws v1.0.4)
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: https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html.
To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference: https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html.Summary
Functions
Defines the information necessary to create an audience model.
Defines the information necessary to create a configured audience model.
Defines the information necessary to create a training dataset, or seed audience.
Deletes the specified audience generation job, and removes all data associated with the job.
Specifies an audience model that you want to delete.
Deletes the specified configured audience model.
Deletes the specified configured audience model policy.
Specifies a training dataset that you want to delete.
Returns information about an audience generation job.
Returns information about an audience model
Returns information about a specified configured audience model.
Returns information about a configured audience model policy.
Returns information about a training dataset.
Returns a list of the audience export jobs.
Returns a list of audience generation jobs.
Returns a list of audience models.
Returns a list of the configured audience models.
Returns a list of tags for a provided resource.
Returns a list of training datasets.
Create or update the resource policy for a configured audience model.
Export an audience of a specified size after you have generated an audience.
Information necessary to start the audience generation job.
Adds metadata tags to a specified resource.
Removes metadata tags from a specified resource.
Provides the information necessary to update a configured audience model.
Functions
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 theStartAudienceGenerationJob API.
Defines the information necessary to create a training dataset, or seed audience.
In Clean Rooms ML, theTrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
Link to this function
delete_audience_generation_job(Client, AudienceGenerationJobArn, Input)
View Source
Link to this function
delete_audience_generation_job(Client, AudienceGenerationJobArn, Input0, Options0)
View SourceSpecifies 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.
Link to this function
delete_configured_audience_model(Client, ConfiguredAudienceModelArn, Input)
View SourceDeletes 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.
Link to this function
delete_configured_audience_model(Client, ConfiguredAudienceModelArn, Input0, Options0)
View Source
Link to this function
delete_configured_audience_model_policy(Client, ConfiguredAudienceModelArn, Input)
View Source
Link to this function
delete_configured_audience_model_policy(Client, ConfiguredAudienceModelArn, Input0, Options0)
View SourceSpecifies 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, theTrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.
Link to this function
delete_training_dataset(Client, TrainingDatasetArn, Input0, Options0)
View Source
Link to this function
get_audience_generation_job(Client, AudienceGenerationJobArn, QueryMap, HeadersMap)
View Source
Link to this function
get_audience_generation_job(Client, AudienceGenerationJobArn, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_audience_model(Client, AudienceModelArn, QueryMap, HeadersMap)
View Source
Link to this function
get_audience_model(Client, AudienceModelArn, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_configured_audience_model(Client, ConfiguredAudienceModelArn, QueryMap, HeadersMap)
View Source
Link to this function
get_configured_audience_model(Client, ConfiguredAudienceModelArn, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_configured_audience_model_policy(Client, ConfiguredAudienceModelArn)
View Source
Link to this function
get_configured_audience_model_policy(Client, ConfiguredAudienceModelArn, QueryMap, HeadersMap)
View Source
Link to this function
get_configured_audience_model_policy(Client, ConfiguredAudienceModelArn, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_training_dataset(Client, TrainingDatasetArn, QueryMap, HeadersMap)
View Source
Link to this function
get_training_dataset(Client, TrainingDatasetArn, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_audience_generation_jobs(Client, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_configured_audience_models(Client, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Source
Link to this function
put_configured_audience_model_policy(Client, ConfiguredAudienceModelArn, Input)
View Source
Link to this function
put_configured_audience_model_policy(Client, ConfiguredAudienceModelArn, Input0, Options0)
View Source
Link to this function
update_configured_audience_model(Client, ConfiguredAudienceModelArn, Input)
View SourceProvides 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.
Link to this function