Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class DescribeModelPackagingJobCommandProtected

Describes an Amazon Lookout for Vision model packaging job.

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

     <p>For more information, see
<i>Using your Amazon Lookout for Vision model on an edge device</i> in the Amazon Lookout for Vision Developer Guide. </p>

Example

Use a bare-bones client and the command you need to make an API call.

import { LookoutVisionClient, DescribeModelPackagingJobCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import
// const { LookoutVisionClient, DescribeModelPackagingJobCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import
const client = new LookoutVisionClient(config);
const input = { // DescribeModelPackagingJobRequest
ProjectName: "STRING_VALUE", // required
JobName: "STRING_VALUE", // required
};
const command = new DescribeModelPackagingJobCommand(input);
const response = await client.send(command);
// { // DescribeModelPackagingJobResponse
// ModelPackagingDescription: { // ModelPackagingDescription
// JobName: "STRING_VALUE",
// ProjectName: "STRING_VALUE",
// ModelVersion: "STRING_VALUE",
// ModelPackagingConfiguration: { // ModelPackagingConfiguration
// Greengrass: { // GreengrassConfiguration
// CompilerOptions: "STRING_VALUE",
// TargetDevice: "jetson_xavier",
// TargetPlatform: { // TargetPlatform
// Os: "LINUX", // required
// Arch: "ARM64" || "X86_64", // required
// Accelerator: "NVIDIA",
// },
// S3OutputLocation: { // S3Location
// Bucket: "STRING_VALUE", // required
// Prefix: "STRING_VALUE",
// },
// ComponentName: "STRING_VALUE", // required
// ComponentVersion: "STRING_VALUE",
// ComponentDescription: "STRING_VALUE",
// Tags: [ // TagList
// { // Tag
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// ],
// },
// },
// ModelPackagingJobDescription: "STRING_VALUE",
// ModelPackagingMethod: "STRING_VALUE",
// ModelPackagingOutputDetails: { // ModelPackagingOutputDetails
// Greengrass: { // GreengrassOutputDetails
// ComponentVersionArn: "STRING_VALUE",
// ComponentName: "STRING_VALUE",
// ComponentVersion: "STRING_VALUE",
// },
// },
// Status: "CREATED" || "RUNNING" || "SUCCEEDED" || "FAILED",
// StatusMessage: "STRING_VALUE",
// CreationTimestamp: new Date("TIMESTAMP"),
// LastUpdatedTimestamp: new Date("TIMESTAMP"),
// },
// };

Param

DescribeModelPackagingJobCommandInput

Returns

DescribeModelPackagingJobCommandOutput

See

Throws

AccessDeniedException (client fault)

You are not authorized to perform the action.

Throws

InternalServerException (server fault)

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

Throws

ResourceNotFoundException (client fault)

The resource could not be found.

Throws

ThrottlingException (client fault)

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

Throws

ValidationException (client fault)

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

Throws

LookoutVisionServiceException

Base exception class for all service exceptions from LookoutVision service.

Hierarchy

Constructors

Properties

Methods