- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeModelCommand
Provides a JSON containing the overall information about a specific machine learning model, including model name and ARN, dataset, training and evaluation information, status, and so on.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LookoutEquipmentClient, DescribeModelCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
// const { LookoutEquipmentClient, DescribeModelCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
const client = new LookoutEquipmentClient(config);
const input = { // DescribeModelRequest
ModelName: "STRING_VALUE", // required
};
const command = new DescribeModelCommand(input);
const response = await client.send(command);
// { // DescribeModelResponse
// ModelName: "STRING_VALUE",
// ModelArn: "STRING_VALUE",
// DatasetName: "STRING_VALUE",
// DatasetArn: "STRING_VALUE",
// Schema: "STRING_VALUE",
// LabelsInputConfiguration: { // LabelsInputConfiguration
// S3InputConfiguration: { // LabelsS3InputConfiguration
// Bucket: "STRING_VALUE", // required
// Prefix: "STRING_VALUE",
// },
// LabelGroupName: "STRING_VALUE",
// },
// TrainingDataStartTime: new Date("TIMESTAMP"),
// TrainingDataEndTime: new Date("TIMESTAMP"),
// EvaluationDataStartTime: new Date("TIMESTAMP"),
// EvaluationDataEndTime: new Date("TIMESTAMP"),
// RoleArn: "STRING_VALUE",
// DataPreProcessingConfiguration: { // DataPreProcessingConfiguration
// TargetSamplingRate: "PT1S" || "PT5S" || "PT10S" || "PT15S" || "PT30S" || "PT1M" || "PT5M" || "PT10M" || "PT15M" || "PT30M" || "PT1H",
// },
// Status: "IN_PROGRESS" || "SUCCESS" || "FAILED" || "IMPORT_IN_PROGRESS",
// TrainingExecutionStartTime: new Date("TIMESTAMP"),
// TrainingExecutionEndTime: new Date("TIMESTAMP"),
// FailedReason: "STRING_VALUE",
// ModelMetrics: "STRING_VALUE",
// LastUpdatedTime: new Date("TIMESTAMP"),
// CreatedAt: new Date("TIMESTAMP"),
// ServerSideKmsKeyId: "STRING_VALUE",
// OffCondition: "STRING_VALUE",
// SourceModelVersionArn: "STRING_VALUE",
// ImportJobStartTime: new Date("TIMESTAMP"),
// ImportJobEndTime: new Date("TIMESTAMP"),
// ActiveModelVersion: Number("long"),
// ActiveModelVersionArn: "STRING_VALUE",
// ModelVersionActivatedAt: new Date("TIMESTAMP"),
// PreviousActiveModelVersion: Number("long"),
// PreviousActiveModelVersionArn: "STRING_VALUE",
// PreviousModelVersionActivatedAt: new Date("TIMESTAMP"),
// PriorModelMetrics: "STRING_VALUE",
// LatestScheduledRetrainingFailedReason: "STRING_VALUE",
// LatestScheduledRetrainingStatus: "IN_PROGRESS" || "SUCCESS" || "FAILED" || "IMPORT_IN_PROGRESS" || "CANCELED",
// LatestScheduledRetrainingModelVersion: Number("long"),
// LatestScheduledRetrainingStartTime: new Date("TIMESTAMP"),
// LatestScheduledRetrainingAvailableDataInDays: Number("int"),
// NextScheduledRetrainingStartDate: new Date("TIMESTAMP"),
// AccumulatedInferenceDataStartTime: new Date("TIMESTAMP"),
// AccumulatedInferenceDataEndTime: new Date("TIMESTAMP"),
// RetrainingSchedulerStatus: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED",
// ModelDiagnosticsOutputConfiguration: { // ModelDiagnosticsOutputConfiguration
// S3OutputConfiguration: { // ModelDiagnosticsS3OutputConfiguration
// Bucket: "STRING_VALUE", // required
// Prefix: "STRING_VALUE",
// },
// KmsKeyId: "STRING_VALUE",
// },
// ModelQuality: "QUALITY_THRESHOLD_MET" || "CANNOT_DETERMINE_QUALITY" || "POOR_QUALITY_DETECTED",
// };
DescribeModelCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ModelName Required | string | undefined | The name of the machine learning model to be described. |
DescribeModelCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
AccumulatedInferenceDataEndTime | Date | undefined | Indicates the end time of the inference data that has been accumulated. |
AccumulatedInferenceDataStartTime | Date | undefined | Indicates the start time of the inference data that has been accumulated. |
ActiveModelVersion | number | undefined | The name of the model version used by the inference schedular when running a scheduled inference execution. |
ActiveModelVersionArn | string | undefined | The Amazon Resource Name (ARN) of the model version used by the inference scheduler when running a scheduled inference execution. |
CreatedAt | Date | undefined | Indicates the time and date at which the machine learning model was created. |
DataPreProcessingConfiguration | DataPreProcessingConfiguration | undefined | The configuration is the When providing a value for the |
DatasetArn | string | undefined | The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model being described. |
DatasetName | string | undefined | The name of the dataset being used by the machine learning being described. |
EvaluationDataEndTime | Date | undefined | Indicates the time reference in the dataset that was used to end the subset of evaluation data for the machine learning model. |
EvaluationDataStartTime | Date | undefined | Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the machine learning model. |
FailedReason | string | undefined | If the training of the machine learning model failed, this indicates the reason for that failure. |
ImportJobEndTime | Date | undefined | The date and time when the import job was completed. This field appears if the active model version was imported. |
ImportJobStartTime | Date | undefined | The date and time when the import job was started. This field appears if the active model version was imported. |
LabelsInputConfiguration | LabelsInputConfiguration | undefined | Specifies configuration information about the labels input, including its S3 location. |
LastUpdatedTime | Date | undefined | Indicates the last time the machine learning model was updated. The type of update is not specified. |
LatestScheduledRetrainingAvailableDataInDays | number | undefined | Indicates the number of days of data used in the most recent scheduled retraining run. |
LatestScheduledRetrainingFailedReason | string | undefined | If the model version was generated by retraining and the training failed, this indicates the reason for that failure. |
LatestScheduledRetrainingModelVersion | number | undefined | Indicates the most recent model version that was generated by retraining. |
LatestScheduledRetrainingStartTime | Date | undefined | Indicates the start time of the most recent scheduled retraining run. |
LatestScheduledRetrainingStatus | ModelVersionStatus | undefined | Indicates the status of the most recent scheduled retraining run. |
ModelArn | string | undefined | The Amazon Resource Name (ARN) of the machine learning model being described. |
ModelDiagnosticsOutputConfiguration | ModelDiagnosticsOutputConfiguration | undefined | Configuration information for the model's pointwise model diagnostics. |
ModelMetrics | AutomaticJsonStringConversion | string | undefined | The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model. |
ModelName | string | undefined | The name of the machine learning model being described. |
ModelQuality | ModelQuality | undefined | 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 If the model is unlabeled, the model quality can't be assessed and the value of 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 . |
ModelVersionActivatedAt | Date | undefined | The date the active model version was activated. |
NextScheduledRetrainingStartDate | Date | undefined | Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day. |
OffCondition | string | undefined | 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. |
PreviousActiveModelVersion | number | undefined | The model version that was set as the active model version prior to the current active model version. |
PreviousActiveModelVersionArn | string | undefined | The ARN of the model version that was set as the active model version prior to the current active model version. |
PreviousModelVersionActivatedAt | Date | undefined | The date and time when the previous active model version was activated. |
PriorModelMetrics | AutomaticJsonStringConversion | string | undefined | 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. |
RetrainingSchedulerStatus | RetrainingSchedulerStatus | undefined | Indicates the status of the retraining scheduler. |
RoleArn | string | undefined | The Amazon Resource Name (ARN) of a role with permission to access the data source for the machine learning model being described. |
Schema | AutomaticJsonStringConversion | string | undefined | A JSON description of the data that is in each time series dataset, including names, column names, and data types. |
ServerSideKmsKeyId | string | undefined | Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment. |
SourceModelVersionArn | string | undefined | The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version was imported. |
Status | ModelStatus | undefined | Specifies the current status of the model being described. Status describes the status of the most recent action of the model. |
TrainingDataEndTime | Date | undefined | Indicates the time reference in the dataset that was used to end the subset of training data for the machine learning model. |
TrainingDataStartTime | Date | undefined | Indicates the time reference in the dataset that was used to begin the subset of training data for the machine learning model. |
TrainingExecutionEndTime | Date | undefined | Indicates the time at which the training of the machine learning model was completed. |
TrainingExecutionStartTime | Date | undefined | Indicates the time at which the training of the machine learning model began. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The request could not be completed because you do not have access to the resource. |
InternalServerException | server | Processing of the request has failed because of an unknown error, exception or failure. |
ResourceNotFoundException | client | The resource requested could not be found. Verify the resource ID and retry your request. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized. |
LookoutEquipmentServiceException | Base exception class for all service exceptions from LookoutEquipment service. |