DescribeModelPackagingJob
Describes an Amazon Lookout for Vision model packaging job.
This operation requires permissions to perform the
lookoutvision:DescribeModelPackagingJob
operation.
For more information, see Using your Amazon Lookout for Vision model on an edge device.
Request Syntax
GET /2020-11-20/projects/projectName
/modelpackagingjobs/jobName
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- jobName
-
The job name for the model packaging job.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]+
Required: Yes
- projectName
-
The name of the project that contains the model packaging job 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
{
"ModelPackagingDescription": {
"CreationTimestamp": number,
"JobName": "string",
"LastUpdatedTimestamp": number,
"ModelPackagingConfiguration": {
"Greengrass": {
"CompilerOptions": "string",
"ComponentDescription": "string",
"ComponentName": "string",
"ComponentVersion": "string",
"S3OutputLocation": {
"Bucket": "string",
"Prefix": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TargetDevice": "string",
"TargetPlatform": {
"Accelerator": "string",
"Arch": "string",
"Os": "string"
}
}
},
"ModelPackagingJobDescription": "string",
"ModelPackagingMethod": "string",
"ModelPackagingOutputDetails": {
"Greengrass": {
"ComponentName": "string",
"ComponentVersion": "string",
"ComponentVersionArn": "string"
}
},
"ModelVersion": "string",
"ProjectName": "string",
"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.
- ModelPackagingDescription
-
The description of the model packaging job.
Type: ModelPackagingDescription 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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: