ListEdgePackagingJobs - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ListEdgePackagingJobs

Returns a list of edge packaging jobs.

Request Syntax

{ "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "ModelNameContains": "string", "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "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.

CreationTimeAfter

Select jobs where the job was created after specified time.

Type: Timestamp

Required: No

CreationTimeBefore

Select jobs where the job was created before specified time.

Type: Timestamp

Required: No

LastModifiedTimeAfter

Select jobs where the job was updated after specified time.

Type: Timestamp

Required: No

LastModifiedTimeBefore

Select jobs where the job was updated before specified time.

Type: Timestamp

Required: No

MaxResults

Maximum number of results to select.

Type: Integer

Valid Range: Maximum value of 100.

Required: No

ModelNameContains

Filter for jobs where the model name contains this string.

Type: String

Length Constraints: Maximum length of 63.

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

Required: No

NameContains

Filter for jobs containing this name in their packaging job name.

Type: String

Length Constraints: Maximum length of 63.

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

Required: No

NextToken

The response from the last list when returning a list large enough to need tokening.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

Use to specify what column to sort by.

Type: String

Valid Values: NAME | MODEL_NAME | CREATION_TIME | LAST_MODIFIED_TIME | STATUS

Required: No

SortOrder

What direction to sort by.

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

The job status to filter for.

Type: String

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

Required: No

Response Syntax

{ "EdgePackagingJobSummaries": [ { "CompilationJobName": "string", "CreationTime": number, "EdgePackagingJobArn": "string", "EdgePackagingJobName": "string", "EdgePackagingJobStatus": "string", "LastModifiedTime": number, "ModelName": "string", "ModelVersion": "string" } ], "NextToken": "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.

EdgePackagingJobSummaries

Summaries of edge packaging jobs.

Type: Array of EdgePackagingJobSummary objects

NextToken

Token to use when calling the next page of results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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

See Also

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