Amazon Lookout for Equipment is no longer open to new customers.
Existing customers can continue to use the service as normal.
For capabilities similar to Amazon Lookout for Equipment see our
blog post
ModelSummary
Provides information about the specified machine learning model, including dataset and model names and ARNs, as well as status.
Contents
- ActiveModelVersion
-
The model version that the inference scheduler uses to run an inference execution.
Type: Long
Valid Range: Minimum value of 1.
Required: No
- ActiveModelVersionArn
-
The Amazon Resource Name (ARN) of the model version that is set as active. The active model version is the model version that the inference scheduler uses to run an inference execution.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$Required: No
- CreatedAt
-
The time at which the specific model was created.
Type: Timestamp
Required: No
- DatasetArn
-
The Amazon Resource Name (ARN) of the dataset used to create the model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/[0-9a-zA-Z_-]{1,200}\/.+Required: No
- DatasetName
-
The name of the dataset being used for the machine learning model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$Required: No
- LatestScheduledRetrainingModelVersion
-
Indicates the most recent model version that was generated by retraining.
Type: Long
Valid Range: Minimum value of 1.
Required: No
- LatestScheduledRetrainingStartTime
-
Indicates the start time of the most recent scheduled retraining run.
Type: Timestamp
Required: No
- LatestScheduledRetrainingStatus
-
Indicates the status of the most recent scheduled retraining run.
Type: String
Valid Values:
IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS | CANCELEDRequired: No
- ModelArn
-
The Amazon Resource Name (ARN) of the machine learning model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+Required: No
- ModelDiagnosticsOutputConfiguration
-
Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.
Type: ModelDiagnosticsOutputConfiguration object
Required: No
- ModelName
-
The name of the machine learning model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$Required: No
- ModelQuality
-
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 isQUALITY_THRESHOLD_MET.If the model is unlabeled, the model quality can't be assessed and the value of
ModelQualityisCANNOT_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.
Type: String
Valid Values:
QUALITY_THRESHOLD_MET | CANNOT_DETERMINE_QUALITY | POOR_QUALITY_DETECTEDRequired: No
- NextScheduledRetrainingStartDate
-
Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.
Type: Timestamp
Required: No
- RetrainingSchedulerStatus
-
Indicates the status of the retraining scheduler.
Type: String
Valid Values:
PENDING | RUNNING | STOPPING | STOPPEDRequired: No
- Status
-
Indicates the status of the machine learning model.
Type: String
Valid Values:
IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESSRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
