# Using the Quick plugin to get insights from structured data **Note** The Quick plugin feature is in preview and is subject to change. The Quick plugin is a fully integrated plugin that gives an Amazon Q Business application access to insights and external databases through [Amazon Quick](https://docs.aws.amazon.com/quicksight/latest/user/welcome.html). Quick is a business intelligence service that provides insights from your structured data, such as databases, data lakes, and data warehouses. With the Quick plugin for Amazon Q Business, end users can get answers from this structured data directly in an Amazon Q Business application. You don't have to index or reformat this structured data, and you don't need to migrate it to Amazon Q Business. For example, an end user might ask "What was the revenue per month for my business for 2023?" in their Amazon Q Business chat application. They would get answers based on your unstructured data in Amazon Q Business and, below this response, Quick answers based on structured data. The response from QuickSight can include a multi-visual answer that includes an AI-generated narrative that summarizes key insights, and supporting visuals and interactive graphs to add context. If these visuals don't exist already, Quick can generate them on the fly based on the user's question and the available data in Quick and external databases. To enable the plugin, you use Amazon Q Business to link your Amazon Quick account with your application and grant it permission to communicate with Quick. If you use the console, you can create the Quick account in Amazon Q Business. If you already have a Quick account, you can enable the plugin with the console or the [CreatePlugin](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreatePlugin.html) API operation. After you create resources in Quick (including datasets, topics, and, optionally, dashboards), end users automatically start getting insights based on your structured data. **Important** The Quick plugin is fully integrated with Amazon Q Business, and won't appear in the list of plugins in the web experience. For every user prompt, it automatically queries Quick. For information about pausing the plugin, see [Pausing integration with Quick](quicksight-plugin-pausing-integration.md). **Note** If your [Admin controls and guardrails](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) settings allow Amazon Q to automatically orchestrate end user chat queries across plugins and data sources, an Quick plugin will only activate if: No other plugin actions (read or write requests requiring additional end user input through forms) are detected, or, in progress. No end user authentication requests are pending. **Topics** + [ ## Pricing ](#quicksight-plugin-pricing) + [ ## Guidelines and requirements ](#quicksight-plugin-req) + [ ## Service access role ](#quicksight-plugin-service-access-role) + [ # Configuring an Amazon Q Business application to use the plugin ](quicksight-plugin-configuring-application.md) + [ # Getting data insights from Amazon Quick answers ](quicksight-plugin-getting-data-insights.md) + [ # Pausing integration with Quick ](quicksight-plugin-pausing-integration.md) ## Pricing When you set up the integration with Quick, you assign one or more IAM Identity Center groups the Quick Admin Pro role. This role grants users access to all Generative BI capabilities in Amazon Quick. Your Quick administrator is responsible for adding and managing user permissions and configuring your Quick account. The Quick Admin Pro role incurs additional costs. For more information about pricing, see [Amazon Quick pricing](https://aws.amazon.com/quicksight/pricing/). For more information about Pro roles in Amazon Quick, see [Get started with Generative BI](https://docs.aws.amazon.com/quicksight/latest/user/generative-bi-get-started.html). When you link a Quick account and an Amazon Q Business application, the following groups get Pro subscription benefits at no additional cost: + Quick Admin Pro groups are added to the Amazon Q Business Pro subscription. + Existing Amazon Q Business Pro groups are assigned the Quick Reader Pro role. ## Guidelines and requirements + You must use IAM Identity Center for authentication for both Quick and Amazon Q Business. If your Amazon Q Business application doesn't use IAM Identity Center, you must create a new one that does. For information about creating an IAM Identity Center integrated application, see [Configuring an Amazon Q Business application using AWS IAM Identity Center](create-application.md). + Your Amazon Q Business application and Amazon Quick account must be in the same AWS Region. + To get answers from QuickSight in your web experience, you must add at least one index to your Amazon Q Business application. To learn how to add an index, see [creating an index](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/select-retriever.html). + If you don't have a Quick account, you can create the account from the Amazon Q Business console when you configure your application to communicate with Quick. + You must authorize Amazon Q Business to communicate with Amazon Quick with a service role. For more information, see [Service access role](#quicksight-plugin-service-access-role). + The IAM role for your Amazon Q Business web experience must have `quicksight:GenerateEmbedUrlForRegisteredUserWithIdentity` permissions. For a policy example, see [IAM role for an Amazon Q Business web experience using IAM Identity Center](web-experience-iam-role-idc.md). ## Service access role When you link your Quick account in the Amazon Q Business console, you specify an AWS Identity and Access Management (IAM) role that authorizes Amazon Q Business to communicate with Amazon Quick. In the console, you can choose to create this role with the correct permissions automatically configured. Or you can manually create it. + The role's permissions policy must grant `quicksight:PredictQAResults` for Amazon Quick topics and, if you create them, dashboards. For a permissions policy example, see [AWS managed policy: QBusinessQuicksightPluginPolicy](security-iam-awsmanpol.md#security-iam-awsmanpol-amazonq-quicksight-policy). + The role's trust policy must grant Amazon Q Business `AssumeRole` and `SetContext`permissions as follows. ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "QBusinessQuicksightManagedPolicyTrustPolicy", "Effect": "Allow", "Principal": { "Service": "qbusiness.amazonaws.com" }, "Action": [ "sts:AssumeRole", "sts:SetContext" ], "Condition": { "StringEquals": { "aws:SourceAccount": "111122223333" }, "ArnLike": { "aws:SourceArn": "arn:aws:qbusiness:us-east-1:111122223333:application/application-id" } } } ] } ``` ------ # Configuring an Amazon Q Business application to use the plugin You configure an Amazon Q Business application to get insights from Quick answers in different ways depending on whether you have a Quick account. + If you don't have a Quick account, you can create one in the Amazon Q Business console, and then authorize Amazon Q Business to communicate with Quick. + If you already have a Quick account, you use the Amazon Q Business console or APIs to authorize Amazon Q Business to communicate with Amazon Quick. After you configure your application, you create Quick datasets, and create and share Quick topics. Users can also get insights from Quick dashboards. + You can create datasets from new or existing data sources in Amazon Quick. You can use a variety of database data sources to provide data to Amazon Quick. For more information, see [Creating datasets](https://docs.aws.amazon.com/quicksight/latest/user/creating-data-sets.html). + Quick *topics* are collections of one or more datasets that represent a subject area that your business users can ask questions about. For more information, see [Working with Amazon Quick Q topics](https://docs.aws.amazon.com/quicksight/latest/user/quicksight-q-topics.html). + A Quick *dashboard* is a read-only snapshot of an analysis that you can share with other Amazon Quick users for reporting purposes. For more information, see [Sharing and subscribing to data in Amazon Quick](https://docs.aws.amazon.com/quicksight/latest/user/working-with-dashboards.html). **Topics** + [ ## Creating a new Amazon Quick account in the Amazon Q Business console ](#quicksight-plugin-creating-new-qs-account) + [ ## Linking an existing Quick account ](#quicksight-plugin-linking-existing-account) ## Creating a new Amazon Quick account in the Amazon Q Business console If you don't have an existing Quick account, you can use the Amazon Q Business console to create one and link the two accounts. Then you configure your Quick resources to start getting insights. **To link a new Quick account** 1. Log in to the Amazon Q Business console. 1. In **Applications**, choose the name of your application from the list of applications. 1. In the navigation pane, choose **Amazon Quick**. 1. Choose **Create Quick Account**. 1. Give your new account a name, and specify the email address to use for account notifications. 1. Optionally, specify an email for product updates. 1. In **Assign Quick Admin Pro role**, choose the IAM Identity Center groups to assign the Quick Admin Pro role, and choose **Next**. 1. In **Service access**, create a new service role or use an existing one. This role authorizes Amazon Q Business to communicate with Amazon Quick. For more information, see [Service access role](quicksight-plugin.md#quicksight-plugin-service-access-role). 1. Choose **Authorize**. 1. Choose **Go to Quick** to go to your Quick account. There you create datasets, create and share Quick topics, and optionally create, publish, and share dashboards. After you configure these resources, end users start getting insights with Quick answers. ## Linking an existing Quick account If you have an existing Quick account that uses AWS IAM Identity Center for authentication, you can authorize Amazon Q Business to communicate with Amazon Quick in the console or with the Amazon Q Business API. Then end users can start getting insights from new and existing Quick topics and dashboards. ### Using the console If you have an existing Quick account that uses AWS IAM Identity Center for authentication, you can start getting insights after you authorize Amazon Q Business to communicate with Amazon Quick. To authorize Amazon Q Business, you use the Amazon Q Business console to assign IAM Identity Center groups the Admin Pro role. Then you specify a service role that grants Amazon Q Business access. **To link an existing Quick account** 1. Log in to the Amazon Q Business console. 1. Choose your application. 1. In the navigation pane, choose **Amazon Quick**. 1. Choose **Authorize Quick answers**. 1. In **Assign Quick Admin Pro role**, choose the IAM Identity Center groups to assign the Admin Pro role. The Quick Admin Pro role includes additional costs. For more information, see Amazon Quick pricing. 1. In **Service access**, create a new service role or use an existing one. This role authorizes Amazon Q Business to communicate with Amazon Quick. For more information, see [Service access role](quicksight-plugin.md#quicksight-plugin-service-access-role). 1. Choose **Authorize**. After you authorize the connection, end users start getting insights from existing Quick resources. 1. To get insights from additional structured data resources, choose **Go to Quick** to go to your Quick account. There you can create additional datasets, topics, and dashboards. ### Using the API To authorize Amazon Q Business with the API, you first use IAM Identity Center to assign groups the Admin Pro role. Also, if your Quick account was created before November 25, 2024 and uses IdC authentication, use the [UpdateApplicationWithTokenExchangeGrant](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateApplicationWithTokenExchangeGrant.html) API to update your subscription to allow integration with Amazon Q Business Then you use the [CreatePlugin](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreatePlugin.html) API operation to create a Quick plugin for an Amazon Q Business application. The following code shows how to create a Quick plugin. For `idcApplicationArn`, specify the Amazon Resource Name (ARN) of your application in IAM Identity Center. For `roleArn`, specify an AWS Identity and Access Management (IAM) role that authorizes Amazon Q Business to communicate with Amazon Quick. For more information about this role, see [Service access role](quicksight-plugin.md#quicksight-plugin-service-access-role). ``` aws qbusiness create-plugin \ --application-id application-id \ --display-name display-name \ --type QUICKSIGHT \ --auth-configuration idcAuthConfiguration="{idcApplicationArn=arn:aws:sso:::application/,roleArn=arn:aws:iam:::role/AmazonQServiceRole}" ``` # Getting data insights from Amazon Quick answers After you complete [Configuring the plugin](quicksight-plugin-configuring-application.md), end users automatically start getting insights from Quick as they submit queries. Unlike other plugins in Amazon Q Business, you don't have to enable Quick insights for end users. The following example shows the results of a query with Quick answers enabled. It shows a response from Amazon Q Business and a Quick dashboard visual. To navigate to Quick and view details for the insights, choose **Explore insights**. ![\[Screenshot showing query results with QuickSight answers enabled, displaying both an Amazon Q Business response and a QuickSight dashboard visual with an "Explore insights" button for accessing more detailed information.\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/images/quicksight-plugin-results.png) # Pausing integration with Quick After you enable the plugin, it automatically queries Amazon Quick for every user prompt. To stop automatically querying Quick, you can pause the plugin. When you pause the plugin, end users will no longer see insights from Quick answers. You continue to incur costs for Quick Admin Pro subscription users. **To pause the integration** 1. Log in to the Amazon Q Business console. 1. Choose your application. 1. In the navigation pane, choose **Amazon Quick**. 1. In **QuickSight details**, choose **Pause Quick answers**. 1. Confirm your decision to pause the integration. When you're ready to resume, choose **Resume QuickSight Answers** on this page.