list_foundation_models¶
Operation¶
list_foundation_models
¶
list_foundation_models(request: ListFoundationModelsInput | ListFoundationModelsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListFoundationModelsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListFoundationModelsInput | ListFoundationModelsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListFoundationModelsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListFoundationModelsOutput
|
An instance of |
list_foundation_models
async
¶
list_foundation_models(request: ListFoundationModelsInput | ListFoundationModelsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListFoundationModelsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListFoundationModelsInput | ListFoundationModelsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListFoundationModelsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListFoundationModelsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListFoundationModelsInputDict
¶
Bases: TypedDict
Dictionary form of ListFoundationModelsInput.
Attributes¶
by_customization_type
instance-attribute
¶
by_customization_type: str | 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
instance-attribute
¶
by_inference_type: str | None
Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
ListFoundationModelsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListFoundationModelsInput structure.
Attributes¶
by_customization_type
class-attribute
instance-attribute
¶
by_customization_type: str | 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 = ...
Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Output¶
ListFoundationModelsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListFoundationModelsOutput structure.
Attributes¶
model_summaries
class-attribute
instance-attribute
¶
model_summaries: list[FoundationModelSummary] | None = ...
A list of Amazon Bedrock foundation models.
response_metadata
class-attribute
instance-attribute
¶
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.