[ aws ]
qbusiness¶
Description¶
This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the ` Amazon Q Business User Guide https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html`__ .
For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations .
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide .
The following resources provide additional information about using the Amazon Q Business API:
Available Commands¶
- batch-delete-document
- batch-put-document
- chat-sync
- create-application
- create-data-source
- create-index
- create-plugin
- create-retriever
- create-user
- create-web-experience
- delete-application
- delete-chat-controls-configuration
- delete-conversation
- delete-data-source
- delete-group
- delete-index
- delete-plugin
- delete-retriever
- delete-user
- delete-web-experience
- get-application
- get-chat-controls-configuration
- get-data-source
- get-group
- get-index
- get-plugin
- get-retriever
- get-user
- get-web-experience
- list-applications
- list-conversations
- list-data-source-sync-jobs
- list-data-sources
- list-documents
- list-groups
- list-indices
- list-messages
- list-plugins
- list-retrievers
- list-tags-for-resource
- list-web-experiences
- put-feedback
- put-group
- start-data-source-sync-job
- stop-data-source-sync-job
- tag-resource
- untag-resource
- update-application
- update-chat-controls-configuration
- update-data-source
- update-index
- update-plugin
- update-retriever
- update-user
- update-web-experience