To manage Amazon Q Business indexes, you can take the following actions:
Actions
Deleting an Amazon Q Business
index
To delete a Amazon Q Business index, you can use the console or the DeleteIndex API operation.
If you use the console, deleting an index automatically deletes the retriever attached to it. If you use the API, you must also use the DeleteRetriever API operation to delete the Amazon Q Business retriever attached to your index.
The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI.
To delete an Amazon Q Business index
-
Sign in to the AWS Management Console and open the Amazon Q Business console.
-
Complete the steps to create your Amazon Q Business application.
-
In Applications, select the name of your application from the list of applications.
-
From the left navigation menu, choose Data sources.
-
From the Data sources page, from Index, select Delete.
-
In the dialog box that opens, type
Confirmto confirm deletion, and then choose Delete.You are returned to the service console while your application environment is deleted. When the deletion process is complete, the console displays a message confirming successful deletion.
Getting properties of an Amazon Q Business index
To get the properties of an Amazon Q Business index and retriever, you can use the console or the GetIndex and GetRetriever API operation.
The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI.
To get properties of an Amazon Q Business index and retriever
-
Sign in to the AWS Management Console and open the Amazon Q Business console.
-
In Applications, select the name of your application from the list of applications.
-
From the left navigation menu, choose Data sources.
-
On the Data sources page, under Index the following settings are available:
-
Index name – The name of the index.
-
Index status – The status of your index.
-
Index provisioning – The number of index units provisioned for your index.
-
Document count – The number of documents that are attached to your index.
-
Storage used – The amount of storage that your index is using.
-
Index ID – The ID of the index attached to your retriever.
-
Retriever ID – The ID of the retriever that you're using.
-
Retriever – The retriever type that you're using.
-
Last modified – The time that your index was last modified.
-
Listing Amazon Q Business indices
and retrievers
To list your native Amazon Q Business indices and retrievers, you can use the console or the ListIndices API operation and the ListRetrievers API operation.
If you use the console, the list of Amazon Q Business indices and retrievers can be found within the list of data sources that you have created.
The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI.
To list your Amazon Q Business indices and retrievers
-
Sign in to the AWS Management Console and open the Amazon Q Business console.
-
In Applications, select the name of your application from the list of applications.
-
From the left navigation menu, choose Data sources.
-
On the Data sources page, a list of all indices that you have created is available.
Editing Amazon Q Business
indices
To edit your Amazon Q Business index, you can use the console or the UpdateIndices API operation.
Note
When you update a native index, you can only update the number of storage units you provisioned for it. You can't change any other settings.
The following tab provides code examples for the AWS Management Console and AWS CLI.
To update your Amazon Q Business retriever
-
Sign in to the AWS Management Console and open the Amazon Q Business console.
-
In Applications, select the name of your application from the list of applications.
-
From the left navigation menu, choose Data sources.
-
In the Data sources page, from Index, select Edit.
-
In Edit index, choose to update index units provisioned from Number of units.
-
Select Update to save your changes.
