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

get-custom-model

Description

Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Synopsis

  get-custom-model
--model-identifier <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

--model-identifier (string)

Name or Amazon Resource Name (ARN) of the custom model.

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

modelArn -> (string)

Amazon Resource Name (ARN) associated with this model.

modelName -> (string)

Model name associated with this model.

jobName -> (string)

Job name associated with this model.

jobArn -> (string)

Job Amazon Resource Name (ARN) associated with this model.

baseModelArn -> (string)

Amazon Resource Name (ARN) of the base model.

customizationType -> (string)

The type of model customization.

modelKmsKeyArn -> (string)

The custom model is encrypted at rest using this key.

hyperParameters -> (map)

Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters .

key -> (string)

value -> (string)

trainingDataConfig -> (structure)

Contains information about the training dataset.

s3Uri -> (string)

The S3 URI where the training data is stored.

validationDataConfig -> (structure)

Contains information about the validation dataset.

validators -> (list)

Information about the validators.

(structure)

Information about a validator.

s3Uri -> (string)

The S3 URI where the validation data is stored.

outputDataConfig -> (structure)

Output data configuration associated with this custom model.

s3Uri -> (string)

The S3 URI where the output data is stored.

trainingMetrics -> (structure)

Contains training metrics from the job creation.

trainingLoss -> (float)

Loss metric associated with the custom job.

validationMetrics -> (list)

The validation metrics from the job creation.

(structure)

The metric for the validator.

validationLoss -> (float)

The validation loss associated with this validator.

creationTime -> (timestamp)

Creation time of the model.