AWS quick documentation change
Summary
Updated documentation for Amazon Quick integration workflows, removing the section on creating knowledge base integrations from existing data access integrations, reordering steps for creating knowledge bases and action connectors, and adding detailed sections on managing existing integrations including editing, deleting, sharing, and managing action connectors.
Security assessment
The changes are procedural updates to documentation, primarily reordering steps and adding management instructions. There is no mention of security vulnerabilities, patches, or security incidents. The changes include standard authentication steps (e.g., 'complete the authentication process') and mention OAuth re-authentication, but these are routine security practices, not new security features or fixes for specific security issues.
Diff
diff --git a/quick/latest/userguide/integration-workflows.md b/quick/latest/userguide/integration-workflows.md index 0c466e895..25a011d95 100644 --- a//quick/latest/userguide/integration-workflows.md +++ b//quick/latest/userguide/integration-workflows.md @@ -5 +5 @@ -Creating a knowledge base from scratchCreating an action connectorCreating a knowledge base integration from an existing data access integrationManaging existing integrations +Creating a knowledge base from scratchCreating an action connectorManaging existing integrations @@ -17 +17 @@ Data access integrations establish the connection to external systems creating k - 2. From the integration grid, choose the application you want to connect to (for example, **Google Drive** , **OneDrive** , or **S3**). + 2. Choose the **Knowledge bases** tab. @@ -19 +19 @@ Data access integrations establish the connection to external systems creating k - 3. In the Integration details section, select the "Add" option (**+**). If required, complete the authentication process in the popup that occurs. + 3. From the integration grid, choose the application you want to connect to (for example, **Google Drive** , **OneDrive** , or **S3**). @@ -21 +21 @@ Data access integrations establish the connection to external systems creating k - 4. 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. + 4. In the Integration details section, select the "Add" option (**+**). If required, complete the authentication process in the popup that occurs. @@ -23 +23 @@ Data access integrations establish the connection to external systems creating k - 5. Enter a **Name** for your integration. + 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. @@ -25 +25 @@ Data access integrations establish the connection to external systems creating k - 6. Enter the required connection details for your chosen application. + 6. Enter a **Name** for your integration. @@ -27 +27 @@ Data access integrations establish the connection to external systems creating k - 7. If required, choose **Create and continue** to continue to knowledge base creation. + 7. Enter the required connection details for your chosen application. @@ -29 +29 @@ Data access integrations establish the connection to external systems creating k - 8. Specify a name for your knowledge base. + 8. If required, choose **Create and continue** to continue to knowledge base creation. @@ -31 +31 @@ Data access integrations establish the connection to external systems creating k - 9. 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). + 9. Specify a name for your knowledge base. @@ -33 +33,3 @@ Data access integrations establish the connection to external systems creating k - 10. Choose **Create**. + 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). + + 11. Choose **Create**. @@ -46 +48,3 @@ Action Connectors enable you to perform actions in external applications directl - 2. From the integration grid, choose an application that supports action connectors (for example, **OneDrive** , **Confluence** , or **Slack**). + 2. Choose the **Actions** tab. + + 3. From the integration grid, choose an application that supports action connectors (for example, **OneDrive** , **Confluence** , or **Slack**). @@ -48 +52 @@ Action Connectors enable you to perform actions in external applications directl - 3. In the Integration details section, select the "Add" option (**+**). + 4. In the Integration details section, select the "Add" option (**+**). @@ -50 +54 @@ Action Connectors enable you to perform actions in external applications directl - 4. Enter a **Name** for your action connector. + 5. Enter a **Name** for your action connector. @@ -52 +56 @@ Action Connectors enable you to perform actions in external applications directl - 5. Configure the task-specific settings for your chosen application. + 6. Configure the task-specific settings for your chosen application. @@ -54 +58 @@ Action Connectors enable you to perform actions in external applications directl - 6. Choose **Next** to complete the authentication and setup process. + 7. Choose **Next** to complete the authentication and setup process. @@ -61 +65 @@ After successful creation, your action connector is available for use in Amazon -## Creating a knowledge base integration from an existing data access integration +## Managing existing integrations @@ -63 +67 @@ After successful creation, your action connector is available for use in Amazon -Knowledge base integrations allow you to create searchable repositories of information from external sources. +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. @@ -65 +69 @@ Knowledge base integrations allow you to create searchable repositories of infor -Follow the procedure below to quickly create a knowledge base for one of the six supported data sources. +### To edit an integration @@ -67 +71 @@ Follow the procedure below to quickly create a knowledge base for one of the six - 1. Open the Amazon Quick console and choose **Integrations**. Then click on the **Data** tab. +From the integrations list: @@ -69 +73 @@ Follow the procedure below to quickly create a knowledge base for one of the six - 2. Select your data source from the available options in the **Data** tab, + 1. In the Amazon Quick console, choose **Integrations**. @@ -71 +75 @@ Follow the procedure below to quickly create a knowledge base for one of the six - 3. Selecting the three-dot menu option under **Actions** , and then select **Create knowledge base**. + 2. Choose the **Knowledge bases** or **Actions** tab. @@ -73 +77 @@ Follow the procedure below to quickly create a knowledge base for one of the six - 4. Add a name and enter an optional description. + 3. Choose the **Open menu** icon in the row of the integration you want to edit. @@ -75 +79 @@ Follow the procedure below to quickly create a knowledge base for one of the six - 5. Select the content to include in your knowledge base. Choose **Create**. + 4. Choose **Edit**. @@ -76,0 +81 @@ Follow the procedure below to quickly create a knowledge base for one of the six + 5. Modify the integration settings as needed and choose **Save changes**. @@ -80 +84,0 @@ Follow the procedure below to quickly create a knowledge base for one of the six -Data synchronization begins automatically. Sync jobs can take a few mins to hours depending upon the size of your data, but you can see what documents are available for querying from the Refresh Reports tab. The knowledge base status changes from _Syncing_ to _Available_ when the sync is complete. @@ -82 +86,3 @@ Data synchronization begins automatically. Sync jobs can take a few mins to hour -## Managing existing integrations +You can also edit from the integration details page by choosing the integration name, then choosing the menu icon (⋮) and selecting **Edit**. + +### To delete an integration @@ -84 +90 @@ Data synchronization begins automatically. Sync jobs can take a few mins to hour -You can edit, delete, and manage existing integrations from the Integrations console. +From the integrations list: @@ -88 +94 @@ You can edit, delete, and manage existing integrations from the Integrations con - 2. From the integrations table, select the integration you want to modify. + 2. Choose the **Knowledge bases** or **Actions** tab. @@ -90 +96 @@ You can edit, delete, and manage existing integrations from the Integrations con - 3. Select the three-dot drop-down menu under "Actions"and then select "Edit integration". + 3. Choose the **Open menu** icon in the row of the integration you want to delete. @@ -92 +98 @@ You can edit, delete, and manage existing integrations from the Integrations con - 4. Modify the integration settings as needed. + 4. Choose **Delete**. @@ -94 +100 @@ You can edit, delete, and manage existing integrations from the Integrations con - 5. Choose **Save changes** to apply your modifications. + 5. In the confirmation dialog, review the integration details and choose **Delete** to confirm. @@ -99 +105 @@ You can edit, delete, and manage existing integrations from the Integrations con -Your integration settings are updated and the changes take effect immediately for new operations using the integration. +You can also delete from the integration details page by choosing the integration name, then choosing the menu icon (⋮) and selecting **Delete**. @@ -101 +107 @@ Your integration settings are updated and the changes take effect immediately fo -### To delete an integration +The integration is permanently removed from your account. Any dependent resources (such as knowledge bases) that rely on this integration will be impacted. @@ -103 +109 @@ Your integration settings are updated and the changes take effect immediately fo - 1. In the Amazon Quick console, choose **Integrations**. +### To share an integration @@ -105 +111 @@ Your integration settings are updated and the changes take effect immediately fo - 2. From the integrations table, select the integration you want to remove. +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. @@ -107 +113 @@ Your integration settings are updated and the changes take effect immediately fo - 3. Select the three-dot drop-down menu under "Actions"and then select "Delete integration". +### Managing action connectors @@ -109 +115 @@ Your integration settings are updated and the changes take effect immediately fo - 4. In the confirmation dialog, review the integration details and any dependent resources that will be affected. +Action connector integrations have additional management options available from the integration details page. @@ -111 +117 @@ Your integration settings are updated and the changes take effect immediately fo - 5. Choose **Delete** to confirm the removal. +**Sign in or re-connect** @@ -113,0 +120 @@ Your integration settings are updated and the changes take effect immediately fo +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. @@ -114,0 +122 @@ Your integration settings are updated and the changes take effect immediately fo +**Test action APIs** @@ -116 +124,6 @@ Your integration settings are updated and the changes take effect immediately fo -The integration is permanently removed from your account. Any dependent resources (such as knowledge bases) that rely on this integration will be impacted. + +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. + +###### Note + +The **Test action APIs** option is available for action connectors only. Knowledge base integrations do not support action testing.