model_versions

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

Overview

Name	model_versions
Type	Resource
Id	aws.lookoutequipment.model_versions

Fields

The following fields are returned by SELECT queries:

describe_model_version

Name	Datatype	Description
auto_promotion_result	string	Indicates whether the model version was promoted to be the active version after retraining or if there was an error with or cancellation of the retraining. (MODEL_PROMOTED, MODEL_NOT_PROMOTED, RETRAINING_INTERNAL_ERROR, RETRAINING_CUSTOMER_ERROR, RETRAINING_CANCELLED)
auto_promotion_result_reason	string	Indicates the reason for the AutoPromotionResult. For example, a model might not be promoted if its performance was worse than the active version, if there was an error during training, or if the retraining scheduler was using MANUAL promote mode. The model will be promoted in MANAGED promote mode if the performance is better than the previous model.
created_at	string (date-time)	Indicates the time and date at which the machine learning model version was created.
data_pre_processing_configuration	object	The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute. When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H
dataset_arn	string	The Amazon Resource Name (ARN) of the dataset used to train the model version. (pattern: <code>arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9-]*:[0-9]{12}:dataset/[0-9a-zA-Z_-]{1,200}/.+</code>)
dataset_name	string	The name of the dataset used to train the model version. (pattern: <code>^[0-9a-zA-Z_-]{1,200}$</code>)
evaluation_data_end_time	string (date-time)	The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version finished being gathered.
evaluation_data_start_time	string (date-time)	The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version began being gathered.
failed_reason	string	The failure message if the training of the model version failed. (pattern: <code>[\P{M}\p{M}]{1,5000}</code>)
import_job_end_time	string (date-time)	The date and time when the import job completed. This field appears if the model version was imported.
import_job_start_time	string (date-time)	The date and time when the import job began. This field appears if the model version was imported.
imported_data_size_in_bytes	integer (int64)	The size in bytes of the imported data. This field appears if the model version was imported.
labels_input_configuration	object	Contains the configuration information for the S3 location being used to hold label data.
last_updated_time	string (date-time)	Indicates the last time the machine learning model version was updated.
model_arn	string	The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to. (pattern: <code>arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9-]*:[0-9]{12}:model/.+</code>)
model_diagnostics_output_configuration	object	The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.
model_diagnostics_results_object	object	Contains information about an S3 bucket.
model_metrics	string	Shows an aggregated summary, in JSON format, of the model's performance within the evaluation time range. These metrics are created when evaluating the model.
model_name	string	The name of the machine learning model that this version belongs to. (pattern: <code>^[0-9a-zA-Z_-]{1,200}$</code>)
model_quality	string	Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET. If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model. For information about using labels with your models, see Understanding labeling. For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment. (QUALITY_THRESHOLD_MET, CANNOT_DETERMINE_QUALITY, POOR_QUALITY_DETECTED)
model_version	integer (int64)	The version of the machine learning model.
model_version_arn	string	The Amazon Resource Name (ARN) of the model version. (pattern: <code>^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9-]*:[0-9]{12}:model/[0-9a-zA-Z_-]{1,200}/.+/model-version/[0-9]{1,}$</code>)
off_condition	string	Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.
prior_model_metrics	string	If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.
retraining_available_data_in_days	integer	Indicates the number of days of data used in the most recent scheduled retraining run.
role_arn	string	The Amazon Resource Name (ARN) of the role that was used to train the model version. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
schema	string	The schema of the data used to train the model version.
server_side_kms_key_id	string	The identifier of the KMS key key used to encrypt model version data by Amazon Lookout for Equipment. (pattern: <code>arn:aws[a-z-]:kms:[a-z0-9-]:\d{12}:[\w-/]+</code>)
source_model_version_arn	string	If model version was imported, then this field is the arn of the source model version. (pattern: <code>^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9-]*:[0-9]{12}:model/[0-9a-zA-Z_-]{1,200}/.+/model-version/[0-9]{1,}$</code>)
source_type	string	Indicates whether this model version was created by training or by importing. (TRAINING, RETRAINING, IMPORT)
status	string	The current status of the model version. (IN_PROGRESS, SUCCESS, FAILED, IMPORT_IN_PROGRESS, CANCELED)
training_data_end_time	string (date-time)	The date on which the training data finished being gathered. If you imported the version, this is the date that the training data in the source version finished being gathered.
training_data_start_time	string (date-time)	The date on which the training data began being gathered. If you imported the version, this is the date that the training data in the source version began being gathered.
training_execution_end_time	string (date-time)	The time when the training of the version completed.
training_execution_start_time	string (date-time)	The time when the training of the version began.

list_model_versions

Name	Datatype	Description
model_version_summaries	array	Provides information on the specified model version, including the created time, model and dataset ARNs, and status. If you don't supply the ModelName request parameter, or if you supply the name of a model that doesn't exist, ListModelVersions returns an empty array in ModelVersionSummaries.
next_token	string	If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results. (pattern: <code>\p{ASCII}{0,8192}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_model_version	select	region		Retrieves information about a specific machine learning model version.
list_model_versions	select	region		Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.
update_active_model_version	update	region, ModelName, ModelVersion		Sets the active model version for a given machine learning model.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_model_version

Retrieves information about a specific machine learning model version.

SELECT
auto_promotion_result,
auto_promotion_result_reason,
created_at,
data_pre_processing_configuration,
dataset_arn,
dataset_name,
evaluation_data_end_time,
evaluation_data_start_time,
failed_reason,
import_job_end_time,
import_job_start_time,
imported_data_size_in_bytes,
labels_input_configuration,
last_updated_time,
model_arn,
model_diagnostics_output_configuration,
model_diagnostics_results_object,
model_metrics,
model_name,
model_quality,
model_version,
model_version_arn,
off_condition,
prior_model_metrics,
retraining_available_data_in_days,
role_arn,
schema,
server_side_kms_key_id,
source_model_version_arn,
source_type,
status,
training_data_end_time,
training_data_start_time,
training_execution_end_time,
training_execution_start_time
FROM aws.lookoutequipment.model_versions
WHERE region = '{{ region }}' -- required
;

list_model_versions

Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.

SELECT
model_version_summaries,
next_token
FROM aws.lookoutequipment.model_versions
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_active_model_version

Sets the active model version for a given machine learning model.

UPDATE aws.lookoutequipment.model_versions
SET 
ModelName = '{{ ModelName }}',
ModelVersion = {{ ModelVersion }}
WHERE 
region = '{{ region }}' --required
AND ModelName = '{{ ModelName }}' --required
AND ModelVersion = '{{ ModelVersion }}' --required
RETURNING
current_active_version,
current_active_version_arn,
model_arn,
model_name,
previous_active_version,
previous_active_version_arn;