feat(client-qbusiness): Amazon Q Business now supports the GetDocumentContent() API that enables customers to securely access the source documents through clickable citation links at query time

awstools · awstools · commit aabc7a596d58 · 2025-08-06T18:22:17.000Z
diff --git a/clients/client-qbusiness/README.md b/clients/client-qbusiness/README.md
@@ -498,6 +498,14 @@ GetDataSource
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/GetDataSourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetDataSourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetDataSourceCommandOutput/)
 
+</details>
+<details>
+<summary>
+GetDocumentContent
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/GetDocumentContentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetDocumentContentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetDocumentContentCommandOutput/)
+
 </details>
 <details>
 <summary>
diff --git a/clients/client-qbusiness/src/QBusiness.ts b/clients/client-qbusiness/src/QBusiness.ts
@@ -159,6 +159,11 @@ import {
   GetDataSourceCommandInput,
   GetDataSourceCommandOutput,
 } from "./commands/GetDataSourceCommand";
+import {
+  GetDocumentContentCommand,
+  GetDocumentContentCommandInput,
+  GetDocumentContentCommandOutput,
+} from "./commands/GetDocumentContentCommand";
 import { GetGroupCommand, GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
 import { GetIndexCommand, GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
 import { GetMediaCommand, GetMediaCommandInput, GetMediaCommandOutput } from "./commands/GetMediaCommand";
@@ -368,6 +373,7 @@ const commands = {
   GetChatResponseConfigurationCommand,
   GetDataAccessorCommand,
   GetDataSourceCommand,
+  GetDocumentContentCommand,
   GetGroupCommand,
   GetIndexCommand,
   GetMediaCommand,
@@ -969,6 +975,23 @@ export interface QBusiness {
     cb: (err: any, data?: GetDataSourceCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetDocumentContentCommand}
+   */
+  getDocumentContent(
+    args: GetDocumentContentCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetDocumentContentCommandOutput>;
+  getDocumentContent(
+    args: GetDocumentContentCommandInput,
+    cb: (err: any, data?: GetDocumentContentCommandOutput) => void
+  ): void;
+  getDocumentContent(
+    args: GetDocumentContentCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetDocumentContentCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link GetGroupCommand}
    */
diff --git a/clients/client-qbusiness/src/QBusinessClient.ts b/clients/client-qbusiness/src/QBusinessClient.ts
@@ -138,6 +138,7 @@ import {
 } from "./commands/GetChatResponseConfigurationCommand";
 import { GetDataAccessorCommandInput, GetDataAccessorCommandOutput } from "./commands/GetDataAccessorCommand";
 import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand";
+import { GetDocumentContentCommandInput, GetDocumentContentCommandOutput } from "./commands/GetDocumentContentCommand";
 import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
 import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
 import { GetMediaCommandInput, GetMediaCommandOutput } from "./commands/GetMediaCommand";
@@ -268,6 +269,7 @@ export type ServiceInputTypes =
   | GetChatResponseConfigurationCommandInput
   | GetDataAccessorCommandInput
   | GetDataSourceCommandInput
+  | GetDocumentContentCommandInput
   | GetGroupCommandInput
   | GetIndexCommandInput
   | GetMediaCommandInput
@@ -355,6 +357,7 @@ export type ServiceOutputTypes =
   | GetChatResponseConfigurationCommandOutput
   | GetDataAccessorCommandOutput
   | GetDataSourceCommandOutput
+  | GetDocumentContentCommandOutput
   | GetGroupCommandOutput
   | GetIndexCommandOutput
   | GetMediaCommandOutput
diff --git a/clients/client-qbusiness/src/commands/ChatCommand.ts b/clients/client-qbusiness/src/commands/ChatCommand.ts
@@ -221,6 +221,9 @@ export interface ChatCommandOutput extends ChatOutput, __MetadataBearer {}
  * //               },
  * //             },
  * //           ],
+ * //           documentId: "STRING_VALUE",
+ * //           indexId: "STRING_VALUE",
+ * //           datasourceId: "STRING_VALUE",
  * //         },
  * //       ],
  * //       finalTextMessage: "STRING_VALUE",
diff --git a/clients/client-qbusiness/src/commands/ChatSyncCommand.ts b/clients/client-qbusiness/src/commands/ChatSyncCommand.ts
@@ -231,6 +231,9 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
  * //           },
  * //         },
  * //       ],
+ * //       documentId: "STRING_VALUE",
+ * //       indexId: "STRING_VALUE",
+ * //       datasourceId: "STRING_VALUE",
  * //     },
  * //   ],
  * //   failedAttachments: [ // AttachmentsOutput
diff --git a/clients/client-qbusiness/src/commands/CreateSubscriptionCommand.ts b/clients/client-qbusiness/src/commands/CreateSubscriptionCommand.ts
@@ -28,7 +28,7 @@ export interface CreateSubscriptionCommandInput extends CreateSubscriptionReques
 export interface CreateSubscriptionCommandOutput extends CreateSubscriptionResponse, __MetadataBearer {}
 
 /**
- * <p>Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.</p> <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business pricing</a>.</p>
+ * <p>Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.</p> <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business pricing</a>.</p> <note> <p>For an example IAM role policy for assigning subscriptions, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/setting-up.html#permissions">Set up required permissions</a> in the Amazon Q Business User Guide.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-qbusiness/src/commands/GetDocumentContentCommand.ts b/clients/client-qbusiness/src/commands/GetDocumentContentCommand.ts
@@ -0,0 +1,113 @@
+// smithy-typescript generated code
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+
+import { commonParams } from "../endpoint/EndpointParameters";
+import { GetDocumentContentRequest, GetDocumentContentResponse } from "../models/models_1";
+import { de_GetDocumentContentCommand, se_GetDocumentContentCommand } from "../protocols/Aws_restJson1";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetDocumentContentCommand}.
+ */
+export interface GetDocumentContentCommandInput extends GetDocumentContentRequest {}
+/**
+ * @public
+ *
+ * The output of {@link GetDocumentContentCommand}.
+ */
+export interface GetDocumentContentCommandOutput extends GetDocumentContentResponse, __MetadataBearer {}
+
+/**
+ * <p>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.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, GetDocumentContentCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, GetDocumentContentCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // GetDocumentContentRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   indexId: "STRING_VALUE", // required
+ *   dataSourceId: "STRING_VALUE",
+ *   documentId: "STRING_VALUE", // required
+ *   outputFormat: "RAW",
+ * };
+ * const command = new GetDocumentContentCommand(input);
+ * const response = await client.send(command);
+ * // { // GetDocumentContentResponse
+ * //   presignedUrl: "STRING_VALUE", // required
+ * //   mimeType: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param GetDocumentContentCommandInput - {@link GetDocumentContentCommandInput}
+ * @returns {@link GetDocumentContentCommandOutput}
+ * @see {@link GetDocumentContentCommandInput} for command's `input` shape.
+ * @see {@link GetDocumentContentCommandOutput} for command's `response` shape.
+ * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
+ *
+ * @throws {@link QBusinessServiceException}
+ * <p>Base exception class for all service exceptions from QBusiness service.</p>
+ *
+ *
+ * @public
+ */
+export class GetDocumentContentCommand extends $Command
+  .classBuilder<
+    GetDocumentContentCommandInput,
+    GetDocumentContentCommandOutput,
+    QBusinessClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep(commonParams)
+  .m(function (this: any, Command: any, cs: any, config: QBusinessClientResolvedConfig, o: any) {
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+  })
+  .s("ExpertQ", "GetDocumentContent", {})
+  .n("QBusinessClient", "GetDocumentContentCommand")
+  .f(void 0, void 0)
+  .ser(se_GetDocumentContentCommand)
+  .de(de_GetDocumentContentCommand)
+  .build() {
+  /** @internal type navigation helper, not in runtime. */
+  protected declare static __types: {
+    api: {
+      input: GetDocumentContentRequest;
+      output: GetDocumentContentResponse;
+    };
+    sdk: {
+      input: GetDocumentContentCommandInput;
+      output: GetDocumentContentCommandOutput;
+    };
+  };
+}
diff --git a/clients/client-qbusiness/src/commands/ListMessagesCommand.ts b/clients/client-qbusiness/src/commands/ListMessagesCommand.ts
@@ -101,6 +101,9 @@ export interface ListMessagesCommandOutput extends ListMessagesResponse, __Metad
  * //               },
  * //             },
  * //           ],
+ * //           documentId: "STRING_VALUE",
+ * //           indexId: "STRING_VALUE",
+ * //           datasourceId: "STRING_VALUE",
  * //         },
  * //       ],
  * //       actionReview: { // ActionReview
diff --git a/clients/client-qbusiness/src/commands/index.ts b/clients/client-qbusiness/src/commands/index.ts
@@ -36,6 +36,7 @@ export * from "./GetChatControlsConfigurationCommand";
 export * from "./GetChatResponseConfigurationCommand";
 export * from "./GetDataAccessorCommand";
 export * from "./GetDataSourceCommand";
+export * from "./GetDocumentContentCommand";
 export * from "./GetGroupCommand";
 export * from "./GetIndexCommand";
 export * from "./GetMediaCommand";
diff --git a/clients/client-qbusiness/src/models/models_0.ts b/clients/client-qbusiness/src/models/models_0.ts
@@ -5344,7 +5344,7 @@ export interface BatchDeleteDocumentResponse {
 }
 
 /**
- * <p>The contents of a document.</p>
+ * <p>The contents of a document.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/doc-types.html">Supported document formats in Amazon Q Business</a>.</p> </note>
  * @public
  */
 export type DocumentContent = DocumentContent.BlobMember | DocumentContent.S3Member | DocumentContent.$UnknownMember;
@@ -5966,6 +5966,24 @@ export interface SourceAttribution {
    * @public
    */
   textMessageSegments?: TextSegment[] | undefined;
+
+  /**
+   * <p>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 <code>GetDocumentContent</code> API to retrieve the actual document content for user verification.</p>
+   * @public
+   */
+  documentId?: string | undefined;
+
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  indexId?: string | undefined;
+
+  /**
+   * <p>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".</p>
+   * @public
+   */
+  datasourceId?: string | undefined;
 }
 
 /**
diff --git a/clients/client-qbusiness/src/models/models_1.ts b/clients/client-qbusiness/src/models/models_1.ts
@@ -105,6 +105,71 @@ export interface GetChatResponseConfigurationResponse {
   lastUpdateConfiguration?: ChatResponseConfigurationDetail | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const OutputFormat = {
+  RAW: "RAW",
+} as const;
+
+/**
+ * @public
+ */
+export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
+
+/**
+ * @public
+ */
+export interface GetDocumentContentRequest {
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  applicationId: string | undefined;
+
+  /**
+   * <p>The identifier of the index where documents are indexed.</p>
+   * @public
+   */
+  indexId: string | undefined;
+
+  /**
+   * <p>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".</p>
+   * @public
+   */
+  dataSourceId?: string | undefined;
+
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  documentId: string | undefined;
+
+  /**
+   * <p>Raw document outputFormat.</p>
+   * @public
+   */
+  outputFormat?: OutputFormat | undefined;
+}
+
+/**
+ * @public
+ */
+export interface GetDocumentContentResponse {
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  presignedUrl: string | undefined;
+
+  /**
+   * <p>The MIME type of the document content (e.g., application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document).</p>
+   * @public
+   */
+  mimeType: string | undefined;
+}
+
 /**
  * @public
  */
diff --git a/clients/client-qbusiness/src/protocols/Aws_restJson1.ts b/clients/client-qbusiness/src/protocols/Aws_restJson1.ts
diff --git a/codegen/sdk-codegen/aws-models/qbusiness.json b/codegen/sdk-codegen/aws-models/qbusiness.json
