Skip to content

get_flow_alias

Operation

get_flow_alias

get_flow_alias(request: GetFlowAliasInput | GetFlowAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFlowAliasInputDict]) -> GetFlowAliasOutput

Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request GetFlowAliasInput | GetFlowAliasInputDict | 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[GetFlowAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFlowAliasOutput

An instance of GetFlowAliasOutput.

get_flow_alias async

get_flow_alias(request: GetFlowAliasInput | GetFlowAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFlowAliasInputDict]) -> GetFlowAliasOutput

Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request GetFlowAliasInput | GetFlowAliasInputDict | 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[GetFlowAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFlowAliasOutput

An instance of GetFlowAliasOutput.

Input

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

GetFlowAliasInputDict

Bases: TypedDict

Dictionary form of GetFlowAliasInput.

Attributes

alias_identifier instance-attribute
alias_identifier: Required[str]

The unique identifier of the alias for which to retrieve information.

flow_identifier instance-attribute
flow_identifier: Required[str]

The unique identifier of the flow that the alias belongs to.

GetFlowAliasInput dataclass

Bases: _SerdeShape

Dataclass for GetFlowAliasInput structure.

Attributes

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

The unique identifier of the alias for which to retrieve information.

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

The unique identifier of the flow that the alias belongs to.

Output

GetFlowAliasOutput dataclass

Bases: _SerdeShape

Dataclass for GetFlowAliasOutput structure.

Attributes

arn instance-attribute
arn: str

The Amazon Resource Name (ARN) of the flow.

concurrency_configuration class-attribute instance-attribute
concurrency_configuration: FlowAliasConcurrencyConfiguration | None = ...

The configuration that specifies how nodes in the flow are executed in parallel.

created_at instance-attribute
created_at: datetime

The time at which the flow was created.

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

The description of the flow.

flow_id instance-attribute
flow_id: str

The unique identifier of the flow that the alias belongs to.

id instance-attribute
id: str

The unique identifier of the alias of the flow.

name instance-attribute
name: str

The name of the alias.

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_configuration instance-attribute

Contains information about the version that the alias is mapped to.

updated_at instance-attribute
updated_at: datetime

The time at which the alias was last updated.