Skip to content

Bedrock  >  Operations  >  list_foundation_models

list_foundation_models

Operation

list_foundation_models async 

list_foundation_models(input: ListFoundationModelsInput, plugins: list[Plugin] | None = None) -> ListFoundationModelsOutput

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.

Parameters:

Name Type Description Default
input ListFoundationModelsInput

An instance of ListFoundationModelsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListFoundationModelsOutput

An instance of ListFoundationModelsOutput.

Input

ListFoundationModelsInput dataclass

Dataclass for ListFoundationModelsInput structure.

Attributes

by_customization_type class-attribute instance-attribute 
by_customization_type: str | None = None

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

by_inference_type class-attribute instance-attribute 
by_inference_type: str | None = None

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

by_output_modality class-attribute instance-attribute 
by_output_modality: str | None = None

Return models that support the output modality that you specify.

by_provider class-attribute instance-attribute 
by_provider: str | None = None

Return models belonging to the model provider that you specify.

Output

ListFoundationModelsOutput dataclass

Dataclass for ListFoundationModelsOutput structure.

Attributes

model_summaries class-attribute instance-attribute 
model_summaries: list[FoundationModelSummary] | None = None

A list of Amazon Bedrock foundation models.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.