Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeModel

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.

Request Syntax


{
   "ModelName": "string"
}

Request Parameters

The request accepts the following data in JSON format.

ModelName

The name of the ML model to be described.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z_-]{1,200}$

Required: Yes

Response Syntax


{
   "CreatedAt": number,
   "DataPreProcessingConfiguration": { 
      "TargetSamplingRate": "string"
   },
   "DatasetArn": "string",
   "DatasetName": "string",
   "EvaluationDataEndTime": number,
   "EvaluationDataStartTime": number,
   "FailedReason": "string",
   "LabelsInputConfiguration": { 
      "LabelGroupName": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "LastUpdatedTime": number,
   "ModelArn": "string",
   "ModelMetrics": "string",
   "ModelName": "string",
   "OffCondition": "string",
   "RoleArn": "string",
   "Schema": "string",
   "ServerSideKmsKeyId": "string",
   "Status": "string",
   "TrainingDataEndTime": number,
   "TrainingDataStartTime": number,
   "TrainingExecutionEndTime": number,
   "TrainingExecutionStartTime": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedAt

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

Type: Timestamp

DataPreProcessingConfiguration

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

Type: DataPreProcessingConfiguration object

DatasetArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/.+

DatasetName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z_-]{1,200}$

EvaluationDataEndTime

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

Type: Timestamp

EvaluationDataStartTime

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

Type: Timestamp

FailedReason

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5000.

Pattern: [\P{M}\p{M}]{1,5000}

LabelsInputConfiguration

Specifies configuration information about the labels input, including its S3 location.

Type: LabelsInputConfiguration object

LastUpdatedTime

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

Type: Timestamp

ModelArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+

ModelMetrics

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50000.

ModelName

The name of the ML model being described.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z_-]{1,200}$

OffCondition

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Schema

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000000.

ServerSideKmsKeyId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: arn:aws[a-z\-]*:kms:[a-z0-9\-]*:\d{12}:[\w\-\/]+

Status

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

Type: String

Valid Values: IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS

TrainingDataEndTime

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

Type: Timestamp

TrainingDataStartTime

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

Type: Timestamp

TrainingExecutionEndTime

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

Type: Timestamp

TrainingExecutionStartTime

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

Type: Timestamp

Errors

AccessDeniedException

The request could not be completed because you do not have access to the resource.

HTTP Status Code: 400

InternalServerException

Processing of the request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource requested could not be found. Verify the resource ID and retry your request.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

HTTP Status Code: 400