Skip to content

get_prompt_router

Operation

get_prompt_router

get_prompt_router(request: GetPromptRouterInput | GetPromptRouterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPromptRouterInputDict]) -> GetPromptRouterOutput

Retrieves details about a prompt router.

Parameters:

Name Type Description Default
request GetPromptRouterInput | GetPromptRouterInputDict | 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[GetPromptRouterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPromptRouterOutput

An instance of GetPromptRouterOutput.

get_prompt_router async

get_prompt_router(request: GetPromptRouterInput | GetPromptRouterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPromptRouterInputDict]) -> GetPromptRouterOutput

Retrieves details about a prompt router.

Parameters:

Name Type Description Default
request GetPromptRouterInput | GetPromptRouterInputDict | 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[GetPromptRouterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPromptRouterOutput

An instance of GetPromptRouterOutput.

Input

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

GetPromptRouterInputDict

Bases: TypedDict

Dictionary form of GetPromptRouterInput.

Attributes

prompt_router_arn instance-attribute
prompt_router_arn: Required[str]

The prompt router's ARN

GetPromptRouterInput dataclass

Bases: _SerdeShape

Dataclass for GetPromptRouterInput structure.

Attributes

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

The prompt router's ARN

Output

GetPromptRouterOutput dataclass

Bases: _SerdeShape

Dataclass for GetPromptRouterOutput structure.

Attributes

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

When the router was created.

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

The router's description.

fallback_model instance-attribute
fallback_model: PromptRouterTargetModel

The router's fallback model.

models instance-attribute

The router's models.

prompt_router_arn instance-attribute
prompt_router_arn: str

The prompt router's ARN

prompt_router_name instance-attribute
prompt_router_name: str

The router's name.

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.

routing_criteria instance-attribute
routing_criteria: RoutingCriteria

The router's routing criteria.

status instance-attribute
status: str

The router's status.

type instance-attribute
type: str

The router's type.

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

When the router was updated.