AWS quick documentation change
Summary
Major restructuring and rewording of the Google Drive integration documentation, including updated section headers, revised authentication flow description, new setup steps, added content types, new access controls section, and troubleshooting guidance.
Security assessment
The changes include a new 'Access controls' section that explicitly states Amazon Quick does not sync ACLs from data sources and that by default only the creator can access the knowledge base, which is a security clarification. It also adds a note about reviewing/removing Google account access. However, there is no evidence of a specific security vulnerability being addressed; these are general security documentation improvements.
Diff
diff --git a/quick/latest/userguide/google-drive-integration.md b/quick/latest/userguide/google-drive-integration.md index f842b7afe..2c83f491a 100644 --- a//quick/latest/userguide/google-drive-integration.md +++ b//quick/latest/userguide/google-drive-integration.md @@ -5 +5 @@ -What you can doBefore you beginPrepare Google Drive authenticationSet up Google Drive integrationManage knowledge basesLimitations +Google Drive capabilitiesBefore you beginAuthenticationSet up the knowledge base integrationSupported content typesAccess controlsManage knowledge basesManage and troubleshootLimitations @@ -7 +7 @@ What you can doBefore you beginPrepare Google Drive authenticationSet up Google -# Google Drive integration +# Google Drive knowledge base integration @@ -9 +9 @@ What you can doBefore you beginPrepare Google Drive authenticationSet up Google -With Google Drive integration in Amazon Quick, you can create knowledge bases from documents stored in Google Drive. This integration supports data access capabilities for indexing and searching Google Drive content including Google Docs, Sheets, and Slides. +Use the Google Drive knowledge base integration to index Google Drive content so that Amazon Quick agents can search and answer questions about it. @@ -11 +11 @@ With Google Drive integration in Amazon Quick, you can create knowledge bases fr -## What you can do +## Google Drive capabilities @@ -13 +13 @@ With Google Drive integration in Amazon Quick, you can create knowledge bases fr -Google Drive users can ask questions about content stored in their Google Drive. For example, users can inquire about key findings from Google Docs, presentation highlights from Google Slides, or search for specific information across multiple document types. The integration enables users to quickly access and understand information from their Google Drive content, regardless of file location or type, while providing contextual details such as publication dates, modification history, and document ownership—all contributing to more efficient information discovery and better-informed decision making. +With the Google Drive integration, you can ask questions about content stored in your Google Drive. For example, you can find key findings from Google Docs, presentation highlights from Google Slides, or specific information across multiple document types. Responses include contextual details such as publication dates, modification history, and document ownership. @@ -17 +17 @@ Google Drive users can ask questions about content stored in their Google Drive. -Google Drive integration supports data ingestion only. It doesn't provide action capabilities for managing Google Drive files through APIs. +Google Drive integration supports data ingestion only. It does not provide action capabilities for managing Google Drive files through APIs. @@ -21 +21 @@ Google Drive integration supports data ingestion only. It doesn't provide action -Before you set up Google Drive integration, make sure you have the following: +Make sure you have the following before you set up the integration. @@ -23 +23 @@ Before you set up Google Drive integration, make sure you have the following: - * Google account with Google Drive access. + * A Google account with Google Drive access. @@ -25 +25 @@ Before you set up Google Drive integration, make sure you have the following: - * Google Drive files and folders to index + * Google Drive files and folders to index. @@ -27 +27 @@ Before you set up Google Drive integration, make sure you have the following: - * Amazon Quick Professional subscription or higher. + * For subscription requirements, see [Set up integrations in the console](./integration-console-setup-process.html). @@ -32 +32 @@ Before you set up Google Drive integration, make sure you have the following: -## Prepare Google Drive authentication +## Authentication @@ -34 +34 @@ Before you set up Google Drive integration, make sure you have the following: -Google Drive integration uses managed three-legged OAuth (3LO) authentication. Before setting up the integration in Amazon Quick, understand the authentication process and required permissions: +For knowledge base integrations, Amazon Quick handles authentication through a popup flow during setup. Google Drive integration uses managed three-legged OAuth (3LO) authentication. @@ -36 +36 @@ Google Drive integration uses managed three-legged OAuth (3LO) authentication. B -### Authentication methods + 1. Complete the Google sign-in popup that appears. @@ -38 +38 @@ Google Drive integration uses managed three-legged OAuth (3LO) authentication. B -**Managed three-legged OAuth (3LO)** + 2. Review the permissions that Amazon Quick is requesting. @@ -39,0 +40 @@ Google Drive integration uses managed three-legged OAuth (3LO) authentication. B + 3. Select both permissions and choose **Continue** to grant access and complete the authentication process. @@ -41 +41,0 @@ Google Drive integration uses managed three-legged OAuth (3LO) authentication. B -Personal access method for individual Google Drive content: @@ -43 +42,0 @@ Personal access method for individual Google Drive content: - * Requires user authentication and consent @@ -45 +43,0 @@ Personal access method for individual Google Drive content: - * Provides access to personal and shared content @@ -46,0 +45 @@ Personal access method for individual Google Drive content: +### Permissions granted during consent @@ -47,0 +47 @@ Personal access method for individual Google Drive content: +When you authorize the connection, Amazon Quick requests the following permissions from your Google account: @@ -48,0 +49 @@ Personal access method for individual Google Drive content: +See and download all your Google Drive files @@ -50 +50,0 @@ Personal access method for individual Google Drive content: -### Required permissions and scopes @@ -52 +52 @@ Personal access method for individual Google Drive content: -Amazon Quick requests the following Google Drive permissions during authentication: + * See your Google Drive files @@ -54 +54 @@ Amazon Quick requests the following Google Drive permissions during authenticati - * `https://www.googleapis.com/auth/drive.readonly` \- Read-only access to Google Drive files and folders + * Download your files @@ -56 +56 @@ Amazon Quick requests the following Google Drive permissions during authenticati - * `https://www.googleapis.com/auth/drive.metadata.readonly` \- Read-only access to file metadata, sharing settings, and properties + * See the names and emails of people you share files with @@ -61 +61 @@ Amazon Quick requests the following Google Drive permissions during authenticati -### OAuth authentication process +See information about your Google Drive files @@ -63 +62,0 @@ Amazon Quick requests the following Google Drive permissions during authenticati -During the integration setup, you will be prompted to: @@ -65 +64 @@ During the integration setup, you will be prompted to: - 1. Select your Google account from the list or sign in with your credentials. + * The titles and descriptions of your files @@ -67 +66 @@ During the integration setup, you will be prompted to: - 2. Review the permissions that Amazon Quick is requesting: + * The names and email addresses of people you share files with @@ -69 +68 @@ During the integration setup, you will be prompted to: - * See and download all your Google Drive files. + * Your folders and how files are organized @@ -71 +69,0 @@ During the integration setup, you will be prompted to: - * See information about your Google Drive files. @@ -73 +70,0 @@ During the integration setup, you will be prompted to: - 3. Select both permissions and click **Continue** to grant permissions and complete the authentication process. @@ -75,0 +73,17 @@ During the integration setup, you will be prompted to: +###### Note + +You can review and remove this access at any time from your Google Account permissions settings. + +## Set up the knowledge base integration + + 1. In the Amazon Quick console, in the navigation pane under **Connect apps and data** , choose **Integrations**. + + 2. Choose the **Knowledge bases** tab. + + 3. Under **Set up new knowledge base** , find **Google Drive** and choose the **Add** (+) icon. + + 4. In the **Create Google Drive knowledge base** dialog, under **Connected account** , select an existing Google Drive connection or choose **\+ Add account** to connect a new Google account. If you add a new account, complete the Google sign-in and consent flow. + + 5. Under **Create knowledge base** , enter a name and an optional description for your knowledge base. + + 6. In the **Content** section, choose **Add content** to select the Google Drive files and folders to index. @@ -76,0 +91 @@ During the integration setup, you will be prompted to: + 7. In the **Add files or folders** dialog, browse your Google Drive content using the following tabs: @@ -78 +93 @@ During the integration setup, you will be prompted to: -## Set up Google Drive integration + * **My Drive** – Files and folders from your personal drive. @@ -80 +95 @@ During the integration setup, you will be prompted to: -After understanding the authentication requirements, follow these steps to create your Google Drive integration: + * **Shared with me** – Files and folders that others have shared with you. @@ -82 +97 @@ After understanding the authentication requirements, follow these steps to creat - 1. In the Amazon Quick console, choose **Integrations**. + * **Shared drives** – Files and folders from shared drives in your organization. @@ -84 +99 @@ After understanding the authentication requirements, follow these steps to creat - 2. Click **Add** (plus "+" button). + 8. Select the files or folders to include and choose **Select**. @@ -86 +101 @@ After understanding the authentication requirements, follow these steps to creat - 3. Select your account and complete the authentication process. + 9. Review the selected content in the **Content** table. To remove an item, choose the delete icon in the **Actions** column. @@ -88 +103 @@ After understanding the authentication requirements, follow these steps to creat - 4. Select **Continue**. + 10. Choose **Create**. @@ -90 +104,0 @@ After understanding the authentication requirements, follow these steps to creat - 5. On the "Add files or folders" section, select the files to place in your knowledge base. You select the files you want Amazon Quick to sync with using a point-and-click experience. @@ -92 +105,0 @@ After understanding the authentication requirements, follow these steps to creat - 6. Complete the knowledge base details: @@ -94 +106,0 @@ After understanding the authentication requirements, follow these steps to creat - * **Name** \- Enter a descriptive name for your knowledge base. @@ -96 +108 @@ After understanding the authentication requirements, follow these steps to creat - * **Description** (optional) - Describe the purpose of this knowledge base. +After you choose **Create** , the data sync starts automatically. @@ -98 +110 @@ After understanding the authentication requirements, follow these steps to creat - 7. Select **Create**. +## Supported content types @@ -99,0 +112 @@ After understanding the authentication requirements, follow these steps to creat +In addition to the common file types supported across all knowledge base integrations, the Google Drive connector supports the following Google Workspace-specific formats: @@ -100,0 +114 @@ After understanding the authentication requirements, follow these steps to creat + * **Google Workspace files:** Google Docs, Google Sheets, Google Slides @@ -103 +117,9 @@ After understanding the authentication requirements, follow these steps to creat -After clicking create, the data sync is started automatically. + + +For more information about supported file types, size limits, and content processing options, see [Common configuration settings](./knowledge-base-integrations.html#common-configuration-settings). + +## Access controls + +###### Important + +Amazon Quick does not sync access control lists (ACLs) from data sources. When you create a knowledge base in Amazon Quick, by default, only you can get insights from the knowledge base. To share content, update the knowledge base permissions to provide access to different users and groups. @@ -107 +129 @@ After clicking create, the data sync is started automatically. -After setting up your Google Drive integration, you can create and manage knowledge bases from your Google Drive content. +After you set up your Google Drive integration, you can manage your knowledge bases. @@ -111,2 +132,0 @@ After setting up your Google Drive integration, you can create and manage knowle -You can modify your existing Google Drive knowledge bases: - @@ -124 +144 @@ You can modify your existing Google Drive knowledge bases: -### Create additional knowledge bases +## Manage and troubleshoot @@ -126 +146 @@ You can modify your existing Google Drive knowledge bases: -You can create multiple knowledge bases from the same Google Drive integration: +For instructions on editing, sharing, or deleting your integration, see [Managing existing integrations](./integration-workflows.html#managing-existing-integrations). @@ -128 +148 @@ You can create multiple knowledge bases from the same Google Drive integration: - 1. In the Amazon Quick console, choose **Integrations** , and then select the **Data** tab. +For more information about knowledge base troubleshooting, including sync issues and missing documents, see [Troubleshooting knowledge bases](./troubleshooting-knowledge-bases.html). @@ -130 +150 @@ You can create multiple knowledge bases from the same Google Drive integration: - 2. Choose your existing Google Drive integration from the list. +### Google Drive-specific issues @@ -132 +152 @@ You can create multiple knowledge bases from the same Google Drive integration: - 3. Choose the three-dot icon under **Actions** , then choose **Create knowledge base**. + * **Authentication popup fails** – Verify that your browser allows popups from the Amazon Quick console domain. Try using a different browser or clearing your browser cache. @@ -134 +154 @@ You can create multiple knowledge bases from the same Google Drive integration: - 4. Configure your knowledge base settings and choose **Create**. + * **Permissions revoked** – If you previously revoked Amazon Quick access from your Google Account permissions settings, you need to re-authenticate by editing the integration and signing in again. @@ -135,0 +156 @@ You can create multiple knowledge bases from the same Google Drive integration: + * **Missing content** – Verify that the Google account that you used for authentication has access to the files and folders you selected. Content that was shared with you after the initial sync requires a resync to be indexed. @@ -136,0 +158 @@ You can create multiple knowledge bases from the same Google Drive integration: + * **Google API rate limiting** – Google Drive might throttle requests during high usage periods. If syncs fail or are incomplete, retry during off-peak hours. @@ -139,3 +160,0 @@ You can create multiple knowledge bases from the same Google Drive integration: -For detailed information about knowledge base configuration options, see [Common configuration settings](./knowledge-base-integrations.html#common-configuration-settings). - -###### Note @@ -143 +161,0 @@ For detailed information about knowledge base configuration options, see [Common -Amazon Quick doesn’t sync ACLs from data sources. When you create a knowledge base in Amazon Quick, by default only you can get insights from the knowledge base. For shared content, you can provide access to different users and groups by updating the knowledge base permissions. @@ -149 +167 @@ When using Google Drive integrations in Amazon Quick, be aware of the following - * File comments synchronization is not supported.. + * File comments synchronization is not supported.