aws_bedrock_flow

account_id

Type: STRING

arn

Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN) of the flow.

created_at

Type: TIMESTAMP
Provider name: createdAt
Description: The time at which the flow was created.

customer_encryption_key_arn

Type: STRING
Provider name: customerEncryptionKeyArn
Description: The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

definition

Type: STRUCT
Provider name: definition
Description: The definition of the nodes and connections between the nodes in the flow.

  • connections
    Type: UNORDERED_LIST_STRUCT
    Provider name: connections
    Description: An array of connection definitions in the flow.
    • configuration
      Type: STRUCT
      Provider name: configuration
      Description: The configuration of the connection.
      • conditional
        Type: STRUCT
        Provider name: conditional
        Description: The configuration of a connection originating from a Condition node.
        • condition
          Type: STRING
          Provider name: condition
          Description: The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.
      • data
        Type: STRUCT
        Provider name: data
        Description: The configuration of a connection originating from a node that isn’t a Condition node.
        • source_output
          Type: STRING
          Provider name: sourceOutput
          Description: The name of the output in the source node that the connection begins from.
        • target_input
          Type: STRING
          Provider name: targetInput
          Description: The name of the input in the target node that the connection ends at.
    • name
      Type: STRING
      Provider name: name
      Description: A name for the connection that you can reference.
    • source
      Type: STRING
      Provider name: source
      Description: The node that the connection starts at.
    • target
      Type: STRING
      Provider name: target
      Description: The node that the connection ends at.
    • type
      Type: STRING
      Provider name: type
      Description: Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).
  • nodes
    Type: UNORDERED_LIST_STRUCT
    Provider name: nodes
    Description: An array of node definitions in the flow.
    • configuration
      Type: STRUCT
      Provider name: configuration
      Description: Contains configurations for the node.
      • agent
        Type: STRUCT
        Provider name: agent
        Description: Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

        • agent_alias_arn
          Type: STRING
          Provider name: agentAliasArn
          Description: The Amazon Resource Name (ARN) of the alias of the agent to invoke.
      • collector
        Type: STRUCT
        Provider name: collector
        Description: Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

      • condition
        Type: STRUCT
        Provider name: condition
        Description: Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.

        • conditions
          Type: UNORDERED_LIST_STRUCT
          Provider name: conditions
          Description: An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
          • expression
            Type: STRING
            Provider name: expression
            Description: Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.
          • name
            Type: STRING
            Provider name: name
            Description: A name for the condition that you can reference.
      • input
        Type: STRUCT
        Provider name: input
        Description: Contains configurations for an input flow node in your flow. The first node in the flow. inputs can’t be specified for this node.

      • iterator
        Type: STRUCT
        Provider name: iterator
        Description: Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output. The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

      • knowledge_base
        Type: STRUCT
        Provider name: knowledgeBase
        Description: Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

        • guardrail_configuration
          Type: STRUCT
          Provider name: guardrailConfiguration
          Description: Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
          • guardrail_identifier
            Type: STRING
            Provider name: guardrailIdentifier
            Description: The unique identifier of the guardrail.
          • guardrail_version
            Type: STRING
            Provider name: guardrailVersion
            Description: The version of the guardrail.
        • knowledge_base_id
          Type: STRING
          Provider name: knowledgeBaseId
          Description: The unique identifier of the knowledge base to query.
        • model_id
          Type: STRING
          Provider name: modelId
          Description: The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
      • lambda_function
        Type: STRUCT
        Provider name: lambdaFunction
        Description: Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

        • lambda_arn
          Type: STRING
          Provider name: lambdaArn
          Description: The Amazon Resource Name (ARN) of the Lambda function to invoke.
      • lex
        Type: STRUCT
        Provider name: lex
        Description: Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

        • bot_alias_arn
          Type: STRING
          Provider name: botAliasArn
          Description: The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
        • locale_id
          Type: STRING
          Provider name: localeId
          Description: The Region to invoke the Amazon Lex bot in.
      • output
        Type: STRUCT
        Provider name: output
        Description: Contains configurations for an output flow node in your flow. The last node in the flow. outputs can’t be specified for this node.

      • prompt
        Type: STRUCT
        Provider name: prompt
        Description: Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

        • guardrail_configuration
          Type: STRUCT
          Provider name: guardrailConfiguration
          Description: Contains configurations for a guardrail to apply to the prompt in this node and the response generated from it.
          • guardrail_identifier
            Type: STRING
            Provider name: guardrailIdentifier
            Description: The unique identifier of the guardrail.
          • guardrail_version
            Type: STRING
            Provider name: guardrailVersion
            Description: The version of the guardrail.
        • source_configuration
          Type: STRUCT
          Provider name: sourceConfiguration
          Description: Specifies whether the prompt is from Prompt management or defined inline.
          • inline
            Type: STRUCT
            Provider name: inline
            Description: Contains configurations for a prompt that is defined inline
            • additional_model_request_fields
              Type: STRUCT
              Provider name: additionalModelRequestFields
              Description: Additional fields to be included in the model request for the Prompt node.

            • inference_configuration
              Type: STRUCT
              Provider name: inferenceConfiguration
              Description: Contains inference configurations for the prompt.

              • text
                Type: STRUCT
                Provider name: text
                Description: Contains inference configurations for a text prompt.
                • max_tokens
                  Type: INT32
                  Provider name: maxTokens
                  Description: The maximum number of tokens to return in the response.
                • stop_sequences
                  Type: UNORDERED_LIST_STRING
                  Provider name: stopSequences
                  Description: A list of strings that define sequences after which the model will stop generating.
                • temperature
                  Type: FLOAT
                  Provider name: temperature
                  Description: Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
                • top_p
                  Type: FLOAT
                  Provider name: topP
                  Description: The percentage of most-likely candidates that the model considers for the next token.
            • model_id
              Type: STRING
              Provider name: modelId
              Description: The unique identifier of the model or inference profile to run inference with.

            • template_configuration
              Type: STRUCT
              Provider name: templateConfiguration
              Description: Contains a prompt and variables in the prompt that can be replaced with values at runtime.

              • chat
                Type: STRUCT
                Provider name: chat
                Description: Contains configurations to use the prompt in a conversational format.
                • input_variables
                  Type: UNORDERED_LIST_STRUCT
                  Provider name: inputVariables
                  Description: An array of the variables in the prompt template.
                  • name
                    Type: STRING
                    Provider name: name
                    Description: The name of the variable.
                • messages
                  Type: UNORDERED_LIST_STRUCT
                  Provider name: messages
                  Description: Contains messages in the chat for the prompt.
                  • content
                    Type: UNORDERED_LIST_STRUCT
                    Provider name: content
                    Description: The content in the message.
                    • cache_point
                      Type: STRUCT
                      Provider name: cachePoint
                      Description: Creates a cache checkpoint within a message.
                      • type
                        Type: STRING
                        Provider name: type
                        Description: Indicates that the CachePointBlock is of the default type
                    • text
                      Type: STRING
                      Provider name: text
                      Description: The text in the message.
                  • role
                    Type: STRING
                    Provider name: role
                    Description: The role that the message belongs to.
                • system
                  Type: UNORDERED_LIST_STRUCT
                  Provider name: system
                  Description: Contains system prompts to provide context to the model or to describe how it should behave.
                  • cache_point
                    Type: STRUCT
                    Provider name: cachePoint
                    Description: Creates a cache checkpoint within a tool designation
                    • type
                      Type: STRING
                      Provider name: type
                      Description: Indicates that the CachePointBlock is of the default type
                  • text
                    Type: STRING
                    Provider name: text
                    Description: The text in the system prompt.
                • tool_configuration
                  Type: STRUCT
                  Provider name: toolConfiguration
                  Description: Configuration information for the tools that the model can use when generating a response.
                  • tool_choice
                    Type: STRUCT
                    Provider name: toolChoice
                    Description: Defines which tools the model should request when invoked.
                    • any
                      Type: STRUCT
                      Provider name: any
                      Description: Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response.

                    • auto
                      Type: STRUCT
                      Provider name: auto
                      Description: Defines tools. The model automatically decides whether to call a tool or to generate text instead.

                    • tool
                      Type: STRUCT
                      Provider name: tool
                      Description: Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response.

                      • name
                        Type: STRING
                        Provider name: name
                        Description: The name of the tool.
                  • tools
                    Type: UNORDERED_LIST_STRUCT
                    Provider name: tools
                    Description: An array of tools to pass to a model.
                    • cache_point
                      Type: STRUCT
                      Provider name: cachePoint
                      Description: Creates a cache checkpoint within a tool designation
                      • type
                        Type: STRING
                        Provider name: type
                        Description: Indicates that the CachePointBlock is of the default type
                    • tool_spec
                      Type: STRUCT
                      Provider name: toolSpec
                      Description: The specification for the tool.
                      • description
                        Type: STRING
                        Provider name: description
                        Description: The description of the tool.
                      • input_schema
                        Type: STRUCT
                        Provider name: inputSchema
                        Description: The input schema for the tool.
                        • json
                          Type: STRUCT
                          Provider name: json
                          Description: A JSON object defining the input schema for the tool.
                      • name
                        Type: STRING
                        Provider name: name
                        Description: The name of the tool.
              • text
                Type: STRUCT
                Provider name: text
                Description: Contains configurations for the text in a message for a prompt.
                • cache_point
                  Type: STRUCT
                  Provider name: cachePoint
                  Description: A cache checkpoint within a template configuration.
                  • type
                    Type: STRING
                    Provider name: type
                    Description: Indicates that the CachePointBlock is of the default type
                • input_variables
                  Type: UNORDERED_LIST_STRUCT
                  Provider name: inputVariables
                  Description: An array of the variables in the prompt template.
                  • name
                    Type: STRING
                    Provider name: name
                    Description: The name of the variable.
                • text
                  Type: STRING
                  Provider name: text
                  Description: The message for the prompt.
            • template_type
              Type: STRING
              Provider name: templateType
              Description: The type of prompt template.

          • resource
            Type: STRUCT
            Provider name: resource
            Description: Contains configurations for a prompt from Prompt management.
            • prompt_arn
              Type: STRING
              Provider name: promptArn
              Description: The Amazon Resource Name (ARN) of the prompt from Prompt management.
      • retrieval
        Type: STRUCT
        Provider name: retrieval
        Description: Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

        • service_configuration
          Type: STRUCT
          Provider name: serviceConfiguration
          Description: Contains configurations for the service to use for retrieving data to return as the output from the node.
          • s3
            Type: STRUCT
            Provider name: s3
            Description: Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
            • bucket_name
              Type: STRING
              Provider name: bucketName
              Description: The name of the Amazon S3 bucket from which to retrieve data.
      • storage
        Type: STRUCT
        Provider name: storage
        Description: Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.

        • service_configuration
          Type: STRUCT
          Provider name: serviceConfiguration
          Description: Contains configurations for the service to use for storing the input into the node.
          • s3
            Type: STRUCT
            Provider name: s3
            Description: Contains configurations for the Amazon S3 location in which to store the input into the node.
            • bucket_name
              Type: STRING
              Provider name: bucketName
              Description: The name of the Amazon S3 bucket in which to store the input into the node.
    • inputs
      Type: UNORDERED_LIST_STRUCT
      Provider name: inputs
      Description: An array of objects, each of which contains information about an input into the node.
      • expression
        Type: STRING
        Provider name: expression
        Description: 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
        Type: STRING
        Provider name: name
        Description: A name for the input that you can reference.
      • type
        Type: STRING
        Provider name: type
        Description: The data type of the input. If the input doesn’t match this type at runtime, a validation error will be thrown.
    • name
      Type: STRING
      Provider name: name
      Description: A name for the node.
    • outputs
      Type: UNORDERED_LIST_STRUCT
      Provider name: outputs
      Description: A list of objects, each of which contains information about an output from the node.
      • name
        Type: STRING
        Provider name: name
        Description: A name for the output that you can reference.
      • type
        Type: STRING
        Provider name: type
        Description: The data type of the output. If the output doesn’t match this type at runtime, a validation error will be thrown.
    • type
      Type: STRING
      Provider name: type
      Description: The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.

description

Type: STRING
Provider name: description
Description: The description of the flow.

execution_role_arn

Type: STRING
Provider name: executionRoleArn
Description: The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

id

Type: STRING
Provider name: id
Description: The unique identifier of the flow.

name

Type: STRING
Provider name: name
Description: The name of the flow.

status

Type: STRING
Provider name: status
Description: The status of the flow. The following statuses are possible:

  • NotPrepared – The flow has been created or updated, but hasn’t been prepared. If you just created the flow, you can’t test it. If you updated the flow, the DRAFT version won’t contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
  • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
  • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
  • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

tags

Type: UNORDERED_LIST_STRING

updated_at

Type: TIMESTAMP
Provider name: updatedAt
Description: The time at which the flow was last updated.

validations

Type: UNORDERED_LIST_STRUCT
Provider name: validations
Description: A list of validation error messages related to the last failed operation on the flow.

  • details
    Type: STRUCT
    Provider name: details
    Description: Specific details about the validation issue encountered in the flow.
    • cyclic_connection
      Type: STRUCT
      Provider name: cyclicConnection
      Description: Details about a cyclic connection in the flow.

      • connection
        Type: STRING
        Provider name: connection
        Description: The name of the connection that causes the cycle in the flow.
    • duplicate_condition_expression
      Type: STRUCT
      Provider name: duplicateConditionExpression
      Description: Details about duplicate condition expressions in a node.

      • expression
        Type: STRING
        Provider name: expression
        Description: The duplicated condition expression.
      • node
        Type: STRING
        Provider name: node
        Description: The name of the node containing the duplicate condition expressions.
    • duplicate_connections
      Type: STRUCT
      Provider name: duplicateConnections
      Description: Details about duplicate connections between nodes.

      • source
        Type: STRING
        Provider name: source
        Description: The name of the source node where the duplicate connection starts.
      • target
        Type: STRING
        Provider name: target
        Description: The name of the target node where the duplicate connection ends.
    • incompatible_connection_data_type
      Type: STRUCT
      Provider name: incompatibleConnectionDataType
      Description: Details about incompatible data types in a connection.

      • connection
        Type: STRING
        Provider name: connection
        Description: The name of the connection with incompatible data types.
    • malformed_condition_expression
      Type: STRUCT
      Provider name: malformedConditionExpression
      Description: Details about a malformed condition expression in a node.

      • cause
        Type: STRING
        Provider name: cause
        Description: The error message describing why the condition expression is malformed.
      • condition
        Type: STRING
        Provider name: condition
        Description: The name of the malformed condition.
      • node
        Type: STRING
        Provider name: node
        Description: The name of the node containing the malformed condition expression.
    • malformed_node_input_expression
      Type: STRUCT
      Provider name: malformedNodeInputExpression
      Description: Details about a malformed input expression in a node.

      • cause
        Type: STRING
        Provider name: cause
        Description: The error message describing why the input expression is malformed.
      • input
        Type: STRING
        Provider name: input
        Description: The name of the input with the malformed expression.
      • node
        Type: STRING
        Provider name: node
        Description: The name of the node containing the malformed input expression.
    • mismatched_node_input_type
      Type: STRUCT
      Provider name: mismatchedNodeInputType
      Description: Details about mismatched input data types in a node.

      • expected_type
        Type: STRING
        Provider name: expectedType
        Description: The expected data type for the node input.
      • input
        Type: STRING
        Provider name: input
        Description: The name of the input with the mismatched data type.
      • node
        Type: STRING
        Provider name: node
        Description: The name of the node containing the input with the mismatched data type.
    • mismatched_node_output_type
      Type: STRUCT
      Provider name: mismatchedNodeOutputType
      Description: Details about mismatched output data types in a node.

      • expected_type
        Type: STRING
        Provider name: expectedType
        Description: The expected data type for the node output.
      • node
        Type: STRING
        Provider name: node
        Description: The name of the node containing the output with the mismatched data type.
      • output
        Type: STRING
        Provider name: output
        Description: The name of the output with the mismatched data type.
    • missing_connection_configuration
      Type: STRUCT
      Provider name: missingConnectionConfiguration
      Description: Details about missing configuration for a connection.

      • connection
        Type: STRING
        Provider name: connection
        Description: The name of the connection missing configuration.
    • missing_default_condition
      Type: STRUCT
      Provider name: missingDefaultCondition
      Description: Details about a missing default condition in a conditional node.

      • node
        Type: STRING
        Provider name: node
        Description: The name of the node missing the default condition.
    • missing_ending_nodes
      Type: STRUCT
      Provider name: missingEndingNodes
      Description: Details about missing ending nodes in the flow.

    • missing_node_configuration
      Type: STRUCT
      Provider name: missingNodeConfiguration
      Description: Details about missing configuration for a node.

      • node
        Type: STRING
        Provider name: node
        Description: The name of the node missing configuration.
    • missing_node_input
      Type: STRUCT
      Provider name: missingNodeInput
      Description: Details about a missing required input in a node.

      • input
        Type: STRING
        Provider name: input
        Description: The name of the missing input.
      • node
        Type: STRING
        Provider name: node
        Description: The name of the node missing the required input.
    • missing_node_output
      Type: STRUCT
      Provider name: missingNodeOutput
      Description: Details about a missing required output in a node.

      • node
        Type: STRING
        Provider name: node
        Description: The name of the node missing the required output.
      • output
        Type: STRING
        Provider name: output
        Description: The name of the missing output.
    • missing_starting_nodes
      Type: STRUCT
      Provider name: missingStartingNodes
      Description: Details about missing starting nodes in the flow.

    • multiple_node_input_connections
      Type: STRUCT
      Provider name: multipleNodeInputConnections
      Description: Details about multiple connections to a single node input.

      • input
        Type: STRING
        Provider name: input
        Description: The name of the input with multiple connections to it.
      • node
        Type: STRING
        Provider name: node
        Description: The name of the node containing the input with multiple connections.
    • unfulfilled_node_input
      Type: STRUCT
      Provider name: unfulfilledNodeInput
      Description: Details about an unfulfilled node input with no valid connections.

      • input
        Type: STRING
        Provider name: input
        Description: The name of the unfulfilled input. An input is unfulfilled if there are no data connections to it.
      • node
        Type: STRING
        Provider name: node
        Description: The name of the node containing the unfulfilled input.
    • unknown_connection_condition
      Type: STRUCT
      Provider name: unknownConnectionCondition
      Description: Details about an unknown condition for a connection.

      • connection
        Type: STRING
        Provider name: connection
        Description: The name of the connection with the unknown condition.
    • unknown_connection_source
      Type: STRUCT
      Provider name: unknownConnectionSource
      Description: Details about an unknown source node for a connection.

      • connection
        Type: STRING
        Provider name: connection
        Description: The name of the connection with the unknown source.
    • unknown_connection_source_output
      Type: STRUCT
      Provider name: unknownConnectionSourceOutput
      Description: Details about an unknown source output for a connection.

      • connection
        Type: STRING
        Provider name: connection
        Description: The name of the connection with the unknown source output.
    • unknown_connection_target
      Type: STRUCT
      Provider name: unknownConnectionTarget
      Description: Details about an unknown target node for a connection.

      • connection
        Type: STRING
        Provider name: connection
        Description: The name of the connection with the unknown target.
    • unknown_connection_target_input
      Type: STRUCT
      Provider name: unknownConnectionTargetInput
      Description: Details about an unknown target input for a connection.

      • connection
        Type: STRING
        Provider name: connection
        Description: The name of the connection with the unknown target input.
    • unknown_node_input
      Type: STRUCT
      Provider name: unknownNodeInput
      Description: Details about an unknown input for a node.

      • input
        Type: STRING
        Provider name: input
        Description: The name of the node with the unknown input.
      • node
        Type: STRING
        Provider name: node
        Description: The name of the unknown input.
    • unknown_node_output
      Type: STRUCT
      Provider name: unknownNodeOutput
      Description: Details about an unknown output for a node.

      • node
        Type: STRING
        Provider name: node
        Description: The name of the node with the unknown output.
      • output
        Type: STRING
        Provider name: output
        Description: The name of the unknown output.
    • unreachable_node
      Type: STRUCT
      Provider name: unreachableNode
      Description: Details about an unreachable node in the flow.

      • node
        Type: STRING
        Provider name: node
        Description: The name of the unreachable node.
    • unsatisfied_connection_conditions
      Type: STRUCT
      Provider name: unsatisfiedConnectionConditions
      Description: Details about unsatisfied conditions for a connection.

      • connection
        Type: STRING
        Provider name: connection
        Description: The name of the connection with unsatisfied conditions.
    • unspecified
      Type: STRUCT
      Provider name: unspecified
      Description: Details about an unspecified validation.

  • message
    Type: STRING
    Provider name: message
    Description: A message describing the validation error.
  • severity
    Type: STRING
    Provider name: severity
    Description: The severity of the issue described in the message.
  • type
    Type: STRING
    Provider name: type
    Description: The type of validation issue encountered in the flow.

version

Type: STRING
Provider name: version
Description: The version of the flow for which information was retrieved.