[ aws . lookoutequipment ]

list-model-versions

Description

Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.

See also: AWS API Documentation

Synopsis

  list-model-versions
--model-name <value>
[--next-token <value>]
[--max-results <value>]
[--status <value>]
[--source-type <value>]
[--created-at-end-time <value>]
[--created-at-start-time <value>]
[--max-model-version <value>]
[--min-model-version <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--model-name (string)

Then name of the machine learning model for which the model versions are to be listed.

--next-token (string)

If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results.

--max-results (integer)

Specifies the maximum number of machine learning model versions to list.

--status (string)

Filter the results based on the current status of the model version.

Possible values:

• IN_PROGRESS
• SUCCESS
• FAILED
• IMPORT_IN_PROGRESS
• CANCELED

--source-type (string)

Filter the results based on the way the model version was generated.

Possible values:

• TRAINING
• RETRAINING
• IMPORT

--created-at-end-time (timestamp)

Filter results to return all the model versions created before this time.

--created-at-start-time (timestamp)

Filter results to return all the model versions created after this time.

--max-model-version (long)

Specifies the highest version of the model to return in the list.

--min-model-version (long)

Specifies the lowest version of the model to return in the list.

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

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

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
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

NextToken -> (string)

If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results.

ModelVersionSummaries -> (list)

Provides information on the specified model version, including the created time, model and dataset ARNs, and status.

Note

If you don’t supply the ModelName request parameter, or if you supply the name of a model that doesn’t exist, ListModelVersions returns an empty array in ModelVersionSummaries .

(structure)

Contains information about the specific model version.

ModelName -> (string)

The name of the model that this model version is a version of.

ModelArn -> (string)

The Amazon Resource Name (ARN) of the model that this model version is a version of.

ModelVersion -> (long)

The version of the model.

ModelVersionArn -> (string)

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

CreatedAt -> (timestamp)

The time when this model version was created.

Status -> (string)

The current status of the model version.

SourceType -> (string)

Indicates how this model version was generated.

ModelQuality -> (string)

Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED . Otherwise, the value is QUALITY_THRESHOLD_MET .

If the model is unlabeled, the model quality can’t be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY . In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment .