QBusiness#
Client#
- class QBusiness.Client#
A low-level client representing QBusiness
Note
Amazon Q is in preview release and is subject to change.
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.
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.
You can use the following AWS SDKs to access Amazon Q Business APIs:
The following resources provide additional information about using the Amazon Q Business API:
client = session.create_client('qbusiness')
These are the available methods:
- batch_delete_document
- batch_put_document
- can_paginate
- chat_sync
- close
- 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_paginator
- get_plugin
- get_retriever
- get_user
- get_waiter
- 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
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: