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 |
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 |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
PrepareFlowOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PrepareFlowOutput structure.