Skip to content

FlowNodeInput

Source code in docs_src/capo_bedrock_agent/types/flow_node_input.py
class FlowNodeInput(TypedDict, closed=True):
    name: "capo_bedrock_agent.types.flow_node_input_name.FlowNodeInputName"
    """<p>Specifies a name for the input that you can reference.</p>"""
    type: "capo_bedrock_agent.types.flow_node_io_data_type.FlowNodeIODataType"
    """<p>Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.</p>"""
    expression: (
        "capo_bedrock_agent.types.flow_node_input_expression.FlowNodeInputExpression"
    )
    """<p>An expression that formats the input for the node. For an explanation of how to create expressions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html">Expressions in Prompt flows in Amazon Bedrock</a>.</p>"""
    category: NotRequired[
        "capo_bedrock_agent.types.flow_node_input_category.FlowNodeInputCategory"
    ]
    """<p>Specifies how input data flows between iterations in a DoWhile loop.</p> <ul> <li> <p> <code>LoopCondition</code> - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue. </p> </li> <li> <p> <code>ReturnValueToLoopStart</code> - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.</p> </li> <li> <p> <code>ExitLoop</code> - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.</p> </li> </ul>"""

category instance-attribute

category: NotRequired[FlowNodeInputCategory]

Specifies how input data flows between iterations in a DoWhile loop.

  • LoopCondition - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.

  • ReturnValueToLoopStart - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.

  • ExitLoop - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.

expression instance-attribute

An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.

name instance-attribute

Specifies a name for the input that you can reference.

type instance-attribute

Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.