Skip to content

get_inference_profile

Operation

get_inference_profile

get_inference_profile(request: GetInferenceProfileInput | GetInferenceProfileInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetInferenceProfileInputDict]) -> GetInferenceProfileOutput

Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request GetInferenceProfileInput | GetInferenceProfileInputDict | 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[GetInferenceProfileInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetInferenceProfileOutput

An instance of GetInferenceProfileOutput.

get_inference_profile async

get_inference_profile(request: GetInferenceProfileInput | GetInferenceProfileInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetInferenceProfileInputDict]) -> GetInferenceProfileOutput

Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request GetInferenceProfileInput | GetInferenceProfileInputDict | 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[GetInferenceProfileInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetInferenceProfileOutput

An instance of GetInferenceProfileOutput.

Input

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

GetInferenceProfileInputDict

Bases: TypedDict

Dictionary form of GetInferenceProfileInput.

Attributes

inference_profile_identifier instance-attribute
inference_profile_identifier: Required[str]

The ID or Amazon Resource Name (ARN) of the inference profile.

GetInferenceProfileInput dataclass

Bases: _SerdeShape

Dataclass for GetInferenceProfileInput structure.

Attributes

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

The ID or Amazon Resource Name (ARN) of the inference profile.

Output

GetInferenceProfileOutput dataclass

Bases: _SerdeShape

Dataclass for GetInferenceProfileOutput structure.

Attributes

created_at class-attribute instance-attribute
created_at: datetime | None = ...

The time at which the inference profile was created.

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

The description of the inference profile.

inference_profile_arn instance-attribute
inference_profile_arn: str

The Amazon Resource Name (ARN) of the inference profile.

inference_profile_id instance-attribute
inference_profile_id: str

The unique identifier of the inference profile.

inference_profile_name instance-attribute
inference_profile_name: str

The name of the inference profile.

models instance-attribute

A list of information about each model in the inference profile.

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.

status instance-attribute
status: str

The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

type instance-attribute
type: str

The type of the inference profile. The following types are possible:

  • SYSTEM_DEFINED -- The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

  • APPLICATION -- The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

The time at which the inference profile was last updated.