aws-sdk-bedrockagent 1.86.0 → 1.87.0

data/sig/client.rbs

@@ -358,6 +358,48 @@ module Aws
                                  ) -> _CreatePromptVersionResponseSuccess
                                | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePromptVersionResponseSuccess
 
+      interface _CreateRetrievalInstructionResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::CreateRetrievalInstructionResponse]
+        def retrieval_instruction_id: () -> ::String
+        def retrieval_instruction_arn: () -> ::String
+        def name: () -> ::String
+        def status: () -> ("ACTIVE" | "INACTIVE")
+        def last_transition_status: () -> ("CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED")
+        def created_at: () -> ::Time
+        def updated_at: () -> ::Time
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_retrieval_instruction-instance_method
+      def create_retrieval_instruction: (
+                                          ?client_token: ::String,
+                                          name: ::String,
+                                          instruction: {
+                                            retrieval_guidance: ::String?,
+                                            persona: ::String?,
+                                            answer_format: ::String?,
+                                            answer_policy: ::String?
+                                          },
+                                          ?description: ::String,
+                                          ?customer_encryption_key_arn: ::String,
+                                          ?tags: Hash[::String, ::String]
+                                        ) -> _CreateRetrievalInstructionResponseSuccess
+                                      | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRetrievalInstructionResponseSuccess
+
+      interface _CreateRetrievalInstructionVersionResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::CreateRetrievalInstructionVersionResponse]
+        def retrieval_instruction_id: () -> ::String
+        def retrieval_instruction_arn: () -> ::String
+        def version: () -> ::String
+        def created_at: () -> ::Time
+        def description: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_retrieval_instruction_version-instance_method
+      def create_retrieval_instruction_version: (
+                                                  retrieval_instruction_id: ::String,
+                                                  ?description: ::String,
+                                                  ?client_token: ::String
+                                                ) -> _CreateRetrievalInstructionVersionResponseSuccess
+                                              | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRetrievalInstructionVersionResponseSuccess
+
       interface _CreateVpcConfigurationResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::CreateVpcConfigurationResponse]
         def vpc_configuration_id: () -> ::String
@@ -530,6 +572,19 @@ module Aws
                                   ) -> _DeleteResourcePolicyResponseSuccess
                                 | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteResourcePolicyResponseSuccess
 
+      interface _DeleteRetrievalInstructionResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::DeleteRetrievalInstructionResponse]
+        def retrieval_instruction_id: () -> ::String
+        def retrieval_instruction_arn: () -> ::String
+        def version: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#delete_retrieval_instruction-instance_method
+      def delete_retrieval_instruction: (
+                                          retrieval_instruction_id: ::String,
+                                          ?retrieval_instruction_version: ::String
+                                        ) -> _DeleteRetrievalInstructionResponseSuccess
+                                      | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteRetrievalInstructionResponseSuccess
+
       interface _DeleteVpcConfigurationResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::DeleteVpcConfigurationResponse]
         def vpc_configuration_id: () -> ::String
@@ -774,6 +829,29 @@ module Aws
                                ) -> _GetResourcePolicyResponseSuccess
                              | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetResourcePolicyResponseSuccess
 
+      interface _GetRetrievalInstructionResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetRetrievalInstructionResponse]
+        def retrieval_instruction_id: () -> ::String
+        def retrieval_instruction_arn: () -> ::String
+        def name: () -> ::String
+        def status: () -> ("ACTIVE" | "INACTIVE")
+        def last_transition_status: () -> ("CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED")
+        def instruction: () -> Types::RetrievalInstructionContent
+        def created_at: () -> ::Time
+        def updated_at: () -> ::Time
+        def description: () -> ::String
+        def customer_encryption_key_arn: () -> ::String
+        def last_transition_status_reasons: () -> ::Array[Types::RetrievalInstructionFailureReason]
+        def version: () -> ::String
+        def latest_version: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#get_retrieval_instruction-instance_method
+      def get_retrieval_instruction: (
+                                       retrieval_instruction_id: ::String,
+                                       ?retrieval_instruction_version: ::String
+                                     ) -> _GetRetrievalInstructionResponseSuccess
+                                   | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRetrievalInstructionResponseSuccess
+
       interface _GetVpcConfigurationResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::GetVpcConfigurationResponse]
         def vpc_configuration: () -> Types::VpcConfiguration
@@ -1050,6 +1128,32 @@ module Aws
                         ) -> _ListPromptsResponseSuccess
                       | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPromptsResponseSuccess
 
+      interface _ListRetrievalInstructionVersionsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListRetrievalInstructionVersionsResponse]
+        def retrieval_instruction_version_summaries: () -> ::Array[Types::RetrievalInstructionVersionSummary]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_retrieval_instruction_versions-instance_method
+      def list_retrieval_instruction_versions: (
+                                                 retrieval_instruction_id: ::String,
+                                                 ?max_results: ::Integer,
+                                                 ?next_token: ::String
+                                               ) -> _ListRetrievalInstructionVersionsResponseSuccess
+                                             | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRetrievalInstructionVersionsResponseSuccess
+
+      interface _ListRetrievalInstructionsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListRetrievalInstructionsResponse]
+        def retrieval_instruction_summaries: () -> ::Array[Types::RetrievalInstructionSummary]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_retrieval_instructions-instance_method
+      def list_retrieval_instructions: (
+                                         ?status: ("ACTIVE" | "INACTIVE"),
+                                         ?max_results: ::Integer,
+                                         ?next_token: ::String
+                                       ) -> _ListRetrievalInstructionsResponseSuccess
+                                     | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRetrievalInstructionsResponseSuccess
+
       interface _ListTagsForResourceResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
         def tags: () -> ::Hash[::String, ::String]
@@ -1388,6 +1492,29 @@ module Aws
                          ) -> _UpdatePromptResponseSuccess
                        | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdatePromptResponseSuccess
 
+      interface _UpdateRetrievalInstructionResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::UpdateRetrievalInstructionResponse]
+        def retrieval_instruction_id: () -> ::String
+        def retrieval_instruction_arn: () -> ::String
+        def name: () -> ::String
+        def status: () -> ("ACTIVE" | "INACTIVE")
+        def last_transition_status: () -> ("CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED")
+        def created_at: () -> ::Time
+        def updated_at: () -> ::Time
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#update_retrieval_instruction-instance_method
+      def update_retrieval_instruction: (
+                                          retrieval_instruction_id: ::String,
+                                          instruction: {
+                                            retrieval_guidance: ::String?,
+                                            persona: ::String?,
+                                            answer_format: ::String?,
+                                            answer_policy: ::String?
+                                          },
+                                          ?description: ::String
+                                        ) -> _UpdateRetrievalInstructionResponseSuccess
+                                      | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRetrievalInstructionResponseSuccess
+
       interface _ValidateFlowDefinitionResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ValidateFlowDefinitionResponse]
         def validations: () -> ::Array[Types::FlowValidation]

data/sig/errors.rbs

@@ -11,25 +11,25 @@ module Aws
       class ServiceError < ::Aws::Errors::ServiceError
       end
 
-      class AccessDeniedException < ::Aws::Errors::ServiceError
+      class AccessDeniedException < ServiceError
         def message: () -> ::String
       end
-      class ConflictException < ::Aws::Errors::ServiceError
+      class ConflictException < ServiceError
         def message: () -> ::String
       end
-      class InternalServerException < ::Aws::Errors::ServiceError
+      class InternalServerException < 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
         def field_list: () -> ::String
       end

data/sig/types.rbs

@@ -611,6 +611,43 @@ module Aws::BedrockAgent
       SENSITIVE: [:variants]
     end
 
+    class CreateRetrievalInstructionRequest
+      attr_accessor client_token: ::String
+      attr_accessor name: ::String
+      attr_accessor instruction: Types::RetrievalInstructionContent
+      attr_accessor description: ::String
+      attr_accessor customer_encryption_key_arn: ::String
+      attr_accessor tags: ::Hash[::String, ::String]
+      SENSITIVE: [:name, :instruction, :description]
+    end
+
+    class CreateRetrievalInstructionResponse
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor retrieval_instruction_arn: ::String
+      attr_accessor name: ::String
+      attr_accessor status: ("ACTIVE" | "INACTIVE")
+      attr_accessor last_transition_status: ("CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED")
+      attr_accessor created_at: ::Time
+      attr_accessor updated_at: ::Time
+      SENSITIVE: [:name]
+    end
+
+    class CreateRetrievalInstructionVersionRequest
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor description: ::String
+      attr_accessor client_token: ::String
+      SENSITIVE: [:description]
+    end
+
+    class CreateRetrievalInstructionVersionResponse
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor retrieval_instruction_arn: ::String
+      attr_accessor version: ::String
+      attr_accessor created_at: ::Time
+      attr_accessor description: ::String
+      SENSITIVE: [:description]
+    end
+
     class CreateVpcConfigurationRequest
       attr_accessor knowledge_base_id: ::String
       attr_accessor client_token: ::String
@@ -875,6 +912,19 @@ module Aws::BedrockAgent
       SENSITIVE: []
     end
 
+    class DeleteRetrievalInstructionRequest
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor retrieval_instruction_version: ::String
+      SENSITIVE: []
+    end
+
+    class DeleteRetrievalInstructionResponse
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor retrieval_instruction_arn: ::String
+      attr_accessor version: ::String
+      SENSITIVE: []
+    end
+
     class DeleteVpcConfigurationRequest
       attr_accessor knowledge_base_id: ::String
       attr_accessor vpc_configuration_id: ::String
@@ -1487,6 +1537,29 @@ module Aws::BedrockAgent
       SENSITIVE: []
     end
 
+    class GetRetrievalInstructionRequest
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor retrieval_instruction_version: ::String
+      SENSITIVE: []
+    end
+
+    class GetRetrievalInstructionResponse
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor retrieval_instruction_arn: ::String
+      attr_accessor name: ::String
+      attr_accessor status: ("ACTIVE" | "INACTIVE")
+      attr_accessor last_transition_status: ("CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED")
+      attr_accessor instruction: Types::RetrievalInstructionContent
+      attr_accessor created_at: ::Time
+      attr_accessor updated_at: ::Time
+      attr_accessor description: ::String
+      attr_accessor customer_encryption_key_arn: ::String
+      attr_accessor last_transition_status_reasons: ::Array[Types::RetrievalInstructionFailureReason]
+      attr_accessor version: ::String
+      attr_accessor latest_version: ::String
+      SENSITIVE: [:name, :instruction, :description]
+    end
+
     class GetVpcConfigurationRequest
       attr_accessor knowledge_base_id: ::String
       attr_accessor vpc_configuration_id: ::String
@@ -1914,6 +1987,32 @@ module Aws::BedrockAgent
       SENSITIVE: []
     end
 
+    class ListRetrievalInstructionVersionsRequest
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor max_results: ::Integer
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class ListRetrievalInstructionVersionsResponse
+      attr_accessor retrieval_instruction_version_summaries: ::Array[Types::RetrievalInstructionVersionSummary]
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class ListRetrievalInstructionsRequest
+      attr_accessor status: ("ACTIVE" | "INACTIVE")
+      attr_accessor max_results: ::Integer
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class ListRetrievalInstructionsResponse
+      attr_accessor retrieval_instruction_summaries: ::Array[Types::RetrievalInstructionSummary]
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
     class ListTagsForResourceRequest
       attr_accessor resource_arn: ::String
       SENSITIVE: []
@@ -2561,6 +2660,39 @@ module Aws::BedrockAgent
       end
     end
 
+    class RetrievalInstructionContent
+      attr_accessor retrieval_guidance: ::String
+      attr_accessor persona: ::String
+      attr_accessor answer_format: ::String
+      attr_accessor answer_policy: ::String
+      SENSITIVE: [:retrieval_guidance, :persona, :answer_format, :answer_policy]
+    end
+
+    class RetrievalInstructionFailureReason
+      attr_accessor field_name: ("RETRIEVAL_GUIDANCE" | "PERSONA" | "ANSWER_FORMAT" | "ANSWER_POLICY")
+      attr_accessor code: ("CONTENT_REJECTED" | "CLIENT_ERROR" | "INTERNAL_ERROR")
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
+    class RetrievalInstructionSummary
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor retrieval_instruction_arn: ::String
+      attr_accessor name: ::String
+      attr_accessor status: ("ACTIVE" | "INACTIVE")
+      attr_accessor last_transition_status: ("CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED")
+      attr_accessor created_at: ::Time
+      attr_accessor updated_at: ::Time
+      attr_accessor description: ::String
+      SENSITIVE: [:name, :description]
+    end
+
+    class RetrievalInstructionVersionSummary
+      attr_accessor version: ::String
+      attr_accessor created_at: ::Time
+      SENSITIVE: []
+    end
+
     class S3Content
       attr_accessor s3_location: Types::S3Location
       SENSITIVE: []
@@ -3124,6 +3256,24 @@ module Aws::BedrockAgent
       SENSITIVE: [:variants]
     end
 
+    class UpdateRetrievalInstructionRequest
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor instruction: Types::RetrievalInstructionContent
+      attr_accessor description: ::String
+      SENSITIVE: [:instruction, :description]
+    end
+
+    class UpdateRetrievalInstructionResponse
+      attr_accessor retrieval_instruction_id: ::String
+      attr_accessor retrieval_instruction_arn: ::String
+      attr_accessor name: ::String
+      attr_accessor status: ("ACTIVE" | "INACTIVE")
+      attr_accessor last_transition_status: ("CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED")
+      attr_accessor created_at: ::Time
+      attr_accessor updated_at: ::Time
+      SENSITIVE: [:name]
+    end
+
     class UrlConfiguration
       attr_accessor seed_urls: ::Array[Types::SeedUrl]
       SENSITIVE: []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockagent
 version: !ruby/object:Gem::Version
-  version: 1.86.0
+  version: 1.87.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