[ aws . sagemaker ]

list-compilation-jobs

Description

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob . To get information about a particular model compilation job you have created, use DescribeCompilationJob .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-compilation-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: CompilationJobSummaries

Synopsis

  list-compilation-jobs
[--creation-time-after <value>]
[--creation-time-before <value>]
[--last-modified-time-after <value>]
[--last-modified-time-before <value>]
[--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>]
[--cli-auto-prompt <value>]

Options

--creation-time-after (timestamp)

A filter that returns the model compilation jobs that were created after a specified time.

--creation-time-before (timestamp)

A filter that returns the model compilation jobs that were created before a specified time.

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

A filter that returns the model compilation jobs that were modified after a specified time.

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

A filter that returns the model compilation jobs that were modified before a specified time.

--name-contains (string)

A filter that returns the model compilation jobs whose name contains a specified string.

--status-equals (string)

A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.

Possible values:

• INPROGRESS

• COMPLETED

• FAILED

• STARTING

• STOPPING

• STOPPED

--sort-by (string)

The field by which to sort results. The default is CreationTime .

Possible values:

• Name

• CreationTime

• Status

--sort-order (string)

The sort order for results. The default is Ascending .

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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

CompilationJobSummaries -> (list)

An array of CompilationJobSummary objects, each describing a model compilation job.

(structure)

A summary of a model compilation job.

CompilationJobName -> (string)

The name of the model compilation job that you want a summary for.

CompilationJobArn -> (string)

The Amazon Resource Name (ARN) of the model compilation job.

CreationTime -> (timestamp)

The time when the model compilation job was created.

CompilationStartTime -> (timestamp)

The time when the model compilation job started.

CompilationEndTime -> (timestamp)

The time when the model compilation job completed.

CompilationTargetDevice -> (string)

The type of device that the model will run on after compilation has completed.

LastModifiedTime -> (timestamp)

The time when the model compilation job was last modified.

CompilationJobStatus -> (string)

The status of the model compilation job.

NextToken -> (string)

If the response is truncated, Amazon SageMaker returns this NextToken . To retrieve the next set of model compilation jobs, use this token in the next request.