

*********
QBusiness
*********



======
Client
======



.. py:class:: QBusiness.Client

  A low-level client representing QBusiness
  

  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 <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview>`__.

   

  For information about the IAM access control permissions you need to use this API, see `IAM roles for Amazon Q Business <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html>`__ in the *Amazon Q Business User Guide*.

   

  The following resources provide additional information about using the Amazon Q Business API:

   

  
  * `Setting up for Amazon Q Business <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html>`__
   
  * `Amazon Q Business CLI Reference <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html>`__
   
  * `Amazon Web Services General Reference <https://docs.aws.amazon.com/general/latest/gr/amazonq.html>`__
  

  ::

    
    import boto3
    
    client = boto3.client('qbusiness')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  qbusiness/client/associate_permission
  qbusiness/client/batch_delete_document
  qbusiness/client/batch_put_document
  qbusiness/client/can_paginate
  qbusiness/client/cancel_subscription
  qbusiness/client/chat_sync
  qbusiness/client/check_document_access
  qbusiness/client/close
  qbusiness/client/create_anonymous_web_experience_url
  qbusiness/client/create_application
  qbusiness/client/create_chat_response_configuration
  qbusiness/client/create_data_accessor
  qbusiness/client/create_data_source
  qbusiness/client/create_index
  qbusiness/client/create_plugin
  qbusiness/client/create_retriever
  qbusiness/client/create_subscription
  qbusiness/client/create_user
  qbusiness/client/create_web_experience
  qbusiness/client/delete_application
  qbusiness/client/delete_attachment
  qbusiness/client/delete_chat_controls_configuration
  qbusiness/client/delete_chat_response_configuration
  qbusiness/client/delete_conversation
  qbusiness/client/delete_data_accessor
  qbusiness/client/delete_data_source
  qbusiness/client/delete_group
  qbusiness/client/delete_index
  qbusiness/client/delete_plugin
  qbusiness/client/delete_retriever
  qbusiness/client/delete_user
  qbusiness/client/delete_web_experience
  qbusiness/client/disassociate_permission
  qbusiness/client/get_application
  qbusiness/client/get_chat_controls_configuration
  qbusiness/client/get_chat_response_configuration
  qbusiness/client/get_data_accessor
  qbusiness/client/get_data_source
  qbusiness/client/get_document_content
  qbusiness/client/get_group
  qbusiness/client/get_index
  qbusiness/client/get_media
  qbusiness/client/get_paginator
  qbusiness/client/get_plugin
  qbusiness/client/get_policy
  qbusiness/client/get_retriever
  qbusiness/client/get_user
  qbusiness/client/get_waiter
  qbusiness/client/get_web_experience
  qbusiness/client/list_applications
  qbusiness/client/list_attachments
  qbusiness/client/list_chat_response_configurations
  qbusiness/client/list_conversations
  qbusiness/client/list_data_accessors
  qbusiness/client/list_data_source_sync_jobs
  qbusiness/client/list_data_sources
  qbusiness/client/list_documents
  qbusiness/client/list_groups
  qbusiness/client/list_indices
  qbusiness/client/list_messages
  qbusiness/client/list_plugin_actions
  qbusiness/client/list_plugin_type_actions
  qbusiness/client/list_plugin_type_metadata
  qbusiness/client/list_plugins
  qbusiness/client/list_retrievers
  qbusiness/client/list_subscriptions
  qbusiness/client/list_tags_for_resource
  qbusiness/client/list_web_experiences
  qbusiness/client/put_feedback
  qbusiness/client/put_group
  qbusiness/client/search_relevant_content
  qbusiness/client/start_data_source_sync_job
  qbusiness/client/stop_data_source_sync_job
  qbusiness/client/tag_resource
  qbusiness/client/untag_resource
  qbusiness/client/update_application
  qbusiness/client/update_chat_controls_configuration
  qbusiness/client/update_chat_response_configuration
  qbusiness/client/update_data_accessor
  qbusiness/client/update_data_source
  qbusiness/client/update_index
  qbusiness/client/update_plugin
  qbusiness/client/update_retriever
  qbusiness/client/update_subscription
  qbusiness/client/update_user
  qbusiness/client/update_web_experience


==========
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 <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  qbusiness/paginator/GetChatControlsConfiguration
  qbusiness/paginator/ListApplications
  qbusiness/paginator/ListAttachments
  qbusiness/paginator/ListChatResponseConfigurations
  qbusiness/paginator/ListConversations
  qbusiness/paginator/ListDataAccessors
  qbusiness/paginator/ListDataSourceSyncJobs
  qbusiness/paginator/ListDataSources
  qbusiness/paginator/ListDocuments
  qbusiness/paginator/ListGroups
  qbusiness/paginator/ListIndices
  qbusiness/paginator/ListMessages
  qbusiness/paginator/ListPluginActions
  qbusiness/paginator/ListPluginTypeActions
  qbusiness/paginator/ListPluginTypeMetadata
  qbusiness/paginator/ListPlugins
  qbusiness/paginator/ListRetrievers
  qbusiness/paginator/ListSubscriptions
  qbusiness/paginator/ListWebExperiences
  qbusiness/paginator/SearchRelevantContent
