[ aws . lookoutvision ]

describe-model-packaging-job

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-model-packaging-job
--project-name <value>
--job-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--project-name (string)

The name of the project that contains the model packaging job that you want to describe.

--job-name (string)

The job name for the model packaging job.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ModelPackagingDescription -> (structure)

The description of the model packaging job.

JobName -> (string)

The name of the model packaging job.

ProjectName -> (string)

The name of the project that’s associated with a model that’s in the model package.

ModelVersion -> (string)

The version of the model used in the model packaging job.

ModelPackagingConfiguration -> (structure)

The configuration information used in the model packaging job.

Greengrass -> (structure)

Configuration information for the AWS IoT Greengrass component in a model packaging job.

CompilerOptions -> (string)

Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) are supported. If you specify TargetPlatform , you must specify CompilerOptions . If you specify TargetDevice , don’t specify CompilerOptions .

For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.

TargetDevice -> (string)

The target device for the model. Currently the only supported value is jetson_xavier . If you specify TargetDevice , you can’t specify TargetPlatform .

TargetPlatform -> (structure)

The target platform for the model. If you specify TargetPlatform , you can’t specify TargetDevice .

Os -> (string)

The target operating system for the model. Linux is the only operating system that is currently supported.

Arch -> (string)

The target architecture for the model. The currently supported architectures are X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit CPU).

Accelerator -> (string)

The target accelerator for the model. NVIDIA (Nvidia graphics processing unit) is the only accelerator that is currently supported. You must also specify the gpu-code , trt-ver , and cuda-ver compiler options.

S3OutputLocation -> (structure)

An S3 location in which Lookout for Vision stores the component artifacts.

Bucket -> (string)

The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

Prefix -> (string)

The path of the folder, within the S3 bucket, that contains the output.

ComponentName -> (string)

A name for the AWS IoT Greengrass component.

ComponentVersion -> (string)

A Version for the AWS IoT Greengrass component. If you don’t provide a value, a default value of `` Model Version .0.0`` is used.

ComponentDescription -> (string)

A description for the AWS IoT Greengrass component.

Tags -> (list)

A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.

(structure)

A key and value pair that is attached to the specified Amazon Lookout for Vision model.

Key -> (string)

The key of the tag that is attached to the specified model.

Value -> (string)

The value of the tag that is attached to the specified model.

ModelPackagingJobDescription -> (string)

The description for the model packaging job.

ModelPackagingMethod -> (string)

The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.

ModelPackagingOutputDetails -> (structure)

Information about the output of the model packaging job. For more information, see DescribeModelPackagingJob .

Greengrass -> (structure)

Information about the AWS IoT Greengrass component in a model packaging job.

ComponentVersionArn -> (string)

The Amazon Resource Name (ARN) of the component.

ComponentName -> (string)

The name of the component.

ComponentVersion -> (string)

The version of the component.

Status -> (string)

The status of the model packaging job.

StatusMessage -> (string)

The status message for the model packaging job.

CreationTimestamp -> (timestamp)

The Unix timestamp for the time and date that the model packaging job was created.

LastUpdatedTimestamp -> (timestamp)

The Unix timestamp for the time and date that the model packaging job was last updated.