[ aws . sagemaker ]

list-edge-packaging-jobs

Description

Returns a list of edge packaging jobs.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-edge-packaging-jobs is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: EdgePackagingJobSummaries

Synopsis

  list-edge-packaging-jobs
[--creation-time-after <value>]
[--creation-time-before <value>]
[--last-modified-time-after <value>]
[--last-modified-time-before <value>]
[--name-contains <value>]
[--model-name-contains <value>]
[--status-equals <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--creation-time-after (timestamp)

Select jobs where the job was created after specified time.

--creation-time-before (timestamp)

Select jobs where the job was created before specified time.

--last-modified-time-after (timestamp)

Select jobs where the job was updated after specified time.

--last-modified-time-before (timestamp)

Select jobs where the job was updated before specified time.

--name-contains (string)

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

--model-name-contains (string)

Filter for jobs where the model name contains this string.

--status-equals (string)

The job status to filter for.

Possible values:

• STARTING

• INPROGRESS

• COMPLETED

• FAILED

• STOPPING

• STOPPED

--sort-by (string)

Use to specify what column to sort by.

Possible values:

• NAME

• MODEL_NAME

• CREATION_TIME

• LAST_MODIFIED_TIME

• STATUS

--sort-order (string)

What direction to sort by.

Possible values:

• Ascending

• Descending

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

EdgePackagingJobSummaries -> (list)

Summaries of edge packaging jobs.

(structure)

Summary of edge packaging job.

EdgePackagingJobArn -> (string)

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

EdgePackagingJobName -> (string)

The name of the edge packaging job.

EdgePackagingJobStatus -> (string)

The status of the edge packaging job.

CompilationJobName -> (string)

The name of the SageMaker Neo compilation job.

ModelName -> (string)

The name of the model.

ModelVersion -> (string)

The version of the model.

CreationTime -> (timestamp)

The timestamp of when the job was created.

LastModifiedTime -> (timestamp)

The timestamp of when the edge packaging job was last updated.

NextToken -> (string)

Token to use when calling the next page of results.