aws-sdk-bedrockagentruntime 1.30.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddd19c39eedacc41d2bef21c75ff2669e9badf69d4b784b9b828ef5c9482d225
-  data.tar.gz: b3b78d61228b5a8db3fbe3efa336e94f11b1f83b453c7aa1f726d7ffab940ef5
+  metadata.gz: 0456f26043768c8a899bebf3fe9e02f7f5ee664c2543ad1ab5ae243d97d00040
+  data.tar.gz: 8e3b743740e6dba682763df127ede599c8a13d1c298984daeee302c59a9935b0
 SHA512:
-  metadata.gz: 3ce22f6888e86e1c8303524cbd67791e688f760182d326fb88f856c98aabefe428310b52b954d243f0d7a8e8a46e79c2e3eae70e8f0acde4d47e24d9b7ef1543
-  data.tar.gz: 9fae515be407940cd0821112ef9248f5f714e139d332da4f3d6a222ca589332c59cf161729493ae69a309ac894fd614664d7fba3e9bb967f7630aa4ae35402d2
+  metadata.gz: c01cf4655c0cbb656e2245f6253c761a656feec75ed4872ea78bd66c8f9b363c34ced4d77d28202b238b0f459c584cc29078de74cdc76ad31868bec447c884ba
+  data.tar.gz: 1a6a16f958c93536a30eb437c21d5b590d92c7f129edcc31c0d1fd6d74ef6c37e606c5816213ac64446e7cec62ff759f00b239f2eee87a89bd867fd0017cf275

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.31.0 (2024-11-08)
+------------------
+
+* Feature - This release adds trace functionality to Bedrock Prompt Flows
+
 1.30.0 (2024-11-06)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.30.0
+1.31.0

data/lib/aws-sdk-bedrockagentruntime/client.rb

@@ -1259,6 +1259,16 @@ module Aws::BedrockAgentRuntime
     #
     # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html
     #
+    # @option params [Boolean] :enable_trace
+    #   Specifies whether to return the trace for the flow or not. Traces
+    #   track inputs and outputs for nodes in the flow. For more information,
+    #   see [Track each step in your prompt flow by viewing its trace in
+    #   Amazon Bedrock][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
     # @option params [required, String] :flow_alias_identifier
     #   The unique identifier of the flow alias.
     #
@@ -1334,6 +1344,9 @@ module Aws::BedrockAgentRuntime
     #       handler.on_flow_output_event_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
     #       end
+    #       handler.on_flow_trace_event_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
+    #       end
     #       handler.on_internal_server_exception_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::internalServerException
     #       end
@@ -1374,6 +1387,9 @@ module Aws::BedrockAgentRuntime
     #       stream.on_flow_output_event_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
     #       end
+    #       stream.on_flow_trace_event_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
+    #       end
     #       stream.on_internal_server_exception_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::internalServerException
     #       end
@@ -1414,6 +1430,9 @@ module Aws::BedrockAgentRuntime
     #       handler.on_flow_output_event_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
     #       end
+    #       handler.on_flow_trace_event_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
+    #       end
     #       handler.on_internal_server_exception_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::internalServerException
     #       end
@@ -1449,6 +1468,7 @@ module Aws::BedrockAgentRuntime
     # @example Request syntax with placeholder values
     #
     #   resp = client.invoke_flow({
+    #     enable_trace: false,
     #     flow_alias_identifier: "FlowAliasIdentifier", # required
     #     flow_identifier: "FlowIdentifier", # required
     #     inputs: [ # required
@@ -1467,7 +1487,7 @@ module Aws::BedrockAgentRuntime
     #
     #   All events are available at resp.response_stream:
     #   resp.response_stream #=> Enumerator
-    #   resp.response_stream.event_types #=> [:access_denied_exception, :bad_gateway_exception, :conflict_exception, :dependency_failed_exception, :flow_completion_event, :flow_output_event, :internal_server_exception, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :validation_exception]
+    #   resp.response_stream.event_types #=> [:access_denied_exception, :bad_gateway_exception, :conflict_exception, :dependency_failed_exception, :flow_completion_event, :flow_output_event, :flow_trace_event, :internal_server_exception, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :validation_exception]
     #
     #   For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
     #   event.message #=> String
@@ -1490,6 +1510,20 @@ module Aws::BedrockAgentRuntime
     #   event.node_name #=> String
     #   event.node_type #=> String, one of "FlowInputNode", "FlowOutputNode", "LambdaFunctionNode", "KnowledgeBaseNode", "PromptNode", "ConditionNode", "LexNode"
     #
+    #   For :flow_trace_event event available at #on_flow_trace_event_event callback and response eventstream enumerator:
+    #   event.trace.condition_node_result_trace.node_name #=> String
+    #   event.trace.condition_node_result_trace.satisfied_conditions #=> Array
+    #   event.trace.condition_node_result_trace.satisfied_conditions[0].condition_name #=> String
+    #   event.trace.condition_node_result_trace.timestamp #=> Time
+    #   event.trace.node_input_trace.fields #=> Array
+    #   event.trace.node_input_trace.fields[0].node_input_name #=> String
+    #   event.trace.node_input_trace.node_name #=> String
+    #   event.trace.node_input_trace.timestamp #=> Time
+    #   event.trace.node_output_trace.fields #=> Array
+    #   event.trace.node_output_trace.fields[0].node_output_name #=> String
+    #   event.trace.node_output_trace.node_name #=> String
+    #   event.trace.node_output_trace.timestamp #=> Time
+    #
     #   For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
     #   event.message #=> String
     #
@@ -1920,7 +1954,7 @@ module Aws::BedrockAgentRuntime
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-bedrockagentruntime'
-      context[:gem_version] = '1.30.0'
+      context[:gem_version] = '1.31.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-bedrockagentruntime/client_api.rb

@@ -85,6 +85,19 @@ module Aws::BedrockAgentRuntime
     FlowOutputContent = Shapes::UnionShape.new(name: 'FlowOutputContent')
     FlowOutputEvent = Shapes::StructureShape.new(name: 'FlowOutputEvent')
     FlowResponseStream = Shapes::StructureShape.new(name: 'FlowResponseStream')
+    FlowTrace = Shapes::UnionShape.new(name: 'FlowTrace')
+    FlowTraceCondition = Shapes::StructureShape.new(name: 'FlowTraceCondition')
+    FlowTraceConditionNodeResultEvent = Shapes::StructureShape.new(name: 'FlowTraceConditionNodeResultEvent')
+    FlowTraceConditions = Shapes::ListShape.new(name: 'FlowTraceConditions')
+    FlowTraceEvent = Shapes::StructureShape.new(name: 'FlowTraceEvent')
+    FlowTraceNodeInputContent = Shapes::UnionShape.new(name: 'FlowTraceNodeInputContent')
+    FlowTraceNodeInputEvent = Shapes::StructureShape.new(name: 'FlowTraceNodeInputEvent')
+    FlowTraceNodeInputField = Shapes::StructureShape.new(name: 'FlowTraceNodeInputField')
+    FlowTraceNodeInputFields = Shapes::ListShape.new(name: 'FlowTraceNodeInputFields')
+    FlowTraceNodeOutputContent = Shapes::UnionShape.new(name: 'FlowTraceNodeOutputContent')
+    FlowTraceNodeOutputEvent = Shapes::StructureShape.new(name: 'FlowTraceNodeOutputEvent')
+    FlowTraceNodeOutputField = Shapes::StructureShape.new(name: 'FlowTraceNodeOutputField')
+    FlowTraceNodeOutputFields = Shapes::ListShape.new(name: 'FlowTraceNodeOutputFields')
     Function = Shapes::StringShape.new(name: 'Function')
     FunctionInvocationInput = Shapes::StructureShape.new(name: 'FunctionInvocationInput')
     FunctionParameter = Shapes::StructureShape.new(name: 'FunctionParameter')
@@ -172,6 +185,7 @@ module Aws::BedrockAgentRuntime
     MimeType = Shapes::StringShape.new(name: 'MimeType')
     ModelInvocationInput = Shapes::StructureShape.new(name: 'ModelInvocationInput')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
+    NodeInputName = Shapes::StringShape.new(name: 'NodeInputName')
     NodeName = Shapes::StringShape.new(name: 'NodeName')
     NodeOutputName = Shapes::StringShape.new(name: 'NodeOutputName')
     NodeType = Shapes::StringShape.new(name: 'NodeType')
@@ -443,6 +457,7 @@ module Aws::BedrockAgentRuntime
     FlowResponseStream.add_member(:dependency_failed_exception, Shapes::ShapeRef.new(shape: DependencyFailedException, location_name: "dependencyFailedException"))
     FlowResponseStream.add_member(:flow_completion_event, Shapes::ShapeRef.new(shape: FlowCompletionEvent, event: true, location_name: "flowCompletionEvent"))
     FlowResponseStream.add_member(:flow_output_event, Shapes::ShapeRef.new(shape: FlowOutputEvent, event: true, location_name: "flowOutputEvent"))
+    FlowResponseStream.add_member(:flow_trace_event, Shapes::ShapeRef.new(shape: FlowTraceEvent, event: true, location_name: "flowTraceEvent"))
     FlowResponseStream.add_member(:internal_server_exception, Shapes::ShapeRef.new(shape: InternalServerException, location_name: "internalServerException"))
     FlowResponseStream.add_member(:resource_not_found_exception, Shapes::ShapeRef.new(shape: ResourceNotFoundException, location_name: "resourceNotFoundException"))
     FlowResponseStream.add_member(:service_quota_exceeded_exception, Shapes::ShapeRef.new(shape: ServiceQuotaExceededException, location_name: "serviceQuotaExceededException"))
@@ -450,6 +465,63 @@ module Aws::BedrockAgentRuntime
     FlowResponseStream.add_member(:validation_exception, Shapes::ShapeRef.new(shape: ValidationException, location_name: "validationException"))
     FlowResponseStream.struct_class = Types::FlowResponseStream
 
+    FlowTrace.add_member(:condition_node_result_trace, Shapes::ShapeRef.new(shape: FlowTraceConditionNodeResultEvent, location_name: "conditionNodeResultTrace"))
+    FlowTrace.add_member(:node_input_trace, Shapes::ShapeRef.new(shape: FlowTraceNodeInputEvent, location_name: "nodeInputTrace"))
+    FlowTrace.add_member(:node_output_trace, Shapes::ShapeRef.new(shape: FlowTraceNodeOutputEvent, location_name: "nodeOutputTrace"))
+    FlowTrace.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    FlowTrace.add_member_subclass(:condition_node_result_trace, Types::FlowTrace::ConditionNodeResultTrace)
+    FlowTrace.add_member_subclass(:node_input_trace, Types::FlowTrace::NodeInputTrace)
+    FlowTrace.add_member_subclass(:node_output_trace, Types::FlowTrace::NodeOutputTrace)
+    FlowTrace.add_member_subclass(:unknown, Types::FlowTrace::Unknown)
+    FlowTrace.struct_class = Types::FlowTrace
+
+    FlowTraceCondition.add_member(:condition_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "conditionName"))
+    FlowTraceCondition.struct_class = Types::FlowTraceCondition
+
+    FlowTraceConditionNodeResultEvent.add_member(:node_name, Shapes::ShapeRef.new(shape: NodeName, required: true, location_name: "nodeName"))
+    FlowTraceConditionNodeResultEvent.add_member(:satisfied_conditions, Shapes::ShapeRef.new(shape: FlowTraceConditions, required: true, location_name: "satisfiedConditions"))
+    FlowTraceConditionNodeResultEvent.add_member(:timestamp, Shapes::ShapeRef.new(shape: DateTimestamp, required: true, location_name: "timestamp"))
+    FlowTraceConditionNodeResultEvent.struct_class = Types::FlowTraceConditionNodeResultEvent
+
+    FlowTraceConditions.member = Shapes::ShapeRef.new(shape: FlowTraceCondition)
+
+    FlowTraceEvent.add_member(:trace, Shapes::ShapeRef.new(shape: FlowTrace, required: true, location_name: "trace"))
+    FlowTraceEvent.struct_class = Types::FlowTraceEvent
+
+    FlowTraceNodeInputContent.add_member(:document, Shapes::ShapeRef.new(shape: Document, location_name: "document"))
+    FlowTraceNodeInputContent.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    FlowTraceNodeInputContent.add_member_subclass(:document, Types::FlowTraceNodeInputContent::Document)
+    FlowTraceNodeInputContent.add_member_subclass(:unknown, Types::FlowTraceNodeInputContent::Unknown)
+    FlowTraceNodeInputContent.struct_class = Types::FlowTraceNodeInputContent
+
+    FlowTraceNodeInputEvent.add_member(:fields, Shapes::ShapeRef.new(shape: FlowTraceNodeInputFields, required: true, location_name: "fields"))
+    FlowTraceNodeInputEvent.add_member(:node_name, Shapes::ShapeRef.new(shape: NodeName, required: true, location_name: "nodeName"))
+    FlowTraceNodeInputEvent.add_member(:timestamp, Shapes::ShapeRef.new(shape: DateTimestamp, required: true, location_name: "timestamp"))
+    FlowTraceNodeInputEvent.struct_class = Types::FlowTraceNodeInputEvent
+
+    FlowTraceNodeInputField.add_member(:content, Shapes::ShapeRef.new(shape: FlowTraceNodeInputContent, required: true, location_name: "content"))
+    FlowTraceNodeInputField.add_member(:node_input_name, Shapes::ShapeRef.new(shape: NodeInputName, required: true, location_name: "nodeInputName"))
+    FlowTraceNodeInputField.struct_class = Types::FlowTraceNodeInputField
+
+    FlowTraceNodeInputFields.member = Shapes::ShapeRef.new(shape: FlowTraceNodeInputField)
+
+    FlowTraceNodeOutputContent.add_member(:document, Shapes::ShapeRef.new(shape: Document, location_name: "document"))
+    FlowTraceNodeOutputContent.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    FlowTraceNodeOutputContent.add_member_subclass(:document, Types::FlowTraceNodeOutputContent::Document)
+    FlowTraceNodeOutputContent.add_member_subclass(:unknown, Types::FlowTraceNodeOutputContent::Unknown)
+    FlowTraceNodeOutputContent.struct_class = Types::FlowTraceNodeOutputContent
+
+    FlowTraceNodeOutputEvent.add_member(:fields, Shapes::ShapeRef.new(shape: FlowTraceNodeOutputFields, required: true, location_name: "fields"))
+    FlowTraceNodeOutputEvent.add_member(:node_name, Shapes::ShapeRef.new(shape: NodeName, required: true, location_name: "nodeName"))
+    FlowTraceNodeOutputEvent.add_member(:timestamp, Shapes::ShapeRef.new(shape: DateTimestamp, required: true, location_name: "timestamp"))
+    FlowTraceNodeOutputEvent.struct_class = Types::FlowTraceNodeOutputEvent
+
+    FlowTraceNodeOutputField.add_member(:content, Shapes::ShapeRef.new(shape: FlowTraceNodeOutputContent, required: true, location_name: "content"))
+    FlowTraceNodeOutputField.add_member(:node_output_name, Shapes::ShapeRef.new(shape: NodeOutputName, required: true, location_name: "nodeOutputName"))
+    FlowTraceNodeOutputField.struct_class = Types::FlowTraceNodeOutputField
+
+    FlowTraceNodeOutputFields.member = Shapes::ShapeRef.new(shape: FlowTraceNodeOutputField)
+
     FunctionInvocationInput.add_member(:action_group, Shapes::ShapeRef.new(shape: String, required: true, location_name: "actionGroup"))
     FunctionInvocationInput.add_member(:action_invocation_type, Shapes::ShapeRef.new(shape: ActionInvocationType, location_name: "actionInvocationType"))
     FunctionInvocationInput.add_member(:function, Shapes::ShapeRef.new(shape: String, location_name: "function"))
@@ -628,6 +700,7 @@ module Aws::BedrockAgentRuntime
     InvokeAgentResponse[:payload] = :completion
     InvokeAgentResponse[:payload_member] = InvokeAgentResponse.member(:completion)
 
+    InvokeFlowRequest.add_member(:enable_trace, Shapes::ShapeRef.new(shape: Boolean, location_name: "enableTrace"))
     InvokeFlowRequest.add_member(:flow_alias_identifier, Shapes::ShapeRef.new(shape: FlowAliasIdentifier, required: true, location: "uri", location_name: "flowAliasIdentifier"))
     InvokeFlowRequest.add_member(:flow_identifier, Shapes::ShapeRef.new(shape: FlowIdentifier, required: true, location: "uri", location_name: "flowIdentifier"))
     InvokeFlowRequest.add_member(:inputs, Shapes::ShapeRef.new(shape: FlowInputs, required: true, location_name: "inputs"))

data/lib/aws-sdk-bedrockagentruntime/event_streams.rb

@@ -133,6 +133,10 @@ module Aws::BedrockAgentRuntime
         @event_emitter.on(:flow_output_event, block) if block_given?
       end
 
+      def on_flow_trace_event_event(&block)
+        @event_emitter.on(:flow_trace_event, block) if block_given?
+      end
+
       def on_internal_server_exception_event(&block)
         @event_emitter.on(:internal_server_exception, block) if block_given?
       end
@@ -172,6 +176,7 @@ module Aws::BedrockAgentRuntime
         on_dependency_failed_exception_event(&block)
         on_flow_completion_event_event(&block)
         on_flow_output_event_event(&block)
+        on_flow_trace_event_event(&block)
         on_internal_server_exception_event(&block)
         on_resource_not_found_exception_event(&block)
         on_service_quota_exceeded_exception_event(&block)

data/lib/aws-sdk-bedrockagentruntime/types.rb

@@ -725,16 +725,6 @@ module Aws::BedrockAgentRuntime
 
     # Contains information about why a flow completed.
     #
-    # This data type is used in the following API operations:
-    #
-    # * [InvokeFlow response][1]
-    #
-    # ^
-    #
-    #
-    #
-    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax
-    #
     # @!attribute [rw] completion_reason
     #   The reason that the flow completed.
     #   @return [String]
@@ -751,16 +741,6 @@ module Aws::BedrockAgentRuntime
     # Contains information about an input into the prompt flow and where to
     # send it.
     #
-    # This data type is used in the following API operations:
-    #
-    # * [InvokeFlow request][1]
-    #
-    # ^
-    #
-    #
-    #
-    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax
-    #
     # @!attribute [rw] content
     #   Contains information about an input into the prompt flow.
     #   @return [Types::FlowInputContent]
@@ -786,16 +766,6 @@ module Aws::BedrockAgentRuntime
 
     # Contains information about an input into the flow.
     #
-    # This data type is used in the following API operations:
-    #
-    # * [InvokeFlow request][1]
-    #
-    # ^
-    #
-    #
-    #
-    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax
-    #
     # @note FlowInputContent is a union - when making an API calls you must set exactly one of the members.
     #
     # @!attribute [rw] document
@@ -818,16 +788,6 @@ module Aws::BedrockAgentRuntime
     # Contains information about the content in an output from prompt flow
     # invocation.
     #
-    # This data type is used in the following API operations:
-    #
-    # * [InvokeFlow request][1]
-    #
-    # ^
-    #
-    #
-    #
-    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax
-    #
     # @note FlowOutputContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowOutputContent corresponding to the set member.
     #
     # @!attribute [rw] document
@@ -849,16 +809,6 @@ module Aws::BedrockAgentRuntime
 
     # Contains information about an output from prompt flow invoction.
     #
-    # This data type is used in the following API operations:
-    #
-    # * [InvokeFlow response][1]
-    #
-    # ^
-    #
-    #
-    #
-    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax
-    #
     # @!attribute [rw] content
     #   The content in the output.
     #   @return [Types::FlowOutputContent]
@@ -882,6 +832,284 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains information about an input or output for a node in the flow.
+    # For more information, see [Track each step in your prompt flow by
+    # viewing its trace in Amazon Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @note FlowTrace is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowTrace corresponding to the set member.
+    #
+    # @!attribute [rw] condition_node_result_trace
+    #   Contains information about an output from a condition node.
+    #   @return [Types::FlowTraceConditionNodeResultEvent]
+    #
+    # @!attribute [rw] node_input_trace
+    #   Contains information about the input into a node.
+    #   @return [Types::FlowTraceNodeInputEvent]
+    #
+    # @!attribute [rw] node_output_trace
+    #   Contains information about the output from a node.
+    #   @return [Types::FlowTraceNodeOutputEvent]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTrace AWS API Documentation
+    #
+    class FlowTrace < Struct.new(
+      :condition_node_result_trace,
+      :node_input_trace,
+      :node_output_trace,
+      :unknown)
+      SENSITIVE = [:condition_node_result_trace, :node_input_trace, :node_output_trace]
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class ConditionNodeResultTrace < FlowTrace; end
+      class NodeInputTrace < FlowTrace; end
+      class NodeOutputTrace < FlowTrace; end
+      class Unknown < FlowTrace; end
+    end
+
+    # Contains information about a condition that was satisfied. For more
+    # information, see [Track each step in your prompt flow by viewing its
+    # trace in Amazon Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @!attribute [rw] condition_name
+    #   The name of the condition.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTraceCondition AWS API Documentation
+    #
+    class FlowTraceCondition < Struct.new(
+      :condition_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains information about an output from a condition node. For more
+    # information, see [Track each step in your prompt flow by viewing its
+    # trace in Amazon Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @!attribute [rw] node_name
+    #   The name of the condition node.
+    #   @return [String]
+    #
+    # @!attribute [rw] satisfied_conditions
+    #   An array of objects containing information about the conditions that
+    #   were satisfied.
+    #   @return [Array<Types::FlowTraceCondition>]
+    #
+    # @!attribute [rw] timestamp
+    #   The date and time that the trace was returned.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTraceConditionNodeResultEvent AWS API Documentation
+    #
+    class FlowTraceConditionNodeResultEvent < Struct.new(
+      :node_name,
+      :satisfied_conditions,
+      :timestamp)
+      SENSITIVE = [:satisfied_conditions]
+      include Aws::Structure
+    end
+
+    # Contains information about a trace, which tracks an input or output
+    # for a node in the flow. For more information, see [Track each step in
+    # your prompt flow by viewing its trace in Amazon Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @!attribute [rw] trace
+    #   The trace object containing information about an input or output for
+    #   a node in the flow.
+    #   @return [Types::FlowTrace]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTraceEvent AWS API Documentation
+    #
+    class FlowTraceEvent < Struct.new(
+      :trace,
+      :event_type)
+      SENSITIVE = [:trace]
+      include Aws::Structure
+    end
+
+    # Contains the content of the node input. For more information, see
+    # [Track each step in your prompt flow by viewing its trace in Amazon
+    # Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @note FlowTraceNodeInputContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowTraceNodeInputContent corresponding to the set member.
+    #
+    # @!attribute [rw] document
+    #   The content of the node input.
+    #   @return [Hash,Array,String,Numeric,Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputContent AWS API Documentation
+    #
+    class FlowTraceNodeInputContent < Struct.new(
+      :document,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class Document < FlowTraceNodeInputContent; end
+      class Unknown < FlowTraceNodeInputContent; end
+    end
+
+    # Contains information about the input into a node. For more
+    # information, see [Track each step in your prompt flow by viewing its
+    # trace in Amazon Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @!attribute [rw] fields
+    #   An array of objects containing information about each field in the
+    #   input.
+    #   @return [Array<Types::FlowTraceNodeInputField>]
+    #
+    # @!attribute [rw] node_name
+    #   The name of the node that received the input.
+    #   @return [String]
+    #
+    # @!attribute [rw] timestamp
+    #   The date and time that the trace was returned.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputEvent AWS API Documentation
+    #
+    class FlowTraceNodeInputEvent < Struct.new(
+      :fields,
+      :node_name,
+      :timestamp)
+      SENSITIVE = [:fields]
+      include Aws::Structure
+    end
+
+    # Contains information about a field in the input into a node. For more
+    # information, see [Track each step in your prompt flow by viewing its
+    # trace in Amazon Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @!attribute [rw] content
+    #   The content of the node input.
+    #   @return [Types::FlowTraceNodeInputContent]
+    #
+    # @!attribute [rw] node_input_name
+    #   The name of the node input.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputField AWS API Documentation
+    #
+    class FlowTraceNodeInputField < Struct.new(
+      :content,
+      :node_input_name)
+      SENSITIVE = [:content]
+      include Aws::Structure
+    end
+
+    # Contains the content of the node output. For more information, see
+    # [Track each step in your prompt flow by viewing its trace in Amazon
+    # Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @note FlowTraceNodeOutputContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowTraceNodeOutputContent corresponding to the set member.
+    #
+    # @!attribute [rw] document
+    #   The content of the node output.
+    #   @return [Hash,Array,String,Numeric,Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputContent AWS API Documentation
+    #
+    class FlowTraceNodeOutputContent < Struct.new(
+      :document,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class Document < FlowTraceNodeOutputContent; end
+      class Unknown < FlowTraceNodeOutputContent; end
+    end
+
+    # Contains information about the output from a node. For more
+    # information, see [Track each step in your prompt flow by viewing its
+    # trace in Amazon Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @!attribute [rw] fields
+    #   An array of objects containing information about each field in the
+    #   output.
+    #   @return [Array<Types::FlowTraceNodeOutputField>]
+    #
+    # @!attribute [rw] node_name
+    #   The name of the node that yielded the output.
+    #   @return [String]
+    #
+    # @!attribute [rw] timestamp
+    #   The date and time that the trace was returned.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputEvent AWS API Documentation
+    #
+    class FlowTraceNodeOutputEvent < Struct.new(
+      :fields,
+      :node_name,
+      :timestamp)
+      SENSITIVE = [:fields]
+      include Aws::Structure
+    end
+
+    # Contains information about a field in the output from a node. For more
+    # information, see [Track each step in your prompt flow by viewing its
+    # trace in Amazon Bedrock][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #
+    # @!attribute [rw] content
+    #   The content of the node output.
+    #   @return [Types::FlowTraceNodeOutputContent]
+    #
+    # @!attribute [rw] node_output_name
+    #   The name of the node output.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputField AWS API Documentation
+    #
+    class FlowTraceNodeOutputField < Struct.new(
+      :content,
+      :node_output_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains information about the function that the agent predicts should
     # be called.
     #
@@ -1069,7 +1297,13 @@ module Aws::BedrockAgentRuntime
     #
     # @!attribute [rw] prompt_template
     #   Contains the template for the prompt that's sent to the model for
-    #   response generation.
+    #   response generation. Generation prompts must include the
+    #   `$search_results$` variable. For more information, see [Use
+    #   placeholder variables][1] in the user guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html
     #   @return [Types::PromptTemplate]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GenerationConfiguration AWS API Documentation
@@ -1763,6 +1997,17 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # @!attribute [rw] enable_trace
+    #   Specifies whether to return the trace for the flow or not. Traces
+    #   track inputs and outputs for nodes in the flow. For more
+    #   information, see [Track each step in your prompt flow by viewing its
+    #   trace in Amazon Bedrock][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html
+    #   @return [Boolean]
+    #
     # @!attribute [rw] flow_alias_identifier
     #   The unique identifier of the flow alias.
     #   @return [String]
@@ -1779,6 +2024,7 @@ module Aws::BedrockAgentRuntime
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeFlowRequest AWS API Documentation
     #
     class InvokeFlowRequest < Struct.new(
+      :enable_trace,
       :flow_alias_identifier,
       :flow_identifier,
       :inputs)
@@ -2297,8 +2543,14 @@ module Aws::BedrockAgentRuntime
     #   @return [Types::InferenceConfig]
     #
     # @!attribute [rw] prompt_template
-    #   Contains the template for the prompt that's sent to the model for
-    #   response generation.
+    #   Contains the template for the prompt that's sent to the model.
+    #   Orchestration prompts must include the `$conversation_history$` and
+    #   `$output_format_instructions$` variables. For more information, see
+    #   [Use placeholder variables][1] in the user guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html
     #   @return [Types::PromptTemplate]
     #
     # @!attribute [rw] query_transformation_configuration
@@ -3888,16 +4140,6 @@ module Aws::BedrockAgentRuntime
 
     # The output of the flow.
     #
-    # This data type is used in the following API operations:
-    #
-    # * [InvokeFlow response][1]
-    #
-    # ^
-    #
-    #
-    #
-    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax
-    #
     # EventStream is an Enumerator of Events.
     #  #event_types #=> Array, returns all modeled event types in the stream
     #
@@ -3913,6 +4155,7 @@ module Aws::BedrockAgentRuntime
           :dependency_failed_exception,
           :flow_completion_event,
           :flow_output_event,
+          :flow_trace_event,
           :internal_server_exception,
           :resource_not_found_exception,
           :service_quota_exceeded_exception,

data/lib/aws-sdk-bedrockagentruntime.rb

@@ -55,7 +55,7 @@ module Aws::BedrockAgentRuntime
   autoload :Endpoints, 'aws-sdk-bedrockagentruntime/endpoints'
   autoload :EventStreams, 'aws-sdk-bedrockagentruntime/event_streams'
 
-  GEM_VERSION = '1.30.0'
+  GEM_VERSION = '1.31.0'
 
 end
 

data/sig/client.rbs

@@ -249,6 +249,7 @@ module Aws
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgentRuntime/Client.html#invoke_flow-instance_method
       def invoke_flow: (
+                         ?enable_trace: bool,
                          flow_alias_identifier: ::String,
                          flow_identifier: ::String,
                          inputs: Array[

data/sig/types.rbs

@@ -232,6 +232,89 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: []
     end
 
+    class FlowTrace
+      attr_accessor condition_node_result_trace: Types::FlowTraceConditionNodeResultEvent
+      attr_accessor node_input_trace: Types::FlowTraceNodeInputEvent
+      attr_accessor node_output_trace: Types::FlowTraceNodeOutputEvent
+      attr_accessor unknown: untyped
+      SENSITIVE: [:condition_node_result_trace, :node_input_trace, :node_output_trace]
+
+      class ConditionNodeResultTrace < FlowTrace
+      end
+      class NodeInputTrace < FlowTrace
+      end
+      class NodeOutputTrace < FlowTrace
+      end
+      class Unknown < FlowTrace
+      end
+    end
+
+    class FlowTraceCondition
+      attr_accessor condition_name: ::String
+      SENSITIVE: []
+    end
+
+    class FlowTraceConditionNodeResultEvent
+      attr_accessor node_name: ::String
+      attr_accessor satisfied_conditions: ::Array[Types::FlowTraceCondition]
+      attr_accessor timestamp: ::Time
+      SENSITIVE: []
+    end
+
+    class FlowTraceEvent
+      attr_accessor trace: Types::FlowTrace
+      attr_accessor event_type: untyped
+      SENSITIVE: [:trace]
+    end
+
+    class FlowTraceNodeInputContent
+      attr_accessor document: untyped
+      attr_accessor unknown: untyped
+      SENSITIVE: []
+
+      class Document < FlowTraceNodeInputContent
+      end
+      class Unknown < FlowTraceNodeInputContent
+      end
+    end
+
+    class FlowTraceNodeInputEvent
+      attr_accessor fields: ::Array[Types::FlowTraceNodeInputField]
+      attr_accessor node_name: ::String
+      attr_accessor timestamp: ::Time
+      SENSITIVE: []
+    end
+
+    class FlowTraceNodeInputField
+      attr_accessor content: Types::FlowTraceNodeInputContent
+      attr_accessor node_input_name: ::String
+      SENSITIVE: [:content]
+    end
+
+    class FlowTraceNodeOutputContent
+      attr_accessor document: untyped
+      attr_accessor unknown: untyped
+      SENSITIVE: []
+
+      class Document < FlowTraceNodeOutputContent
+      end
+      class Unknown < FlowTraceNodeOutputContent
+      end
+    end
+
+    class FlowTraceNodeOutputEvent
+      attr_accessor fields: ::Array[Types::FlowTraceNodeOutputField]
+      attr_accessor node_name: ::String
+      attr_accessor timestamp: ::Time
+      SENSITIVE: []
+    end
+
+    class FlowTraceNodeOutputField
+      attr_accessor content: Types::FlowTraceNodeOutputContent
+      attr_accessor node_output_name: ::String
+      SENSITIVE: []
+    end
+
     class FunctionInvocationInput
       attr_accessor action_group: ::String
       attr_accessor action_invocation_type: ("RESULT" | "USER_CONFIRMATION" | "USER_CONFIRMATION_AND_RESULT")
@@ -456,6 +539,7 @@ module Aws::BedrockAgentRuntime
     end
 
     class InvokeFlowRequest
+      attr_accessor enable_trace: bool
       attr_accessor flow_alias_identifier: ::String
       attr_accessor flow_identifier: ::String
       attr_accessor inputs: ::Array[Types::FlowInput]
@@ -973,7 +1057,7 @@ module Aws::BedrockAgentRuntime
     end
 
     class FlowResponseStream < Enumerator[untyped, untyped]
-      def event_types: () -> [:access_denied_exception, :bad_gateway_exception, :conflict_exception, :dependency_failed_exception, :flow_completion_event, :flow_output_event, :internal_server_exception, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :validation_exception]
+      def event_types: () -> [:access_denied_exception, :bad_gateway_exception, :conflict_exception, :dependency_failed_exception, :flow_completion_event, :flow_output_event, :flow_trace_event, :internal_server_exception, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :validation_exception]
     end
 
     class ResponseStream < Enumerator[untyped, untyped]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockagentruntime
 version: !ruby/object:Gem::Version
-  version: 1.30.0
+  version: 1.31.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core