Connecting an Amazon Kendra retriever to an Amazon Q Business application

To use an Amazon Kendra index as a retriever for Amazon Q Business, you must have already configured an Amazon Kendra index and connected it with data. For more information, see What is Amazon Kendra? and Are you a first-time Amazon Kendra user? in the Amazon Kendra Developer Guide.

To add an existing Amazon Kendra retriever to your Amazon Q application, you can use the AWS Management Console or the CreateRetriever API operation. If you use the console, selecting and connecting an Amazon Kendra retriever is a two-step process. The first step is when you select an Amazon Kendra retriever. In this topic, you perform the second step—connecting an Amazon Kendra retriever.

If you use the API, you create your web experience after connecting your Amazon Kendra retriever using the CreateWebExperience API operation. If you use the console, connecting your Amazon Kendra retriever also automatically creates your Amazon Q web experience. At the end of the retriever connection process, your Amazon Kendra powered Amazon Q web experience is ready to be previewed, enhanced, and deployed.

Note

If you select an Amazon Kendra retriever, data in your Amazon Kendra is connected to your Amazon Q application.

Console

To connect an Amazon Kendra retriever

1. Sign in to the AWS Management Console and open the Amazon Q console at https://console.aws.amazon.com/amazonq/business/.

2. Complete the steps to create your Amazon Q application.

3. Complete the steps for selecting an Amazon Kendra retriever.

4. Then, in Content sources, for Amazon Kendra indexes – Choose the Amazon Kendra index that you want to use for your Amazon Q Business application. Then, enter the following information:

   • Service access – Provide the IAM access role to connect Amazon Kendra to Amazon Q Business. Use an existing role, or create a new one.

   • Service role name – Provide a name for your IAM access role. Or, choose to use the auto-generated role that's provided.

5. To connect your Amazon Kendra indexes to the application, choose Create application.

You are returned to the Amazon Q console while your web application is created.

AWS CLI

To create and connect an Amazon Kendra retriever

aws qbusiness create-retriever \
--application-id application-id \
--display-name display-name \
--type KENDRA_INDEX \
--role-arn roleArn \
--configuration kendraIndexConfiguration="{indexId=<kendra-index-id>}"

Note

For information on managing your Amazon Kendra retriever, see Managing Amazon Kendra retrievers.