Skip to content

Bedrock Agent  >  Operations  >  get_flow

get_flow

Operation

get_flow async 

get_flow(input: GetFlowInput, plugins: list[Plugin] | None = None) -> GetFlowOutput

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

Parameters:

Name Type Description Default
input GetFlowInput

An instance of GetFlowInput.

 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
GetFlowOutput

An instance of GetFlowOutput.

Input

GetFlowInput dataclass

Dataclass for GetFlowInput structure.

Attributes

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

The unique identifier of the flow.

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

GetFlowOutput dataclass

Dataclass for GetFlowOutput 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 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 the 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 row for flows 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 flow.

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. The following statuses are possible:

  • NotPrepared -- The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

  • Preparing -- The flow is being prepared so that the DRAFT version contains the latest changes for testing.

  • Prepared -- The flow is prepared and the DRAFT version contains the latest changes for testing.

  • Failed -- The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

updated_at instance-attribute 
updated_at: datetime

The time at which the flow was last updated.

validations class-attribute instance-attribute 
validations: list[FlowValidation] | None = None

A list of validation error messages related to the last failed operation on the flow.

version instance-attribute 
version: str

The version of the flow for which information was retrieved.