collaboration_trained_model_export_jobs

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

Overview

Name	collaboration_trained_model_export_jobs
Type	Resource
Id	aws.cleanroomsml.collaboration_trained_model_export_jobs

Fields

The following fields are returned by SELECT queries:

list_collaboration_trained_model_export_jobs

Name	Datatype	Description
name	string	The name of the trained model export job. (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 export job. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time at which the trained model export job was created.
creator_account_id	string	The account ID of the member that created the trained model. (pattern: <code>[0-9]{12}</code>)
description	string	The description of the trained model. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
membership_identifier	string	The membership ID of the member that created the trained model export job. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
output_configuration	object	Information about the output of the trained model export job.
status	string	The status of the trained model. (CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE)
status_details	object	Details about the status of a resource.
trained_model_arn	string	The Amazon Resource Name (ARN) of the trained model that is being exported. (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>)
trained_model_version_identifier	string	The version identifier of the trained model that was exported in this job. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
update_time	string (date-time)	The most recent time at which the trained model export job was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_collaboration_trained_model_export_jobs	select	collaboration_identifier, trained_model_arn, region	nextToken, maxResults, trainedModelVersionIdentifier	Returns a list of the export jobs for a trained model 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.

Name	Datatype	Description
collaboration_identifier	string	The collaboration ID of the collaboration that contains the trained model export jobs that you are interested in.
region	string	AWS region (default: us-east-1)
trained_model_arn	string	The Amazon Resource Name (ARN) of the trained model that was used to create the export jobs that you are interested in.
maxResults	integer	The maximum size of the results that is returned per call.
nextToken	string	The token value retrieved from a previous call to access the next page of results.
trainedModelVersionIdentifier	string	The version identifier of the trained model to filter export jobs by. When specified, only export jobs for this specific version of the trained model are returned.

SELECT examples

list_collaboration_trained_model_export_jobs

Returns a list of the export jobs for a trained model in a collaboration.

SELECT
name,
collaboration_identifier,
create_time,
creator_account_id,
description,
membership_identifier,
output_configuration,
status,
status_details,
trained_model_arn,
trained_model_version_identifier,
update_time
FROM aws.cleanroomsml.collaboration_trained_model_export_jobs
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND trained_model_arn = '{{ trained_model_arn }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND trainedModelVersionIdentifier = '{{ trainedModelVersionIdentifier }}'
;