aws-sdk-qbusiness 1.45.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86fe13f19c8403f49d1083e76d2a4af7a97c931651f168f15dc359abf58ae8ef
-  data.tar.gz: b15203cd86dddeffa7c7e171247514b1cb4fa284dba89347ba58353c16288071
+  metadata.gz: 6ee160372a0fedf8d85b3ae09be272eb3ae6a271f19817fb5aec805adc06fc89
+  data.tar.gz: 026b72d9666cc29640878772454f2a31a4623b8cf24f0f042dd747416c76b0d3
 SHA512:
-  metadata.gz: b918ead9cc5959e9b913e9ba7a3d21dbd21d6502d76c7df3b0df7fdd2307ad01c16d87edb2571b125956fba992b8672173b505804c04515ec9ffcc1ab8bc0565
-  data.tar.gz: b3af2ae8837847003d810bc093e17e1186d9e6acf62d1409baf2e8f0a4c78f6c7b10223cde867020c784e94e9807947355d0e89798a9479bc93a6ce0e5231bf0
+  metadata.gz: 0e7dfaaeeeb7e39aaf95cbfd5915079b2dec2034779874d54fdda243fb64e8349356c0328ac3fd6fb9a7404e673641cd2255afa03e180c80b362e9383e8f635f
+  data.tar.gz: ff803217ccb31ca95265bbe515aa1b2e3cc0cea96eaab6132f66482660c2a64bb7e796cf710918a6b63b13a282bade219a8b93e721fc03175f3e9aabf0ebb5fa

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.46.0 (2025-08-06)
+------------------
+
+* Feature - Amazon Q Business now supports the GetDocumentContent() API that enables customers to securely access the source documents through clickable citation links at query time
+
 1.45.0 (2025-08-04)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.45.0
+1.46.0

data/lib/aws-sdk-qbusiness/async_client.rb

@@ -600,6 +600,9 @@ module Aws::QBusiness
     #   event.source_attributions[0].text_message_segments[0].source_details.video_source_details.start_time_milliseconds #=> Integer
     #   event.source_attributions[0].text_message_segments[0].source_details.video_source_details.end_time_milliseconds #=> Integer
     #   event.source_attributions[0].text_message_segments[0].source_details.video_source_details.video_extraction_type #=> String, one of "TRANSCRIPT", "SUMMARY"
+    #   event.source_attributions[0].document_id #=> String
+    #   event.source_attributions[0].index_id #=> String
+    #   event.source_attributions[0].datasource_id #=> String
     #   event.final_text_message #=> String
     #
     #   # For :action_review_event event available at #on_action_review_event_event callback and response eventstream enumerator:
@@ -680,7 +683,7 @@ module Aws::QBusiness
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-qbusiness'
-      context[:gem_version] = '1.45.0'
+      context[:gem_version] = '1.46.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -1073,6 +1073,9 @@ module Aws::QBusiness
     #   resp.source_attributions[0].text_message_segments[0].source_details.video_source_details.start_time_milliseconds #=> Integer
     #   resp.source_attributions[0].text_message_segments[0].source_details.video_source_details.end_time_milliseconds #=> Integer
     #   resp.source_attributions[0].text_message_segments[0].source_details.video_source_details.video_extraction_type #=> String, one of "TRANSCRIPT", "SUMMARY"
+    #   resp.source_attributions[0].document_id #=> String
+    #   resp.source_attributions[0].index_id #=> String
+    #   resp.source_attributions[0].datasource_id #=> String
     #   resp.failed_attachments #=> Array
     #   resp.failed_attachments[0].name #=> String
     #   resp.failed_attachments[0].status #=> String, one of "FAILED", "SUCCESS"
@@ -2125,9 +2128,15 @@ module Aws::QBusiness
     # user. For more information on subscriptions and pricing tiers, see
     # [Amazon Q Business pricing][1].
     #
+    # <note markdown="1"> For an example IAM role policy for assigning subscriptions, see [Set
+    # up required permissions][2] in the Amazon Q Business User Guide.
+    #
+    #  </note>
+    #
     #
     #
     # [1]: https://aws.amazon.com/q/business/pricing/
+    # [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/setting-up.html#permissions
     #
     # @option params [required, String] :application_id
     #   The identifier of the Amazon Q Business application the subscription
@@ -3216,6 +3225,64 @@ module Aws::QBusiness
       req.send_request(options)
     end
 
+    # Retrieves the content of a document that was ingested into Amazon Q
+    # Business. This API validates user authorization against document ACLs
+    # before returning a pre-signed URL for secure document access. You can
+    # download or view source documents referenced in chat responses through
+    # the URL.
+    #
+    # @option params [required, String] :application_id
+    #   The unique identifier of the Amazon Q Business application containing
+    #   the document. This ensures the request is scoped to the correct
+    #   application environment and its associated security policies.
+    #
+    # @option params [required, String] :index_id
+    #   The identifier of the index where documents are indexed.
+    #
+    # @option params [String] :data_source_id
+    #   The identifier of the data source from which the document was
+    #   ingested. This field is not present if the document is ingested by
+    #   directly calling the BatchPutDocument API. If the document is from a
+    #   file-upload data source, the datasource will be
+    #   "uploaded-docs-file-stat-datasourceid".
+    #
+    # @option params [required, String] :document_id
+    #   The unique identifier of the document that is indexed via
+    #   BatchPutDocument API or file-upload or connector sync. It is also
+    #   found in chat or chatSync response.
+    #
+    # @option params [String] :output_format
+    #   Raw document outputFormat.
+    #
+    # @return [Types::GetDocumentContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetDocumentContentResponse#presigned_url #presigned_url} => String
+    #   * {Types::GetDocumentContentResponse#mime_type #mime_type} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_document_content({
+    #     application_id: "ApplicationId", # required
+    #     index_id: "IndexId", # required
+    #     data_source_id: "DataSourceId",
+    #     document_id: "DocumentId", # required
+    #     output_format: "RAW", # accepts RAW
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.presigned_url #=> String
+    #   resp.mime_type #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDocumentContent AWS API Documentation
+    #
+    # @overload get_document_content(params = {})
+    # @param [Hash] params ({})
+    def get_document_content(params = {}, options = {})
+      req = build_request(:get_document_content, params)
+      req.send_request(options)
+    end
+
     # Describes a group by group name.
     #
     # @option params [required, String] :application_id
@@ -4316,6 +4383,9 @@ module Aws::QBusiness
     #   resp.messages[0].source_attribution[0].text_message_segments[0].source_details.video_source_details.start_time_milliseconds #=> Integer
     #   resp.messages[0].source_attribution[0].text_message_segments[0].source_details.video_source_details.end_time_milliseconds #=> Integer
     #   resp.messages[0].source_attribution[0].text_message_segments[0].source_details.video_source_details.video_extraction_type #=> String, one of "TRANSCRIPT", "SUMMARY"
+    #   resp.messages[0].source_attribution[0].document_id #=> String
+    #   resp.messages[0].source_attribution[0].index_id #=> String
+    #   resp.messages[0].source_attribution[0].datasource_id #=> String
     #   resp.messages[0].action_review.plugin_id #=> String
     #   resp.messages[0].action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM", "QUICKSIGHT", "SERVICENOW_NOW_PLATFORM", "JIRA_CLOUD", "SALESFORCE_CRM", "ZENDESK_SUITE", "ATLASSIAN_CONFLUENCE", "GOOGLE_CALENDAR", "MICROSOFT_TEAMS", "MICROSOFT_EXCHANGE", "PAGERDUTY_ADVANCE", "SMARTSHEET", "ASANA"
     #   resp.messages[0].action_review.payload #=> Hash
@@ -6180,7 +6250,7 @@ module Aws::QBusiness
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-qbusiness'
-      context[:gem_version] = '1.45.0'
+      context[:gem_version] = '1.46.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -278,6 +278,8 @@ module Aws::QBusiness
     GetDataAccessorResponse = Shapes::StructureShape.new(name: 'GetDataAccessorResponse')
     GetDataSourceRequest = Shapes::StructureShape.new(name: 'GetDataSourceRequest')
     GetDataSourceResponse = Shapes::StructureShape.new(name: 'GetDataSourceResponse')
+    GetDocumentContentRequest = Shapes::StructureShape.new(name: 'GetDocumentContentRequest')
+    GetDocumentContentResponse = Shapes::StructureShape.new(name: 'GetDocumentContentResponse')
     GetGroupRequest = Shapes::StructureShape.new(name: 'GetGroupRequest')
     GetGroupResponse = Shapes::StructureShape.new(name: 'GetGroupResponse')
     GetIndexRequest = Shapes::StructureShape.new(name: 'GetIndexRequest')
@@ -429,6 +431,7 @@ module Aws::QBusiness
     OrchestrationConfiguration = Shapes::StructureShape.new(name: 'OrchestrationConfiguration')
     OrchestrationControl = Shapes::StringShape.new(name: 'OrchestrationControl')
     Origin = Shapes::StringShape.new(name: 'Origin')
+    OutputFormat = Shapes::StringShape.new(name: 'OutputFormat')
     Payload = Shapes::StringShape.new(name: 'Payload')
     PermissionCondition = Shapes::StructureShape.new(name: 'PermissionCondition')
     PermissionConditionKey = Shapes::StringShape.new(name: 'PermissionConditionKey')
@@ -1560,6 +1563,17 @@ module Aws::QBusiness
     GetDataSourceResponse.add_member(:media_extraction_configuration, Shapes::ShapeRef.new(shape: MediaExtractionConfiguration, location_name: "mediaExtractionConfiguration"))
     GetDataSourceResponse.struct_class = Types::GetDataSourceResponse
 
+    GetDocumentContentRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "applicationId"))
+    GetDocumentContentRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location: "uri", location_name: "indexId"))
+    GetDocumentContentRequest.add_member(:data_source_id, Shapes::ShapeRef.new(shape: DataSourceId, location: "querystring", location_name: "dataSourceId"))
+    GetDocumentContentRequest.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, required: true, location: "uri", location_name: "documentId"))
+    GetDocumentContentRequest.add_member(:output_format, Shapes::ShapeRef.new(shape: OutputFormat, location: "querystring", location_name: "outputFormat"))
+    GetDocumentContentRequest.struct_class = Types::GetDocumentContentRequest
+
+    GetDocumentContentResponse.add_member(:presigned_url, Shapes::ShapeRef.new(shape: String, required: true, location_name: "presignedUrl"))
+    GetDocumentContentResponse.add_member(:mime_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "mimeType"))
+    GetDocumentContentResponse.struct_class = Types::GetDocumentContentResponse
+
     GetGroupRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "applicationId"))
     GetGroupRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location: "uri", location_name: "indexId"))
     GetGroupRequest.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName, required: true, location: "uri", location_name: "groupName"))
@@ -2202,6 +2216,9 @@ module Aws::QBusiness
     SourceAttribution.add_member(:citation_number, Shapes::ShapeRef.new(shape: Integer, location_name: "citationNumber"))
     SourceAttribution.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "updatedAt"))
     SourceAttribution.add_member(:text_message_segments, Shapes::ShapeRef.new(shape: TextSegmentList, location_name: "textMessageSegments"))
+    SourceAttribution.add_member(:document_id, Shapes::ShapeRef.new(shape: String, location_name: "documentId"))
+    SourceAttribution.add_member(:index_id, Shapes::ShapeRef.new(shape: String, location_name: "indexId"))
+    SourceAttribution.add_member(:datasource_id, Shapes::ShapeRef.new(shape: String, location_name: "datasourceId"))
     SourceAttribution.struct_class = Types::SourceAttribution
 
     SourceAttributions.member = Shapes::ShapeRef.new(shape: SourceAttribution)
@@ -3049,6 +3066,19 @@ module Aws::QBusiness
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
       end)
 
+      api.add_operation(:get_document_content, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetDocumentContent"
+        o.http_method = "GET"
+        o.http_request_uri = "/applications/{applicationId}/index/{indexId}/documents/{documentId}/content"
+        o.input = Shapes::ShapeRef.new(shape: GetDocumentContentRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetDocumentContentResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+      end)
+
       api.add_operation(:get_group, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetGroup"
         o.http_method = "GET"

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

@@ -4028,6 +4028,17 @@ module Aws::QBusiness
 
     # The contents of a document.
     #
+    # <note markdown="1"> Documents have size limitations. The maximum file size for a document
+    # is 50 MB. The maximum amount of text that can be extracted from a
+    # single document is 5 MB. For more information, see [Supported document
+    # formats in Amazon Q Business][1].
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/doc-types.html
+    #
     # @note DocumentContent is a union - when making an API calls you must set exactly one of the members.
     #
     # @!attribute [rw] blob
@@ -4797,6 +4808,69 @@ module Aws::QBusiness
       include Aws::Structure
     end
 
+    # @!attribute [rw] application_id
+    #   The unique identifier of the Amazon Q Business application
+    #   containing the document. This ensures the request is scoped to the
+    #   correct application environment and its associated security
+    #   policies.
+    #   @return [String]
+    #
+    # @!attribute [rw] index_id
+    #   The identifier of the index where documents are indexed.
+    #   @return [String]
+    #
+    # @!attribute [rw] data_source_id
+    #   The identifier of the data source from which the document was
+    #   ingested. This field is not present if the document is ingested by
+    #   directly calling the BatchPutDocument API. If the document is from a
+    #   file-upload data source, the datasource will be
+    #   "uploaded-docs-file-stat-datasourceid".
+    #   @return [String]
+    #
+    # @!attribute [rw] document_id
+    #   The unique identifier of the document that is indexed via
+    #   BatchPutDocument API or file-upload or connector sync. It is also
+    #   found in chat or chatSync response.
+    #   @return [String]
+    #
+    # @!attribute [rw] output_format
+    #   Raw document outputFormat.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDocumentContentRequest AWS API Documentation
+    #
+    class GetDocumentContentRequest < Struct.new(
+      :application_id,
+      :index_id,
+      :data_source_id,
+      :document_id,
+      :output_format)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] presigned_url
+    #   A pre-signed URL that provides temporary access to download the
+    #   document content directly from Amazon Q Business. The URL expires
+    #   after 5 minutes for security purposes. This URL is generated only
+    #   after successful ACL validation.
+    #   @return [String]
+    #
+    # @!attribute [rw] mime_type
+    #   The MIME type of the document content (e.g., application/pdf,
+    #   text/plain,
+    #   application/vnd.openxmlformats-officedocument.wordprocessingml.document).
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDocumentContentResponse AWS API Documentation
+    #
+    class GetDocumentContentResponse < Struct.new(
+      :presigned_url,
+      :mime_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] application_id
     #   The identifier of the application id the group is attached to.
     #   @return [String]
@@ -8018,6 +8092,29 @@ module Aws::QBusiness
     #   attribution.
     #   @return [Array<Types::TextSegment>]
     #
+    # @!attribute [rw] document_id
+    #   The unique identifier of the source document used in the citation,
+    #   obtained from the Amazon Q Business index during chat response
+    #   generation. This ID is used as input to the `GetDocumentContent` API
+    #   to retrieve the actual document content for user verification.
+    #   @return [String]
+    #
+    # @!attribute [rw] index_id
+    #   The identifier of the index containing the source document's
+    #   metadata and access control information. This links the citation
+    #   back to the specific Amazon Q Business index where the document's
+    #   searchable content and permissions are stored.
+    #   @return [String]
+    #
+    # @!attribute [rw] datasource_id
+    #   The identifier of the data source from which the document was
+    #   ingested. This field is not present if the document is ingested by
+    #   directly calling the BatchPutDocument API (similar to
+    #   checkDocumentAccess). If the document is from a file-upload data
+    #   source, the datasource will be
+    #   "uploaded-docs-file-stat-datasourceid".
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SourceAttribution AWS API Documentation
     #
     class SourceAttribution < Struct.new(
@@ -8026,7 +8123,10 @@ module Aws::QBusiness
       :url,
       :citation_number,
       :updated_at,
-      :text_message_segments)
+      :text_message_segments,
+      :document_id,
+      :index_id,
+      :datasource_id)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-qbusiness.rb

@@ -57,7 +57,7 @@ module Aws::QBusiness
   autoload :AsyncClient, 'aws-sdk-qbusiness/async_client'
   autoload :EventStreams, 'aws-sdk-qbusiness/event_streams'
 
-  GEM_VERSION = '1.45.0'
+  GEM_VERSION = '1.46.0'
 
 end
 

data/sig/client.rbs

@@ -1141,6 +1141,21 @@ module Aws
                            ) -> _GetDataSourceResponseSuccess
                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDataSourceResponseSuccess
 
+      interface _GetDocumentContentResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetDocumentContentResponse]
+        def presigned_url: () -> ::String
+        def mime_type: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_document_content-instance_method
+      def get_document_content: (
+                                  application_id: ::String,
+                                  index_id: ::String,
+                                  ?data_source_id: ::String,
+                                  document_id: ::String,
+                                  ?output_format: ("RAW")
+                                ) -> _GetDocumentContentResponseSuccess
+                              | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDocumentContentResponseSuccess
+
       interface _GetGroupResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::GetGroupResponse]
         def status: () -> Types::GroupStatusDetail

data/sig/types.rbs

@@ -1201,6 +1201,21 @@ module Aws::QBusiness
       SENSITIVE: []
     end
 
+    class GetDocumentContentRequest
+      attr_accessor application_id: ::String
+      attr_accessor index_id: ::String
+      attr_accessor data_source_id: ::String
+      attr_accessor document_id: ::String
+      attr_accessor output_format: ("RAW")
+      SENSITIVE: []
+    end
+
+    class GetDocumentContentResponse
+      attr_accessor presigned_url: ::String
+      attr_accessor mime_type: ::String
+      SENSITIVE: []
+    end
+
     class GetGroupRequest
       attr_accessor application_id: ::String
       attr_accessor index_id: ::String
@@ -2056,6 +2071,9 @@ module Aws::QBusiness
       attr_accessor citation_number: ::Integer
       attr_accessor updated_at: ::Time
       attr_accessor text_message_segments: ::Array[Types::TextSegment]
+      attr_accessor document_id: ::String
+      attr_accessor index_id: ::String
+      attr_accessor datasource_id: ::String
       SENSITIVE: []
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-qbusiness
 version: !ruby/object:Gem::Version
-  version: 1.45.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Amazon Web Services