DescribeEdgePackagingJob - Amazon SageMaker Service

DescribeEdgePackagingJob

A description of edge packaging jobs.

Request Syntax

{ "EdgePackagingJobName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EdgePackagingJobName

The name of the edge packaging job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: Yes

Response Syntax

{ "CompilationJobName": "string", "CreationTime": number, "EdgePackagingJobArn": "string", "EdgePackagingJobName": "string", "EdgePackagingJobStatus": "string", "EdgePackagingJobStatusMessage": "string", "LastModifiedTime": number, "ModelArtifact": "string", "ModelName": "string", "ModelSignature": "string", "ModelVersion": "string", "OutputConfig": { "KmsKeyId": "string", "S3OutputLocation": "string" }, "ResourceKey": "string", "RoleArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CompilationJobName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

CreationTime

The timestamp of when the packaging job was created.

Type: Timestamp

EdgePackagingJobArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z\-]*:\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\-_/]+$

EdgePackagingJobName

The name of the edge packaging job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

EdgePackagingJobStatus

The current status of the packaging job.

Type: String

Valid Values: STARTING | INPROGRESS | COMPLETED | FAILED | STOPPING | STOPPED

EdgePackagingJobStatusMessage

Returns a message describing the job status and error messages.

Type: String

LastModifiedTime

The timestamp of when the job was last updated.

Type: Timestamp

ModelArtifact

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^(https|s3)://([^/]+)/?(.*)$

ModelName

The name of the model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

ModelSignature

The signature document of files in the model artifact.

Type: String

ModelVersion

The version of the model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 30.

Pattern: [a-zA-Z0-9\ \_\.]+

OutputConfig

The output configuration for the edge packaging job.

Type: EdgeOutputConfig object

ResourceKey

The CMK to use when encrypting the EBS volume the job run on.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: .*

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: