StartModelPackagingJob - Amazon Lookout for Vision API Reference

StartModelPackagingJob

Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.

Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job is complete if the value of Status is SUCCEEDED.

To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API.

This operation requires the following permissions:

  • lookoutvision:StartModelPackagingJob

  • s3:PutObject

  • s3:GetBucketLocation

  • greengrass:CreateComponentVersion

  • greengrass:DescribeComponent

  • (Optional) greengrass:TagResource. Only required if you want to tag the component.

For more information, see Using your Amazon Lookout for Vision model on an edge device.

Request Syntax

POST /2020-11-20/projects/projectName/modelpackagingjobs HTTP/1.1 X-Amzn-Client-Token: ClientToken Content-type: application/json { "Configuration": { "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" } } }, "Description": "string", "JobName": "string", "ModelVersion": "string" }

URI Request Parameters

The request uses the following URI parameters.

ClientToken

ClientToken is an idempotency token that ensures a call to StartModelPackagingJob completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModelPackagingJob. In this case, safely retry your call to StartModelPackagingJob by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModelPackagingJob. An idempotency token is active for 8 hours.

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

Pattern: ^[a-zA-Z0-9-]+$

projectName

The name of the project which contains the version of the model that you want to package.

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 accepts the following data in JSON format.

Configuration

The configuration for the model packaging job.

Type: ModelPackagingConfiguration object

Required: Yes

Description

A description for the model packaging job.

Type: String

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

Pattern: [a-zA-Z0-9-_. ()':,;?]+

Required: No

JobName

A name for the model packaging job. If you don't supply a value, the service creates a job name for you.

Type: String

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

Pattern: [a-zA-Z0-9-]+

Required: No

ModelVersion

The version of the model within the project that you want to package.

Type: String

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

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "JobName": "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.

JobName

The job name for the model packaging job. If you don't supply a job name in the JobName input parameter, the service creates a job name for you.

Type: String

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

Pattern: [a-zA-Z0-9-]+

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

ServiceQuotaExceededException

A service quota was exceeded the allowed limit. For more information, see Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide.

HTTP Status Code: 402

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: