Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1422138111.2 KB

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

  • kms:GenerateDataKey

  • 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 in the Amazon Lookout for Vision Developer Guide.

post/2020-11-20/projects/{projectName}/modelpackagingjobs

Path parameters

projectNamestring required

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

Headers

X-Amzn-Client-Tokenstring
<p>ClientToken is an idempotency token that ensures a call to <code>StartModelPackagingJob</code> completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from <code>StartModelPackagingJob</code>. In this case, safely retry your call to <code>StartModelPackagingJob</code> by using the same <code>ClientToken</code> parameter value.</p> <p>If you don't supply a value for <code>ClientToken</code>, 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. </p> <p>An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>StartModelPackagingJob</code>. An idempotency token is active for 8 hours. </p>

Request body

ModelVersionstring required

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

JobNamestring

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

Descriptionstring

A description for the model packaging job.

Response

Success

JobNamestring

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