AbstractAWSQBusiness (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.qbusiness.AbstractAWSQBusiness

All Implemented Interfaces:

AWSQBusiness

Direct Known Subclasses:

AbstractAWSQBusinessAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSQBusiness
extends Object
implements AWSQBusiness
```
Abstract implementation of AWSQBusiness. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.qbusiness.AWSQBusiness
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchDeleteDocumentResult`	`batchDeleteDocument(BatchDeleteDocumentRequest request)` Asynchronously deletes one or more documents added using the `BatchPutDocument` API from an Amazon Q Business index.
`BatchPutDocumentResult`	`batchPutDocument(BatchPutDocumentRequest request)` Adds one or more documents to an Amazon Q Business index.
`ChatSyncResult`	`chatSync(ChatSyncRequest request)` Starts or continues a non-streaming Amazon Q Business conversation.
`CreateApplicationResult`	`createApplication(CreateApplicationRequest request)` Creates an Amazon Q Business application.
`CreateIndexResult`	`createIndex(CreateIndexRequest request)` Creates an Amazon Q Business index.
`CreatePluginResult`	`createPlugin(CreatePluginRequest request)` Creates an Amazon Q Business plugin.
`CreateRetrieverResult`	`createRetriever(CreateRetrieverRequest request)` Adds a retriever to your Amazon Q Business application.
`CreateUserResult`	`createUser(CreateUserRequest request)` Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
`CreateWebExperienceResult`	`createWebExperience(CreateWebExperienceRequest request)` Creates an Amazon Q Business web experience.
`DeleteApplicationResult`	`deleteApplication(DeleteApplicationRequest request)` Deletes an Amazon Q Business application.
`DeleteChatControlsConfigurationResult`	`deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest request)` Deletes chat controls configured for an existing Amazon Q Business application.
`DeleteConversationResult`	`deleteConversation(DeleteConversationRequest request)` Deletes an Amazon Q Business web experience conversation.
`DeleteDataSourceResult`	`deleteDataSource(DeleteDataSourceRequest request)` Deletes an Amazon Q Business data source connector.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest request)` 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 request)` Deletes an Amazon Q Business index.
`DeletePluginResult`	`deletePlugin(DeletePluginRequest request)` Deletes an Amazon Q Business plugin.
`DeleteRetrieverResult`	`deleteRetriever(DeleteRetrieverRequest request)` Deletes the retriever used by an Amazon Q Business application.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Deletes a user by email id.
`DeleteWebExperienceResult`	`deleteWebExperience(DeleteWebExperienceRequest request)` Deletes an Amazon Q Business web experience.
`GetApplicationResult`	`getApplication(GetApplicationRequest request)` 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 request)` Gets information about an chat controls configured for an existing Amazon Q Business application.
`GetDataSourceResult`	`getDataSource(GetDataSourceRequest request)` Gets information about an existing Amazon Q Business data source connector.
`GetGroupResult`	`getGroup(GetGroupRequest request)` Describes a group by group name.
`GetIndexResult`	`getIndex(GetIndexRequest request)` Gets information about an existing Amazon Q Business index.
`GetPluginResult`	`getPlugin(GetPluginRequest request)` Gets information about an existing Amazon Q Business plugin.
`GetRetrieverResult`	`getRetriever(GetRetrieverRequest request)` Gets information about an existing retriever used by an Amazon Q Business application.
`GetUserResult`	`getUser(GetUserRequest request)` Describes the universally unique identifier (UUID) associated with a local user in a data source.
`GetWebExperienceResult`	`getWebExperience(GetWebExperienceRequest request)` Gets information about an existing Amazon Q Business web experience.
`ListApplicationsResult`	`listApplications(ListApplicationsRequest request)` Lists Amazon Q Business applications.
`ListConversationsResult`	`listConversations(ListConversationsRequest request)` Lists one or more Amazon Q Business conversations.
`ListDataSourcesResult`	`listDataSources(ListDataSourcesRequest request)` Lists the Amazon Q Business data source connectors that you have created.
`ListDataSourceSyncJobsResult`	`listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)` Get information about an Amazon Q Business data source connector synchronization.
`ListDocumentsResult`	`listDocuments(ListDocumentsRequest request)` A list of documents attached to an index.
`ListGroupsResult`	`listGroups(ListGroupsRequest request)` Provides a list of groups that are mapped to users.
`ListIndicesResult`	`listIndices(ListIndicesRequest request)` Lists the Amazon Q Business indices you have created.
`ListMessagesResult`	`listMessages(ListMessagesRequest request)` Gets a list of messages associated with an Amazon Q Business web experience.
`ListPluginsResult`	`listPlugins(ListPluginsRequest request)` Lists configured Amazon Q Business plugins.
`ListRetrieversResult`	`listRetrievers(ListRetrieversRequest request)` Lists the retriever used by an Amazon Q Business application.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Gets a list of tags associated with a specified resource.
`ListWebExperiencesResult`	`listWebExperiences(ListWebExperiencesRequest request)` Lists one or more Amazon Q Business Web Experiences.
`PutFeedbackResult`	`putFeedback(PutFeedbackRequest request)` Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
`PutGroupResult`	`putGroup(PutGroupRequest request)` 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 request)` Starts a data source connector synchronization job.
`StopDataSourceSyncJobResult`	`stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)` Stops an Amazon Q Business data source connector synchronization job already in progress.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds the specified tag to the specified Amazon Q Business application or data source resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a tag from an Amazon Q Business application or a data source.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest request)` Updates an existing Amazon Q Business application.
`UpdateChatControlsConfigurationResult`	`updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest request)` Updates an set of chat controls configured for an existing Amazon Q Business application.
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest request)` Updates an existing Amazon Q Business data source connector.
`UpdateIndexResult`	`updateIndex(UpdateIndexRequest request)` Updates an Amazon Q Business index.
`UpdatePluginResult`	`updatePlugin(UpdatePluginRequest request)` Updates an Amazon Q Business plugin.
`UpdateRetrieverResult`	`updateRetriever(UpdateRetrieverRequest request)` Updates the retriever used for your Amazon Q Business application.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Updates a information associated with a user id.
`UpdateWebExperienceResult`	`updateWebExperience(UpdateWebExperienceRequest request)` Updates an Amazon Q Business web experience.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - batchDeleteDocument
```
public BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest request)
```
    Description copied from interface: AWSQBusiness
    
    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.
    
    Specified by:
    
    batchDeleteDocument in interface AWSQBusiness
    
    Returns:
    
    Result of the BatchDeleteDocument operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchPutDocument
```
public BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest request)
```
    Description copied from interface: AWSQBusiness
    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.
    Specified by:
    
    batchPutDocument in interface AWSQBusiness
    
    Returns:
    
    Result of the BatchPutDocument operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - chatSync
```
public ChatSyncResult chatSync(ChatSyncRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Starts or continues a non-streaming Amazon Q Business conversation.
    
    Specified by:
    
    chatSync in interface AWSQBusiness
    
    Returns:
    
    Result of the ChatSync operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createApplication
```
public CreateApplicationResult createApplication(CreateApplicationRequest request)
```
    Description copied from interface: AWSQBusiness
    
    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.
    
    Specified by:
    
    createApplication in interface AWSQBusiness
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createIndex
```
public CreateIndexResult createIndex(CreateIndexRequest request)
```
    Description copied from interface: AWSQBusiness
    
    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.
    
    Specified by:
    
    createIndex in interface AWSQBusiness
    
    Returns:
    
    Result of the CreateIndex operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPlugin
```
public CreatePluginResult createPlugin(CreatePluginRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Creates an Amazon Q Business plugin.
    
    Specified by:
    
    createPlugin in interface AWSQBusiness
    
    Returns:
    
    Result of the CreatePlugin operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRetriever
```
public CreateRetrieverResult createRetriever(CreateRetrieverRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Adds a retriever to your Amazon Q Business application.
    
    Specified by:
    
    createRetriever in interface AWSQBusiness
    
    Returns:
    
    Result of the CreateRetriever operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
    
    Specified by:
    
    createUser in interface AWSQBusiness
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWebExperience
```
public CreateWebExperienceResult createWebExperience(CreateWebExperienceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Creates an Amazon Q Business web experience.
    
    Specified by:
    
    createWebExperience in interface AWSQBusiness
    
    Returns:
    
    Result of the CreateWebExperience operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteApplication
```
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Deletes an Amazon Q Business application.
    
    Specified by:
    
    deleteApplication in interface AWSQBusiness
    
    Returns:
    
    Result of the DeleteApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteChatControlsConfiguration
```
public DeleteChatControlsConfigurationResult deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Deletes chat controls configured for an existing Amazon Q Business application.
    
    Specified by:
    
    deleteChatControlsConfiguration in interface AWSQBusiness
    
    Returns:
    
    Result of the DeleteChatControlsConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteConversation
```
public DeleteConversationResult deleteConversation(DeleteConversationRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Deletes an Amazon Q Business web experience conversation.
    
    Specified by:
    
    deleteConversation in interface AWSQBusiness
    
    Returns:
    
    Result of the DeleteConversation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataSource
```
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    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.
    
    Specified by:
    
    deleteDataSource in interface AWSQBusiness
    
    Returns:
    
    Result of the DeleteDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Description copied from interface: AWSQBusiness
    
    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.
    
    Specified by:
    
    deleteGroup in interface AWSQBusiness
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteIndex
```
public DeleteIndexResult deleteIndex(DeleteIndexRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Deletes an Amazon Q Business index.
    
    Specified by:
    
    deleteIndex in interface AWSQBusiness
    
    Returns:
    
    Result of the DeleteIndex operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePlugin
```
public DeletePluginResult deletePlugin(DeletePluginRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Deletes an Amazon Q Business plugin.
    
    Specified by:
    
    deletePlugin in interface AWSQBusiness
    
    Returns:
    
    Result of the DeletePlugin operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRetriever
```
public DeleteRetrieverResult deleteRetriever(DeleteRetrieverRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Deletes the retriever used by an Amazon Q Business application.
    
    Specified by:
    
    deleteRetriever in interface AWSQBusiness
    
    Returns:
    
    Result of the DeleteRetriever operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Deletes a user by email id.
    
    Specified by:
    
    deleteUser in interface AWSQBusiness
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWebExperience
```
public DeleteWebExperienceResult deleteWebExperience(DeleteWebExperienceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Deletes an Amazon Q Business web experience.
    
    Specified by:
    
    deleteWebExperience in interface AWSQBusiness
    
    Returns:
    
    Result of the DeleteWebExperience operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getApplication
```
public GetApplicationResult getApplication(GetApplicationRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Gets information about an existing Amazon Q Business application.
    
    Specified by:
    
    getApplication in interface AWSQBusiness
    
    Returns:
    
    Result of the GetApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getChatControlsConfiguration
```
public GetChatControlsConfigurationResult getChatControlsConfiguration(GetChatControlsConfigurationRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Gets information about an chat controls configured for an existing Amazon Q Business application.
    
    Specified by:
    
    getChatControlsConfiguration in interface AWSQBusiness
    
    Returns:
    
    Result of the GetChatControlsConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDataSource
```
public GetDataSourceResult getDataSource(GetDataSourceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Gets information about an existing Amazon Q Business data source connector.
    
    Specified by:
    
    getDataSource in interface AWSQBusiness
    
    Returns:
    
    Result of the GetDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getGroup
```
public GetGroupResult getGroup(GetGroupRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Describes a group by group name.
    
    Specified by:
    
    getGroup in interface AWSQBusiness
    
    Returns:
    
    Result of the GetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getIndex
```
public GetIndexResult getIndex(GetIndexRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Gets information about an existing Amazon Q Business index.
    
    Specified by:
    
    getIndex in interface AWSQBusiness
    
    Returns:
    
    Result of the GetIndex operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPlugin
```
public GetPluginResult getPlugin(GetPluginRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Gets information about an existing Amazon Q Business plugin.
    
    Specified by:
    
    getPlugin in interface AWSQBusiness
    
    Returns:
    
    Result of the GetPlugin operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRetriever
```
public GetRetrieverResult getRetriever(GetRetrieverRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Gets information about an existing retriever used by an Amazon Q Business application.
    
    Specified by:
    
    getRetriever in interface AWSQBusiness
    
    Returns:
    
    Result of the GetRetriever operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getUser
```
public GetUserResult getUser(GetUserRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Describes the universally unique identifier (UUID) associated with a local user in a data source.
    
    Specified by:
    
    getUser in interface AWSQBusiness
    
    Returns:
    
    Result of the GetUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getWebExperience
```
public GetWebExperienceResult getWebExperience(GetWebExperienceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Gets information about an existing Amazon Q Business web experience.
    
    Specified by:
    
    getWebExperience in interface AWSQBusiness
    
    Returns:
    
    Result of the GetWebExperience operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listApplications
```
public ListApplicationsResult listApplications(ListApplicationsRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Lists Amazon Q Business applications.
    
    Specified by:
    
    listApplications in interface AWSQBusiness
    
    Returns:
    
    Result of the ListApplications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConversations
```
public ListConversationsResult listConversations(ListConversationsRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Lists one or more Amazon Q Business conversations.
    
    Specified by:
    
    listConversations in interface AWSQBusiness
    
    Returns:
    
    Result of the ListConversations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDataSourceSyncJobs
```
public ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Get information about an Amazon Q Business data source connector synchronization.
    
    Specified by:
    
    listDataSourceSyncJobs in interface AWSQBusiness
    
    Returns:
    
    Result of the ListDataSourceSyncJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDataSources
```
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Lists the Amazon Q Business data source connectors that you have created.
    
    Specified by:
    
    listDataSources in interface AWSQBusiness
    
    Returns:
    
    Result of the ListDataSources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDocuments
```
public ListDocumentsResult listDocuments(ListDocumentsRequest request)
```
    Description copied from interface: AWSQBusiness
    
    A list of documents attached to an index.
    
    Specified by:
    
    listDocuments in interface AWSQBusiness
    
    Returns:
    
    Result of the ListDocuments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Provides a list of groups that are mapped to users.
    
    Specified by:
    
    listGroups in interface AWSQBusiness
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIndices
```
public ListIndicesResult listIndices(ListIndicesRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Lists the Amazon Q Business indices you have created.
    
    Specified by:
    
    listIndices in interface AWSQBusiness
    
    Returns:
    
    Result of the ListIndices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMessages
```
public ListMessagesResult listMessages(ListMessagesRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Gets a list of messages associated with an Amazon Q Business web experience.
    
    Specified by:
    
    listMessages in interface AWSQBusiness
    
    Returns:
    
    Result of the ListMessages operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPlugins
```
public ListPluginsResult listPlugins(ListPluginsRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Lists configured Amazon Q Business plugins.
    
    Specified by:
    
    listPlugins in interface AWSQBusiness
    
    Returns:
    
    Result of the ListPlugins operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRetrievers
```
public ListRetrieversResult listRetrievers(ListRetrieversRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Lists the retriever used by an Amazon Q Business application.
    
    Specified by:
    
    listRetrievers in interface AWSQBusiness
    
    Returns:
    
    Result of the ListRetrievers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
    
    Specified by:
    
    listTagsForResource in interface AWSQBusiness
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWebExperiences
```
public ListWebExperiencesResult listWebExperiences(ListWebExperiencesRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Lists one or more Amazon Q Business Web Experiences.
    
    Specified by:
    
    listWebExperiences in interface AWSQBusiness
    
    Returns:
    
    Result of the ListWebExperiences operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putFeedback
```
public PutFeedbackResult putFeedback(PutFeedbackRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
    
    Specified by:
    
    putFeedback in interface AWSQBusiness
    
    Returns:
    
    Result of the PutFeedback operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putGroup
```
public PutGroupResult putGroup(PutGroupRequest request)
```
    Description copied from interface: AWSQBusiness
    
    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.
    
    Specified by:
    
    putGroup in interface AWSQBusiness
    
    Returns:
    
    Result of the PutGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDataSourceSyncJob
```
public StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.
    
    Specified by:
    
    startDataSourceSyncJob in interface AWSQBusiness
    
    Returns:
    
    Result of the StartDataSourceSyncJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopDataSourceSyncJob
```
public StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Stops an Amazon Q Business data source connector synchronization job already in progress.
    
    Specified by:
    
    stopDataSourceSyncJob in interface AWSQBusiness
    
    Returns:
    
    Result of the StopDataSourceSyncJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    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.
    
    Specified by:
    
    tagResource in interface AWSQBusiness
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Removes a tag from an Amazon Q Business application or a data source.
    
    Specified by:
    
    untagResource in interface AWSQBusiness
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateApplication
```
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Updates an existing Amazon Q Business application.
    
    Specified by:
    
    updateApplication in interface AWSQBusiness
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateChatControlsConfiguration
```
public UpdateChatControlsConfigurationResult updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Updates an set of chat controls configured for an existing Amazon Q Business application.
    
    Specified by:
    
    updateChatControlsConfiguration in interface AWSQBusiness
    
    Returns:
    
    Result of the UpdateChatControlsConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataSource
```
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Updates an existing Amazon Q Business data source connector.
    
    Specified by:
    
    updateDataSource in interface AWSQBusiness
    
    Returns:
    
    Result of the UpdateDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateIndex
```
public UpdateIndexResult updateIndex(UpdateIndexRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Updates an Amazon Q Business index.
    
    Specified by:
    
    updateIndex in interface AWSQBusiness
    
    Returns:
    
    Result of the UpdateIndex operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePlugin
```
public UpdatePluginResult updatePlugin(UpdatePluginRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Updates an Amazon Q Business plugin.
    
    Specified by:
    
    updatePlugin in interface AWSQBusiness
    
    Returns:
    
    Result of the UpdatePlugin operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRetriever
```
public UpdateRetrieverResult updateRetriever(UpdateRetrieverRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Updates the retriever used for your Amazon Q Business application.
    
    Specified by:
    
    updateRetriever in interface AWSQBusiness
    
    Returns:
    
    Result of the UpdateRetriever operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Updates a information associated with a user id.
    
    Specified by:
    
    updateUser in interface AWSQBusiness
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateWebExperience
```
public UpdateWebExperienceResult updateWebExperience(UpdateWebExperienceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    Updates an Amazon Q Business web experience.
    
    Specified by:
    
    updateWebExperience in interface AWSQBusiness
    
    Returns:
    
    Result of the UpdateWebExperience operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSQBusiness
    
    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.
    
    Specified by:
    
    shutdown in interface AWSQBusiness
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSQBusiness
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSQBusiness
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.796

Class AbstractAWSQBusiness

Field Summary

Fields inherited from interface com.amazonaws.services.qbusiness.AWSQBusiness

Method Summary

Methods inherited from class java.lang.Object

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