start_flow_execution¶
Operation¶
async
¶
start_flow_execution(input: StartFlowExecutionInput, plugins: list[Plugin] | None = None) -> StartFlowExecutionOutput
Starts an execution of an Amazon Bedrock flow. Unlike flows that run until completion or time out after five minutes, flow executions let you run flows asynchronously for longer durations. Flow executions also yield control so that your application can perform other tasks.
This operation returns an Amazon Resource Name (ARN) that you can use to track and manage your flow execution.
Note
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StartFlowExecutionInput
|
An instance of |
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 |
|---|---|
StartFlowExecutionOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for StartFlowExecutionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
flow_alias_identifier: str | None = None
The unique identifier of the flow alias to use for the flow execution.
class-attribute
instance-attribute
¶
flow_execution_name: str | None = None
The unique name for the flow execution. If you don't provide one, a system-generated name is used.
class-attribute
instance-attribute
¶
flow_identifier: str | None = None
The unique identifier of the flow to execute.
class-attribute
instance-attribute
¶
inputs: list[FlowInput] | None = None
The input data required for the flow execution. This must match the input schema defined in the flow.
class-attribute
instance-attribute
¶
model_performance_configuration: ModelPerformanceConfiguration | None = None
The performance settings for the foundation model used in the flow execution.