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 ]

list-foundation-models

Description

Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Synopsis

  list-foundation-models
[--by-provider <value>]
[--by-customization-type <value>]
[--by-output-modality <value>]
[--by-inference-type <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

--by-provider (string)

Return models belonging to the model provider that you specify.

--by-customization-type (string)

Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.

Possible values:

  • FINE_TUNING
  • CONTINUED_PRE_TRAINING

--by-output-modality (string)

Return models that support the output modality that you specify.

Possible values:

  • TEXT
  • IMAGE
  • EMBEDDING

--by-inference-type (string)

Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Possible values:

  • ON_DEMAND
  • PROVISIONED

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

modelSummaries -> (list)

A list of Amazon Bedrock foundation models.

(structure)

Summary information for a foundation model.

modelArn -> (string)

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

modelId -> (string)

The model ID of the foundation model.

modelName -> (string)

The name of the model.

providerName -> (string)

The model's provider name.

inputModalities -> (list)

The input modalities that the model supports.

(string)

outputModalities -> (list)

The output modalities that the model supports.

(string)

responseStreamingSupported -> (boolean)

Indicates whether the model supports streaming.

customizationsSupported -> (list)

Whether the model supports fine-tuning or continual pre-training.

(string)

inferenceTypesSupported -> (list)

The inference types that the model supports.

(string)

modelLifecycle -> (structure)

Contains details about whether a model version is available or deprecated.

status -> (string)

Specifies whether a model version is available (ACTIVE ) or deprecated (LEGACY .