CleanRoomsML class

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.

Constructors

CleanRoomsML({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancelTrainedModel({required String membershipIdentifier, required String trainedModelArn, String? versionIdentifier}) → Future<void>
Submits a request to cancel the trained model job.
cancelTrainedModelInferenceJob({required String membershipIdentifier, required String trainedModelInferenceJobArn}) → Future<void>
Submits a request to cancel a trained model inference job.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createAudienceModel({required String name, required String trainingDatasetArn, String? description, String? kmsKeyArn, Map<String, String>? tags, DateTime? trainingDataEndTime, DateTime? trainingDataStartTime}) → Future<CreateAudienceModelResponse>
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.
createConfiguredAudienceModel({required String audienceModelArn, required String name, required ConfiguredAudienceModelOutputConfig outputConfig, required List<SharedAudienceMetrics> sharedAudienceMetrics, AudienceSizeConfig? audienceSizeConfig, TagOnCreatePolicy? childResourceTagOnCreatePolicy, String? description, int? minMatchingSeedSize, Map<String, String>? tags}) → Future<CreateConfiguredAudienceModelResponse>
Defines the information necessary to create a configured audience model.
createConfiguredModelAlgorithm({required String name, required String roleArn, String? description, InferenceContainerConfig? inferenceContainerConfig, String? kmsKeyArn, Map<String, String>? tags, ContainerConfig? trainingContainerConfig}) → Future<CreateConfiguredModelAlgorithmResponse>
Creates a configured model algorithm using a container image stored in an ECR repository.
createConfiguredModelAlgorithmAssociation({required String configuredModelAlgorithmArn, required String membershipIdentifier, required String name, String? description, PrivacyConfiguration? privacyConfiguration, Map<String, String>? tags}) → Future<CreateConfiguredModelAlgorithmAssociationResponse>
Associates a configured model algorithm to a collaboration for use by any member of the collaboration.
createMLInputChannel({required List<String> configuredModelAlgorithmAssociations, required InputChannel inputChannel, required String membershipIdentifier, required String name, required int retentionInDays, String? description, String? kmsKeyArn, PayerConfiguration? payerConfiguration, Map<String, String>? tags}) → Future<CreateMLInputChannelResponse>
Provides 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.
createTrainedModel({required String configuredModelAlgorithmAssociationArn, required List<ModelTrainingDataChannel> dataChannels, required String membershipIdentifier, required String name, required ResourceConfig resourceConfig, String? description, Map<String, String>? environment, Map<String, String>? hyperparameters, List<IncrementalTrainingDataChannel>? incrementalTrainingDataChannels, String? kmsKeyArn, String? mlModelTrainingPayerAccountId, StoppingCondition? stoppingCondition, Map<String, String>? tags, TrainingInputMode? trainingInputMode}) → Future<CreateTrainedModelResponse>
Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.
createTrainingDataset({required String name, required String roleArn, required List<Dataset> trainingData, String? description, Map<String, String>? tags}) → Future<CreateTrainingDatasetResponse>
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.
deleteAudienceGenerationJob({required String audienceGenerationJobArn}) → Future<void>
Deletes the specified audience generation job, and removes all data associated with the job.
deleteAudienceModel({required String audienceModelArn}) → Future<void>
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.
deleteConfiguredAudienceModel({required String configuredAudienceModelArn}) → Future<void>
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.
deleteConfiguredAudienceModelPolicy({required String configuredAudienceModelArn}) → Future<void>
Deletes the specified configured audience model policy.
deleteConfiguredModelAlgorithm({required String configuredModelAlgorithmArn}) → Future<void>
Deletes a configured model algorithm.
deleteConfiguredModelAlgorithmAssociation({required String configuredModelAlgorithmAssociationArn, required String membershipIdentifier}) → Future<void>
Deletes a configured model algorithm association.
deleteMLConfiguration({required String membershipIdentifier}) → Future<void>
Deletes a ML modeling configuration.
deleteMLInputChannelData({required String membershipIdentifier, required String mlInputChannelArn}) → Future<void>
Provides the information necessary to delete an ML input channel.
deleteTrainedModelOutput({required String membershipIdentifier, required String trainedModelArn, String? versionIdentifier}) → Future<void>
Deletes the model artifacts stored by the service.
deleteTrainingDataset({required String trainingDatasetArn}) → Future<void>
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.
getAudienceGenerationJob({required String audienceGenerationJobArn}) → Future<GetAudienceGenerationJobResponse>
Returns information about an audience generation job.
getAudienceModel({required String audienceModelArn}) → Future<GetAudienceModelResponse>
Returns information about an audience model
getCollaborationConfiguredModelAlgorithmAssociation({required String collaborationIdentifier, required String configuredModelAlgorithmAssociationArn}) → Future<GetCollaborationConfiguredModelAlgorithmAssociationResponse>
Returns information about the configured model algorithm association in a collaboration.
getCollaborationMLInputChannel({required String collaborationIdentifier, required String mlInputChannelArn}) → Future<GetCollaborationMLInputChannelResponse>
Returns information about a specific ML input channel in a collaboration.
getCollaborationTrainedModel({required String collaborationIdentifier, required String trainedModelArn, String? versionIdentifier}) → Future<GetCollaborationTrainedModelResponse>
Returns information about a trained model in a collaboration.
getConfiguredAudienceModel({required String configuredAudienceModelArn}) → Future<GetConfiguredAudienceModelResponse>
Returns information about a specified configured audience model.
getConfiguredAudienceModelPolicy({required String configuredAudienceModelArn}) → Future<GetConfiguredAudienceModelPolicyResponse>
Returns information about a configured audience model policy.
getConfiguredModelAlgorithm({required String configuredModelAlgorithmArn}) → Future<GetConfiguredModelAlgorithmResponse>
Returns information about a configured model algorithm.
getConfiguredModelAlgorithmAssociation({required String configuredModelAlgorithmAssociationArn, required String membershipIdentifier}) → Future<GetConfiguredModelAlgorithmAssociationResponse>
Returns information about a configured model algorithm association.
getMLConfiguration({required String membershipIdentifier}) → Future<GetMLConfigurationResponse>
Returns information about a specific ML configuration.
getMLInputChannel({required String membershipIdentifier, required String mlInputChannelArn}) → Future<GetMLInputChannelResponse>
Returns information about an ML input channel.
getTrainedModel({required String membershipIdentifier, required String trainedModelArn, String? versionIdentifier}) → Future<GetTrainedModelResponse>
Returns information about a trained model.
getTrainedModelInferenceJob({required String membershipIdentifier, required String trainedModelInferenceJobArn}) → Future<GetTrainedModelInferenceJobResponse>
Returns information about a trained model inference job.
getTrainingDataset({required String trainingDatasetArn}) → Future<GetTrainingDatasetResponse>
Returns information about a training dataset.
listAudienceExportJobs({String? audienceGenerationJobArn, int? maxResults, String? nextToken}) → Future<ListAudienceExportJobsResponse>
Returns a list of the audience export jobs.
listAudienceGenerationJobs({String? collaborationId, String? configuredAudienceModelArn, int? maxResults, String? nextToken}) → Future<ListAudienceGenerationJobsResponse>
Returns a list of audience generation jobs.
listAudienceModels({int? maxResults, String? nextToken}) → Future<ListAudienceModelsResponse>
Returns a list of audience models.
listCollaborationConfiguredModelAlgorithmAssociations({required String collaborationIdentifier, int? maxResults, String? nextToken}) → Future<ListCollaborationConfiguredModelAlgorithmAssociationsResponse>
Returns a list of the configured model algorithm associations in a collaboration.
listCollaborationMLInputChannels({required String collaborationIdentifier, int? maxResults, String? nextToken}) → Future<ListCollaborationMLInputChannelsResponse>
Returns a list of the ML input channels in a collaboration.
listCollaborationTrainedModelExportJobs({required String collaborationIdentifier, required String trainedModelArn, int? maxResults, String? nextToken, String? trainedModelVersionIdentifier}) → Future<ListCollaborationTrainedModelExportJobsResponse>
Returns a list of the export jobs for a trained model in a collaboration.
listCollaborationTrainedModelInferenceJobs({required String collaborationIdentifier, int? maxResults, String? nextToken, String? trainedModelArn, String? trainedModelVersionIdentifier}) → Future<ListCollaborationTrainedModelInferenceJobsResponse>
Returns a list of trained model inference jobs in a specified collaboration.
listCollaborationTrainedModels({required String collaborationIdentifier, int? maxResults, String? nextToken}) → Future<ListCollaborationTrainedModelsResponse>
Returns a list of the trained models in a collaboration.
listConfiguredAudienceModels({int? maxResults, String? nextToken}) → Future<ListConfiguredAudienceModelsResponse>
Returns a list of the configured audience models.
listConfiguredModelAlgorithmAssociations({required String membershipIdentifier, int? maxResults, String? nextToken}) → Future<ListConfiguredModelAlgorithmAssociationsResponse>
Returns a list of configured model algorithm associations.
listConfiguredModelAlgorithms({int? maxResults, String? nextToken}) → Future<ListConfiguredModelAlgorithmsResponse>
Returns a list of configured model algorithms.
listMLInputChannels({required String membershipIdentifier, int? maxResults, String? nextToken}) → Future<ListMLInputChannelsResponse>
Returns a list of ML input channels.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Returns a list of tags for a provided resource.
listTrainedModelInferenceJobs({required String membershipIdentifier, int? maxResults, String? nextToken, String? trainedModelArn, String? trainedModelVersionIdentifier}) → Future<ListTrainedModelInferenceJobsResponse>
Returns a list of trained model inference jobs that match the request parameters.
listTrainedModels({required String membershipIdentifier, int? maxResults, String? nextToken}) → Future<ListTrainedModelsResponse>
Returns a list of trained models.
listTrainedModelVersions({required String membershipIdentifier, required String trainedModelArn, int? maxResults, String? nextToken, TrainedModelStatus? status}) → Future<ListTrainedModelVersionsResponse>
Returns a list of trained model versions for a specified trained model. This operation allows you to view all versions of a trained model, including information about their status and creation details. You can use this to track the evolution of your trained models and select specific versions for inference or further training.
listTrainingDatasets({int? maxResults, String? nextToken}) → Future<ListTrainingDatasetsResponse>
Returns a list of training datasets.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putConfiguredAudienceModelPolicy({required String configuredAudienceModelArn, required String configuredAudienceModelPolicy, PolicyExistenceCondition? policyExistenceCondition, String? previousPolicyHash}) → Future<PutConfiguredAudienceModelPolicyResponse>
Create or update the resource policy for a configured audience model.
putMLConfiguration({required MLOutputConfiguration defaultOutputLocation, required String membershipIdentifier}) → Future<void>
Assigns information about an ML configuration.
startAudienceExportJob({required String audienceGenerationJobArn, required AudienceSize audienceSize, required String name, String? description}) → Future<void>
Export an audience of a specified size after you have generated an audience.
startAudienceGenerationJob({required String configuredAudienceModelArn, required String name, required AudienceGenerationJobDataSource seedAudience, String? collaborationId, String? description, bool? includeSeedInOutput, Map<String, String>? tags}) → Future<StartAudienceGenerationJobResponse>
Information necessary to start the audience generation job.
startTrainedModelExportJob({required String membershipIdentifier, required String name, required TrainedModelExportOutputConfiguration outputConfiguration, required String trainedModelArn, String? description, String? trainedModelVersionIdentifier}) → Future<void>
Provides the information necessary to start a trained model export job.
startTrainedModelInferenceJob({required ModelInferenceDataSource dataSource, required String membershipIdentifier, required String name, required InferenceOutputConfiguration outputConfiguration, required InferenceResourceConfig resourceConfig, required String trainedModelArn, String? configuredModelAlgorithmAssociationArn, InferenceContainerExecutionParameters? containerExecutionParameters, String? description, Map<String, String>? environment, String? kmsKeyArn, String? mlModelInferencePayerAccountId, Map<String, String>? tags, String? trainedModelVersionIdentifier}) → Future<StartTrainedModelInferenceJobResponse>
Defines the information necessary to begin a trained model inference job.
tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>
Adds metadata tags to a specified resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes metadata tags from a specified resource.
updateConfiguredAudienceModel({required String configuredAudienceModelArn, String? audienceModelArn, AudienceSizeConfig? audienceSizeConfig, String? description, int? minMatchingSeedSize, ConfiguredAudienceModelOutputConfig? outputConfig, List<SharedAudienceMetrics>? sharedAudienceMetrics}) → Future<UpdateConfiguredAudienceModelResponse>
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.

Operators

operator ==(Object other) → bool
The equality operator.
inherited