Skip to content

get_foundation_model

Operation

get_foundation_model

get_foundation_model(request: GetFoundationModelInput | GetFoundationModelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFoundationModelInputDict]) -> GetFoundationModelOutput

Get details about a Amazon Bedrock foundation model.

Parameters:

Name Type Description Default
request GetFoundationModelInput | GetFoundationModelInputDict | 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[GetFoundationModelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFoundationModelOutput

An instance of GetFoundationModelOutput.

get_foundation_model async

get_foundation_model(request: GetFoundationModelInput | GetFoundationModelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFoundationModelInputDict]) -> GetFoundationModelOutput

Get details about a Amazon Bedrock foundation model.

Parameters:

Name Type Description Default
request GetFoundationModelInput | GetFoundationModelInputDict | 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[GetFoundationModelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFoundationModelOutput

An instance of GetFoundationModelOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetFoundationModelInputDict

Bases: TypedDict

Dictionary form of GetFoundationModelInput.

Attributes

model_identifier instance-attribute
model_identifier: Required[str]

The model identifier.

GetFoundationModelInput dataclass

Bases: _SerdeShape

Dataclass for GetFoundationModelInput structure.

Attributes

model_identifier class-attribute instance-attribute
model_identifier: str | None = ...

The model identifier.

Output

GetFoundationModelOutput dataclass

Bases: _SerdeShape

Dataclass for GetFoundationModelOutput structure.

Attributes

model_details class-attribute instance-attribute
model_details: FoundationModelDetails | None = ...

Information about the foundation model.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.