start_flow_execution¶
Operation¶
start_flow_execution
¶
start_flow_execution(request: StartFlowExecutionInput | StartFlowExecutionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartFlowExecutionInputDict]) -> 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 |
|---|---|---|---|
request
|
StartFlowExecutionInput | StartFlowExecutionInputDict | 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[StartFlowExecutionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartFlowExecutionOutput
|
An instance of |
start_flow_execution
async
¶
start_flow_execution(request: StartFlowExecutionInput | StartFlowExecutionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartFlowExecutionInputDict]) -> 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 |
|---|---|---|---|
request
|
StartFlowExecutionInput | StartFlowExecutionInputDict | 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[StartFlowExecutionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartFlowExecutionOutput
|
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.
StartFlowExecutionInputDict
¶
Bases: TypedDict
Dictionary form of StartFlowExecutionInput.
Attributes¶
flow_alias_identifier
instance-attribute
¶
The unique identifier of the flow alias to use for the flow execution.
flow_execution_name
instance-attribute
¶
flow_execution_name: str | None
The unique name for the flow execution. If you don't provide one, a system-generated name is used.
flow_identifier
instance-attribute
¶
The unique identifier of the flow to execute.
inputs
instance-attribute
¶
inputs: Required[Sequence[FlowInput | FlowInputDict]]
The input data required for the flow execution. This must match the input schema defined in the flow.
model_performance_configuration
instance-attribute
¶
model_performance_configuration: ModelPerformanceConfiguration | ModelPerformanceConfigurationDict | None
The performance settings for the foundation model used in the flow execution.
StartFlowExecutionInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartFlowExecutionInput structure.
Attributes¶
flow_alias_identifier
class-attribute
instance-attribute
¶
flow_alias_identifier: str | None = ...
The unique identifier of the flow alias to use for the flow execution.
flow_execution_name
class-attribute
instance-attribute
¶
flow_execution_name: str | None = ...
The unique name for the flow execution. If you don't provide one, a system-generated name is used.
flow_identifier
class-attribute
instance-attribute
¶
flow_identifier: str | None = ...
The unique identifier of the flow to execute.
inputs
class-attribute
instance-attribute
¶
The input data required for the flow execution. This must match the input schema defined in the flow.
model_performance_configuration
class-attribute
instance-attribute
¶
model_performance_configuration: ModelPerformanceConfiguration | None = ...
The performance settings for the foundation model used in the flow execution.
Output¶
StartFlowExecutionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartFlowExecutionOutput structure.
Attributes¶
execution_arn
class-attribute
instance-attribute
¶
execution_arn: str | None = ...
The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
response_metadata
class-attribute
instance-attribute
¶
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.