v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1433170151.6 KB

Provides a JSON containing the overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on.

post/#X-Amz-Target=AWSLookoutEquipmentFrontendService.DescribeModel

Headers

X-Amz-Target'AWSLookoutEquipmentFrontendService.DescribeModel' required

Request body

ModelNamestring required

The name of the ML model to be described.

Response

Success

ModelNamestring

The name of the ML model being described.

ModelArnstring

The Amazon Resource Name (ARN) of the ML model being described.

DatasetNamestring

The name of the dataset being used by the ML being described.

DatasetArnstring

The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.

Schemastring

A JSON description of the data that is in each time series dataset, including names, column names, and data types.

TrainingDataStartTimestring date-time

Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.

TrainingDataEndTimestring date-time

Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.

EvaluationDataStartTimestring date-time

Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.

EvaluationDataEndTimestring date-time

Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.

RoleArnstring

The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.

Status'IN_PROGRESS' | 'SUCCESS' | 'FAILED'

Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

TrainingExecutionStartTimestring date-time

Indicates the time at which the training of the ML model began.

TrainingExecutionEndTimestring date-time

Indicates the time at which the training of the ML model was completed.

FailedReasonstring

If the training of the ML model failed, this indicates the reason for that failure.

ModelMetricsstring

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.

LastUpdatedTimestring date-time

Indicates the last time the ML model was updated. The type of update is not specified.

CreatedAtstring date-time

Indicates the time and date at which the ML model was created.

ServerSideKmsKeyIdstring

Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.

OffConditionstring

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.