Skip to main content

trained_model_inference_jobs

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

Overview​

Nametrained_model_inference_jobs
TypeResource
Idaws.cleanroomsml.trained_model_inference_jobs

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe name of the trained model inference job. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
configured_model_algorithm_association_arnstringThe Amazon Resource Name (ARN) of the configured model algorithm association that was 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>)
container_execution_parametersobjectThe execution parameters for the model inference job container.
create_timestring (date-time)The time at which the trained model inference job was created.
data_sourceobjectThe data source that was used for the trained model inference job.
descriptionstringThe description of the trained model inference job. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
environmentobjectThe environment variables to set in the Docker container.
inference_container_image_digeststringInformation about the training container image.
kms_key_arnstringThe Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the ML inference job and associated data. (pattern: <code>arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+</code>)
logs_statusstringThe logs status for the trained model inference job. (PUBLISH_SUCCEEDED, PUBLISH_FAILED)
logs_status_detailsstringDetails about the logs status for the trained model inference job.
membership_identifierstringThe 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_statusstringThe metrics status for the trained model inference job. (PUBLISH_SUCCEEDED, PUBLISH_FAILED)
metrics_status_detailsstringDetails about the metrics status for the trained model inference job.
ml_model_inference_payer_account_idstringThe account ID of the member that is responsible for paying for model inference costs. (pattern: <code>[0-9]{12}</code>)
output_configurationobjectThe output configuration information for the trained model inference job.
resource_configobjectThe resource configuration information for the trained model inference job.
statusstringThe status of the trained model inference job. (CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE, CANCEL_PENDING, CANCEL_IN_PROGRESS, CANCEL_FAILED, INACTIVE)
status_detailsobjectDetails about the status of a resource.
tagsobjectThe optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags: Maximum number of tags per resource - 50. For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8. Maximum value length - 256 Unicode characters in UTF-8. If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
trained_model_arnstringThe Amazon Resource Name (ARN) for the trained model that was 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_arnstringThe 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_identifierstringThe version identifier of the trained model used for this inference job. This identifies the specific version of the trained model that was used to generate the inference results. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
update_timestring (date-time)The most recent time at which the trained model inference job was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_trained_model_inference_jobselectmembership_identifier, trained_model_inference_job_arn, regionReturns information about a trained model inference job.
list_trained_model_inference_jobsselectmembership_identifier, regionnextToken, maxResults, trainedModelArn, trainedModelVersionIdentifierReturns a list of trained model inference jobs that match the request parameters.

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
membership_identifierstringThe membership
regionstringAWS region (default: us-east-1)
trained_model_inference_job_arnstringProvides the Amazon Resource Name (ARN) of the trained model inference job that you are interested in.
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.
trainedModelArnstringThe Amazon Resource Name (ARN) of a trained model that was used to create the trained model inference jobs that you are interested in.
trainedModelVersionIdentifierstringThe 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​

Returns information about a trained model inference job.

SELECT
name,
configured_model_algorithm_association_arn,
container_execution_parameters,
create_time,
data_source,
description,
environment,
inference_container_image_digest,
kms_key_arn,
logs_status,
logs_status_details,
membership_identifier,
metrics_status,
metrics_status_details,
ml_model_inference_payer_account_id,
output_configuration,
resource_config,
status,
status_details,
tags,
trained_model_arn,
trained_model_inference_job_arn,
trained_model_version_identifier,
update_time
FROM aws.cleanroomsml.trained_model_inference_jobs
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND trained_model_inference_job_arn = '{{ trained_model_inference_job_arn }}' -- required
AND region = '{{ region }}' -- required
;
Last updated on