Amazon Q Business - API References
Amazon Q Business is an AI-powered chat assistant that helps businesses boost employee productivity. It can answer questions, find information, write emails, summarize texts, and even brainstorm ideas.
Creating an Amazon Q Business Application
All Amazon Q Business application environment actions are supported both on the console and using APIs.
| API action | API description |
|---|---|
| CreateApplication | Creates an Amazon Q Business application |
| DeleteApplication | Deletes an Amazon Q Business application |
| GetApplication | Gets information about an existing Amazon Q Business application |
| ListApplications | Lists existing Amazon Q Business applications |
| UpdateApplication | Updates an existing Amazon Q Business application |
Creating Index
You can't create or manage indexes directly in the AWS Management Console for Amazon Q Business. When you create a retriever, the console automatically creates an index. The only thing you can do with indexes in the console is tag them.
| API action | API description |
|---|---|
| CreateIndex | Creates an Amazon Q Business index |
| DeleteIndex | Deletes an Amazon Q Business index |
| GetIndex | Gets information about an existing Amazon Q Business index |
| ListIndices | Lists existing Amazon Q Business indices |
| UpdateIndex | Updates an existing Amazon Q Business index |
Creating Retriever
Amazon Q Business supports retriever creation through both the console and the APIs.
| API action | API description |
|---|---|
| CreateRetriever | Creates an Amazon Q Business or Amazon Kendra retriever |
| DeleteRetriever | Deletes an Amazon Q Business or Amazon Kendra retriever |
| GetRetriever | Gets information about an existing Amazon Q Business or Amazon Kendra retriever |
| ListRetrievers | Lists existing Amazon Q Business or Amazon Kendra retrievers |
| UpdateRetriever | Updates an existing Amazon Q Business or Amazon Kendra retriever |
Connecting Data Source
Amazon Q Business supports data source connector configuration through both the console and the APIs.
| API action | API description |
|---|---|
| CreateDataSource | Creates an connects Amazon Q Business data source |
| DeleteDataSource | Deletes an Amazon Q Business data source |
| GetDataSource | Gets information about an existing Amazon Q Business data source |
| ListDataSources | Lists existing Amazon Q Business data sources |
| UpdateDataSource | Updates an existing Amazon Q Business data source |
| StartDataSourceSyncJobs | Starts an Amazon Q Business data source sync job |
| StopDataSourceSyncJobs | Stops an Amazon Q Business data source sync job |
| ListDataSourceSyncJobs | Lists data source sync jobs |
Upload Documents Directly
Amazon Q Business supports direct document uploads into an Amazon Q Business index using both the console and the APIs.
| API action | API description |
|---|---|
| BatchPutDocument | Adds one or more documents to an Amazon Q Business index |
| BatchDeleteDocument | Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index |
Creating a Web Experience
If you use the console to create your Amazon Q Business application, a web experience is created automatically and connected to your chosen data source.
| API action | API description |
|---|---|
| CreateWebExperience | Creates an Amazon Q Business web experience |
| DeleteWebExperience | Deletes an Amazon Q Business web experience |
| GetWebExperience | Gets information about an Amazon Q Business web experience |
| ListWebExperiences | Lists Amazon Q Business web experiences |
| UpdateWebExperience | Updates an Amazon Q Business web experience |
Chat and Conversation Management
Chatting in an Amazon Q Business web experience preview and a deployed Amazon Q Business web experience uses the following API operations.
| API action | API description |
|---|---|
| Chat | Starts or continues a streaming Amazon Q Business conversation |
| ChatSync | Starts or continues a non-streaming Amazon Q Business conversation |
| DeleteConversation | Deletes an Amazon Q Business web experience conversation |
| ListConversations | Lists conversations in an Amazon Q Business web experience |
| ListMessages | Lists messages in an Amazon Q Business web experience |
User and Group Management
Amazon Q Business offers APIs to manage users and groups, which are automatically invoked when setting up a data source connector connection. These APIs can also be used to create a custom user and group management solution when building an Amazon Q Business application environment programmatically.
| API action | API description |
|---|---|
| CreateUser | Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application |
| GetUser | Describes the universally unique identifier (UUID) associated with a local user in a data source |
| UpdateUser | Updates information associated with a user id |
| PutGroup | Creates, or updates, a mapping of users to groups |
| DeleteGroup | Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group |
| GetGroup | Describes a group by group name |
| ListGroups | Provides a list of groups that are mapped to users |
Plugins
Amazon Q Business supports plugin creation through both the console and the APIs.
| API action | API description |
|---|---|
| CreatePlugin | Creates an Amazon Q Business plugin |
| DeletePlugin | Deletes an Amazon Q Business plugin |
| GetPlugin | Gets information about an existing Amazon Q Business plugin |
| UpdatePlugin | Updates an Amazon Q Business plugin |
Admin Controls and Guardrails
Amazon Q Business supports admin controls and guardrails configuration through both the console and the APIs.
| API action | API description |
|---|---|
| UpdateChatControlsConfiguration | Updates an set of chat controls configured for an existing Amazon Q Business application |
| DeletePlugin | Deletes an Amazon Q Business plugin |
| DeleteChatControlsConfiguration | Deletes chat controls configured for an existing Amazon Q Business application |
| GetChatControlsConfiguration | Gets information about chat controls configured for an existing Amazon Q Business application. |
User Feedback
Amazon Q Business captures end user feedback to chat responses to help address any technical issues. You can't configure this feature using the console.
| API action | API description |
|---|---|
| PutFeedback | Enables your end user to provide feedback on their Amazon Q Business generated chat responses. |