Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

describe-edge-packaging-job

Description

A description of edge packaging jobs.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-edge-packaging-job
--edge-packaging-job-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--edge-packaging-job-name (string)

The name of the edge packaging job.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

EdgePackagingJobArn -> (string)

The Amazon Resource Name (ARN) of the edge packaging job.

EdgePackagingJobName -> (string)

The name of the edge packaging job.

CompilationJobName -> (string)

The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

ModelName -> (string)

The name of the model.

ModelVersion -> (string)

The version of the model.

RoleArn -> (string)

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

OutputConfig -> (structure)

The output configuration for the edge packaging job.

S3OutputLocation -> (string)

The Amazon Simple Storage (S3) bucker URI.

KmsKeyId -> (string)

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

PresetDeploymentType -> (string)

The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

PresetDeploymentConfig -> (string)

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

  • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.
  • ComponentDescription (optional) - Description of the component.
  • ComponentVersion (optional) - The version of the component.

Note

Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a*major.minor.patch* number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification .

  • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.
  • PlatformArchitecture (optional) - The processor architecture for the platform. Supported architectures Windows include: Windows32_x86, Windows64_x64. Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

ResourceKey -> (string)

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

EdgePackagingJobStatus -> (string)

The current status of the packaging job.

EdgePackagingJobStatusMessage -> (string)

Returns a message describing the job status and error messages.

CreationTime -> (timestamp)

The timestamp of when the packaging job was created.

LastModifiedTime -> (timestamp)

The timestamp of when the job was last updated.

ModelArtifact -> (string)

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

ModelSignature -> (string)

The signature document of files in the model artifact.

PresetDeploymentOutput -> (structure)

The output of a SageMaker Edge Manager deployable resource.

Type -> (string)

The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

Artifact -> (string)

The Amazon Resource Name (ARN) of the generated deployable resource.

Status -> (string)

The status of the deployable resource.

StatusMessage -> (string)

Returns a message describing the status of the deployed resource.