@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSQBusinessAsync extends AWSQBusiness
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSQBusinessAsync
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.
You can use the following AWS SDKs to access Amazon Q Business APIs:
The following resources provide additional information about using the Amazon Q Business API:
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<BatchDeleteDocumentResult> |
batchDeleteDocumentAsync(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
Asynchronously deletes one or more documents added using the
BatchPutDocument API from an Amazon Q
Business index. |
Future<BatchDeleteDocumentResult> |
batchDeleteDocumentAsync(BatchDeleteDocumentRequest batchDeleteDocumentRequest,
AsyncHandler<BatchDeleteDocumentRequest,BatchDeleteDocumentResult> asyncHandler)
Asynchronously deletes one or more documents added using the
BatchPutDocument API from an Amazon Q
Business index. |
Future<BatchPutDocumentResult> |
batchPutDocumentAsync(BatchPutDocumentRequest batchPutDocumentRequest)
Adds one or more documents to an Amazon Q Business index.
|
Future<BatchPutDocumentResult> |
batchPutDocumentAsync(BatchPutDocumentRequest batchPutDocumentRequest,
AsyncHandler<BatchPutDocumentRequest,BatchPutDocumentResult> asyncHandler)
Adds one or more documents to an Amazon Q Business index.
|
Future<ChatSyncResult> |
chatSyncAsync(ChatSyncRequest chatSyncRequest)
Starts or continues a non-streaming Amazon Q Business conversation.
|
Future<ChatSyncResult> |
chatSyncAsync(ChatSyncRequest chatSyncRequest,
AsyncHandler<ChatSyncRequest,ChatSyncResult> asyncHandler)
Starts or continues a non-streaming Amazon Q Business conversation.
|
Future<CreateApplicationResult> |
createApplicationAsync(CreateApplicationRequest createApplicationRequest)
Creates an Amazon Q Business application.
|
Future<CreateApplicationResult> |
createApplicationAsync(CreateApplicationRequest createApplicationRequest,
AsyncHandler<CreateApplicationRequest,CreateApplicationResult> asyncHandler)
Creates an Amazon Q Business application.
|
Future<CreateIndexResult> |
createIndexAsync(CreateIndexRequest createIndexRequest)
Creates an Amazon Q Business index.
|
Future<CreateIndexResult> |
createIndexAsync(CreateIndexRequest createIndexRequest,
AsyncHandler<CreateIndexRequest,CreateIndexResult> asyncHandler)
Creates an Amazon Q Business index.
|
Future<CreatePluginResult> |
createPluginAsync(CreatePluginRequest createPluginRequest)
Creates an Amazon Q Business plugin.
|
Future<CreatePluginResult> |
createPluginAsync(CreatePluginRequest createPluginRequest,
AsyncHandler<CreatePluginRequest,CreatePluginResult> asyncHandler)
Creates an Amazon Q Business plugin.
|
Future<CreateRetrieverResult> |
createRetrieverAsync(CreateRetrieverRequest createRetrieverRequest)
Adds a retriever to your Amazon Q Business application.
|
Future<CreateRetrieverResult> |
createRetrieverAsync(CreateRetrieverRequest createRetrieverRequest,
AsyncHandler<CreateRetrieverRequest,CreateRetrieverResult> asyncHandler)
Adds a retriever to your Amazon Q Business application.
|
Future<CreateUserResult> |
createUserAsync(CreateUserRequest createUserRequest)
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
|
Future<CreateUserResult> |
createUserAsync(CreateUserRequest createUserRequest,
AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
|
Future<CreateWebExperienceResult> |
createWebExperienceAsync(CreateWebExperienceRequest createWebExperienceRequest)
Creates an Amazon Q Business web experience.
|
Future<CreateWebExperienceResult> |
createWebExperienceAsync(CreateWebExperienceRequest createWebExperienceRequest,
AsyncHandler<CreateWebExperienceRequest,CreateWebExperienceResult> asyncHandler)
Creates an Amazon Q Business web experience.
|
Future<DeleteApplicationResult> |
deleteApplicationAsync(DeleteApplicationRequest deleteApplicationRequest)
Deletes an Amazon Q Business application.
|
Future<DeleteApplicationResult> |
deleteApplicationAsync(DeleteApplicationRequest deleteApplicationRequest,
AsyncHandler<DeleteApplicationRequest,DeleteApplicationResult> asyncHandler)
Deletes an Amazon Q Business application.
|
Future<DeleteChatControlsConfigurationResult> |
deleteChatControlsConfigurationAsync(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest)
Deletes chat controls configured for an existing Amazon Q Business application.
|
Future<DeleteChatControlsConfigurationResult> |
deleteChatControlsConfigurationAsync(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest,
AsyncHandler<DeleteChatControlsConfigurationRequest,DeleteChatControlsConfigurationResult> asyncHandler)
Deletes chat controls configured for an existing Amazon Q Business application.
|
Future<DeleteConversationResult> |
deleteConversationAsync(DeleteConversationRequest deleteConversationRequest)
Deletes an Amazon Q Business web experience conversation.
|
Future<DeleteConversationResult> |
deleteConversationAsync(DeleteConversationRequest deleteConversationRequest,
AsyncHandler<DeleteConversationRequest,DeleteConversationResult> asyncHandler)
Deletes an Amazon Q Business web experience conversation.
|
Future<DeleteDataSourceResult> |
deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes an Amazon Q Business data source connector.
|
Future<DeleteDataSourceResult> |
deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest,
AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
Deletes an Amazon Q Business data source connector.
|
Future<DeleteGroupResult> |
deleteGroupAsync(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.
|
Future<DeleteGroupResult> |
deleteGroupAsync(DeleteGroupRequest deleteGroupRequest,
AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
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.
|
Future<DeleteIndexResult> |
deleteIndexAsync(DeleteIndexRequest deleteIndexRequest)
Deletes an Amazon Q Business index.
|
Future<DeleteIndexResult> |
deleteIndexAsync(DeleteIndexRequest deleteIndexRequest,
AsyncHandler<DeleteIndexRequest,DeleteIndexResult> asyncHandler)
Deletes an Amazon Q Business index.
|
Future<DeletePluginResult> |
deletePluginAsync(DeletePluginRequest deletePluginRequest)
Deletes an Amazon Q Business plugin.
|
Future<DeletePluginResult> |
deletePluginAsync(DeletePluginRequest deletePluginRequest,
AsyncHandler<DeletePluginRequest,DeletePluginResult> asyncHandler)
Deletes an Amazon Q Business plugin.
|
Future<DeleteRetrieverResult> |
deleteRetrieverAsync(DeleteRetrieverRequest deleteRetrieverRequest)
Deletes the retriever used by an Amazon Q Business application.
|
Future<DeleteRetrieverResult> |
deleteRetrieverAsync(DeleteRetrieverRequest deleteRetrieverRequest,
AsyncHandler<DeleteRetrieverRequest,DeleteRetrieverResult> asyncHandler)
Deletes the retriever used by an Amazon Q Business application.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest deleteUserRequest)
Deletes a user by email id.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest deleteUserRequest,
AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes a user by email id.
|
Future<DeleteWebExperienceResult> |
deleteWebExperienceAsync(DeleteWebExperienceRequest deleteWebExperienceRequest)
Deletes an Amazon Q Business web experience.
|
Future<DeleteWebExperienceResult> |
deleteWebExperienceAsync(DeleteWebExperienceRequest deleteWebExperienceRequest,
AsyncHandler<DeleteWebExperienceRequest,DeleteWebExperienceResult> asyncHandler)
Deletes an Amazon Q Business web experience.
|
Future<GetApplicationResult> |
getApplicationAsync(GetApplicationRequest getApplicationRequest)
Gets information about an existing Amazon Q Business application.
|
Future<GetApplicationResult> |
getApplicationAsync(GetApplicationRequest getApplicationRequest,
AsyncHandler<GetApplicationRequest,GetApplicationResult> asyncHandler)
Gets information about an existing Amazon Q Business application.
|
Future<GetChatControlsConfigurationResult> |
getChatControlsConfigurationAsync(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest)
Gets information about an chat controls configured for an existing Amazon Q Business application.
|
Future<GetChatControlsConfigurationResult> |
getChatControlsConfigurationAsync(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest,
AsyncHandler<GetChatControlsConfigurationRequest,GetChatControlsConfigurationResult> asyncHandler)
Gets information about an chat controls configured for an existing Amazon Q Business application.
|
Future<GetDataSourceResult> |
getDataSourceAsync(GetDataSourceRequest getDataSourceRequest)
Gets information about an existing Amazon Q Business data source connector.
|
Future<GetDataSourceResult> |
getDataSourceAsync(GetDataSourceRequest getDataSourceRequest,
AsyncHandler<GetDataSourceRequest,GetDataSourceResult> asyncHandler)
Gets information about an existing Amazon Q Business data source connector.
|
Future<GetGroupResult> |
getGroupAsync(GetGroupRequest getGroupRequest)
Describes a group by group name.
|
Future<GetGroupResult> |
getGroupAsync(GetGroupRequest getGroupRequest,
AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
Describes a group by group name.
|
Future<GetIndexResult> |
getIndexAsync(GetIndexRequest getIndexRequest)
Gets information about an existing Amazon Q Business index.
|
Future<GetIndexResult> |
getIndexAsync(GetIndexRequest getIndexRequest,
AsyncHandler<GetIndexRequest,GetIndexResult> asyncHandler)
Gets information about an existing Amazon Q Business index.
|
Future<GetPluginResult> |
getPluginAsync(GetPluginRequest getPluginRequest)
Gets information about an existing Amazon Q Business plugin.
|
Future<GetPluginResult> |
getPluginAsync(GetPluginRequest getPluginRequest,
AsyncHandler<GetPluginRequest,GetPluginResult> asyncHandler)
Gets information about an existing Amazon Q Business plugin.
|
Future<GetRetrieverResult> |
getRetrieverAsync(GetRetrieverRequest getRetrieverRequest)
Gets information about an existing retriever used by an Amazon Q Business application.
|
Future<GetRetrieverResult> |
getRetrieverAsync(GetRetrieverRequest getRetrieverRequest,
AsyncHandler<GetRetrieverRequest,GetRetrieverResult> asyncHandler)
Gets information about an existing retriever used by an Amazon Q Business application.
|
Future<GetUserResult> |
getUserAsync(GetUserRequest getUserRequest)
Describes the universally unique identifier (UUID) associated with a local user in a data source.
|
Future<GetUserResult> |
getUserAsync(GetUserRequest getUserRequest,
AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)
Describes the universally unique identifier (UUID) associated with a local user in a data source.
|
Future<GetWebExperienceResult> |
getWebExperienceAsync(GetWebExperienceRequest getWebExperienceRequest)
Gets information about an existing Amazon Q Business web experience.
|
Future<GetWebExperienceResult> |
getWebExperienceAsync(GetWebExperienceRequest getWebExperienceRequest,
AsyncHandler<GetWebExperienceRequest,GetWebExperienceResult> asyncHandler)
Gets information about an existing Amazon Q Business web experience.
|
Future<ListApplicationsResult> |
listApplicationsAsync(ListApplicationsRequest listApplicationsRequest)
Lists Amazon Q Business applications.
|
Future<ListApplicationsResult> |
listApplicationsAsync(ListApplicationsRequest listApplicationsRequest,
AsyncHandler<ListApplicationsRequest,ListApplicationsResult> asyncHandler)
Lists Amazon Q Business applications.
|
Future<ListConversationsResult> |
listConversationsAsync(ListConversationsRequest listConversationsRequest)
Lists one or more Amazon Q Business conversations.
|
Future<ListConversationsResult> |
listConversationsAsync(ListConversationsRequest listConversationsRequest,
AsyncHandler<ListConversationsRequest,ListConversationsResult> asyncHandler)
Lists one or more Amazon Q Business conversations.
|
Future<ListDataSourcesResult> |
listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest)
Lists the Amazon Q Business data source connectors that you have created.
|
Future<ListDataSourcesResult> |
listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest,
AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
Lists the Amazon Q Business data source connectors that you have created.
|
Future<ListDataSourceSyncJobsResult> |
listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Get information about an Amazon Q Business data source connector synchronization.
|
Future<ListDataSourceSyncJobsResult> |
listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest,
AsyncHandler<ListDataSourceSyncJobsRequest,ListDataSourceSyncJobsResult> asyncHandler)
Get information about an Amazon Q Business data source connector synchronization.
|
Future<ListDocumentsResult> |
listDocumentsAsync(ListDocumentsRequest listDocumentsRequest)
A list of documents attached to an index.
|
Future<ListDocumentsResult> |
listDocumentsAsync(ListDocumentsRequest listDocumentsRequest,
AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
A list of documents attached to an index.
|
Future<ListGroupsResult> |
listGroupsAsync(ListGroupsRequest listGroupsRequest)
Provides a list of groups that are mapped to users.
|
Future<ListGroupsResult> |
listGroupsAsync(ListGroupsRequest listGroupsRequest,
AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Provides a list of groups that are mapped to users.
|
Future<ListIndicesResult> |
listIndicesAsync(ListIndicesRequest listIndicesRequest)
Lists the Amazon Q Business indices you have created.
|
Future<ListIndicesResult> |
listIndicesAsync(ListIndicesRequest listIndicesRequest,
AsyncHandler<ListIndicesRequest,ListIndicesResult> asyncHandler)
Lists the Amazon Q Business indices you have created.
|
Future<ListMessagesResult> |
listMessagesAsync(ListMessagesRequest listMessagesRequest)
Gets a list of messages associated with an Amazon Q Business web experience.
|
Future<ListMessagesResult> |
listMessagesAsync(ListMessagesRequest listMessagesRequest,
AsyncHandler<ListMessagesRequest,ListMessagesResult> asyncHandler)
Gets a list of messages associated with an Amazon Q Business web experience.
|
Future<ListPluginsResult> |
listPluginsAsync(ListPluginsRequest listPluginsRequest)
Lists configured Amazon Q Business plugins.
|
Future<ListPluginsResult> |
listPluginsAsync(ListPluginsRequest listPluginsRequest,
AsyncHandler<ListPluginsRequest,ListPluginsResult> asyncHandler)
Lists configured Amazon Q Business plugins.
|
Future<ListRetrieversResult> |
listRetrieversAsync(ListRetrieversRequest listRetrieversRequest)
Lists the retriever used by an Amazon Q Business application.
|
Future<ListRetrieversResult> |
listRetrieversAsync(ListRetrieversRequest listRetrieversRequest,
AsyncHandler<ListRetrieversRequest,ListRetrieversResult> asyncHandler)
Lists the retriever used by an Amazon Q Business application.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Gets a list of tags associated with a specified resource.
|
Future<ListWebExperiencesResult> |
listWebExperiencesAsync(ListWebExperiencesRequest listWebExperiencesRequest)
Lists one or more Amazon Q Business Web Experiences.
|
Future<ListWebExperiencesResult> |
listWebExperiencesAsync(ListWebExperiencesRequest listWebExperiencesRequest,
AsyncHandler<ListWebExperiencesRequest,ListWebExperiencesResult> asyncHandler)
Lists one or more Amazon Q Business Web Experiences.
|
Future<PutFeedbackResult> |
putFeedbackAsync(PutFeedbackRequest putFeedbackRequest)
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
|
Future<PutFeedbackResult> |
putFeedbackAsync(PutFeedbackRequest putFeedbackRequest,
AsyncHandler<PutFeedbackRequest,PutFeedbackResult> asyncHandler)
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
|
Future<PutGroupResult> |
putGroupAsync(PutGroupRequest putGroupRequest)
Create, or updates, a mapping of users—who have access to a document—to groups.
|
Future<PutGroupResult> |
putGroupAsync(PutGroupRequest putGroupRequest,
AsyncHandler<PutGroupRequest,PutGroupResult> asyncHandler)
Create, or updates, a mapping of users—who have access to a document—to groups.
|
Future<StartDataSourceSyncJobResult> |
startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a data source connector synchronization job.
|
Future<StartDataSourceSyncJobResult> |
startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest,
AsyncHandler<StartDataSourceSyncJobRequest,StartDataSourceSyncJobResult> asyncHandler)
Starts a data source connector synchronization job.
|
Future<StopDataSourceSyncJobResult> |
stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops an Amazon Q Business data source connector synchronization job already in progress.
|
Future<StopDataSourceSyncJobResult> |
stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest,
AsyncHandler<StopDataSourceSyncJobRequest,StopDataSourceSyncJobResult> asyncHandler)
Stops an Amazon Q Business data source connector synchronization job already in progress.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds the specified tag to the specified Amazon Q Business application or data source resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds the specified tag to the specified Amazon Q Business application or data source resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag from an Amazon Q Business application or a data source.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag from an Amazon Q Business application or a data source.
|
Future<UpdateApplicationResult> |
updateApplicationAsync(UpdateApplicationRequest updateApplicationRequest)
Updates an existing Amazon Q Business application.
|
Future<UpdateApplicationResult> |
updateApplicationAsync(UpdateApplicationRequest updateApplicationRequest,
AsyncHandler<UpdateApplicationRequest,UpdateApplicationResult> asyncHandler)
Updates an existing Amazon Q Business application.
|
Future<UpdateChatControlsConfigurationResult> |
updateChatControlsConfigurationAsync(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest)
Updates an set of chat controls configured for an existing Amazon Q Business application.
|
Future<UpdateChatControlsConfigurationResult> |
updateChatControlsConfigurationAsync(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest,
AsyncHandler<UpdateChatControlsConfigurationRequest,UpdateChatControlsConfigurationResult> asyncHandler)
Updates an set of chat controls configured for an existing Amazon Q Business application.
|
Future<UpdateDataSourceResult> |
updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Q Business data source connector.
|
Future<UpdateDataSourceResult> |
updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest,
AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
Updates an existing Amazon Q Business data source connector.
|
Future<UpdateIndexResult> |
updateIndexAsync(UpdateIndexRequest updateIndexRequest)
Updates an Amazon Q Business index.
|
Future<UpdateIndexResult> |
updateIndexAsync(UpdateIndexRequest updateIndexRequest,
AsyncHandler<UpdateIndexRequest,UpdateIndexResult> asyncHandler)
Updates an Amazon Q Business index.
|
Future<UpdatePluginResult> |
updatePluginAsync(UpdatePluginRequest updatePluginRequest)
Updates an Amazon Q Business plugin.
|
Future<UpdatePluginResult> |
updatePluginAsync(UpdatePluginRequest updatePluginRequest,
AsyncHandler<UpdatePluginRequest,UpdatePluginResult> asyncHandler)
Updates an Amazon Q Business plugin.
|
Future<UpdateRetrieverResult> |
updateRetrieverAsync(UpdateRetrieverRequest updateRetrieverRequest)
Updates the retriever used for your Amazon Q Business application.
|
Future<UpdateRetrieverResult> |
updateRetrieverAsync(UpdateRetrieverRequest updateRetrieverRequest,
AsyncHandler<UpdateRetrieverRequest,UpdateRetrieverResult> asyncHandler)
Updates the retriever used for your Amazon Q Business application.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest updateUserRequest)
Updates a information associated with a user id.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest updateUserRequest,
AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Updates a information associated with a user id.
|
Future<UpdateWebExperienceResult> |
updateWebExperienceAsync(UpdateWebExperienceRequest updateWebExperienceRequest)
Updates an Amazon Q Business web experience.
|
Future<UpdateWebExperienceResult> |
updateWebExperienceAsync(UpdateWebExperienceRequest updateWebExperienceRequest,
AsyncHandler<UpdateWebExperienceRequest,UpdateWebExperienceResult> asyncHandler)
Updates an Amazon Q Business web experience.
|
batchDeleteDocument, batchPutDocument, chatSync, createApplication, createIndex, createPlugin, createRetriever, createUser, createWebExperience, deleteApplication, deleteChatControlsConfiguration, deleteConversation, deleteDataSource, deleteGroup, deleteIndex, deletePlugin, deleteRetriever, deleteUser, deleteWebExperience, getApplication, getCachedResponseMetadata, getChatControlsConfiguration, getDataSource, getGroup, getIndex, getPlugin, getRetriever, getUser, getWebExperience, listApplications, listConversations, listDataSources, listDataSourceSyncJobs, listDocuments, listGroups, listIndices, listMessages, listPlugins, listRetrievers, listTagsForResource, listWebExperiences, putFeedback, putGroup, shutdown, startDataSourceSyncJob, stopDataSourceSyncJob, tagResource, untagResource, updateApplication, updateChatControlsConfiguration, updateDataSource, updateIndex, updatePlugin, updateRetriever, updateUser, updateWebExperience
Future<BatchDeleteDocumentResult> batchDeleteDocumentAsync(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.
batchDeleteDocumentRequest
- Future<BatchDeleteDocumentResult> batchDeleteDocumentAsync(BatchDeleteDocumentRequest batchDeleteDocumentRequest, AsyncHandler<BatchDeleteDocumentRequest,BatchDeleteDocumentResult> asyncHandler)
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.
batchDeleteDocumentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchPutDocumentResult> batchPutDocumentAsync(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.
batchPutDocumentRequest
- Future<BatchPutDocumentResult> batchPutDocumentAsync(BatchPutDocumentRequest batchPutDocumentRequest, AsyncHandler<BatchPutDocumentRequest,BatchPutDocumentResult> asyncHandler)
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.
batchPutDocumentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ChatSyncResult> chatSyncAsync(ChatSyncRequest chatSyncRequest)
Starts or continues a non-streaming Amazon Q Business conversation.
chatSyncRequest
- Future<ChatSyncResult> chatSyncAsync(ChatSyncRequest chatSyncRequest, AsyncHandler<ChatSyncRequest,ChatSyncResult> asyncHandler)
Starts or continues a non-streaming Amazon Q Business conversation.
chatSyncRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateApplicationResult> createApplicationAsync(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.
createApplicationRequest
- Future<CreateApplicationResult> createApplicationAsync(CreateApplicationRequest createApplicationRequest, AsyncHandler<CreateApplicationRequest,CreateApplicationResult> asyncHandler)
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.
createApplicationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateIndexResult> createIndexAsync(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.
createIndexRequest
- Future<CreateIndexResult> createIndexAsync(CreateIndexRequest createIndexRequest, AsyncHandler<CreateIndexRequest,CreateIndexResult> asyncHandler)
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.
createIndexRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePluginResult> createPluginAsync(CreatePluginRequest createPluginRequest)
Creates an Amazon Q Business plugin.
createPluginRequest
- Future<CreatePluginResult> createPluginAsync(CreatePluginRequest createPluginRequest, AsyncHandler<CreatePluginRequest,CreatePluginResult> asyncHandler)
Creates an Amazon Q Business plugin.
createPluginRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateRetrieverResult> createRetrieverAsync(CreateRetrieverRequest createRetrieverRequest)
Adds a retriever to your Amazon Q Business application.
createRetrieverRequest
- Future<CreateRetrieverResult> createRetrieverAsync(CreateRetrieverRequest createRetrieverRequest, AsyncHandler<CreateRetrieverRequest,CreateRetrieverResult> asyncHandler)
Adds a retriever to your Amazon Q Business application.
createRetrieverRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest)
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
createUserRequest
- Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
createUserRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateWebExperienceResult> createWebExperienceAsync(CreateWebExperienceRequest createWebExperienceRequest)
Creates an Amazon Q Business web experience.
createWebExperienceRequest
- Future<CreateWebExperienceResult> createWebExperienceAsync(CreateWebExperienceRequest createWebExperienceRequest, AsyncHandler<CreateWebExperienceRequest,CreateWebExperienceResult> asyncHandler)
Creates an Amazon Q Business web experience.
createWebExperienceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest deleteApplicationRequest)
Deletes an Amazon Q Business application.
deleteApplicationRequest
- Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest deleteApplicationRequest, AsyncHandler<DeleteApplicationRequest,DeleteApplicationResult> asyncHandler)
Deletes an Amazon Q Business application.
deleteApplicationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChatControlsConfigurationResult> deleteChatControlsConfigurationAsync(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest)
Deletes chat controls configured for an existing Amazon Q Business application.
deleteChatControlsConfigurationRequest
- Future<DeleteChatControlsConfigurationResult> deleteChatControlsConfigurationAsync(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest, AsyncHandler<DeleteChatControlsConfigurationRequest,DeleteChatControlsConfigurationResult> asyncHandler)
Deletes chat controls configured for an existing Amazon Q Business application.
deleteChatControlsConfigurationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteConversationResult> deleteConversationAsync(DeleteConversationRequest deleteConversationRequest)
Deletes an Amazon Q Business web experience conversation.
deleteConversationRequest
- Future<DeleteConversationResult> deleteConversationAsync(DeleteConversationRequest deleteConversationRequest, AsyncHandler<DeleteConversationRequest,DeleteConversationResult> asyncHandler)
Deletes an Amazon Q Business web experience conversation.
deleteConversationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDataSourceResult> deleteDataSourceAsync(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
.
deleteDataSourceRequest
- Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
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
.
deleteDataSourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteGroupResult> deleteGroupAsync(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
.
deleteGroupRequest
- Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
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
.
deleteGroupRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteIndexResult> deleteIndexAsync(DeleteIndexRequest deleteIndexRequest)
Deletes an Amazon Q Business index.
deleteIndexRequest
- Future<DeleteIndexResult> deleteIndexAsync(DeleteIndexRequest deleteIndexRequest, AsyncHandler<DeleteIndexRequest,DeleteIndexResult> asyncHandler)
Deletes an Amazon Q Business index.
deleteIndexRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeletePluginResult> deletePluginAsync(DeletePluginRequest deletePluginRequest)
Deletes an Amazon Q Business plugin.
deletePluginRequest
- Future<DeletePluginResult> deletePluginAsync(DeletePluginRequest deletePluginRequest, AsyncHandler<DeletePluginRequest,DeletePluginResult> asyncHandler)
Deletes an Amazon Q Business plugin.
deletePluginRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRetrieverResult> deleteRetrieverAsync(DeleteRetrieverRequest deleteRetrieverRequest)
Deletes the retriever used by an Amazon Q Business application.
deleteRetrieverRequest
- Future<DeleteRetrieverResult> deleteRetrieverAsync(DeleteRetrieverRequest deleteRetrieverRequest, AsyncHandler<DeleteRetrieverRequest,DeleteRetrieverResult> asyncHandler)
Deletes the retriever used by an Amazon Q Business application.
deleteRetrieverRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
Deletes a user by email id.
deleteUserRequest
- Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes a user by email id.
deleteUserRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteWebExperienceResult> deleteWebExperienceAsync(DeleteWebExperienceRequest deleteWebExperienceRequest)
Deletes an Amazon Q Business web experience.
deleteWebExperienceRequest
- Future<DeleteWebExperienceResult> deleteWebExperienceAsync(DeleteWebExperienceRequest deleteWebExperienceRequest, AsyncHandler<DeleteWebExperienceRequest,DeleteWebExperienceResult> asyncHandler)
Deletes an Amazon Q Business web experience.
deleteWebExperienceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest getApplicationRequest)
Gets information about an existing Amazon Q Business application.
getApplicationRequest
- Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest getApplicationRequest, AsyncHandler<GetApplicationRequest,GetApplicationResult> asyncHandler)
Gets information about an existing Amazon Q Business application.
getApplicationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetChatControlsConfigurationResult> getChatControlsConfigurationAsync(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest)
Gets information about an chat controls configured for an existing Amazon Q Business application.
getChatControlsConfigurationRequest
- Future<GetChatControlsConfigurationResult> getChatControlsConfigurationAsync(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest, AsyncHandler<GetChatControlsConfigurationRequest,GetChatControlsConfigurationResult> asyncHandler)
Gets information about an chat controls configured for an existing Amazon Q Business application.
getChatControlsConfigurationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDataSourceResult> getDataSourceAsync(GetDataSourceRequest getDataSourceRequest)
Gets information about an existing Amazon Q Business data source connector.
getDataSourceRequest
- Future<GetDataSourceResult> getDataSourceAsync(GetDataSourceRequest getDataSourceRequest, AsyncHandler<GetDataSourceRequest,GetDataSourceResult> asyncHandler)
Gets information about an existing Amazon Q Business data source connector.
getDataSourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest)
Describes a group by group name.
getGroupRequest
- Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
Describes a group by group name.
getGroupRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIndexResult> getIndexAsync(GetIndexRequest getIndexRequest)
Gets information about an existing Amazon Q Business index.
getIndexRequest
- Future<GetIndexResult> getIndexAsync(GetIndexRequest getIndexRequest, AsyncHandler<GetIndexRequest,GetIndexResult> asyncHandler)
Gets information about an existing Amazon Q Business index.
getIndexRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPluginResult> getPluginAsync(GetPluginRequest getPluginRequest)
Gets information about an existing Amazon Q Business plugin.
getPluginRequest
- Future<GetPluginResult> getPluginAsync(GetPluginRequest getPluginRequest, AsyncHandler<GetPluginRequest,GetPluginResult> asyncHandler)
Gets information about an existing Amazon Q Business plugin.
getPluginRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRetrieverResult> getRetrieverAsync(GetRetrieverRequest getRetrieverRequest)
Gets information about an existing retriever used by an Amazon Q Business application.
getRetrieverRequest
- Future<GetRetrieverResult> getRetrieverAsync(GetRetrieverRequest getRetrieverRequest, AsyncHandler<GetRetrieverRequest,GetRetrieverResult> asyncHandler)
Gets information about an existing retriever used by an Amazon Q Business application.
getRetrieverRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest)
Describes the universally unique identifier (UUID) associated with a local user in a data source.
getUserRequest
- Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)
Describes the universally unique identifier (UUID) associated with a local user in a data source.
getUserRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetWebExperienceResult> getWebExperienceAsync(GetWebExperienceRequest getWebExperienceRequest)
Gets information about an existing Amazon Q Business web experience.
getWebExperienceRequest
- Future<GetWebExperienceResult> getWebExperienceAsync(GetWebExperienceRequest getWebExperienceRequest, AsyncHandler<GetWebExperienceRequest,GetWebExperienceResult> asyncHandler)
Gets information about an existing Amazon Q Business web experience.
getWebExperienceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest listApplicationsRequest)
Lists Amazon Q Business applications.
listApplicationsRequest
- Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest listApplicationsRequest, AsyncHandler<ListApplicationsRequest,ListApplicationsResult> asyncHandler)
Lists Amazon Q Business applications.
listApplicationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListConversationsResult> listConversationsAsync(ListConversationsRequest listConversationsRequest)
Lists one or more Amazon Q Business conversations.
listConversationsRequest
- Future<ListConversationsResult> listConversationsAsync(ListConversationsRequest listConversationsRequest, AsyncHandler<ListConversationsRequest,ListConversationsResult> asyncHandler)
Lists one or more Amazon Q Business conversations.
listConversationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Get information about an Amazon Q Business data source connector synchronization.
listDataSourceSyncJobsRequest
- Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest, AsyncHandler<ListDataSourceSyncJobsRequest,ListDataSourceSyncJobsResult> asyncHandler)
Get information about an Amazon Q Business data source connector synchronization.
listDataSourceSyncJobsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest)
Lists the Amazon Q Business data source connectors that you have created.
listDataSourcesRequest
- Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
Lists the Amazon Q Business data source connectors that you have created.
listDataSourcesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest listDocumentsRequest)
A list of documents attached to an index.
listDocumentsRequest
- Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest listDocumentsRequest, AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
A list of documents attached to an index.
listDocumentsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest)
Provides a list of groups that are mapped to users.
listGroupsRequest
- Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Provides a list of groups that are mapped to users.
listGroupsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest listIndicesRequest)
Lists the Amazon Q Business indices you have created.
listIndicesRequest
- Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest listIndicesRequest, AsyncHandler<ListIndicesRequest,ListIndicesResult> asyncHandler)
Lists the Amazon Q Business indices you have created.
listIndicesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMessagesResult> listMessagesAsync(ListMessagesRequest listMessagesRequest)
Gets a list of messages associated with an Amazon Q Business web experience.
listMessagesRequest
- Future<ListMessagesResult> listMessagesAsync(ListMessagesRequest listMessagesRequest, AsyncHandler<ListMessagesRequest,ListMessagesResult> asyncHandler)
Gets a list of messages associated with an Amazon Q Business web experience.
listMessagesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPluginsResult> listPluginsAsync(ListPluginsRequest listPluginsRequest)
Lists configured Amazon Q Business plugins.
listPluginsRequest
- Future<ListPluginsResult> listPluginsAsync(ListPluginsRequest listPluginsRequest, AsyncHandler<ListPluginsRequest,ListPluginsResult> asyncHandler)
Lists configured Amazon Q Business plugins.
listPluginsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListRetrieversResult> listRetrieversAsync(ListRetrieversRequest listRetrieversRequest)
Lists the retriever used by an Amazon Q Business application.
listRetrieversRequest
- Future<ListRetrieversResult> listRetrieversAsync(ListRetrieversRequest listRetrieversRequest, AsyncHandler<ListRetrieversRequest,ListRetrieversResult> asyncHandler)
Lists the retriever used by an Amazon Q Business application.
listRetrieversRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(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.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
listTagsForResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListWebExperiencesResult> listWebExperiencesAsync(ListWebExperiencesRequest listWebExperiencesRequest)
Lists one or more Amazon Q Business Web Experiences.
listWebExperiencesRequest
- Future<ListWebExperiencesResult> listWebExperiencesAsync(ListWebExperiencesRequest listWebExperiencesRequest, AsyncHandler<ListWebExperiencesRequest,ListWebExperiencesResult> asyncHandler)
Lists one or more Amazon Q Business Web Experiences.
listWebExperiencesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutFeedbackResult> putFeedbackAsync(PutFeedbackRequest putFeedbackRequest)
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
putFeedbackRequest
- Future<PutFeedbackResult> putFeedbackAsync(PutFeedbackRequest putFeedbackRequest, AsyncHandler<PutFeedbackRequest,PutFeedbackResult> asyncHandler)
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
putFeedbackRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutGroupResult> putGroupAsync(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.
putGroupRequest
- Future<PutGroupResult> putGroupAsync(PutGroupRequest putGroupRequest, AsyncHandler<PutGroupRequest,PutGroupResult> asyncHandler)
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.
putGroupRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartDataSourceSyncJobResult> startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q
Business returns a ConflictException
.
startDataSourceSyncJobRequest
- Future<StartDataSourceSyncJobResult> startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest, AsyncHandler<StartDataSourceSyncJobRequest,StartDataSourceSyncJobResult> asyncHandler)
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q
Business returns a ConflictException
.
startDataSourceSyncJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops an Amazon Q Business data source connector synchronization job already in progress.
stopDataSourceSyncJobRequest
- Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest, AsyncHandler<StopDataSourceSyncJobRequest,StopDataSourceSyncJobResult> asyncHandler)
Stops an Amazon Q Business data source connector synchronization job already in progress.
stopDataSourceSyncJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(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.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag from an Amazon Q Business application or a data source.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag from an Amazon Q Business application or a data source.
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest updateApplicationRequest)
Updates an existing Amazon Q Business application.
updateApplicationRequest
- Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest updateApplicationRequest, AsyncHandler<UpdateApplicationRequest,UpdateApplicationResult> asyncHandler)
Updates an existing Amazon Q Business application.
updateApplicationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateChatControlsConfigurationResult> updateChatControlsConfigurationAsync(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest)
Updates an set of chat controls configured for an existing Amazon Q Business application.
updateChatControlsConfigurationRequest
- Future<UpdateChatControlsConfigurationResult> updateChatControlsConfigurationAsync(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest, AsyncHandler<UpdateChatControlsConfigurationRequest,UpdateChatControlsConfigurationResult> asyncHandler)
Updates an set of chat controls configured for an existing Amazon Q Business application.
updateChatControlsConfigurationRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Q Business data source connector.
updateDataSourceRequest
- Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
Updates an existing Amazon Q Business data source connector.
updateDataSourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest updateIndexRequest)
Updates an Amazon Q Business index.
updateIndexRequest
- Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest updateIndexRequest, AsyncHandler<UpdateIndexRequest,UpdateIndexResult> asyncHandler)
Updates an Amazon Q Business index.
updateIndexRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdatePluginResult> updatePluginAsync(UpdatePluginRequest updatePluginRequest)
Updates an Amazon Q Business plugin.
updatePluginRequest
- Future<UpdatePluginResult> updatePluginAsync(UpdatePluginRequest updatePluginRequest, AsyncHandler<UpdatePluginRequest,UpdatePluginResult> asyncHandler)
Updates an Amazon Q Business plugin.
updatePluginRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateRetrieverResult> updateRetrieverAsync(UpdateRetrieverRequest updateRetrieverRequest)
Updates the retriever used for your Amazon Q Business application.
updateRetrieverRequest
- Future<UpdateRetrieverResult> updateRetrieverAsync(UpdateRetrieverRequest updateRetrieverRequest, AsyncHandler<UpdateRetrieverRequest,UpdateRetrieverResult> asyncHandler)
Updates the retriever used for your Amazon Q Business application.
updateRetrieverRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest)
Updates a information associated with a user id.
updateUserRequest
- Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Updates a information associated with a user id.
updateUserRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateWebExperienceResult> updateWebExperienceAsync(UpdateWebExperienceRequest updateWebExperienceRequest)
Updates an Amazon Q Business web experience.
updateWebExperienceRequest
- Future<UpdateWebExperienceResult> updateWebExperienceAsync(UpdateWebExperienceRequest updateWebExperienceRequest, AsyncHandler<UpdateWebExperienceRequest,UpdateWebExperienceResult> asyncHandler)
Updates an Amazon Q Business web experience.
updateWebExperienceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.