View Source AWS.CleanRoomsML (aws-elixir 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.
To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.
Link to this section Summary
Functions
Submits a request to cancel the trained model job.
Submits a request to cancel a trained model inference job.
Defines the information necessary to create an audience model.
Defines the information necessary to create a configured audience model.
Creates a configured model algorithm using a container image stored in an ECR repository.
Associates a configured model algorithm to a collaboration for use by any member of the collaboration.
Provides the information to create an ML input channel.
Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.
Defines the information necessary to create a training dataset.
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.
Deletes a configured model algorithm.
Deletes a configured model algorithm association.
Deletes a ML modeling configuration.
Provides the information necessary to delete an ML input channel.
Deletes the output of a trained model.
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 the configured model algorithm association in a collaboration.
Returns information about a specific ML input channel in a collaboration.
Returns information about a trained model in a collaboration.
Returns information about a specified configured audience model.
Returns information about a configured audience model policy.
Returns information about a configured model algorithm.
Returns information about a configured model algorithm association.
Returns information about a specific ML configuration.
Returns information about an ML input channel.
Returns information about a trained model.
Returns information about a trained model inference job.
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 model algorithm associations in a collaboration.
Returns a list of the ML input channels in a collaboration.
Returns a list of the export jobs for a trained model in a collaboration.
Returns a list of trained model inference jobs in a specified collaboration.
Returns a list of the trained models in a collaboration.
Returns a list of the configured audience models.
Returns a list of configured model algorithm associations.
Returns a list of configured model algorithms.
Returns a list of ML input channels.
Returns a list of tags for a provided resource.
Returns a list of trained model inference jobs that match the request parameters.
Returns a list of trained models.
Returns a list of training datasets.
Create or update the resource policy for a configured audience model.
Assigns information about an ML configuration.
Export an audience of a specified size after you have generated an audience.
Information necessary to start the audience generation job.
Provides the information necessary to start a trained model export job.
Defines the information necessary to begin a trained model inference 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.
Link to this section Functions
cancel_trained_model(client, membership_identifier, trained_model_arn, input, options \\ [])
View SourceSubmits a request to cancel the trained model job.
cancel_trained_model_inference_job(client, membership_identifier, trained_model_inference_job_arn, input, options \\ [])
View SourceSubmits a request to cancel a trained model inference job.
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.
Defines the information necessary to create a configured audience model.
Creates a configured model algorithm using a container image stored in an ECR repository.
create_configured_model_algorithm_association(client, membership_identifier, input, options \\ [])
View SourceAssociates a configured model algorithm to a collaboration for use by any member of the collaboration.
create_ml_input_channel(client, membership_identifier, input, options \\ [])
View SourceProvides the information to create an ML input channel.
An ML input channel is the result of a query that can be used for ML modeling.
create_trained_model(client, membership_identifier, input, options \\ [])
View SourceCreates a trained model from an associated configured model algorithm using data from any member of the collaboration.
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.
delete_audience_generation_job(client, audience_generation_job_arn, input, options \\ [])
View SourceDeletes the specified audience generation job, and removes all data associated with the job.
delete_audience_model(client, audience_model_arn, input, options \\ [])
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.
delete_configured_audience_model(client, configured_audience_model_arn, input, options \\ [])
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.
delete_configured_audience_model_policy(client, configured_audience_model_arn, input, options \\ [])
View SourceDeletes the specified configured audience model policy.
delete_configured_model_algorithm(client, configured_model_algorithm_arn, input, options \\ [])
View SourceDeletes a configured model algorithm.
delete_configured_model_algorithm_association(client, configured_model_algorithm_association_arn, membership_identifier, input, options \\ [])
View SourceDeletes a configured model algorithm association.
delete_ml_configuration(client, membership_identifier, input, options \\ [])
View SourceDeletes a ML modeling configuration.
delete_ml_input_channel_data(client, membership_identifier, ml_input_channel_arn, input, options \\ [])
View SourceProvides the information necessary to delete an ML input channel.
delete_trained_model_output(client, membership_identifier, trained_model_arn, input, options \\ [])
View SourceDeletes the output of a trained model.
delete_training_dataset(client, training_dataset_arn, input, options \\ [])
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, the TrainingDataset is metadata
that points to a Glue table, which is read only during AudienceModel creation.
This action deletes the metadata.
get_audience_generation_job(client, audience_generation_job_arn, options \\ [])
View SourceReturns information about an audience generation job.
Returns information about an audience model
get_collaboration_configured_model_algorithm_association(client, collaboration_identifier, configured_model_algorithm_association_arn, options \\ [])
View SourceReturns information about the configured model algorithm association in a collaboration.
get_collaboration_ml_input_channel(client, collaboration_identifier, ml_input_channel_arn, options \\ [])
View SourceReturns information about a specific ML input channel in a collaboration.
get_collaboration_trained_model(client, collaboration_identifier, trained_model_arn, options \\ [])
View SourceReturns information about a trained model in a collaboration.
get_configured_audience_model(client, configured_audience_model_arn, options \\ [])
View SourceReturns information about a specified configured audience model.
get_configured_audience_model_policy(client, configured_audience_model_arn, options \\ [])
View SourceReturns information about a configured audience model policy.
get_configured_model_algorithm(client, configured_model_algorithm_arn, options \\ [])
View SourceReturns information about a configured model algorithm.
get_configured_model_algorithm_association(client, configured_model_algorithm_association_arn, membership_identifier, options \\ [])
View SourceReturns information about a configured model algorithm association.
get_ml_configuration(client, membership_identifier, options \\ [])
View SourceReturns information about a specific ML configuration.
get_ml_input_channel(client, membership_identifier, ml_input_channel_arn, options \\ [])
View SourceReturns information about an ML input channel.
get_trained_model(client, membership_identifier, trained_model_arn, options \\ [])
View SourceReturns information about a trained model.
get_trained_model_inference_job(client, membership_identifier, trained_model_inference_job_arn, options \\ [])
View SourceReturns information about a trained model inference job.
Returns information about a training dataset.
list_audience_export_jobs(client, audience_generation_job_arn \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns 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 \\ [])
View SourceReturns a list of audience generation jobs.
list_audience_models(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of audience models.
list_collaboration_configured_model_algorithm_associations(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of the configured model algorithm associations in a collaboration.
list_collaboration_ml_input_channels(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of the ML input channels in a collaboration.
list_collaboration_trained_model_export_jobs(client, collaboration_identifier, trained_model_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of the export jobs for a trained model in a collaboration.
list_collaboration_trained_model_inference_jobs(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, trained_model_arn \\ nil, options \\ [])
View SourceReturns a list of trained model inference jobs in a specified collaboration.
list_collaboration_trained_models(client, collaboration_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of the trained models in a collaboration.
list_configured_audience_models(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of the configured audience models.
list_configured_model_algorithm_associations(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of configured model algorithm associations.
list_configured_model_algorithms(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of configured model algorithms.
list_ml_input_channels(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of ML input channels.
Returns a list of tags for a provided resource.
list_trained_model_inference_jobs(client, membership_identifier, max_results \\ nil, next_token \\ nil, trained_model_arn \\ nil, options \\ [])
View SourceReturns a list of trained model inference jobs that match the request parameters.
list_trained_models(client, membership_identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of trained models.
list_training_datasets(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of training datasets.
put_configured_audience_model_policy(client, configured_audience_model_arn, input, options \\ [])
View SourceCreate or update the resource policy for a configured audience model.
put_ml_configuration(client, membership_identifier, input, options \\ [])
View SourceAssigns information about an ML configuration.
Export an audience of a specified size after you have generated an audience.
Information necessary to start the audience generation job.
start_trained_model_export_job(client, membership_identifier, trained_model_arn, input, options \\ [])
View SourceProvides the information necessary to start a trained model export job.
start_trained_model_inference_job(client, membership_identifier, input, options \\ [])
View SourceDefines the information necessary to begin a trained model inference job.
Adds metadata tags to a specified resource.
Removes metadata tags from a specified resource.
update_configured_audience_model(client, configured_audience_model_arn, input, options \\ [])
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.