AWSQBusiness (AWS Java SDK for QBusiness 1.12.780 API)

All Known Subinterfaces:

AWSQBusinessAsync

All Known Implementing Classes:

AbstractAWSQBusiness, AbstractAWSQBusinessAsync, AWSQBusinessAsyncClient, AWSQBusinessClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSQBusiness
```
Interface for accessing QBusiness.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSQBusiness instead.

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.

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

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchDeleteDocumentResult`	`batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)` Asynchronously deletes one or more documents added using the `BatchPutDocument` API from an Amazon Q Business index.
`BatchPutDocumentResult`	`batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)` Adds one or more documents to an Amazon Q Business index.
`ChatSyncResult`	`chatSync(ChatSyncRequest chatSyncRequest)` Starts or continues a non-streaming Amazon Q Business conversation.
`CreateApplicationResult`	`createApplication(CreateApplicationRequest createApplicationRequest)` Creates an Amazon Q Business application.
`CreateIndexResult`	`createIndex(CreateIndexRequest createIndexRequest)` Creates an Amazon Q Business index.
`CreatePluginResult`	`createPlugin(CreatePluginRequest createPluginRequest)` Creates an Amazon Q Business plugin.
`CreateRetrieverResult`	`createRetriever(CreateRetrieverRequest createRetrieverRequest)` Adds a retriever to your Amazon Q Business application.
`CreateUserResult`	`createUser(CreateUserRequest createUserRequest)` Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
`CreateWebExperienceResult`	`createWebExperience(CreateWebExperienceRequest createWebExperienceRequest)` Creates an Amazon Q Business web experience.
`DeleteApplicationResult`	`deleteApplication(DeleteApplicationRequest deleteApplicationRequest)` Deletes an Amazon Q Business application.
`DeleteChatControlsConfigurationResult`	`deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest)` Deletes chat controls configured for an existing Amazon Q Business application.
`DeleteConversationResult`	`deleteConversation(DeleteConversationRequest deleteConversationRequest)` Deletes an Amazon Q Business web experience conversation.
`DeleteDataSourceResult`	`deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)` Deletes an Amazon Q Business data source connector.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest deleteGroupRequest)` 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.
`DeleteIndexResult`	`deleteIndex(DeleteIndexRequest deleteIndexRequest)` Deletes an Amazon Q Business index.
`DeletePluginResult`	`deletePlugin(DeletePluginRequest deletePluginRequest)` Deletes an Amazon Q Business plugin.
`DeleteRetrieverResult`	`deleteRetriever(DeleteRetrieverRequest deleteRetrieverRequest)` Deletes the retriever used by an Amazon Q Business application.
`DeleteUserResult`	`deleteUser(DeleteUserRequest deleteUserRequest)` Deletes a user by email id.
`DeleteWebExperienceResult`	`deleteWebExperience(DeleteWebExperienceRequest deleteWebExperienceRequest)` Deletes an Amazon Q Business web experience.
`GetApplicationResult`	`getApplication(GetApplicationRequest getApplicationRequest)` Gets information about an existing Amazon Q Business application.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetChatControlsConfigurationResult`	`getChatControlsConfiguration(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest)` Gets information about an chat controls configured for an existing Amazon Q Business application.
`GetDataSourceResult`	`getDataSource(GetDataSourceRequest getDataSourceRequest)` Gets information about an existing Amazon Q Business data source connector.
`GetGroupResult`	`getGroup(GetGroupRequest getGroupRequest)` Describes a group by group name.
`GetIndexResult`	`getIndex(GetIndexRequest getIndexRequest)` Gets information about an existing Amazon Q Business index.
`GetPluginResult`	`getPlugin(GetPluginRequest getPluginRequest)` Gets information about an existing Amazon Q Business plugin.
`GetRetrieverResult`	`getRetriever(GetRetrieverRequest getRetrieverRequest)` Gets information about an existing retriever used by an Amazon Q Business application.
`GetUserResult`	`getUser(GetUserRequest getUserRequest)` Describes the universally unique identifier (UUID) associated with a local user in a data source.
`GetWebExperienceResult`	`getWebExperience(GetWebExperienceRequest getWebExperienceRequest)` Gets information about an existing Amazon Q Business web experience.
`ListApplicationsResult`	`listApplications(ListApplicationsRequest listApplicationsRequest)` Lists Amazon Q Business applications.
`ListConversationsResult`	`listConversations(ListConversationsRequest listConversationsRequest)` Lists one or more Amazon Q Business conversations.
`ListDataSourcesResult`	`listDataSources(ListDataSourcesRequest listDataSourcesRequest)` Lists the Amazon Q Business data source connectors that you have created.
`ListDataSourceSyncJobsResult`	`listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)` Get information about an Amazon Q Business data source connector synchronization.
`ListDocumentsResult`	`listDocuments(ListDocumentsRequest listDocumentsRequest)` A list of documents attached to an index.
`ListGroupsResult`	`listGroups(ListGroupsRequest listGroupsRequest)` Provides a list of groups that are mapped to users.
`ListIndicesResult`	`listIndices(ListIndicesRequest listIndicesRequest)` Lists the Amazon Q Business indices you have created.
`ListMessagesResult`	`listMessages(ListMessagesRequest listMessagesRequest)` Gets a list of messages associated with an Amazon Q Business web experience.
`ListPluginsResult`	`listPlugins(ListPluginsRequest listPluginsRequest)` Lists configured Amazon Q Business plugins.
`ListRetrieversResult`	`listRetrievers(ListRetrieversRequest listRetrieversRequest)` Lists the retriever used by an Amazon Q Business application.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Gets a list of tags associated with a specified resource.
`ListWebExperiencesResult`	`listWebExperiences(ListWebExperiencesRequest listWebExperiencesRequest)` Lists one or more Amazon Q Business Web Experiences.
`PutFeedbackResult`	`putFeedback(PutFeedbackRequest putFeedbackRequest)` Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
`PutGroupResult`	`putGroup(PutGroupRequest putGroupRequest)` Create, or updates, a mapping of users—who have access to a document—to groups.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDataSourceSyncJobResult`	`startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)` Starts a data source connector synchronization job.
`StopDataSourceSyncJobResult`	`stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)` Stops an Amazon Q Business data source connector synchronization job already in progress.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds the specified tag to the specified Amazon Q Business application or data source resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes a tag from an Amazon Q Business application or a data source.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest updateApplicationRequest)` Updates an existing Amazon Q Business application.
`UpdateChatControlsConfigurationResult`	`updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest)` Updates an set of chat controls configured for an existing Amazon Q Business application.
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)` Updates an existing Amazon Q Business data source connector.
`UpdateIndexResult`	`updateIndex(UpdateIndexRequest updateIndexRequest)` Updates an Amazon Q Business index.
`UpdatePluginResult`	`updatePlugin(UpdatePluginRequest updatePluginRequest)` Updates an Amazon Q Business plugin.
`UpdateRetrieverResult`	`updateRetriever(UpdateRetrieverRequest updateRetrieverRequest)` Updates the retriever used for your Amazon Q Business application.
`UpdateUserResult`	`updateUser(UpdateUserRequest updateUserRequest)` Updates a information associated with a user id.
`UpdateWebExperienceResult`	`updateWebExperience(UpdateWebExperienceRequest updateWebExperienceRequest)` Updates an Amazon Q Business web experience.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchDeleteDocument
```
BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
```
    Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.
    
    You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
    
    Parameters:
    
    batchDeleteDocumentRequest -
    
    Returns:
    
    Result of the BatchDeleteDocument operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - batchPutDocument
```
BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
```
    Adds one or more documents to an Amazon Q Business index.
    
    You use this API to:
    - ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.
    - add custom attributes to documents in an Amazon Q Business index.
    - attach an access control list to the documents added to an Amazon Q Business index.
    You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
    Parameters:
    
    batchPutDocumentRequest -
    
    Returns:
    
    Result of the BatchPutDocument operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - chatSync
```
ChatSyncResult chatSync(ChatSyncRequest chatSyncRequest)
```
    Starts or continues a non-streaming Amazon Q Business conversation.
    
    Parameters:
    
    chatSyncRequest -
    
    Returns:
    
    Result of the ChatSync operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    LicenseNotFoundException - You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - createApplication
```
CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
```
    Creates an Amazon Q Business application.
    
    There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.
    
    Parameters:
    
    createApplicationRequest -
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - createIndex
```
CreateIndexResult createIndex(CreateIndexRequest createIndexRequest)
```
    Creates an Amazon Q Business index.
    
    To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.
    
    Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.
    
    Parameters:
    
    createIndexRequest -
    
    Returns:
    
    Result of the CreateIndex operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - createPlugin
```
CreatePluginResult createPlugin(CreatePluginRequest createPluginRequest)
```
    Creates an Amazon Q Business plugin.
    
    Parameters:
    
    createPluginRequest -
    
    Returns:
    
    Result of the CreatePlugin operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - createRetriever
```
CreateRetrieverResult createRetriever(CreateRetrieverRequest createRetrieverRequest)
```
    Adds a retriever to your Amazon Q Business application.
    
    Parameters:
    
    createRetrieverRequest -
    
    Returns:
    
    Result of the CreateRetriever operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
CreateUserResult createUser(CreateUserRequest createUserRequest)
```
    Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - createWebExperience
```
CreateWebExperienceResult createWebExperience(CreateWebExperienceRequest createWebExperienceRequest)
```
    Creates an Amazon Q Business web experience.
    
    Parameters:
    
    createWebExperienceRequest -
    
    Returns:
    
    Result of the CreateWebExperience operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - deleteApplication
```
DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
```
    Deletes an Amazon Q Business application.
    
    Parameters:
    
    deleteApplicationRequest -
    
    Returns:
    
    Result of the DeleteApplication operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteChatControlsConfiguration
```
DeleteChatControlsConfigurationResult deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest)
```
    Deletes chat controls configured for an existing Amazon Q Business application.
    
    Parameters:
    
    deleteChatControlsConfigurationRequest -
    
    Returns:
    
    Result of the DeleteChatControlsConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteConversation
```
DeleteConversationResult deleteConversation(DeleteConversationRequest deleteConversationRequest)
```
    Deletes an Amazon Q Business web experience conversation.
    
    Parameters:
    
    deleteConversationRequest -
    
    Returns:
    
    Result of the DeleteConversation operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    LicenseNotFoundException - You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteDataSource
```
DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
```
    Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.
    
    Parameters:
    
    deleteDataSourceRequest -
    
    Returns:
    
    Result of the DeleteDataSource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
```
    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. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results.
    
    If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.
    
    Parameters:
    
    deleteGroupRequest -
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteIndex
```
DeleteIndexResult deleteIndex(DeleteIndexRequest deleteIndexRequest)
```
    Deletes an Amazon Q Business index.
    
    Parameters:
    
    deleteIndexRequest -
    
    Returns:
    
    Result of the DeleteIndex operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - deletePlugin
```
DeletePluginResult deletePlugin(DeletePluginRequest deletePluginRequest)
```
    Deletes an Amazon Q Business plugin.
    
    Parameters:
    
    deletePluginRequest -
    
    Returns:
    
    Result of the DeletePlugin operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteRetriever
```
DeleteRetrieverResult deleteRetriever(DeleteRetrieverRequest deleteRetrieverRequest)
```
    Deletes the retriever used by an Amazon Q Business application.
    
    Parameters:
    
    deleteRetrieverRequest -
    
    Returns:
    
    Result of the DeleteRetriever operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    Deletes a user by email id.
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteWebExperience
```
DeleteWebExperienceResult deleteWebExperience(DeleteWebExperienceRequest deleteWebExperienceRequest)
```
    Deletes an Amazon Q Business web experience.
    
    Parameters:
    
    deleteWebExperienceRequest -
    
    Returns:
    
    Result of the DeleteWebExperience operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - getApplication
```
GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)
```
    Gets information about an existing Amazon Q Business application.
    
    Parameters:
    
    getApplicationRequest -
    
    Returns:
    
    Result of the GetApplication operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - getChatControlsConfiguration
```
GetChatControlsConfigurationResult getChatControlsConfiguration(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest)
```
    Gets information about an chat controls configured for an existing Amazon Q Business application.
    
    Parameters:
    
    getChatControlsConfigurationRequest -
    
    Returns:
    
    Result of the GetChatControlsConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - getDataSource
```
GetDataSourceResult getDataSource(GetDataSourceRequest getDataSourceRequest)
```
    Gets information about an existing Amazon Q Business data source connector.
    
    Parameters:
    
    getDataSourceRequest -
    
    Returns:
    
    Result of the GetDataSource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - getGroup
```
GetGroupResult getGroup(GetGroupRequest getGroupRequest)
```
    Describes a group by group name.
    
    Parameters:
    
    getGroupRequest -
    
    Returns:
    
    Result of the GetGroup operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - getIndex
```
GetIndexResult getIndex(GetIndexRequest getIndexRequest)
```
    Gets information about an existing Amazon Q Business index.
    
    Parameters:
    
    getIndexRequest -
    
    Returns:
    
    Result of the GetIndex operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - getPlugin
```
GetPluginResult getPlugin(GetPluginRequest getPluginRequest)
```
    Gets information about an existing Amazon Q Business plugin.
    
    Parameters:
    
    getPluginRequest -
    
    Returns:
    
    Result of the GetPlugin operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - getRetriever
```
GetRetrieverResult getRetriever(GetRetrieverRequest getRetrieverRequest)
```
    Gets information about an existing retriever used by an Amazon Q Business application.
    
    Parameters:
    
    getRetrieverRequest -
    
    Returns:
    
    Result of the GetRetriever operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - getUser
```
GetUserResult getUser(GetUserRequest getUserRequest)
```
    Describes the universally unique identifier (UUID) associated with a local user in a data source.
    
    Parameters:
    
    getUserRequest -
    
    Returns:
    
    Result of the GetUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - getWebExperience
```
GetWebExperienceResult getWebExperience(GetWebExperienceRequest getWebExperienceRequest)
```
    Gets information about an existing Amazon Q Business web experience.
    
    Parameters:
    
    getWebExperienceRequest -
    
    Returns:
    
    Result of the GetWebExperience operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listApplications
```
ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
```
    Lists Amazon Q Business applications.
    
    Parameters:
    
    listApplicationsRequest -
    
    Returns:
    
    Result of the ListApplications operation returned by the service.
    
    Throws:
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listConversations
```
ListConversationsResult listConversations(ListConversationsRequest listConversationsRequest)
```
    Lists one or more Amazon Q Business conversations.
    
    Parameters:
    
    listConversationsRequest -
    
    Returns:
    
    Result of the ListConversations operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    LicenseNotFoundException - You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listDataSourceSyncJobs
```
ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
```
    Get information about an Amazon Q Business data source connector synchronization.
    
    Parameters:
    
    listDataSourceSyncJobsRequest -
    
    Returns:
    
    Result of the ListDataSourceSyncJobs operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listDataSources
```
ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)
```
    Lists the Amazon Q Business data source connectors that you have created.
    
    Parameters:
    
    listDataSourcesRequest -
    
    Returns:
    
    Result of the ListDataSources operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listDocuments
```
ListDocumentsResult listDocuments(ListDocumentsRequest listDocumentsRequest)
```
    A list of documents attached to an index.
    
    Parameters:
    
    listDocumentsRequest -
    
    Returns:
    
    Result of the ListDocuments operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
```
    Provides a list of groups that are mapped to users.
    
    Parameters:
    
    listGroupsRequest -
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listIndices
```
ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest)
```
    Lists the Amazon Q Business indices you have created.
    
    Parameters:
    
    listIndicesRequest -
    
    Returns:
    
    Result of the ListIndices operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listMessages
```
ListMessagesResult listMessages(ListMessagesRequest listMessagesRequest)
```
    Gets a list of messages associated with an Amazon Q Business web experience.
    
    Parameters:
    
    listMessagesRequest -
    
    Returns:
    
    Result of the ListMessages operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    LicenseNotFoundException - You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listPlugins
```
ListPluginsResult listPlugins(ListPluginsRequest listPluginsRequest)
```
    Lists configured Amazon Q Business plugins.
    
    Parameters:
    
    listPluginsRequest -
    
    Returns:
    
    Result of the ListPlugins operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listRetrievers
```
ListRetrieversResult listRetrievers(ListRetrieversRequest listRetrieversRequest)
```
    Lists the retriever used by an Amazon Q Business application.
    
    Parameters:
    
    listRetrieversRequest -
    
    Returns:
    
    Result of the ListRetrievers operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - listWebExperiences
```
ListWebExperiencesResult listWebExperiences(ListWebExperiencesRequest listWebExperiencesRequest)
```
    Lists one or more Amazon Q Business Web Experiences.
    
    Parameters:
    
    listWebExperiencesRequest -
    
    Returns:
    
    Result of the ListWebExperiences operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - putFeedback
```
PutFeedbackResult putFeedback(PutFeedbackRequest putFeedbackRequest)
```
    Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
    
    Parameters:
    
    putFeedbackRequest -
    
    Returns:
    
    Result of the PutFeedback operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - putGroup
```
PutGroupResult putGroup(PutGroupRequest putGroupRequest)
```
    Create, or updates, a mapping of users—who have access to a document—to groups.
    
    You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.
    
    Parameters:
    
    putGroupRequest -
    
    Returns:
    
    Result of the PutGroup operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - startDataSourceSyncJob
```
StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
```
    Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.
    
    Parameters:
    
    startDataSourceSyncJobRequest -
    
    Returns:
    
    Result of the StartDataSourceSyncJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - stopDataSourceSyncJob
```
StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
```
    Stops an Amazon Q Business data source connector synchronization job already in progress.
    
    Parameters:
    
    stopDataSourceSyncJobRequest -
    
    Returns:
    
    Result of the StopDataSourceSyncJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes a tag from an Amazon Q Business application or a data source.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - updateApplication
```
UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
```
    Updates an existing Amazon Q Business application.
    
    Parameters:
    
    updateApplicationRequest -
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - updateChatControlsConfiguration
```
UpdateChatControlsConfigurationResult updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest)
```
    Updates an set of chat controls configured for an existing Amazon Q Business application.
    
    Parameters:
    
    updateChatControlsConfigurationRequest -
    
    Returns:
    
    Result of the UpdateChatControlsConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - updateDataSource
```
UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
```
    Updates an existing Amazon Q Business data source connector.
    
    Parameters:
    
    updateDataSourceRequest -
    
    Returns:
    
    Result of the UpdateDataSource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - updateIndex
```
UpdateIndexResult updateIndex(UpdateIndexRequest updateIndexRequest)
```
    Updates an Amazon Q Business index.
    
    Parameters:
    
    updateIndexRequest -
    
    Returns:
    
    Result of the UpdateIndex operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - updatePlugin
```
UpdatePluginResult updatePlugin(UpdatePluginRequest updatePluginRequest)
```
    Updates an Amazon Q Business plugin.
    
    Parameters:
    
    updatePluginRequest -
    
    Returns:
    
    Result of the UpdatePlugin operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - updateRetriever
```
UpdateRetrieverResult updateRetriever(UpdateRetrieverRequest updateRetrieverRequest)
```
    Updates the retriever used for your Amazon Q Business application.
    
    Parameters:
    
    updateRetrieverRequest -
    
    Returns:
    
    Result of the UpdateRetriever operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
```
    Updates a information associated with a user id.
    
    Parameters:
    
    updateUserRequest -
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Q Business service.
    
    See Also:
    
    AWS API Documentation
  - updateWebExperience
```
UpdateWebExperienceResult updateWebExperience(UpdateWebExperienceRequest updateWebExperienceRequest)
```
    Updates an Amazon Q Business web experience.
    
    Parameters:
    
    updateWebExperienceRequest -
    
    Returns:
    
    Result of the UpdateWebExperience operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
    
    InternalServerException - An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
    
    ConflictException - You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
    
    ThrottlingException - The request was denied due to throttling. Reduce the number of requests and try again.
    
    ValidationException - The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
    
    AccessDeniedException - You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSQBusiness

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchDeleteDocument

batchPutDocument

chatSync

createApplication

createIndex

createPlugin

createRetriever

createUser

createWebExperience

deleteApplication

deleteChatControlsConfiguration

deleteConversation

deleteDataSource

deleteGroup

deleteIndex

deletePlugin

deleteRetriever

deleteUser

deleteWebExperience

getApplication

getChatControlsConfiguration

getDataSource

getGroup

getIndex

getPlugin

getRetriever

getUser

getWebExperience

listApplications

listConversations

listDataSourceSyncJobs

listDataSources

listDocuments

listGroups

listIndices

listMessages

listPlugins

listRetrievers

listTagsForResource

listWebExperiences

putFeedback

putGroup

startDataSourceSyncJob

stopDataSourceSyncJob

tagResource

untagResource

updateApplication

updateChatControlsConfiguration

updateDataSource

updateIndex

updatePlugin

updateRetriever

updateUser

updateWebExperience

shutdown

getCachedResponseMetadata