AWS quick documentation change
Summary
Updated documentation for Amazon Quick integration workflows, restructuring the process for creating knowledge bases and action connectors with new UI navigation paths and updated authentication terminology.
Security assessment
The changes are primarily workflow and UI updates, moving from an 'Integrations' console to separate 'Knowledge' and 'Connectors' sections. The authentication section was updated from 'user-based OAuth authentication' to 'Default OAuth app or Custom OAuth app authentication', which appears to be a terminology update rather than a security fix. No specific vulnerabilities, security incidents, or new security features are mentioned in the diff.
Diff
diff --git a/quick/latest/userguide/integration-workflows.md b/quick/latest/userguide/integration-workflows.md index 41f66ce2d..da5be8b01 100644 --- a//quick/latest/userguide/integration-workflows.md +++ b//quick/latest/userguide/integration-workflows.md @@ -7 +7 @@ -Creating a knowledge base from scratchCreating an action connectorManaging existing integrations +Creating a knowledge baseCreating an action connectorManaging existing integrations @@ -13 +13 @@ The following procedures describe the general workflows for creating and managin -## Creating a knowledge base from scratch +## Creating a knowledge base @@ -15 +15 @@ The following procedures describe the general workflows for creating and managin -Data access integrations establish the connection to external systems creating knowledge bases from external data sources. +Knowledge bases connect external data sources to Amazon Quick so you can ask questions about and get insights from your content. @@ -17 +17 @@ Data access integrations establish the connection to external systems creating k - 1. In the Amazon Quick console, choose **Integrations**. + 1. In the Amazon Quick console, choose **Knowledge**. @@ -19 +19 @@ Data access integrations establish the connection to external systems creating k - 2. Choose the **Knowledge bases** tab. + 2. Find the application you want to connect to (for example, **Google Drive** , **Microsoft OneDrive** , or **Amazon S3**) and choose the **Add** (+) icon. @@ -21 +21 @@ Data access integrations establish the connection to external systems creating k - 3. From the integration grid, choose the application you want to connect to (for example, **Google Drive** , **OneDrive** , or **S3**). + 3. Complete the authentication process for your chosen application. @@ -23 +23 @@ Data access integrations establish the connection to external systems creating k - 4. In the Integration details section, select the "Add" option (**+**). If required, complete the authentication process in the popup that occurs. + 4. Enter a **Name** and optional description for your knowledge base. @@ -25 +25 @@ Data access integrations establish the connection to external systems creating k - 5. Fill in the appropriate details, depending on your chosen integration. For example, for Amazon S3, select your AWS account and your Amazon S3 bucket url. + 5. Select the files and folders you want to include in your knowledge base using the file picker or sync options. @@ -27 +27 @@ Data access integrations establish the connection to external systems creating k - 6. Enter a **Name** for your integration. + 6. Choose **Create**. @@ -29 +28,0 @@ Data access integrations establish the connection to external systems creating k - 7. Enter the required connection details for your chosen application. @@ -31 +29,0 @@ Data access integrations establish the connection to external systems creating k - 8. If required, choose **Create and continue** to continue to knowledge base creation. @@ -33 +30,0 @@ Data access integrations establish the connection to external systems creating k - 9. Specify a name for your knowledge base. @@ -35 +32 @@ Data access integrations establish the connection to external systems creating k - 10. Specify the files you want to include in your knowledge base using the file picker or appropriate sync options (for example, **S3** allows you to choose to add all content of specific content). +After you choose **Create** , the data sync starts automatically. @@ -37 +34 @@ Data access integrations establish the connection to external systems creating k - 11. Choose **Create**. +## Creating an action connector @@ -39 +36 @@ Data access integrations establish the connection to external systems creating k -Syncing of your content will automatically begin after creation of the knowledge base. +Action connectors enable you to perform actions in external applications directly from Amazon Quick. @@ -40,0 +38 @@ Syncing of your content will automatically begin after creation of the knowledge + 1. In the Amazon Quick console, choose **Connectors**. @@ -41,0 +40 @@ Syncing of your content will automatically begin after creation of the knowledge + 2. Choose the **Create for your team** tab. @@ -42,0 +42 @@ Syncing of your content will automatically begin after creation of the knowledge + 3. Find and choose the application you want to connect to (for example, **Google Drive** , **Atlassian Confluence Cloud** , or **Slack**). @@ -44 +44 @@ Syncing of your content will automatically begin after creation of the knowledge -## Creating an action connector + 4. Enter a **Name** for your connector. Optionally, add a description. @@ -46 +46 @@ Syncing of your content will automatically begin after creation of the knowledge -Action Connectors enable you to perform actions in external applications directly from Amazon Quick. + 5. Configure the connection type and authentication method. For more information about authentication options, see [Authentication methods](./quick-action-auth.html). @@ -48 +48 @@ Action Connectors enable you to perform actions in external applications directl - 1. In the Amazon Quick console, choose **Integrations**. + 6. Review the available actions and choose **Publish**. @@ -50 +49,0 @@ Action Connectors enable you to perform actions in external applications directl - 2. Choose the **Actions** tab. @@ -52 +50,0 @@ Action Connectors enable you to perform actions in external applications directl - 3. From the integration grid, choose an application that supports action connectors (for example, **OneDrive** , **Confluence** , or **Slack**). @@ -54 +51,0 @@ Action Connectors enable you to perform actions in external applications directl - 4. In the Integration details section, select the "Add" option (**+**). @@ -56 +53 @@ Action Connectors enable you to perform actions in external applications directl - 5. Enter a **Name** for your action connector. +After successful creation, your action connector is available for use in Amazon Quick chat, workflows, and Amazon Q Apps. @@ -58 +55 @@ Action Connectors enable you to perform actions in external applications directl - 6. Configure the task-specific settings for your chosen application. +## Managing existing integrations @@ -60 +57 @@ Action Connectors enable you to perform actions in external applications directl - 7. Choose **Next** to complete the authentication and setup process. +You can edit, delete, share, and manage existing integrations from the Amazon Quick console. @@ -61,0 +59 @@ Action Connectors enable you to perform actions in external applications directl +### To edit an integration @@ -62,0 +61 @@ Action Connectors enable you to perform actions in external applications directl +For knowledge bases: @@ -63,0 +63 @@ Action Connectors enable you to perform actions in external applications directl + 1. In the Amazon Quick console, choose **Knowledge**. @@ -65 +65 @@ Action Connectors enable you to perform actions in external applications directl -After successful creation, your action connector is available for use in Amazon Quick workflows and can be triggered from analyses, dashboards, or automated processes. + 2. Choose the knowledge base you want to edit. @@ -67 +67 @@ After successful creation, your action connector is available for use in Amazon -## Managing existing integrations + 3. Choose the menu icon (⋮) and select **Edit**. @@ -69 +69 @@ After successful creation, your action connector is available for use in Amazon -You can edit, delete, share, and manage existing integrations from the Integrations console. You can access management options from the integrations list or from an integration's details page. + 4. Modify the settings as needed and choose **Save changes**. @@ -71 +70,0 @@ You can edit, delete, share, and manage existing integrations from the Integrati -### To edit an integration @@ -73 +71,0 @@ You can edit, delete, share, and manage existing integrations from the Integrati -From the integrations list: @@ -75 +72,0 @@ From the integrations list: - 1. In the Amazon Quick console, choose **Integrations**. @@ -77 +74 @@ From the integrations list: - 2. Choose the **Knowledge bases** or **Actions** tab. +For action connectors: @@ -79 +76 @@ From the integrations list: - 3. Choose the **Open menu** icon in the row of the integration you want to edit. + 1. In the Amazon Quick console, choose **Connectors**. @@ -81 +78 @@ From the integrations list: - 4. Choose **Edit**. + 2. Choose the connector you want to edit. @@ -83 +80 @@ From the integrations list: - 5. Modify the integration settings as needed and choose **Save changes**. + 3. Choose the menu icon (⋮) and select **Edit**. @@ -84,0 +82 @@ From the integrations list: + 4. Modify the connector settings as needed and choose **Save changes**. @@ -88 +85,0 @@ From the integrations list: -You can also edit from the integration details page by choosing the integration name, then choosing the menu icon (⋮) and selecting **Edit**. @@ -92 +89,11 @@ You can also edit from the integration details page by choosing the integration -From the integrations list: +For knowledge bases: + + 1. In the Amazon Quick console, choose **Knowledge**. + + 2. Choose the knowledge base you want to delete. + + 3. Choose the menu icon (⋮) and select **Delete**. + + 4. In the confirmation dialog, choose **Delete** to confirm. + + @@ -94 +100,0 @@ From the integrations list: - 1. In the Amazon Quick console, choose **Integrations**. @@ -96 +102 @@ From the integrations list: - 2. Choose the **Knowledge bases** or **Actions** tab. +For action connectors: @@ -98 +104 @@ From the integrations list: - 3. Choose the **Open menu** icon in the row of the integration you want to delete. + 1. In the Amazon Quick console, choose **Connectors**. @@ -100 +106 @@ From the integrations list: - 4. Choose **Delete**. + 2. Choose the connector you want to delete. @@ -102 +108 @@ From the integrations list: - 5. In the confirmation dialog, review the integration details and choose **Delete** to confirm. + 3. Choose the menu icon (⋮) and select **Delete**. @@ -103,0 +110 @@ From the integrations list: + 4. In the confirmation dialog, choose **Delete** to confirm. @@ -107 +113,0 @@ From the integrations list: -You can also delete from the integration details page by choosing the integration name, then choosing the menu icon (⋮) and selecting **Delete**. @@ -113 +119 @@ The integration is permanently removed from your account. Any dependent resource -From the integrations list, choose the **Open menu** icon in the row of the integration and choose **Share**. You can also choose **Share** from the integration details page. +From the connector or knowledge base details page, choose the menu icon (⋮) and select **Share**. @@ -117 +123 @@ From the integrations list, choose the **Open menu** icon in the row of the inte -Action connector integrations have additional management options available from the integration details page. +Action connectors have additional management options available from the connector details page. @@ -122 +128 @@ Action connector integrations have additional management options available from -For integrations that use user-based OAuth authentication, you must sign in to the server before you can use its actions. If you have not yet signed in, a **Sign in** button appears at the top of the details page. After you sign in, the button changes to **Re-Connect** , which you can use to re-authenticate if your session expires or the connection is interrupted. +For connectors that use Default OAuth app or Custom OAuth app authentication, you must sign in to the service before you can use its actions. If you have not yet signed in, a **Sign in** button appears on the details page. After you sign in, you can use **Re-Connect** to re-authenticate if your session expires or the connection is interrupted. @@ -127 +133 @@ For integrations that use user-based OAuth authentication, you must sign in to t -Choose **Test action APIs** in the Actions section of the details page to test individual actions provided by the integration. This lets you verify that the connection is working correctly and that the server responds as expected. +Choose **Test action APIs** in the Actions section of the details page to test individual actions provided by the connector. This lets you verify that the connection is working correctly and that the service responds as expected. @@ -131 +137 @@ Choose **Test action APIs** in the Actions section of the details page to test i -The **Test action APIs** option is available for action connectors only. Knowledge base integrations do not support action testing. +The **Test action APIs** option is available for action connectors only. Knowledge bases do not support action testing.