View Source AWS.CleanRoomsML (aws-elixir v1.0.0)

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.

Summary

Functions

create_audience_model(client, input, options \\ [])

Defines the information necessary to create an audience model.

create_configured_audience_model(client, input, options \\ [])

Defines the information necessary to create a configured audience model.

create_training_dataset(client, input, options \\ [])

Defines the information necessary to create a training dataset.

delete_audience_generation_job(client, audience_generation_job_arn, input, options \\ [])

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

delete_audience_model(client, audience_model_arn, input, options \\ [])

Specifies an audience model that you want to delete.

delete_configured_audience_model(client, configured_audience_model_arn, input, options \\ [])

Deletes the specified configured audience model.

delete_configured_audience_model_policy(client, configured_audience_model_arn, input, options \\ [])

Deletes the specified configured audience model policy.

delete_training_dataset(client, training_dataset_arn, input, options \\ [])

Specifies a training dataset that you want to delete.

get_audience_generation_job(client, audience_generation_job_arn, options \\ [])

Returns information about an audience generation job.

get_audience_model(client, audience_model_arn, options \\ [])

Returns information about an audience model

get_configured_audience_model(client, configured_audience_model_arn, options \\ [])

Returns information about a specified configured audience model.

get_configured_audience_model_policy(client, configured_audience_model_arn, options \\ [])

Returns information about a configured audience model policy.

get_training_dataset(client, training_dataset_arn, options \\ [])

Returns information about a training dataset.

list_audience_export_jobs(client, audience_generation_job_arn \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of the audience export jobs.

list_audience_generation_jobs(client, collaboration_id \\ nil, configured_audience_model_arn \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of audience generation jobs.

list_audience_models(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of audience models.

list_configured_audience_models(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of the configured audience models.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of tags for a provided resource.

list_training_datasets(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of training datasets.

metadata()
put_configured_audience_model_policy(client, configured_audience_model_arn, input, options \\ [])

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

start_audience_export_job(client, input, options \\ [])

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

start_audience_generation_job(client, input, options \\ [])

Information necessary to start the audience generation job.

tag_resource(client, resource_arn, input, options \\ [])

Adds metadata tags to a specified resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes metadata tags from a specified resource.

update_configured_audience_model(client, configured_audience_model_arn, input, options \\ [])

Provides the information necessary to update a configured audience model.

Functions

Link to this function

create_audience_model(client, input, options \\ [])

View Source

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.

Link to this function

create_configured_audience_model(client, input, options \\ [])

View Source

Defines the information necessary to create a configured audience model.

Link to this function

create_training_dataset(client, input, options \\ [])

View Source

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.

Link to this function

delete_audience_generation_job(client, audience_generation_job_arn, input, options \\ [])

View Source

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

Link to this function

delete_audience_model(client, audience_model_arn, input, options \\ [])

View Source

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.

Link to this function

delete_configured_audience_model(client, configured_audience_model_arn, input, options \\ [])

View Source

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.

Link to this function

delete_configured_audience_model_policy(client, configured_audience_model_arn, input, options \\ [])

View Source

Deletes the specified configured audience model policy.

Link to this function

delete_training_dataset(client, training_dataset_arn, input, options \\ [])

View Source

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.

Link to this function

get_audience_generation_job(client, audience_generation_job_arn, options \\ [])

View Source

Returns information about an audience generation job.

Link to this function

get_audience_model(client, audience_model_arn, options \\ [])

View Source

Returns information about an audience model

Link to this function

get_configured_audience_model(client, configured_audience_model_arn, options \\ [])

View Source

Returns information about a specified configured audience model.

Link to this function

get_configured_audience_model_policy(client, configured_audience_model_arn, options \\ [])

View Source

Returns information about a configured audience model policy.

Link to this function

get_training_dataset(client, training_dataset_arn, options \\ [])

View Source

Returns information about a training dataset.

Link to this function

list_audience_export_jobs(client, audience_generation_job_arn \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of the audience export jobs.

Link to this function

list_audience_generation_jobs(client, collaboration_id \\ nil, configured_audience_model_arn \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of audience generation jobs.

Link to this function

list_audience_models(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of audience models.

Link to this function

list_configured_audience_models(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of the configured audience models.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns a list of tags for a provided resource.

Link to this function

list_training_datasets(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of training datasets.

Link to this function

metadata()

View Source
Link to this function

put_configured_audience_model_policy(client, configured_audience_model_arn, input, options \\ [])

View Source

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

Link to this function

start_audience_export_job(client, input, options \\ [])

View Source

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

Link to this function

start_audience_generation_job(client, input, options \\ [])

View Source

Information necessary to start the audience generation job.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds metadata tags to a specified resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes metadata tags from a specified resource.

Link to this function

update_configured_audience_model(client, configured_audience_model_arn, input, options \\ [])

View Source

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.