trained_model_versions

Creates, updates, deletes, gets or lists a trained_model_versions resource.

Overview

Name	trained_model_versions
Type	Resource
Id	aws.cleanroomsml.trained_model_versions

Fields

The following fields are returned by SELECT queries:

list_trained_model_versions

Name	Datatype	Description
name	string	The name of the trained model. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
collaboration_identifier	string	The collaboration ID of the collaboration that contains the trained model. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
configured_model_algorithm_association_arn	string	The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/configured-model-algorithm-association/[-a-zA-Z0-9_/.]+</code>)
create_time	string (date-time)	The time at which the trained model was created.
description	string	The description of the trained model. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
incremental_training_data_channels	array	Information about the incremental training data channels used to create this version of the trained model.
membership_identifier	string	The membership ID of the member that created the trained model. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
ml_model_training_payer_account_id	string	The account ID of the member that is responsible for paying for model training costs. (pattern: <code>[0-9]{12}</code>)
status	string	The status of the trained model. (CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE, DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED, INACTIVE, CANCEL_PENDING, CANCEL_IN_PROGRESS, CANCEL_FAILED)
trained_model_arn	string	The Amazon Resource Name (ARN) of the trained model. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/trained-model/[-a-zA-Z0-9_/.]+</code>)
update_time	string (date-time)	The most recent time at which the trained model was updated.
version_identifier	string	The version identifier of this trained model version. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_trained_model_versions	select	membership_identifier, trained_model_arn, region	nextToken, maxResults, status	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
membership_identifier	string	The membership identifier for the collaboration that contains the trained model.
region	string	AWS region (default: us-east-1)
trained_model_arn	string	The Amazon Resource Name (ARN) of the trained model for which to list versions.
maxResults	integer	The maximum number of trained model versions to return in a single page. The default value is 10, and the maximum value is 100.
nextToken	string	The pagination token from a previous ListTrainedModelVersions request. Use this token to retrieve the next page of results.
status	string	Filter the results to only include trained model versions with the specified status. Valid values include CREATE_PENDING, CREATE_IN_PROGRESS, ACTIVE, CREATE_FAILED, and others.

SELECT examples

list_trained_model_versions

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.

SELECT
name,
collaboration_identifier,
configured_model_algorithm_association_arn,
create_time,
description,
incremental_training_data_channels,
membership_identifier,
ml_model_training_payer_account_id,
status,
trained_model_arn,
update_time,
version_identifier
FROM aws.cleanroomsml.trained_model_versions
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND trained_model_arn = '{{ trained_model_arn }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND status = '{{ status }}'
;