aws-sdk-bedrockagentruntime 1.83.0 → 1.84.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64cab7e9c3d40e31a684ad2774b9ccea870a126d2b21f6bd10244b0e9d1092d2
-  data.tar.gz: ea9a4ff59ad86272e546c0c0c301907b8611828df881277a7167e3a7847993c3
+  metadata.gz: 9191ec22c4f80374a7f7f6848053fcc13d4c2232dea708219457d52b799b4b79
+  data.tar.gz: 9efe31e8f7520001be6029a760a738c0c824da6efef311d3bb0dd46dc98c04a4
 SHA512:
-  metadata.gz: 671c92315d2110a010dd7116136631fa99ac570dd65e75f3fc999b8923c75e50440cd82b06888d3900dbfd78019e61521e7476bd2a4861189c2bcd49331a85de
-  data.tar.gz: a7e0478abe6a15ec26d2978e3a3a0e5ab16b4256fb285f3b968b38a496878f731f965d7c017808998b8855f55bdba04dfe592f18b8cb6582c2d79256ecd8e66f
+  metadata.gz: b5e3d037e41a7b91cf75f5eadda510d8f51ec263d5145b5b4f98ab950e02160daf34e809afce1ec7be4ff130bdf5e292eeea4a11bcdc66ffbfb12bf9817e4ef3
+  data.tar.gz: f6cba559cb61a2bb42ca1c176f1987994f47e8d716e0c31ce54afb7b663b2a67ca5b74a70ec6100275f832002898181f77fd03ad421d667af922a8a6d79aff05

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.84.0 (2026-10-19)
+------------------
+
+* Feature - Adds support for applying a Retrieval Instruction, optionally by version, to AgenticRetrieveStream requests for Amazon Bedrock Knowledge Bases, and reports the applied instruction and version on the trace.
+
 1.83.0 (2026-09-29)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.83.0
+1.84.0

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

@@ -516,6 +516,9 @@ module Aws::BedrockAgentRuntime
     # @option params [Types::AgenticRetrievePolicyConfiguration] :policy_configuration
     #   Policy configuration for guardrails and content filtering.
     #
+    # @option params [Types::AgenticRetrieveInstructionConfiguration] :retrieval_instruction_configuration
+    #   A retrieval instruction to apply to this request.
+    #
     # @option params [required, Array<Types::AgenticRetriever>] :retrievers
     #   The list of retrievers to use for agentic retrieval.
     #
@@ -793,6 +796,10 @@ module Aws::BedrockAgentRuntime
     #         guardrail_version: "AgenticRetrieveBedrockGuardrailConfigurationGuardrailVersionString", # required
     #       },
     #     },
+    #     retrieval_instruction_configuration: {
+    #       retrieval_instruction_id: "RetrievalInstructionId", # required
+    #       version: "RetrievalInstructionVersion",
+    #     },
     #     retrievers: [ # required
     #       {
     #         configuration: { # required
@@ -941,6 +948,8 @@ module Aws::BedrockAgentRuntime
     #   event.attributes.actions[0].retrieve.input_query.text #=> String
     #   event.attributes.actions[0].retrieve.source_retrievers #=> Array
     #   event.attributes.actions[0].retrieve.source_retrievers[0].identifier #=> String
+    #   event.attributes.applied_instruction.id #=> String
+    #   event.attributes.applied_instruction.version #=> String
     #   event.attributes.failures #=> Array
     #   event.attributes.failures[0].message #=> String
     #   event.attributes.message #=> String
@@ -8473,7 +8482,7 @@ module Aws::BedrockAgentRuntime
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-bedrockagentruntime'
-      context[:gem_version] = '1.83.0'
+      context[:gem_version] = '1.84.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -49,6 +49,7 @@ module Aws::BedrockAgentRuntime
     AgenticRetrieveAction = Shapes::StructureShape.new(name: 'AgenticRetrieveAction')
     AgenticRetrieveActionDetails = Shapes::StructureShape.new(name: 'AgenticRetrieveActionDetails')
     AgenticRetrieveActions = Shapes::ListShape.new(name: 'AgenticRetrieveActions')
+    AgenticRetrieveAppliedInstruction = Shapes::StructureShape.new(name: 'AgenticRetrieveAppliedInstruction')
     AgenticRetrieveBedrockGuardrailConfiguration = Shapes::StructureShape.new(name: 'AgenticRetrieveBedrockGuardrailConfiguration')
     AgenticRetrieveBedrockGuardrailConfigurationGuardrailIdString = Shapes::StringShape.new(name: 'AgenticRetrieveBedrockGuardrailConfigurationGuardrailIdString')
     AgenticRetrieveBedrockGuardrailConfigurationGuardrailVersionString = Shapes::StringShape.new(name: 'AgenticRetrieveBedrockGuardrailConfigurationGuardrailVersionString')
@@ -65,6 +66,7 @@ module Aws::BedrockAgentRuntime
     AgenticRetrieveFullDocExpansionDetails = Shapes::StructureShape.new(name: 'AgenticRetrieveFullDocExpansionDetails')
     AgenticRetrieveGeneratedResponse = Shapes::StructureShape.new(name: 'AgenticRetrieveGeneratedResponse')
     AgenticRetrieveGuardrailWarning = Shapes::StructureShape.new(name: 'AgenticRetrieveGuardrailWarning')
+    AgenticRetrieveInstructionConfiguration = Shapes::StructureShape.new(name: 'AgenticRetrieveInstructionConfiguration')
     AgenticRetrieveMemoryConfiguration = Shapes::StructureShape.new(name: 'AgenticRetrieveMemoryConfiguration')
     AgenticRetrieveMemoryMetadataFilter = Shapes::StructureShape.new(name: 'AgenticRetrieveMemoryMetadataFilter')
     AgenticRetrieveMemoryMetadataFilterLeft = Shapes::UnionShape.new(name: 'AgenticRetrieveMemoryMetadataFilterLeft')
@@ -590,6 +592,8 @@ module Aws::BedrockAgentRuntime
     RetrievalContent = Shapes::StructureShape.new(name: 'RetrievalContent')
     RetrievalFilter = Shapes::UnionShape.new(name: 'RetrievalFilter')
     RetrievalFilterList = Shapes::ListShape.new(name: 'RetrievalFilterList')
+    RetrievalInstructionId = Shapes::StringShape.new(name: 'RetrievalInstructionId')
+    RetrievalInstructionVersion = Shapes::StringShape.new(name: 'RetrievalInstructionVersion')
     RetrievalOverrides = Shapes::StructureShape.new(name: 'RetrievalOverrides')
     RetrievalOverridesMaxNumberOfResultsInteger = Shapes::IntegerShape.new(name: 'RetrievalOverridesMaxNumberOfResultsInteger')
     RetrievalResultConfluenceLocation = Shapes::StructureShape.new(name: 'RetrievalResultConfluenceLocation')
@@ -800,6 +804,10 @@ module Aws::BedrockAgentRuntime
 
     AgenticRetrieveActions.member = Shapes::ShapeRef.new(shape: AgenticRetrieveAction)
 
+    AgenticRetrieveAppliedInstruction.add_member(:id, Shapes::ShapeRef.new(shape: RetrievalInstructionId, required: true, location_name: "id"))
+    AgenticRetrieveAppliedInstruction.add_member(:version, Shapes::ShapeRef.new(shape: RetrievalInstructionVersion, location_name: "version"))
+    AgenticRetrieveAppliedInstruction.struct_class = Types::AgenticRetrieveAppliedInstruction
+
     AgenticRetrieveBedrockGuardrailConfiguration.add_member(:guardrail_id, Shapes::ShapeRef.new(shape: AgenticRetrieveBedrockGuardrailConfigurationGuardrailIdString, required: true, location_name: "guardrailId"))
     AgenticRetrieveBedrockGuardrailConfiguration.add_member(:guardrail_version, Shapes::ShapeRef.new(shape: AgenticRetrieveBedrockGuardrailConfigurationGuardrailVersionString, required: true, location_name: "guardrailVersion"))
     AgenticRetrieveBedrockGuardrailConfiguration.struct_class = Types::AgenticRetrieveBedrockGuardrailConfiguration
@@ -848,6 +856,10 @@ module Aws::BedrockAgentRuntime
     AgenticRetrieveGuardrailWarning.add_member(:version, Shapes::ShapeRef.new(shape: String, required: true, location_name: "version"))
     AgenticRetrieveGuardrailWarning.struct_class = Types::AgenticRetrieveGuardrailWarning
 
+    AgenticRetrieveInstructionConfiguration.add_member(:retrieval_instruction_id, Shapes::ShapeRef.new(shape: RetrievalInstructionId, required: true, location_name: "retrievalInstructionId"))
+    AgenticRetrieveInstructionConfiguration.add_member(:version, Shapes::ShapeRef.new(shape: RetrievalInstructionVersion, location_name: "version"))
+    AgenticRetrieveInstructionConfiguration.struct_class = Types::AgenticRetrieveInstructionConfiguration
+
     AgenticRetrieveMemoryConfiguration.add_member(:memory_id, Shapes::ShapeRef.new(shape: AgentCoreMemoryId, required: true, location_name: "memoryId"))
     AgenticRetrieveMemoryConfiguration.add_member(:persistence_mode, Shapes::ShapeRef.new(shape: AgenticRetrieveMemoryPersistenceMode, location_name: "persistenceMode"))
     AgenticRetrieveMemoryConfiguration.add_member(:retrieval_configs, Shapes::ShapeRef.new(shape: AgenticRetrieveMemoryRetrievalConfigList, location_name: "retrievalConfigs"))
@@ -955,6 +967,7 @@ module Aws::BedrockAgentRuntime
     AgenticRetrieveStreamRequest.add_member(:messages, Shapes::ShapeRef.new(shape: AgenticRetrieveStreamRequestMessagesList, required: true, location_name: "messages"))
     AgenticRetrieveStreamRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     AgenticRetrieveStreamRequest.add_member(:policy_configuration, Shapes::ShapeRef.new(shape: AgenticRetrievePolicyConfiguration, location_name: "policyConfiguration"))
+    AgenticRetrieveStreamRequest.add_member(:retrieval_instruction_configuration, Shapes::ShapeRef.new(shape: AgenticRetrieveInstructionConfiguration, location_name: "retrievalInstructionConfiguration"))
     AgenticRetrieveStreamRequest.add_member(:retrievers, Shapes::ShapeRef.new(shape: AgenticRetrieveStreamRequestRetrieversList, required: true, location_name: "retrievers"))
     AgenticRetrieveStreamRequest.add_member(:user_context, Shapes::ShapeRef.new(shape: UserContext, location_name: "userContext"))
     AgenticRetrieveStreamRequest.struct_class = Types::AgenticRetrieveStreamRequest
@@ -988,6 +1001,7 @@ module Aws::BedrockAgentRuntime
     AgenticRetrieveTraceEvent.struct_class = Types::AgenticRetrieveTraceEvent
 
     AgenticRetrieveTraceEventAttributes.add_member(:actions, Shapes::ShapeRef.new(shape: AgenticRetrieveActions, location_name: "actions"))
+    AgenticRetrieveTraceEventAttributes.add_member(:applied_instruction, Shapes::ShapeRef.new(shape: AgenticRetrieveAppliedInstruction, location_name: "appliedInstruction"))
     AgenticRetrieveTraceEventAttributes.add_member(:failures, Shapes::ShapeRef.new(shape: AgenticRetrieveFailures, location_name: "failures"))
     AgenticRetrieveTraceEventAttributes.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
     AgenticRetrieveTraceEventAttributes.add_member(:retrieval_metadata, Shapes::ShapeRef.new(shape: AgenticRetrieveSourceMetadataList, location_name: "retrievalMetadata"))

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

@@ -423,6 +423,28 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # The retrieval instruction, identified by its ID and version, that was
+    # applied to the request.
+    #
+    # @!attribute [rw] id
+    #   The identifier of the retrieval instruction applied.
+    #   @return [String]
+    #
+    # @!attribute [rw] version
+    #   The version that was applied: a version number, or DRAFT. The
+    #   service reports this version whenever it reports appliedInstruction,
+    #   including DRAFT when the request did not specify a version.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveAppliedInstruction AWS API Documentation
+    #
+    class AgenticRetrieveAppliedInstruction < Struct.new(
+      :id,
+      :version)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Configuration for a Bedrock guardrail applied during agentic
     # retrieval.
     #
@@ -631,6 +653,29 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # The retrieval instruction, identified by its ID and optional version,
+    # to apply to this request.
+    #
+    # @!attribute [rw] retrieval_instruction_id
+    #   The identifier of the retrieval instruction. The instruction must
+    #   exist in the caller's account and its status must be ACTIVE.
+    #   @return [String]
+    #
+    # @!attribute [rw] version
+    #   The version of the retrieval instruction to apply: a version number,
+    #   or DRAFT for the instruction's current reviewed content. When
+    #   omitted, DRAFT is used. This default is permanent.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveInstructionConfiguration AWS API Documentation
+    #
+    class AgenticRetrieveInstructionConfiguration < Struct.new(
+      :retrieval_instruction_id,
+      :version)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifies an AgentCore Memory resource and how this retrieval uses it.
     # Set sessionBinding to restore and continue a session. Set
     # retrievalConfigs to let the agent retrieve from long-term memory. You
@@ -1085,6 +1130,10 @@ module Aws::BedrockAgentRuntime
     #   Policy configuration for guardrails and content filtering.
     #   @return [Types::AgenticRetrievePolicyConfiguration]
     #
+    # @!attribute [rw] retrieval_instruction_configuration
+    #   A retrieval instruction to apply to this request.
+    #   @return [Types::AgenticRetrieveInstructionConfiguration]
+    #
     # @!attribute [rw] retrievers
     #   The list of retrievers to use for agentic retrieval.
     #   @return [Array<Types::AgenticRetriever>]
@@ -1104,6 +1153,7 @@ module Aws::BedrockAgentRuntime
       :messages,
       :next_token,
       :policy_configuration,
+      :retrieval_instruction_configuration,
       :retrievers,
       :user_context)
       SENSITIVE = [:user_context]
@@ -1155,6 +1205,11 @@ module Aws::BedrockAgentRuntime
     #   The list of actions taken during this step.
     #   @return [Array<Types::AgenticRetrieveAction>]
     #
+    # @!attribute [rw] applied_instruction
+    #   The agent reports the retrieval instruction applied to this request
+    #   on the first planning step.
+    #   @return [Types::AgenticRetrieveAppliedInstruction]
+    #
     # @!attribute [rw] failures
     #   Failures that occurred during this step.
     #   @return [Array<Types::AgenticRetrieveFailure>]
@@ -1187,6 +1242,7 @@ module Aws::BedrockAgentRuntime
     #
     class AgenticRetrieveTraceEventAttributes < Struct.new(
       :actions,
+      :applied_instruction,
       :failures,
       :message,
       :retrieval_metadata,

data/lib/aws-sdk-bedrockagentruntime.rb

@@ -56,7 +56,7 @@ module Aws::BedrockAgentRuntime
   autoload :Endpoints, 'aws-sdk-bedrockagentruntime/endpoints'
   autoload :EventStreams, 'aws-sdk-bedrockagentruntime/event_streams'
 
-  GEM_VERSION = '1.83.0'
+  GEM_VERSION = '1.84.0'
 
 end
 

data/sig/client.rbs

@@ -161,6 +161,10 @@ module Aws
                                          guardrail_version: ::String
                                        }?
                                      },
+                                     ?retrieval_instruction_configuration: {
+                                       retrieval_instruction_id: ::String,
+                                       version: ::String?
+                                     },
                                      retrievers: Array[
                                        {
                                          configuration: {

data/sig/errors.rbs

@@ -11,37 +11,37 @@ module Aws
       class ServiceError < ::Aws::Errors::ServiceError
       end
 
-      class AccessDeniedException < ::Aws::Errors::ServiceError
+      class AccessDeniedException < ServiceError
         def message: () -> ::String
       end
-      class BadGatewayException < ::Aws::Errors::ServiceError
+      class BadGatewayException < ServiceError
         def message: () -> ::String
         def resource_name: () -> ::String
       end
-      class ConflictException < ::Aws::Errors::ServiceError
+      class ConflictException < ServiceError
         def message: () -> ::String
       end
-      class DependencyFailedException < ::Aws::Errors::ServiceError
+      class DependencyFailedException < ServiceError
         def message: () -> ::String
         def resource_name: () -> ::String
       end
-      class InternalServerException < ::Aws::Errors::ServiceError
+      class InternalServerException < ServiceError
         def message: () -> ::String
         def reason: () -> ::String
       end
-      class ModelNotReadyException < ::Aws::Errors::ServiceError
+      class ModelNotReadyException < ServiceError
         def message: () -> ::String
       end
-      class ResourceNotFoundException < ::Aws::Errors::ServiceError
+      class ResourceNotFoundException < ServiceError
         def message: () -> ::String
       end
-      class ServiceQuotaExceededException < ::Aws::Errors::ServiceError
+      class ServiceQuotaExceededException < ServiceError
         def message: () -> ::String
       end
-      class ThrottlingException < ::Aws::Errors::ServiceError
+      class ThrottlingException < ServiceError
         def message: () -> ::String
       end
-      class ValidationException < ::Aws::Errors::ServiceError
+      class ValidationException < ServiceError
         def message: () -> ::String
       end
     end

data/sig/types.rbs

@@ -113,6 +113,12 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: [:input_query]
     end
 
+    class AgenticRetrieveAppliedInstruction
+      attr_accessor id: ::String
+      attr_accessor version: ::String
+      SENSITIVE: []
+    end
+
     class AgenticRetrieveBedrockGuardrailConfiguration
       attr_accessor guardrail_id: ::String
       attr_accessor guardrail_version: ::String
@@ -175,6 +181,12 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: []
     end
 
+    class AgenticRetrieveInstructionConfiguration
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor version: ::String
+      SENSITIVE: []
+    end
+
     class AgenticRetrieveMemoryConfiguration
       attr_accessor memory_id: ::String
       attr_accessor persistence_mode: ("DEFAULT" | "NONE")
@@ -316,6 +328,7 @@ module Aws::BedrockAgentRuntime
       attr_accessor messages: ::Array[Types::AgenticRetrieveMessage]
       attr_accessor next_token: ::String
       attr_accessor policy_configuration: Types::AgenticRetrievePolicyConfiguration
+      attr_accessor retrieval_instruction_configuration: Types::AgenticRetrieveInstructionConfiguration
       attr_accessor retrievers: ::Array[Types::AgenticRetriever]
       attr_accessor user_context: Types::UserContext
       SENSITIVE: [:user_context]
@@ -336,6 +349,7 @@ module Aws::BedrockAgentRuntime
 
     class AgenticRetrieveTraceEventAttributes
       attr_accessor actions: ::Array[Types::AgenticRetrieveAction]
+      attr_accessor applied_instruction: Types::AgenticRetrieveAppliedInstruction
       attr_accessor failures: ::Array[Types::AgenticRetrieveFailure]
       attr_accessor message: ::String
       attr_accessor retrieval_metadata: ::Array[Types::AgenticRetrieveSourceMetadata]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockagentruntime
 version: !ruby/object:Gem::Version
-  version: 1.83.0
+  version: 1.84.0
 platform: ruby
 authors:
 - Amazon Web Services
@@ -18,7 +18,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.256.0
+        version: 3.258.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.256.0
+        version: 3.258.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement