Skip to content

Bedrock Agent  >  Operations  >  get_flow_version

get_flow_version

Operation

get_flow_version async 

get_flow_version(input: GetFlowVersionInput, plugins: list[Plugin] | None = None) -> GetFlowVersionOutput

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

Parameters:

Name Type Description Default
input GetFlowVersionInput

An instance of GetFlowVersionInput.

 required
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

Returns:

Type Description
GetFlowVersionOutput

An instance of GetFlowVersionOutput.

Input

GetFlowVersionInput dataclass

Dataclass for GetFlowVersionInput structure.

Attributes

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

The unique identifier of the flow for which to get information.

flow_version class-attribute instance-attribute 
flow_version: str | None = None

The version of the flow for which to get information.

included_data class-attribute instance-attribute 
included_data: str | None = None

Controls the scope of data returned. Set to METADATA_ONLY to return only resource metadata. Set to ALL_DATA or omit this field to return the full response.

Output

GetFlowVersionOutput dataclass

Dataclass for GetFlowVersionOutput structure.

Attributes

arn instance-attribute 
arn: str

The Amazon Resource Name (ARN) of the flow.

created_at instance-attribute 
created_at: datetime

The time at which the flow was created.

customer_encryption_key_arn class-attribute instance-attribute 
customer_encryption_key_arn: str | None = None

The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.

definition class-attribute instance-attribute 
definition: FlowDefinition | None = field(repr=False, default=None)

The definition of the nodes and connections between nodes in the flow.

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

The description of the flow.

execution_role_arn instance-attribute 
execution_role_arn: str

The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

id instance-attribute 
id: str

The unique identifier of the flow.

name instance-attribute 
name: str

The name of the version.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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 flow.

version instance-attribute 
version: str

The version of the flow for which information was retrieved.