Skip to content

Bedrock Agent  >  Operations  >  prepare_flow

prepare_flow

Operation

prepare_flow async 

prepare_flow(input: PrepareFlowInput, plugins: list[Plugin] | None = None) -> PrepareFlowOutput

Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
input PrepareFlowInput

An instance of PrepareFlowInput.

 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
PrepareFlowOutput

An instance of PrepareFlowOutput.

Input

PrepareFlowInput dataclass

Dataclass for PrepareFlowInput structure.

Attributes

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

The unique identifier of the flow.

Output

PrepareFlowOutput dataclass

Dataclass for PrepareFlowOutput structure.

Attributes

id instance-attribute 
id: str

The unique identifier 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. When you submit this request, the status will be NotPrepared. If preparation succeeds, the status becomes Prepared. If it fails, the status becomes FAILED.