AWS Clean Rooms ML
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
Endpoints 59
Trained model
- GETGet trained model
/memberships/:membershipIdentifier/trained-models/:trainedModelArn?versionIdentifier=stringReturns information about a trained model. - DELETEDelete trained model output
/memberships/:membershipIdentifier/trained-models/:trainedModelArn?versionIdentifier=stringDeletes the model artifacts stored by the service. - PATCHCancel trained model
/memberships/:membershipIdentifier/trained-models/:trainedModelArn?versionIdentifier=stringSubmits a request to cancel the trained model job. - GETList trained models
/memberships/:membershipIdentifier/trained-models?nextToken=string&maxResults=0Returns a list of trained models. - POSTCreate trained model
/memberships/:membershipIdentifier/trained-modelsCreates a trained model from an associated configured model algorithm using data from any member of the collaboration. - GETGet collaboration trained model
/collaborations/:collaborationIdentifier/trained-models/:trainedModelArn?versionIdentifier=stringReturns information about a trained model in a collaboration. - GETList trained model versions
/memberships/:membershipIdentifier/trained-models/:trainedModelArn/versions?nextToken=string&maxResults=0&status=stringReturns a list of trained model versions for a specified trained model. This operation allows you to view all versions of a trained model, including…
Trained model inference job
- GETGet trained model inference job
/memberships/:membershipIdentifier/trained-model-inference-jobs/:trainedModelInferenceJobArnReturns information about a trained model inference job. - PATCHCancel trained model inference job
/memberships/:membershipIdentifier/trained-model-inference-jobs/:trainedModelInferenceJobArnSubmits a request to cancel a trained model inference job. - GETList trained model inference jobs
/memberships/:membershipIdentifier/trained-model-inference-jobs?nextToken=string&maxResults=0&trainedModelArn=string&trainedModelVersionIdentifier=stringReturns a list of trained model inference jobs that match the request parameters. - POSTStart trained model inference job
/memberships/:membershipIdentifier/trained-model-inference-jobsDefines the information necessary to begin a trained model inference job.
Audience model
- GETList audience models
/audience-model?nextToken=string&maxResults=0Returns a list of audience models. - POSTCreate audience model
/audience-modelDefines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity… - GETGet audience model
/audience-model/:audienceModelArnReturns information about an audience model - DELETEDelete audience model
/audience-model/:audienceModelArnSpecifies 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…
Configured audience model
- GETList configured audience models
/configured-audience-model?nextToken=string&maxResults=0Returns a list of the configured audience models. - POSTCreate configured audience model
/configured-audience-modelDefines the information necessary to create a configured audience model. - GETGet configured audience model
/configured-audience-model/:configuredAudienceModelArnReturns information about a specified configured audience model. - DELETEDelete configured audience model
/configured-audience-model/:configuredAudienceModelArnDeletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured… - PATCHUpdate configured audience model
/configured-audience-model/:configuredAudienceModelArnProvides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but…
Configured model algorithm
- GETList configured model algorithms
/configured-model-algorithms?nextToken=string&maxResults=0Returns a list of configured model algorithms. - POSTCreate configured model algorithm
/configured-model-algorithmsCreates a configured model algorithm using a container image stored in an ECR repository. - GETGet configured model algorithm
/configured-model-algorithms/:configuredModelAlgorithmArnReturns information about a configured model algorithm. - DELETEDelete configured model algorithm
/configured-model-algorithms/:configuredModelAlgorithmArnDeletes a configured model algorithm.
Configured model algorithm association
- GETList configured model algorithm associations
/memberships/:membershipIdentifier/configured-model-algorithm-associations?nextToken=string&maxResults=0Returns a list of configured model algorithm associations. - POSTCreate configured model algorithm association
/memberships/:membershipIdentifier/configured-model-algorithm-associationsAssociates a configured model algorithm to a collaboration for use by any member of the collaboration. - GETGet configured model algorithm association
/memberships/:membershipIdentifier/configured-model-algorithm-associations/:configuredModelAlgorithmAssociationArnReturns information about a configured model algorithm association. - DELETEDelete configured model algorithm association
/memberships/:membershipIdentifier/configured-model-algorithm-associations/:configuredModelAlgorithmAssociationArnDeletes a configured model algorithm association. - GETGet collaboration configured model algorithm association
/collaborations/:collaborationIdentifier/configured-model-algorithm-associations/:configuredModelAlgorithmAssociationArnReturns information about the configured model algorithm association in a collaboration.
ML input channel
- GETList mL input channels
/memberships/:membershipIdentifier/ml-input-channels?nextToken=string&maxResults=0Returns a list of ML input channels. - POSTCreate mL input channel
/memberships/:membershipIdentifier/ml-input-channelsProvides 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. - GETGet mL input channel
/memberships/:membershipIdentifier/ml-input-channels/:mlInputChannelArnReturns information about an ML input channel. - DELETEDelete mL input channel data
/memberships/:membershipIdentifier/ml-input-channels/:mlInputChannelArnProvides the information necessary to delete an ML input channel. - GETGet collaboration mL input channel
/collaborations/:collaborationIdentifier/ml-input-channels/:mlInputChannelArnReturns information about a specific ML input channel in a collaboration.
Training dataset
- GETList training datasets
/training-dataset?nextToken=string&maxResults=0Returns a list of training datasets. - POSTCreate training dataset
/training-datasetDefines 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… - GETGet training dataset
/training-dataset/:trainingDatasetArnReturns information about a training dataset. - DELETEDelete training dataset
/training-dataset/:trainingDatasetArnSpecifies 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…
Audience generation job
- GETGet audience generation job
/audience-generation-job/:audienceGenerationJobArnReturns information about an audience generation job. - DELETEDelete audience generation job
/audience-generation-job/:audienceGenerationJobArnDeletes the specified audience generation job, and removes all data associated with the job. - GETList audience generation jobs
/audience-generation-job?nextToken=string&maxResults=0&configuredAudienceModelArn=string&collaborationId=stringReturns a list of audience generation jobs. - POSTStart audience generation job
/audience-generation-jobInformation necessary to start the audience generation job.
Configured audience model policy
- GETGet configured audience model policy
/configured-audience-model/:configuredAudienceModelArn/policyReturns information about a configured audience model policy. - PUTPut configured audience model policy
/configured-audience-model/:configuredAudienceModelArn/policyCreate or update the resource policy for a configured audience model. - DELETEDelete configured audience model policy
/configured-audience-model/:configuredAudienceModelArn/policyDeletes the specified configured audience model policy.
ML configuration
- GETGet mL configuration
/memberships/:membershipIdentifier/ml-configurationsReturns information about a specific ML configuration. - PUTPut mL configuration
/memberships/:membershipIdentifier/ml-configurationsAssigns information about an ML configuration. - DELETEDelete mL configuration
/memberships/:membershipIdentifier/ml-configurationsDeletes a ML modeling configuration.
Audience export job
- GETList audience export jobs
/audience-export-job?nextToken=string&maxResults=0&audienceGenerationJobArn=stringReturns a list of the audience export jobs. - POSTStart audience export job
/audience-export-jobExport an audience of a specified size after you have generated an audience.
Trained model export job
- POSTStart trained model export job
/memberships/:membershipIdentifier/trained-models/:trainedModelArn/export-jobsProvides the information necessary to start a trained model export job.
- GETList collaboration configured model algorithm associations
/collaborations/:collaborationIdentifier/configured-model-algorithm-associations?nextToken=string&maxResults=0Returns a list of the configured model algorithm associations in a collaboration. - GETList collaboration mL input channels
/collaborations/:collaborationIdentifier/ml-input-channels?nextToken=string&maxResults=0Returns a list of the ML input channels in a collaboration. - GETList collaboration trained model export jobs
/collaborations/:collaborationIdentifier/trained-models/:trainedModelArn/export-jobs?nextToken=string&maxResults=0&trainedModelVersionIdentifier=stringReturns a list of the export jobs for a trained model in a collaboration. - GETList collaboration trained model inference jobs
/collaborations/:collaborationIdentifier/trained-model-inference-jobs?nextToken=string&maxResults=0&trainedModelArn=string&trainedModelVersionIdentifier=stringReturns a list of trained model inference jobs in a specified collaboration. - GETList collaboration trained models
/collaborations/:collaborationIdentifier/trained-models?nextToken=string&maxResults=0Returns a list of the trained models in a collaboration. - GETList tags for resource
/tags/:resourceArnReturns a list of tags for a provided resource. - POSTTag resource
/tags/:resourceArnAdds metadata tags to a specified resource. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes metadata tags from a specified resource.
API details
- Base URL
https://cleanrooms-ml.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 59 operations on 32 pathsGET 31POST 12DELETE 11PATCH 3PUT 2
- Main resources
- Trained model 7Configured audience model 5Configured model algorithm association 5ML input channel 5Audience generation job 4Audience model 4Configured model algorithm 4Trained model inference job 4Training dataset 4Configured audience model policy 3
- Description format
- AWS Smithy model, API version
2023-09-06 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Clean Rooms ML in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Clean Rooms ML collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get trained model” (GET /memberships/:membershipIdentifier/trained-models/:trainedModelArn?versionIdentifier=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Clean Rooms ML?
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… It is listed under AI & machine learning and has 59 endpoints.
Who publishes the AWS Clean Rooms ML?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Clean Rooms ML?
Requests go to https://cleanrooms-ml.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Clean Rooms ML?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Clean Rooms ML have?
59 operations on 32 paths (31 GET, 12 POST, 11 DELETE, 3 PATCH, 2 PUT). The largest groups are Trained model, Configured audience model, Configured model algorithm association, ML input channel.
Is forking the AWS Clean Rooms ML free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.