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

describe-model

Description

Describes a version of an Amazon Lookout for Vision model.

This operation requires permissions to perform the lookoutvision:DescribeModel operation.

See also: AWS API Documentation

Synopsis

  describe-model
--project-name <value>
--model-version <value>
[--cli-input-json <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

--project-name (string)

The project that contains the version of a model that you want to describe.

--model-version (string)

The version of the model that you want to describe.

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

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

ModelDescription -> (structure)

Contains the description of the model.

ModelVersion -> (string)

The version of the model

ModelArn -> (string)

The Amazon Resource Name (ARN) of the model.

CreationTimestamp -> (timestamp)

The unix timestamp for the date and time that the model was created.

Description -> (string)

The description for the model.

Status -> (string)

The status of the model.

StatusMessage -> (string)

The status message for the model.

Performance -> (structure)

Performance metrics for the model. Created during training.

F1Score -> (float)

The overall F1 score metric for the trained model.

Recall -> (float)

The overall recall metric value for the trained model.

Precision -> (float)

The overall precision metric value for the trained model.

OutputConfig -> (structure)

The S3 location where Amazon Lookout for Vision saves model training files.

S3Location -> (structure)

The S3 location for the output.

Bucket -> (string)

The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

Prefix -> (string)

The path of the folder, within the S3 bucket, that contains the output.

EvaluationManifest -> (structure)

The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

Bucket -> (string)

The bucket that contains the training output.

Key -> (string)

The location of the training output in the bucket.

EvaluationResult -> (structure)

The S3 location where Amazon Lookout for Vision saves the performance metrics.

Bucket -> (string)

The bucket that contains the training output.

Key -> (string)

The location of the training output in the bucket.

EvaluationEndTimestamp -> (timestamp)

The unix timestamp for the date and time that the evaluation ended.

KmsKeyId -> (string)

The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

MinInferenceUnits -> (integer)

The minimum number of inference units used by the model. For more information, see StartModel

MaxInferenceUnits -> (integer)

The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel .