# Bring Your Own Amazon Q Business Index (BYOI)
<a name="quick-byoa"></a>

Amazon Quick enables you to use your existing Amazon Q Business indexes as data sources. You can leverage your enterprise data without having to recreate indexes. This capability, known as Bring Your Own Index (BYOI), lets you connect your Amazon Q Business indexes to Amazon Quick and use them alongside other data sources for comprehensive analytics and intelligent responses.

BYOI supports two implementation methods:

**IDC Implementation**  
Uses IAM Identity Center for authentication. Requires both Amazon Q Business and Amazon Quick to authenticate through IAM Identity Center in the same AWS account and region.

**Non-IDC Implementation**  
Supports multiple authentication methods including native identities, AWS Managed Microsoft AD, and IAM federation. All Amazon Quick users automatically receive access to connected Amazon Q Business indexes.

**Topics**
+ [Overview of Amazon Q Business indexes in Amazon Quick](qbiz-indexes-overview.md)
+ [Prerequisites](qbiz-indexes-prerequisites.md)
+ [Supported authentication methods](qbiz-indexes-supported-authentication.md)
+ [Setting up permissions](qbiz-indexes-permissions.md)
+ [Creating knowledge bases from Amazon Q Business indexes](qbiz-indexes-creating-datasets.md)
+ [Sharing Amazon Q Business index knowledge bases](qbiz-indexes-sharing.md)
+ [Using Amazon Q Business index knowledge bases](qbiz-indexes-using.md)
+ [Limitations](qbiz-indexes-limitations.md)
+ [Billing](qbiz-indexes-billing.md)
+ [Feature comparison](qbiz-indexes-feature-comparison.md)
+ [Troubleshooting](qbiz-indexes-troubleshooting.md)
+ [Security best practices](qbiz-indexes-security.md)
+ [User types and capabilities](qbiz-indexes-user-types.md)
+ [Common use cases](qbiz-indexes-use-cases.md)
+ [Interacting with your Amazon Q Business indexes](qbiz-indexes-chat-interaction.md)

# Overview of Amazon Q Business indexes in Amazon Quick
<a name="qbiz-indexes-overview"></a>

Amazon Q Business indexes contain indexed enterprise data that you can now use directly in Amazon Quick. When you connect an Amazon Q Business index to Amazon Quick, it becomes available as a knowledge base. You can use it in spaces, agents, and automations, just like any other knowledge base in Amazon Quick.

Key benefits of using Amazon Q Business indexes in Amazon Quick include:

**Leverage existing data investments**  
Use your existing Amazon Q Business indexes and indexed data directly in Amazon Quick. You don't need to recreate indexes or upload the same data again.

**Unified analytics experience**  
Query across multiple data sources including Amazon Q Business indexes, uploaded documents, and structured data. Use Amazon Quick's unified analytical environment for all your data.

**Consistent security and permissions**  
Amazon Q Business index knowledge bases in Amazon Quick maintain the same security and access controls as in Amazon Q Business. Users only see content they have permission to access.

**Enhanced collaboration**  
Share Amazon Q Business index knowledge bases with other users in Amazon Quick, add them to spaces, and use them with agents and automations to create comprehensive business solutions.

# Prerequisites
<a name="qbiz-indexes-prerequisites"></a>

Before you can use Amazon Q Business indexes in Amazon Quick, ensure that you meet the following prerequisites:

## Common Prerequisites
<a name="qbiz-indexes-prerequisites-common"></a>
+ You have an existing Amazon Q Business index with indexed data.
+ Both the Amazon Q Business index and the Amazon Quick instance are in the same AWS account and region.
+ You have administrator permissions in Amazon Quick.

## IDC Implementation Prerequisites
<a name="qbiz-indexes-prerequisites-idc"></a>
+ AWS Identity Center is enabled and configured.
+ Both Amazon Q Business and Amazon Quick authenticate through IAM Identity Center.
+ The IAM Identity Center region and Amazon Q Business index region are the same.
+ You have access to both the Amazon Q Business index and AWS Identity Center administration.

# Supported authentication methods
<a name="qbiz-indexes-supported-authentication"></a>

The authentication methods supported depend on your implementation type:

## IDC Implementation
<a name="qbiz-indexes-auth-idc"></a>
+ Amazon Quick: AWS Identity Center authentication only
+ Amazon Q Business: `AWS_IAM_IDC`

## Non-IDC Implementation
<a name="qbiz-indexes-auth-qbiz"></a>
+ Amazon Quick:
  + Native identities (username/password)
  + AWS Managed Microsoft AD
  + IAM federation
+ Amazon Q Business: `AWS_QUICKSIGHT_IDP`

# Setting up permissions
<a name="qbiz-indexes-permissions"></a>

To use Amazon Q Business indexes in Amazon Quick, you need to set up the appropriate permissions based on your implementation method:

## Initial Setup
<a name="initial-setup"></a>

1. Sign in to the Amazon Quick console as an administrator.

1. Navigate to the **Admin** section.

1. Select **AWS Resources**.

1. Choose **Amazon Q Business** from the list of available data sources.

1. Choose **Select Applications**.

## Application Setup
<a name="application-setup"></a>

You can either connect to an existing Amazon Q Business application or create a new one:

1. Choose one of the following options:
   + **Connect to existing Amazon Q Business application** - Select an existing application from your account.
   + **Create new Amazon Q Business application** - Create a new application. The new application will use the same authentication used by your Amazon Quick instance setup.

1. For new applications, the system automatically configures authentication based on your Amazon Quick instance setup.

1. Wait for application creation to complete.

1. You will be redirected to the Amazon Q Business application to configure indexes and data sources.

## Access Management by Implementation
<a name="access-management"></a>

**IDC Implementation**  
+ Access is managed through AWS Identity Center.
+ Access to the Amazon Q Business application is managed through the Amazon Q Business console.

**Non-IDC Implementation**  
+ All Amazon Quick users automatically gain access to connected Amazon Q Business indexes.
+ No additional access management required in Amazon Q Business.

Once permissions are set up, you can use your Amazon Q Business index as a knowledge base in Amazon Quick, and Admin users can create knowledge bases from Amazon Q Business indexes.

# Creating knowledge bases from Amazon Q Business indexes
<a name="qbiz-indexes-creating-datasets"></a>

After setting up permissions, Admin or Admin Pro users can create knowledge bases from Amazon Q Business indexes:

1. Sign in to the Amazon Quick console as an Admin or Admin pro user.

1. Navigate to **Knowledge bases**.

1. Choose **Create knowledge base**.

1. Select **Amazon Q Business** as the data source.

1. Choose the Amazon Q Business index you want to use from the list of available indexes.

1. Provide a name and description for the knowledge base.

1. Choose **Create** to create the knowledge base.

**Note**  
If multiple Admin users create knowledge bases from the same Amazon Q Business index, these knowledge bases will functionally be identical.

# Sharing Amazon Q Business index knowledge bases
<a name="qbiz-indexes-sharing"></a>

Users who have access to an Amazon Q Business index in Amazon Q Business will automatically have the corresponding knowledge base in Amazon Quick shared with them when it is created. The knowledge base can be shared with other users after creation, but only the user who created the knowledge base can share it with other users.

In an IDC implementation, any changes to the permissions in Amazon Q Business application after the creation of knowledge base will not take effect in Amazon Quick.

If you are an admin and want to share the knowledge base with other users in Amazon Quick:

1. Navigate to **Knowledge bases**.

1. Select the Amazon Q Business index knowledge base you want to share.

1. Choose **Share**.

1. Select the users or groups you want to share the knowledge base with.

1. Choose **Share** to confirm.

# Using Amazon Q Business index knowledge bases
<a name="qbiz-indexes-using"></a>

Once created, Amazon Q Business index knowledge bases can be used in Amazon Quick just like any other knowledge base:

## Using in spaces
<a name="qbiz-indexes-in-spaces"></a>

Admins can add Amazon Q Business index knowledge bases to spaces:

1. Navigate to the space where you want to add the knowledge base.

1. Choose **Add resources**.

1. Select **Knowledge bases**.

1. Choose the Amazon Q Business index knowledge base from the list.

1. Choose **Add** to confirm.

## Using in output cards
<a name="qbiz-indexes-in-spaces-output"></a>

Admins can use Amazon Q Business index knowledge bases via Spaces in output cards.

## Using with agents
<a name="qbiz-indexes-in-agents"></a>

Admins can add Amazon Q Business index knowledge bases to custom agents:

1. Navigate to **Agents**.

1. Select an existing agent or create a new one.

1. In the agent configuration, choose **Add knowledge bases**.

1. Select the Amazon Q Business index knowledge base from the list.

1. Choose **Add** to confirm.

## Using with automations
<a name="qbiz-indexes-in-automations"></a>

Admins can add Amazon Q Business index knowledge bases to automations:

1. Navigate to **Automations**.

1. Select an existing automation or create a new one.

1. In the automation configuration, add a step that uses knowledge bases.

1. Select the Amazon Q Business index knowledge base from the list.

1. Configure the step and save the automation.

## Querying knowledge bases
<a name="qbiz-indexes-querying"></a>

Readers can query Amazon Q Business index knowledge bases through the Amazon Quick web application. However, a user will only be able to get a response from the Amazon Q Business index if they also have access to the Amazon Q Business application. To query the knowledge base:

1. Navigate to the Amazon Quick web application.

1. Select a space that contains the Amazon Q Business index knowledge base or use the default agent.

1. Enter your query in the chat interface.

1. View the response, which includes citations and clickable links to the source documents from the Amazon Q Business index.

# Limitations
<a name="qbiz-indexes-limitations"></a>

**Note**  
In an IDC implementation, when a Amazon Q Business knowledge base is first created in Amazon Quick, access to the knowledge base is automatically granted to users with access to the selected Amazon Q Business index. For additional users to have access to a knowledge base, the admin must configure user access in both the Amazon Q Business console and Amazon Quick knowledge base permissions pages.

When using Amazon Q Business indexes in Amazon Quick, be aware of the following limitations:

## General Limitations
<a name="general-limitations"></a>
+ Amazon Q Business index knowledge bases cannot be changed like other knowledge bases in Amazon Quick.
+ Amazon Q Business index knowledge bases only support the docs types supported by Amazon Q Business.
+ QApps, Actions, and Amazon Q Business chat guardrails are not included in the BYOI capability.
+ Amazon Q Business indexes must be in the same AWS account and region as Amazon Quick.

## IDC Implementation Limitations
<a name="idc-implementation-limitations"></a>
+ Both Amazon Quick and Amazon Q Business must use the same instance of IAM Identity Center.

## Index Quotas
<a name="index-quotas"></a>
+ You can connect up to two Amazon Q Business indexes per Region to Amazon Quick in the current release.
+ This quota cannot be increased.
+ Once indexes are selected and saved in a Amazon Quick instance, they cannot be directly unselected.

# Billing
<a name="qbiz-indexes-billing"></a>

When using Amazon Q Business indexes in Amazon Quick, billing works as follows:

## IDC Implementation Billing
<a name="idc-implementation-billing"></a>
+ You are billed for index and subscription costs in Amazon Q Business (recommended at least 1 user).
+ You are billed for subscription costs in Amazon Quick based on your Amazon Quick user subscriptions.
+ There are no additional charges for connecting Amazon Q Business indexes to Amazon Quick.

## Non-IDC Implementation Billing
<a name="qbiz-implementation-billing"></a>
+ No explicit Amazon Q Business subscription charges apply in this implementation model.
+ You are billed for subscription costs in Amazon Quick based on your Amazon Quick user subscriptions.

For more information about Amazon Quick pricing, see [Amazon Quick pricing](https://aws.amazon.com/quicksight/pricing/).

# Feature comparison
<a name="qbiz-indexes-feature-comparison"></a>

The following table compares key features between IDC and Amazon Q Business implementations:


| Feature | IDC Implementation | Non-IDC Implementation | 
| --- | --- | --- | 
|  User management  |  AWS Identity Center  |  Amazon Quick  | 
|  Amazon Quick authentication methods  |  Identity Center Only  |  Native identities (username/password), AWS Managed Microsoft AD, IAM federation  | 
|  Amazon Q Business authentication methods  |  `AWS_IAM_IDC`  |  `AWS_QUICKSIGHT_IDP`  | 
|  Share permissions  |  Amazon Q Business Console and Knowledge base permissions page  |  Amazon Quick Knowledge Base Permission page (Automatic)  | 
|  Index compatibility  |  All indexes  |  All indexes  | 

# Troubleshooting
<a name="qbiz-indexes-troubleshooting"></a>

## Amazon Q Business not seen in Integrations page
<a name="qbiz-not-seen-in-integrations"></a>

**Symptoms**
+ Amazon Q Business option missing from Integrations page
+ Cannot create new Amazon Q Business integration

**Resolution**
+ Only Admin users have access to create a Amazon Q Business/BYOI knowledge base
+ Verify user has Admin persona permissions

## Failed to fetch Amazon Q Business applications
<a name="failed-to-fetch-qbiz-applications"></a>

**Resolution**
+ Confirm Amazon Q Business is enabled in the Admin console
+ Try logging out and back in to refresh the session, then retry the operation

## Amazon Q Business application not seen in the list of applications displayed during knowledge base creation
<a name="qbiz-application-not-seen-in-list"></a>

**Symptoms**
+ Amazon Q Business applications list is empty on Create Knowledge Base page
+ Amazon Q Business applications list is populated but missing expected applications

**Resolution**
+ Check if missing Amazon Q Business applications were granted permissions in the AWS resources page of the Admin console

## Failed to create dataset. Chat instance is not ready. Please try again later
<a name="failed-to-create-dataset-chat-instance-not-ready"></a>

**Symptoms**
+ Knowledge base creation fails with error "Chat instance is not ready. Please try again later"
+ Unable to complete knowledge base creation process

**Resolution**
+ If this is the first time creating a knowledge base in Amazon Quick, wait 5 minutes and retry the operation

# Security best practices
<a name="qbiz-indexes-security"></a>
+ Regularly review access permissions
+ Monitor user activities
+ Implement least-privilege access
+ Maintain authentication method security

# User types and capabilities
<a name="qbiz-indexes-user-types"></a>

Different user types have different capabilities when working with Amazon Q Business indexes in Amazon Quick:

Amazon Q Business Administrator  
Manages Amazon Q Business indexes in the Amazon Q Business console.

Amazon Quick Administrator  
Enables permissions for Amazon Quick to access Amazon Q Business indexes in the same AWS account and region.

Amazon Quick Admin  
Creates knowledge bases from Amazon Q Business indexes, shares them with other users, and adds them to spaces.

Amazon Quick Admin  
Creates agents and automations that leverage Amazon Q Business index knowledge bases.

Amazon Quick Reader  
Uses agents and automations that leverage Amazon Q Business index knowledge bases, and queries these knowledge bases through the Amazon Quick web application.

# Common use cases
<a name="qbiz-indexes-use-cases"></a>

Here are some common use cases for using Amazon Q Business indexes in Amazon Quick:

**Finding relevant information**  
Query about specific topics across your enterprise data, such as HR policies, support documentation, or compliance guidelines.  
Example: "What is the maternity leave policy for my company in Washington state?" where national guidelines are in an Amazon Q Business index and state-specific information is in Amazon Quick.

**Business analytics and insights**  
Extract key findings from status updates across multiple groups or analyze the health of your product portfolio.  
Example: "Analyze the health of my product portfolio" where product sales data is in an Amazon Q Business index, and product engineering and support data is in Amazon Quick.

**Content creation and summarization**  
Create summaries or reports based on documents from multiple sources.  
Example: "Summarize last week's Service WBR and Sales update into a one-pager reflecting key initiatives" where the Service WBR is indexed in an Amazon Q Business index and the latest sales update is uploaded to Amazon Quick.

# Interacting with your Amazon Q Business indexes
<a name="qbiz-indexes-chat-interaction"></a>

Once you've connected your Amazon Q Business index to Amazon Quick, you can interact with it through chat using agents. 

1. From the left navigation menu in the console, select **Agents**.

1. From the **Actions** column for the agent you want to share, select the menu icon, and then select **Chat**.

1. You can then narrow down the resource to just the Knowledge Base created from the Amazon Q Business index by selecting the All Resources option and clicking on your Amazon Q Business index from the Knowledge Bases sub-tab.

When you ask questions, the agent analyzes data from your Amazon Q Business index alongside other data sources to provide comprehensive responses.

You can ask complex questions in plain language about your enterprise data and get detailed responses that draw from your Amazon Q Business index's indexed content. The chat interface allows you to:
+ Query your enterprise data using natural language
+ Get contextual responses that combine data from your Amazon Q Business index with other Amazon Quick data sources
+ View source citations with clickable references to see where information originated
+ Continue conversations and build on previous queries

For detailed information about using the chat interface and working with agents, see [Use a chat agent](use-agents.md).