edge_packaging_jobs

Creates, updates, deletes, gets or lists an edge_packaging_jobs resource.

Overview

Name	edge_packaging_jobs
Type	Resource
Id	aws.sagemaker.edge_packaging_jobs

Fields

The following fields are returned by SELECT queries:

describe_edge_packaging_job

Name	Datatype	Description
compilation_job_name	string	The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
creation_time	string (date-time)	The timestamp of when the packaging job was created.
edge_packaging_job_arn	string	The Amazon Resource Name (ARN) of the edge packaging job. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z-]:\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@-_/]+</code>)
edge_packaging_job_name	string	The name of the edge packaging job. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
edge_packaging_job_status	string	The current status of the packaging job. (STARTING, INPROGRESS, COMPLETED, FAILED, STOPPING, STOPPED)
edge_packaging_job_status_message	string	Returns a message describing the job status and error messages.
last_modified_time	string (date-time)	The timestamp of when the job was last updated.
model_artifact	string	The Amazon Simple Storage (S3) URI where model artifacts ares stored. (pattern: <code>(https|s3):​//([^/]+)/?(.*)</code>)
model_name	string	The name of the model. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
model_signature	string	The signature document of files in the model artifact.
model_version	string	The version of the model. (pattern: <code>[a-zA-Z0-9\ _.]+</code>)
output_config	object	The output configuration for the edge packaging job.
preset_deployment_output	object	The output of a SageMaker Edge Manager deployable resource.
resource_key	string	The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on. (pattern: <code>[a-zA-Z0-9:/_-]*</code>)
role_arn	string	The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo. (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)

list_edge_packaging_jobs

Name	Datatype	Description
compilation_job_name	string	The name of the SageMaker Neo compilation job. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
creation_time	string (date-time)	The timestamp of when the job was created.
edge_packaging_job_arn	string	The Amazon Resource Name (ARN) of the edge packaging job. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z-]:\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@-_/]+</code>)
edge_packaging_job_name	string	The name of the edge packaging job. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
edge_packaging_job_status	string	The status of the edge packaging job. (STARTING, INPROGRESS, COMPLETED, FAILED, STOPPING, STOPPED)
last_modified_time	string (date-time)	The timestamp of when the edge packaging job was last updated.
model_name	string	The name of the model. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
model_version	string	The version of the model. (pattern: <code>[a-zA-Z0-9\ _.]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_edge_packaging_job	select	region		A description of edge packaging jobs.
list_edge_packaging_jobs	select	region		Returns a list of edge packaging jobs.
create_edge_packaging_job	insert	region, EdgePackagingJobName, CompilationJobName, ModelName, ModelVersion, RoleArn, OutputConfig		Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
stop_edge_packaging_job	exec	region, EdgePackagingJobName		Request to stop an edge packaging job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_edge_packaging_job

A description of edge packaging jobs.

SELECT
compilation_job_name,
creation_time,
edge_packaging_job_arn,
edge_packaging_job_name,
edge_packaging_job_status,
edge_packaging_job_status_message,
last_modified_time,
model_artifact,
model_name,
model_signature,
model_version,
output_config,
preset_deployment_output,
resource_key,
role_arn
FROM aws.sagemaker.edge_packaging_jobs
WHERE region = '{{ region }}' -- required
;

list_edge_packaging_jobs

Returns a list of edge packaging jobs.

SELECT
compilation_job_name,
creation_time,
edge_packaging_job_arn,
edge_packaging_job_name,
edge_packaging_job_status,
last_modified_time,
model_name,
model_version
FROM aws.sagemaker.edge_packaging_jobs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_edge_packaging_job

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

INSERT INTO aws.sagemaker.edge_packaging_jobs (
EdgePackagingJobName,
CompilationJobName,
ModelName,
ModelVersion,
RoleArn,
OutputConfig,
ResourceKey,
Tags,
region
)
SELECT 
'{{ EdgePackagingJobName }}' /* required */,
'{{ CompilationJobName }}' /* required */,
'{{ ModelName }}' /* required */,
'{{ ModelVersion }}' /* required */,
'{{ RoleArn }}' /* required */,
'{{ OutputConfig }}' /* required */,
'{{ ResourceKey }}',
'{{ Tags }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: edge_packaging_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the edge_packaging_jobs resource.
  - name: EdgePackagingJobName
    value: "{{ EdgePackagingJobName }}"
    description: |
      The name of the edge packaging job.
  - name: CompilationJobName
    value: "{{ CompilationJobName }}"
    description: |
      The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
  - name: ModelName
    value: "{{ ModelName }}"
    description: |
      The name of the model.
  - name: ModelVersion
    value: "{{ ModelVersion }}"
    description: |
      The version of the model.
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.
  - name: OutputConfig
    description: |
      Provides information about the output location for the packaged model.
    value:
      S3OutputLocation: "{{ S3OutputLocation }}"
      KmsKeyId: "{{ KmsKeyId }}"
      PresetDeploymentType: "{{ PresetDeploymentType }}"
      PresetDeploymentConfig: "{{ PresetDeploymentConfig }}"
  - name: ResourceKey
    value: "{{ ResourceKey }}"
    description: |
      The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.
  - name: Tags
    description: |
      Creates tags for the packaging job.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

Lifecycle Methods

stop_edge_packaging_job

Request to stop an edge packaging job.

EXEC aws.sagemaker.edge_packaging_jobs.stop_edge_packaging_job 
@region='{{ region }}' --required 
@@json=
'{
"EdgePackagingJobName": "{{ EdgePackagingJobName }}"
}'
;