Skip to content

prepare_flow

Operation

prepare_flow

prepare_flow(request: PrepareFlowInput | PrepareFlowInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PrepareFlowInputDict]) -> 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
request PrepareFlowInput | PrepareFlowInputDict | 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[PrepareFlowInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PrepareFlowOutput

An instance of PrepareFlowOutput.

prepare_flow async

prepare_flow(request: PrepareFlowInput | PrepareFlowInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PrepareFlowInputDict]) -> 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
request PrepareFlowInput | PrepareFlowInputDict | 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[PrepareFlowInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PrepareFlowOutput

An instance of PrepareFlowOutput.

Input

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

PrepareFlowInputDict

Bases: TypedDict

Dictionary form of PrepareFlowInput.

Attributes

flow_identifier instance-attribute
flow_identifier: Required[str]

The unique identifier of the flow.

PrepareFlowInput dataclass

Bases: _SerdeShape

Dataclass for PrepareFlowInput structure.

Attributes

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

The unique identifier of the flow.

Output

PrepareFlowOutput dataclass

Bases: _SerdeShape

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

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.