Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeModel

Describes a version of an Amazon Lookout for Vision model.

This operation requires permissions to perform the lookoutvision:DescribeModel operation.

Request Syntax


GET /2020-11-20/projects/projectName/models/modelVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

modelVersion

The version of the model that you want to describe.

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

Pattern: ([1-9][0-9]*|latest)

Required: Yes

projectName

The project that contains the version of a model that you want to describe.

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

Pattern: [a-zA-Z0-9][a-zA-Z0-9_\-]*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ModelDescription": { 
      "CreationTimestamp": number,
      "Description": "string",
      "EvaluationEndTimestamp": number,
      "EvaluationManifest": { 
         "Bucket": "string",
         "Key": "string"
      },
      "EvaluationResult": { 
         "Bucket": "string",
         "Key": "string"
      },
      "KmsKeyId": "string",
      "MaxInferenceUnits": number,
      "MinInferenceUnits": number,
      "ModelArn": "string",
      "ModelVersion": "string",
      "OutputConfig": { 
         "S3Location": { 
            "Bucket": "string",
            "Prefix": "string"
         }
      },
      "Performance": { 
         "F1Score": number,
         "Precision": number,
         "Recall": number
      },
      "Status": "string",
      "StatusMessage": "string"
   }
}

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.

ModelDescription

Contains the description of the model.

Type: ModelDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You are not authorized to perform the action.

HTTP Status Code: 403

ConflictException

The update or deletion of a resource caused an inconsistent state.

HTTP Status Code: 409

InternalServerException

Amazon Lookout for Vision experienced a service issue. Try your call again.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 404

ThrottlingException

Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

HTTP Status Code: 429

ValidationException

An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

HTTP Status Code: 400