Skip to content

StartFlowExecutionRequest

Source code in docs_src/capo_bedrock_agent_runtime/types/start_flow_execution_request.py
class StartFlowExecutionRequest(TypedDict, closed=True):
    flow_identifier: "capo_bedrock_agent_runtime.types.flow_identifier.FlowIdentifier"
    """<p>The unique identifier of the flow to execute.</p>"""
    flow_alias_identifier: (
        "capo_bedrock_agent_runtime.types.flow_alias_identifier.FlowAliasIdentifier"
    )
    """<p>The unique identifier of the flow alias to use for the flow execution.</p>"""
    flow_execution_name: NotRequired[
        "capo_bedrock_agent_runtime.types.flow_execution_name.FlowExecutionName"
    ]
    """<p>The unique name for the flow execution. If you don't provide one, a system-generated name is used.</p>"""
    inputs: "capo_bedrock_agent_runtime.types.flow_inputs.FlowInputs"
    """<p>The input data required for the flow execution. This must match the input schema defined in the flow.</p>"""
    model_performance_configuration: NotRequired[
        "capo_bedrock_agent_runtime.types.model_performance_configuration.ModelPerformanceConfiguration"
    ]
    """<p>The performance settings for the foundation model used in the flow execution.</p>"""

flow_alias_identifier instance-attribute

flow_alias_identifier: FlowAliasIdentifier

The unique identifier of the flow alias to use for the flow execution.

flow_execution_name instance-attribute

flow_execution_name: NotRequired[FlowExecutionName]

The unique name for the flow execution. If you don't provide one, a system-generated name is used.

flow_identifier instance-attribute

flow_identifier: FlowIdentifier

The unique identifier of the flow to execute.

inputs instance-attribute

inputs: FlowInputs

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: NotRequired[ModelPerformanceConfiguration]

The performance settings for the foundation model used in the flow execution.