Creating an Amazon QuickSight-integrated Amazon Q Business application - Amazon Q Business
ConsiderationsCreating a QuickSight-integrated application from Amazon QuickSightCreating a QuickSight-integrated application with Amazon Q Business API operations

Creating an Amazon QuickSight-integrated Amazon Q Business application

With an Amazon QuickSight-integrated Amazon Q Business application, QuickSight users authenticate through Amazon QuickSight and access answers from unstructured data in Amazon Q Business. Amazon QuickSight is a business intelligence service that provides insights from your structured data, such as databases, data lakes, and data warehouses.

With QuickSight authentication, your Amazon QuickSight administrator uses QuickSight as a single point of entry to manage access to unstructured data in Amazon Q Business. You can manage users and groups without reliance on AWS IAM Identity Center, including permissions, governance, and access controls.

After you set up QuickSight as your authentication, users sign in through QuickSight with their existing credentials. After authentication, they can use QuickSight Q&A and Data Stories to get answers to questions based on your unstructured enterprise data in Amazon Q Business and your structured data analytics.

You can create an QuickSight integrated Amazon Q Business application environment from Amazon QuickSight or you can create it with the Amazon Q Business CreateApplication API operation.

Considerations

The following limitations apply to the Amazon Q application.

  • Amazon QuickSight and Amazon Q Business must exist in the same AWS account. Cross account calls are not supported.

  • Amazon QuickSight and Amazon Q Business accounts must exist in the same AWS Region. Cross-region calls are not supported. For a list of all supported QuickSight Regions, see Supported AWS Regions for Amazon Q in QuickSight. For a list of all supported Amazon Q Business Regions, see Service quotas for Amazon Q Business.

    If your Amazon QuickSight account exists in more than one region, you can connect one Amazon Q Business application from each region to the QuickSight account. For example, if your QuickSight account exists in US East (N. Virginia) and US West (Oregon), one Amazon Q Business application located in US East (N. Virginia) and one Amazon Q Business application located in US West (Oregon) can be connected to the QuickSight account.

  • Amazon QuickSight and Amazon Q Business accounts that are integrated need to use the same identity methods. For example, if a QuickSight account uses IAM Identity Center for identity management, the Amazon Q Business account that it is integrating with must also use IAM Identity Center for identity management.

  • Email addresses that are associated with QuickSight users and groups are used to perform authorization checks in Amazon Q Business.

  • To create an Amazon Q Business application with the CreateApplication API operation, the user or role must have permissions to create an application. For more information about setting up Amazon Q Business, see Setting up for Amazon Q Business.

Creating a QuickSight-integrated application from Amazon QuickSight

To set up an QuickSight-integrated Amazon Q Business application environment, QuickSight administrators can create a new application from the QuickSight admin portal or connect to an existing one. After you create an application environment, you create an index and add a data source in Amazon Q Business.

Creating a QuickSight-integrated application with Amazon Q Business API operations

To create an Amazon QuickSight integrated application environment with Amazon Q Business APIs, you use the CreateApplication API operation. For identityType, specify AWS_QUICKSIGHT_IDP. In QuickSightConfiguration, specify the clientNamespace. This is the QuickSight namespace that you use as your identity provider. For more information about QuickSight namespaces, see Namespace operations.

The following example shows how to use the AWS Command Line Interface (AWS CLI) to create a QuickSight-integrated application environment.

aws qbusiness create-application \
--display-name MyQBusinessApp \
--identity-type AWS_QUICKSIGHT_IDP \
--quick-sight-configuration '{"clientNamespace": "my-quicksight-namespace"}'