collaboration_trained_model_inference_jobs

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

Overview

Name	collaboration_trained_model_inference_jobs
Type	Resource
Id	aws.cleanroomsml.collaboration_trained_model_inference_jobs

Fields

The following fields are returned by SELECT queries:

list_collaboration_trained_model_inference_jobs

Name	Datatype	Description
name	string	The name of the trained model inference 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 inference job. (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 is used for the trained model inference job. (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 inference job was created.
creator_account_id	string	The account ID that created the trained model inference job. (pattern: <code>[0-9]{12}</code>)
description	string	The description of the trained model inference job. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
logs_status	string	The trained model inference job logs status. (PUBLISH_SUCCEEDED, PUBLISH_FAILED)
logs_status_details	string	Details about the logs status for the trained model inference job.
membership_identifier	string	The membership ID of the membership that contains the trained model inference job. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
metrics_status	string	the trained model inference job metrics status. (PUBLISH_SUCCEEDED, PUBLISH_FAILED)
metrics_status_details	string	Details about the metrics status for trained model inference job.
ml_model_inference_payer_account_id	string	The account ID of the member that is responsible for paying for model inference costs. (pattern: <code>[0-9]{12}</code>)
output_configuration	object	Returns output configuration information for the trained model inference job.
status	string	The status of the trained model inference job. (CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE, CANCEL_PENDING, CANCEL_IN_PROGRESS, CANCEL_FAILED, INACTIVE)
trained_model_arn	string	The Amazon Resource Name (ARN) of the trained model that is used for the trained model inference job. (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_inference_job_arn	string	The Amazon Resource Name (ARN) of the trained model inference job. (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-inference-job/[-a-zA-Z0-9_/.]+</code>)
trained_model_version_identifier	string	The version identifier of the trained model that was used for inference 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 inference job was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_collaboration_trained_model_inference_jobs	select	collaboration_identifier, region	nextToken, maxResults, trainedModelArn, trainedModelVersionIdentifier	Returns a list of trained model inference jobs in a specified 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 inference jobs that you are interested in.
region	string	AWS region (default: us-east-1)
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.
trainedModelArn	string	The Amazon Resource Name (ARN) of the trained model that was used to create the trained model inference jobs that you are interested in.
trainedModelVersionIdentifier	string	The version identifier of the trained model to filter inference jobs by. When specified, only inference jobs that used this specific version of the trained model are returned.

SELECT examples

list_collaboration_trained_model_inference_jobs

Returns a list of trained model inference jobs in a specified collaboration.

SELECT
name,
collaboration_identifier,
configured_model_algorithm_association_arn,
create_time,
creator_account_id,
description,
logs_status,
logs_status_details,
membership_identifier,
metrics_status,
metrics_status_details,
ml_model_inference_payer_account_id,
output_configuration,
status,
trained_model_arn,
trained_model_inference_job_arn,
trained_model_version_identifier,
update_time
FROM aws.cleanroomsml.collaboration_trained_model_inference_jobs
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND trainedModelArn = '{{ trainedModelArn }}'
AND trainedModelVersionIdentifier = '{{ trainedModelVersionIdentifier }}'
;