Skip to main content

collaboration_trained_models

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

Overview​

Namecollaboration_trained_models
TypeResource
Idaws.cleanroomsml.collaboration_trained_models

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe name of the trained model. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
collaboration_identifierstringThe 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_arnstringThe 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_timestring (date-time)The time at which the trained model was created.
creator_account_idstringThe account ID of the member that created the trained model. (pattern: <code>[0-9]{12}</code>)
descriptionstringThe description of the trained model. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
incremental_training_data_channelsarrayInformation about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.
logs_statusstringStatus information for the logs. (PUBLISH_SUCCEEDED, PUBLISH_FAILED)
logs_status_detailsstringDetails about the status information for the logs.
membership_identifierstringThe 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>)
metrics_statusstringThe status of the model metrics. (PUBLISH_SUCCEEDED, PUBLISH_FAILED)
metrics_status_detailsstringDetails about the status information for the model metrics.
ml_model_training_payer_account_idstringThe account ID of the member that is responsible for paying for model training costs. (pattern: <code>[0-9]{12}</code>)
resource_configobjectInformation about the EC2 resources that are used to train the model.
statusstringThe 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)
status_detailsobjectDetails about the status of a resource.
stopping_conditionobjectThe criteria used to stop model training.
trained_model_arnstringThe 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>)
training_container_image_digeststringInformation about the training container image.
training_input_modestringThe input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm. (File, FastFile, Pipe)
update_timestring (date-time)The most recent time at which the trained model was updated.
version_identifierstringThe version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same 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>)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_collaboration_trained_modelselecttrained_model_arn, collaboration_identifier, regionversionIdentifierReturns information about a trained model in a collaboration.
list_collaboration_trained_modelsselectcollaboration_identifier, regionnextToken, maxResultsReturns a list of the trained models in a collaboration.

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.

NameDatatypeDescription
collaboration_identifierstringThe collaboration ID of the collaboration that contains the trained models you are interested in.
regionstringAWS region (default: us-east-1)
trained_model_arnstringThe Amazon Resource Name (ARN) of the trained model that you want to return information about.
maxResultsintegerThe maximum size of the results that is returned per call.
nextTokenstringThe token value retrieved from a previous call to access the next page of results.
versionIdentifierstringThe version identifier of the trained model to retrieve. If not specified, the operation returns information about the latest version of the trained model.

SELECT examples​

Returns information about a trained model in a collaboration.

SELECT
name,
collaboration_identifier,
configured_model_algorithm_association_arn,
create_time,
creator_account_id,
description,
incremental_training_data_channels,
logs_status,
logs_status_details,
membership_identifier,
metrics_status,
metrics_status_details,
ml_model_training_payer_account_id,
resource_config,
status,
status_details,
stopping_condition,
trained_model_arn,
training_container_image_digest,
training_input_mode,
update_time,
version_identifier
FROM aws.cleanroomsml.collaboration_trained_models
WHERE trained_model_arn = '{{ trained_model_arn }}' -- required
AND collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
AND versionIdentifier = '{{ versionIdentifier }}'
;
Last updated on