[ aws . lookoutequipment ]

list-models

Description

Generates a list of all models in the account, including model name and ARN, dataset, and status.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-models
[--next-token <value>]
[--max-results <value>]
[--status <value>]
[--model-name-begins-with <value>]
[--dataset-name-begins-with <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

An opaque pagination token indicating where to continue the listing of ML models.

--max-results (integer)

Specifies the maximum number of ML models to list.

--status (string)

The status of the ML model.

Possible values:

  • IN_PROGRESS

  • SUCCESS

  • FAILED

--model-name-begins-with (string)

The beginning of the name of the ML models being listed.

--dataset-name-begins-with (string)

The beginning of the name of the dataset of the ML models to be listed.

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

See ‘aws help’ for descriptions of global parameters.

Output

NextToken -> (string)

An opaque pagination token indicating where to continue the listing of ML models.

ModelSummaries -> (list)

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

(structure)

Provides information about the specified ML model, including dataset and model names and ARNs, as well as status.

ModelName -> (string)

The name of the ML model.

ModelArn -> (string)

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

DatasetName -> (string)

The name of the dataset being used for the ML model.

DatasetArn -> (string)

The Amazon Resource Name (ARN) of the dataset used to create the model.

Status -> (string)

Indicates the status of the ML model.

CreatedAt -> (timestamp)

The time at which the specific model was created.