AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

list-model-packages

Description

Lists the model packages that have been created.

See also: AWS API Documentation

list-model-packages 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: ModelPackageSummaryList

Synopsis

  list-model-packages
[--creation-time-after <value>]
[--creation-time-before <value>]
[--name-contains <value>]
[--model-approval-status <value>]
[--model-package-group-name <value>]
[--model-package-type <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--creation-time-after (timestamp)

A filter that returns only model packages created after the specified time (timestamp).

--creation-time-before (timestamp)

A filter that returns only model packages created before the specified time (timestamp).

--name-contains (string)

A string in the model package name. This filter returns only model packages whose name contains the specified string.

--model-approval-status (string)

A filter that returns only the model packages with the specified approval status.

Possible values:

  • Approved
  • Rejected
  • PendingManualApproval

--model-package-group-name (string)

A filter that returns only model versions that belong to the specified model group.

--model-package-type (string)

A filter that returns only the model packages of the specified type. This can be one of the following values.

  • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.
  • VERSIONED - List only versioned models.
  • BOTH - List both versioned and unversioned models.

Possible values:

  • Versioned
  • Unversioned
  • Both

--sort-by (string)

The parameter by which to sort the results. The default is CreationTime .

Possible values:

  • Name
  • CreationTime

--sort-order (string)

The sort order for the results. The default is Ascending .

Possible values:

  • Ascending
  • Descending

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ModelPackageSummaryList -> (list)

An array of ModelPackageSummary objects, each of which lists a model package.

(structure)

Provides summary information about a model package.

ModelPackageName -> (string)

The name of the model package.

ModelPackageGroupName -> (string)

If the model package is a versioned model, the model group that the versioned model belongs to.

ModelPackageVersion -> (integer)

If the model package is a versioned model, the version of the model.

ModelPackageArn -> (string)

The Amazon Resource Name (ARN) of the model package.

ModelPackageDescription -> (string)

A brief description of the model package.

CreationTime -> (timestamp)

A timestamp that shows when the model package was created.

ModelPackageStatus -> (string)

The overall status of the model package.

ModelApprovalStatus -> (string)

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved
  • REJECTED - The model is rejected.
  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

NextToken -> (string)

If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.