@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSQBusinessAsyncClient extends AWSQBusinessClient implements AWSQBusinessAsync
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
Amazon Q is in preview release and is subject to change.
This is the Amazon Q (for business use) API Reference. Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q 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 and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q (for business use) Developer Guide .
For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q in the Amazon Q (for business use) Developer Guide.
You can use the following AWS SDKs to access Amazon Q APIs:
The following resources provide additional information about using the Amazon Q API:
configFactoryclient, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIXbatchDeleteDocument, batchPutDocument, builder, 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, startDataSourceSyncJob, stopDataSourceSyncJob, tagResource, untagResource, updateApplication, updateChatControlsConfiguration, updateDataSource, updateIndex, updatePlugin, updateRetriever, updateUser, updateWebExperienceaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbatchDeleteDocument, 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, startDataSourceSyncJob, stopDataSourceSyncJob, tagResource, untagResource, updateApplication, updateChatControlsConfiguration, updateDataSource, updateIndex, updatePlugin, updateRetriever, updateUser, updateWebExperiencepublic static AWSQBusinessAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<BatchDeleteDocumentResult> batchDeleteDocumentAsync(BatchDeleteDocumentRequest request)
AWSQBusinessAsync
Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q
index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
batchDeleteDocumentAsync in interface AWSQBusinessAsyncpublic Future<BatchDeleteDocumentResult> batchDeleteDocumentAsync(BatchDeleteDocumentRequest request, AsyncHandler<BatchDeleteDocumentRequest,BatchDeleteDocumentResult> asyncHandler)
AWSQBusinessAsync
Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q
index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
batchDeleteDocumentAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<BatchPutDocumentResult> batchPutDocumentAsync(BatchPutDocumentRequest request)
AWSQBusinessAsyncAdds one or more documents to an Amazon Q index.
You use this API to:
ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q index.
add custom attributes to documents in an Amazon Q index.
attach an access control list to the documents added to an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
batchPutDocumentAsync in interface AWSQBusinessAsyncpublic Future<BatchPutDocumentResult> batchPutDocumentAsync(BatchPutDocumentRequest request, AsyncHandler<BatchPutDocumentRequest,BatchPutDocumentResult> asyncHandler)
AWSQBusinessAsyncAdds one or more documents to an Amazon Q index.
You use this API to:
ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q index.
add custom attributes to documents in an Amazon Q index.
attach an access control list to the documents added to an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
batchPutDocumentAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ChatSyncResult> chatSyncAsync(ChatSyncRequest request)
AWSQBusinessAsyncStarts or continues a non-streaming Amazon Q conversation.
chatSyncAsync in interface AWSQBusinessAsyncpublic Future<ChatSyncResult> chatSyncAsync(ChatSyncRequest request, AsyncHandler<ChatSyncRequest,ChatSyncResult> asyncHandler)
AWSQBusinessAsyncStarts or continues a non-streaming Amazon Q conversation.
chatSyncAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<CreateApplicationResult> createApplicationAsync(CreateApplicationRequest request)
AWSQBusinessAsyncCreates an Amazon Q application.
createApplicationAsync in interface AWSQBusinessAsyncpublic Future<CreateApplicationResult> createApplicationAsync(CreateApplicationRequest request, AsyncHandler<CreateApplicationRequest,CreateApplicationResult> asyncHandler)
AWSQBusinessAsyncCreates an Amazon Q application.
createApplicationAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<CreateIndexResult> createIndexAsync(CreateIndexRequest request)
AWSQBusinessAsyncCreates an Amazon Q 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.
createIndexAsync in interface AWSQBusinessAsyncpublic Future<CreateIndexResult> createIndexAsync(CreateIndexRequest request, AsyncHandler<CreateIndexRequest,CreateIndexResult> asyncHandler)
AWSQBusinessAsyncCreates an Amazon Q 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.
createIndexAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<CreatePluginResult> createPluginAsync(CreatePluginRequest request)
AWSQBusinessAsyncCreates an Amazon Q plugin.
createPluginAsync in interface AWSQBusinessAsyncpublic Future<CreatePluginResult> createPluginAsync(CreatePluginRequest request, AsyncHandler<CreatePluginRequest,CreatePluginResult> asyncHandler)
AWSQBusinessAsyncCreates an Amazon Q plugin.
createPluginAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<CreateRetrieverResult> createRetrieverAsync(CreateRetrieverRequest request)
AWSQBusinessAsyncAdds a retriever to your Amazon Q application.
createRetrieverAsync in interface AWSQBusinessAsyncpublic Future<CreateRetrieverResult> createRetrieverAsync(CreateRetrieverRequest request, AsyncHandler<CreateRetrieverRequest,CreateRetrieverResult> asyncHandler)
AWSQBusinessAsyncAdds a retriever to your Amazon Q application.
createRetrieverAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<CreateUserResult> createUserAsync(CreateUserRequest request)
AWSQBusinessAsyncCreates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
createUserAsync in interface AWSQBusinessAsyncpublic Future<CreateUserResult> createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
AWSQBusinessAsyncCreates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
createUserAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<CreateWebExperienceResult> createWebExperienceAsync(CreateWebExperienceRequest request)
AWSQBusinessAsyncCreates an Amazon Q web experience.
createWebExperienceAsync in interface AWSQBusinessAsyncpublic Future<CreateWebExperienceResult> createWebExperienceAsync(CreateWebExperienceRequest request, AsyncHandler<CreateWebExperienceRequest,CreateWebExperienceResult> asyncHandler)
AWSQBusinessAsyncCreates an Amazon Q web experience.
createWebExperienceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest request)
AWSQBusinessAsyncDeletes an Amazon Q application.
deleteApplicationAsync in interface AWSQBusinessAsyncpublic Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest request, AsyncHandler<DeleteApplicationRequest,DeleteApplicationResult> asyncHandler)
AWSQBusinessAsyncDeletes an Amazon Q application.
deleteApplicationAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeleteChatControlsConfigurationResult> deleteChatControlsConfigurationAsync(DeleteChatControlsConfigurationRequest request)
AWSQBusinessAsyncDeletes chat controls configured for an existing Amazon Q application.
deleteChatControlsConfigurationAsync in interface AWSQBusinessAsyncpublic Future<DeleteChatControlsConfigurationResult> deleteChatControlsConfigurationAsync(DeleteChatControlsConfigurationRequest request, AsyncHandler<DeleteChatControlsConfigurationRequest,DeleteChatControlsConfigurationResult> asyncHandler)
AWSQBusinessAsyncDeletes chat controls configured for an existing Amazon Q application.
deleteChatControlsConfigurationAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeleteConversationResult> deleteConversationAsync(DeleteConversationRequest request)
AWSQBusinessAsyncDeletes an Amazon Q web experience conversation.
deleteConversationAsync in interface AWSQBusinessAsyncpublic Future<DeleteConversationResult> deleteConversationAsync(DeleteConversationRequest request, AsyncHandler<DeleteConversationRequest,DeleteConversationResult> asyncHandler)
AWSQBusinessAsyncDeletes an Amazon Q web experience conversation.
deleteConversationAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest request)
AWSQBusinessAsync
Deletes an Amazon Q 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.
deleteDataSourceAsync in interface AWSQBusinessAsyncpublic Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
AWSQBusinessAsync
Deletes an Amazon Q 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.
deleteDataSourceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)
AWSQBusinessAsyncDeletes 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.
deleteGroupAsync in interface AWSQBusinessAsyncpublic Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AWSQBusinessAsyncDeletes 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.
deleteGroupAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeleteIndexResult> deleteIndexAsync(DeleteIndexRequest request)
AWSQBusinessAsyncDeletes an Amazon Q index.
deleteIndexAsync in interface AWSQBusinessAsyncpublic Future<DeleteIndexResult> deleteIndexAsync(DeleteIndexRequest request, AsyncHandler<DeleteIndexRequest,DeleteIndexResult> asyncHandler)
AWSQBusinessAsyncDeletes an Amazon Q index.
deleteIndexAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeletePluginResult> deletePluginAsync(DeletePluginRequest request)
AWSQBusinessAsyncDeletes an Amazon Q plugin.
deletePluginAsync in interface AWSQBusinessAsyncpublic Future<DeletePluginResult> deletePluginAsync(DeletePluginRequest request, AsyncHandler<DeletePluginRequest,DeletePluginResult> asyncHandler)
AWSQBusinessAsyncDeletes an Amazon Q plugin.
deletePluginAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeleteRetrieverResult> deleteRetrieverAsync(DeleteRetrieverRequest request)
AWSQBusinessAsyncDeletes the retriever used by an Amazon Q application.
deleteRetrieverAsync in interface AWSQBusinessAsyncpublic Future<DeleteRetrieverResult> deleteRetrieverAsync(DeleteRetrieverRequest request, AsyncHandler<DeleteRetrieverRequest,DeleteRetrieverResult> asyncHandler)
AWSQBusinessAsyncDeletes the retriever used by an Amazon Q application.
deleteRetrieverAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AWSQBusinessAsyncDeletes a user by email id.
deleteUserAsync in interface AWSQBusinessAsyncpublic Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AWSQBusinessAsyncDeletes a user by email id.
deleteUserAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<DeleteWebExperienceResult> deleteWebExperienceAsync(DeleteWebExperienceRequest request)
AWSQBusinessAsyncDeletes an Amazon Q web experience.
deleteWebExperienceAsync in interface AWSQBusinessAsyncpublic Future<DeleteWebExperienceResult> deleteWebExperienceAsync(DeleteWebExperienceRequest request, AsyncHandler<DeleteWebExperienceRequest,DeleteWebExperienceResult> asyncHandler)
AWSQBusinessAsyncDeletes an Amazon Q web experience.
deleteWebExperienceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest request)
AWSQBusinessAsyncGets information about an existing Amazon Q application.
getApplicationAsync in interface AWSQBusinessAsyncpublic Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest request, AsyncHandler<GetApplicationRequest,GetApplicationResult> asyncHandler)
AWSQBusinessAsyncGets information about an existing Amazon Q application.
getApplicationAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<GetChatControlsConfigurationResult> getChatControlsConfigurationAsync(GetChatControlsConfigurationRequest request)
AWSQBusinessAsyncGets information about an chat controls configured for an existing Amazon Q application.
getChatControlsConfigurationAsync in interface AWSQBusinessAsyncpublic Future<GetChatControlsConfigurationResult> getChatControlsConfigurationAsync(GetChatControlsConfigurationRequest request, AsyncHandler<GetChatControlsConfigurationRequest,GetChatControlsConfigurationResult> asyncHandler)
AWSQBusinessAsyncGets information about an chat controls configured for an existing Amazon Q application.
getChatControlsConfigurationAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<GetDataSourceResult> getDataSourceAsync(GetDataSourceRequest request)
AWSQBusinessAsyncGets information about an existing Amazon Q data source connector.
getDataSourceAsync in interface AWSQBusinessAsyncpublic Future<GetDataSourceResult> getDataSourceAsync(GetDataSourceRequest request, AsyncHandler<GetDataSourceRequest,GetDataSourceResult> asyncHandler)
AWSQBusinessAsyncGets information about an existing Amazon Q data source connector.
getDataSourceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<GetGroupResult> getGroupAsync(GetGroupRequest request)
AWSQBusinessAsyncDescribes a group by group name.
getGroupAsync in interface AWSQBusinessAsyncpublic Future<GetGroupResult> getGroupAsync(GetGroupRequest request, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
AWSQBusinessAsyncDescribes a group by group name.
getGroupAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<GetIndexResult> getIndexAsync(GetIndexRequest request)
AWSQBusinessAsyncGets information about an existing Amazon Q index.
getIndexAsync in interface AWSQBusinessAsyncpublic Future<GetIndexResult> getIndexAsync(GetIndexRequest request, AsyncHandler<GetIndexRequest,GetIndexResult> asyncHandler)
AWSQBusinessAsyncGets information about an existing Amazon Q index.
getIndexAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<GetPluginResult> getPluginAsync(GetPluginRequest request)
AWSQBusinessAsyncGets information about an existing Amazon Q plugin.
getPluginAsync in interface AWSQBusinessAsyncpublic Future<GetPluginResult> getPluginAsync(GetPluginRequest request, AsyncHandler<GetPluginRequest,GetPluginResult> asyncHandler)
AWSQBusinessAsyncGets information about an existing Amazon Q plugin.
getPluginAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<GetRetrieverResult> getRetrieverAsync(GetRetrieverRequest request)
AWSQBusinessAsyncGets information about an existing retriever used by an Amazon Q application.
getRetrieverAsync in interface AWSQBusinessAsyncpublic Future<GetRetrieverResult> getRetrieverAsync(GetRetrieverRequest request, AsyncHandler<GetRetrieverRequest,GetRetrieverResult> asyncHandler)
AWSQBusinessAsyncGets information about an existing retriever used by an Amazon Q application.
getRetrieverAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<GetUserResult> getUserAsync(GetUserRequest request)
AWSQBusinessAsyncDescribes the universally unique identifier (UUID) associated with a local user in a data source.
getUserAsync in interface AWSQBusinessAsyncpublic Future<GetUserResult> getUserAsync(GetUserRequest request, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)
AWSQBusinessAsyncDescribes the universally unique identifier (UUID) associated with a local user in a data source.
getUserAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<GetWebExperienceResult> getWebExperienceAsync(GetWebExperienceRequest request)
AWSQBusinessAsyncGets information about an existing Amazon Q web experience.
getWebExperienceAsync in interface AWSQBusinessAsyncpublic Future<GetWebExperienceResult> getWebExperienceAsync(GetWebExperienceRequest request, AsyncHandler<GetWebExperienceRequest,GetWebExperienceResult> asyncHandler)
AWSQBusinessAsyncGets information about an existing Amazon Q web experience.
getWebExperienceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest request)
AWSQBusinessAsyncLists Amazon Q applications.
listApplicationsAsync in interface AWSQBusinessAsyncpublic Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest request, AsyncHandler<ListApplicationsRequest,ListApplicationsResult> asyncHandler)
AWSQBusinessAsyncLists Amazon Q applications.
listApplicationsAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListConversationsResult> listConversationsAsync(ListConversationsRequest request)
AWSQBusinessAsyncLists one or more Amazon Q conversations.
listConversationsAsync in interface AWSQBusinessAsyncpublic Future<ListConversationsResult> listConversationsAsync(ListConversationsRequest request, AsyncHandler<ListConversationsRequest,ListConversationsResult> asyncHandler)
AWSQBusinessAsyncLists one or more Amazon Q conversations.
listConversationsAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest request)
AWSQBusinessAsyncGet information about an Amazon Q data source connector synchronization.
listDataSourceSyncJobsAsync in interface AWSQBusinessAsyncpublic Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest request, AsyncHandler<ListDataSourceSyncJobsRequest,ListDataSourceSyncJobsResult> asyncHandler)
AWSQBusinessAsyncGet information about an Amazon Q data source connector synchronization.
listDataSourceSyncJobsAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request)
AWSQBusinessAsyncLists the Amazon Q data source connectors that you have created.
listDataSourcesAsync in interface AWSQBusinessAsyncpublic Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
AWSQBusinessAsyncLists the Amazon Q data source connectors that you have created.
listDataSourcesAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request)
AWSQBusinessAsyncA list of documents attached to an index.
listDocumentsAsync in interface AWSQBusinessAsyncpublic Future<ListDocumentsResult> listDocumentsAsync(ListDocumentsRequest request, AsyncHandler<ListDocumentsRequest,ListDocumentsResult> asyncHandler)
AWSQBusinessAsyncA list of documents attached to an index.
listDocumentsAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request)
AWSQBusinessAsyncProvides a list of groups that are mapped to users.
listGroupsAsync in interface AWSQBusinessAsyncpublic Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
AWSQBusinessAsyncProvides a list of groups that are mapped to users.
listGroupsAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest request)
AWSQBusinessAsyncLists the Amazon Q indices you have created.
listIndicesAsync in interface AWSQBusinessAsyncpublic Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest request, AsyncHandler<ListIndicesRequest,ListIndicesResult> asyncHandler)
AWSQBusinessAsyncLists the Amazon Q indices you have created.
listIndicesAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListMessagesResult> listMessagesAsync(ListMessagesRequest request)
AWSQBusinessAsyncGets a list of messages associated with an Amazon Q web experience.
listMessagesAsync in interface AWSQBusinessAsyncpublic Future<ListMessagesResult> listMessagesAsync(ListMessagesRequest request, AsyncHandler<ListMessagesRequest,ListMessagesResult> asyncHandler)
AWSQBusinessAsyncGets a list of messages associated with an Amazon Q web experience.
listMessagesAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListPluginsResult> listPluginsAsync(ListPluginsRequest request)
AWSQBusinessAsyncLists configured Amazon Q plugins.
listPluginsAsync in interface AWSQBusinessAsyncpublic Future<ListPluginsResult> listPluginsAsync(ListPluginsRequest request, AsyncHandler<ListPluginsRequest,ListPluginsResult> asyncHandler)
AWSQBusinessAsyncLists configured Amazon Q plugins.
listPluginsAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListRetrieversResult> listRetrieversAsync(ListRetrieversRequest request)
AWSQBusinessAsyncLists the retriever used by an Amazon Q application.
listRetrieversAsync in interface AWSQBusinessAsyncpublic Future<ListRetrieversResult> listRetrieversAsync(ListRetrieversRequest request, AsyncHandler<ListRetrieversRequest,ListRetrieversResult> asyncHandler)
AWSQBusinessAsyncLists the retriever used by an Amazon Q application.
listRetrieversAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSQBusinessAsyncGets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.
listTagsForResourceAsync in interface AWSQBusinessAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSQBusinessAsyncGets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.
listTagsForResourceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<ListWebExperiencesResult> listWebExperiencesAsync(ListWebExperiencesRequest request)
AWSQBusinessAsyncLists one or more Amazon Q Web Experiences.
listWebExperiencesAsync in interface AWSQBusinessAsyncpublic Future<ListWebExperiencesResult> listWebExperiencesAsync(ListWebExperiencesRequest request, AsyncHandler<ListWebExperiencesRequest,ListWebExperiencesResult> asyncHandler)
AWSQBusinessAsyncLists one or more Amazon Q Web Experiences.
listWebExperiencesAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<PutFeedbackResult> putFeedbackAsync(PutFeedbackRequest request)
AWSQBusinessAsyncEnables your end user to to provide feedback on their Amazon Q generated chat responses.
putFeedbackAsync in interface AWSQBusinessAsyncpublic Future<PutFeedbackResult> putFeedbackAsync(PutFeedbackRequest request, AsyncHandler<PutFeedbackRequest,PutFeedbackResult> asyncHandler)
AWSQBusinessAsyncEnables your end user to to provide feedback on their Amazon Q generated chat responses.
putFeedbackAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<PutGroupResult> putGroupAsync(PutGroupRequest request)
AWSQBusinessAsyncCreate, 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 chat results.
putGroupAsync in interface AWSQBusinessAsyncpublic Future<PutGroupResult> putGroupAsync(PutGroupRequest request, AsyncHandler<PutGroupRequest,PutGroupResult> asyncHandler)
AWSQBusinessAsyncCreate, 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 chat results.
putGroupAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<StartDataSourceSyncJobResult> startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest request)
AWSQBusinessAsync
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q
returns a ConflictException.
startDataSourceSyncJobAsync in interface AWSQBusinessAsyncpublic Future<StartDataSourceSyncJobResult> startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest request, AsyncHandler<StartDataSourceSyncJobRequest,StartDataSourceSyncJobResult> asyncHandler)
AWSQBusinessAsync
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q
returns a ConflictException.
startDataSourceSyncJobAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest request)
AWSQBusinessAsyncStops an Amazon Q data source connector synchronization job already in progress.
stopDataSourceSyncJobAsync in interface AWSQBusinessAsyncpublic Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest request, AsyncHandler<StopDataSourceSyncJobRequest,StopDataSourceSyncJobResult> asyncHandler)
AWSQBusinessAsyncStops an Amazon Q data source connector synchronization job already in progress.
stopDataSourceSyncJobAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSQBusinessAsyncAdds the specified tag to the specified Amazon Q application or data source resource. If the tag already exists, the existing value is replaced with the new value.
tagResourceAsync in interface AWSQBusinessAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSQBusinessAsyncAdds the specified tag to the specified Amazon Q application or data source resource. If the tag already exists, the existing value is replaced with the new value.
tagResourceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSQBusinessAsyncRemoves a tag from an Amazon Q application or a data source.
untagResourceAsync in interface AWSQBusinessAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSQBusinessAsyncRemoves a tag from an Amazon Q application or a data source.
untagResourceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest request)
AWSQBusinessAsyncUpdates an existing Amazon Q application.
updateApplicationAsync in interface AWSQBusinessAsyncpublic Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest request, AsyncHandler<UpdateApplicationRequest,UpdateApplicationResult> asyncHandler)
AWSQBusinessAsyncUpdates an existing Amazon Q application.
updateApplicationAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<UpdateChatControlsConfigurationResult> updateChatControlsConfigurationAsync(UpdateChatControlsConfigurationRequest request)
AWSQBusinessAsyncUpdates an set of chat controls configured for an existing Amazon Q application.
updateChatControlsConfigurationAsync in interface AWSQBusinessAsyncpublic Future<UpdateChatControlsConfigurationResult> updateChatControlsConfigurationAsync(UpdateChatControlsConfigurationRequest request, AsyncHandler<UpdateChatControlsConfigurationRequest,UpdateChatControlsConfigurationResult> asyncHandler)
AWSQBusinessAsyncUpdates an set of chat controls configured for an existing Amazon Q application.
updateChatControlsConfigurationAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest request)
AWSQBusinessAsyncUpdates an existing Amazon Q data source connector.
updateDataSourceAsync in interface AWSQBusinessAsyncpublic Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
AWSQBusinessAsyncUpdates an existing Amazon Q data source connector.
updateDataSourceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest request)
AWSQBusinessAsyncUpdates an Amazon Q index.
updateIndexAsync in interface AWSQBusinessAsyncpublic Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest request, AsyncHandler<UpdateIndexRequest,UpdateIndexResult> asyncHandler)
AWSQBusinessAsyncUpdates an Amazon Q index.
updateIndexAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<UpdatePluginResult> updatePluginAsync(UpdatePluginRequest request)
AWSQBusinessAsyncUpdates an Amazon Q plugin.
updatePluginAsync in interface AWSQBusinessAsyncpublic Future<UpdatePluginResult> updatePluginAsync(UpdatePluginRequest request, AsyncHandler<UpdatePluginRequest,UpdatePluginResult> asyncHandler)
AWSQBusinessAsyncUpdates an Amazon Q plugin.
updatePluginAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<UpdateRetrieverResult> updateRetrieverAsync(UpdateRetrieverRequest request)
AWSQBusinessAsyncUpdates the retriever used for your Amazon Q application.
updateRetrieverAsync in interface AWSQBusinessAsyncpublic Future<UpdateRetrieverResult> updateRetrieverAsync(UpdateRetrieverRequest request, AsyncHandler<UpdateRetrieverRequest,UpdateRetrieverResult> asyncHandler)
AWSQBusinessAsyncUpdates the retriever used for your Amazon Q application.
updateRetrieverAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)
AWSQBusinessAsyncUpdates a information associated with a user id.
updateUserAsync in interface AWSQBusinessAsyncpublic Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AWSQBusinessAsyncUpdates a information associated with a user id.
updateUserAsync in interface AWSQBusinessAsyncasyncHandler - 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.public Future<UpdateWebExperienceResult> updateWebExperienceAsync(UpdateWebExperienceRequest request)
AWSQBusinessAsyncUpdates an Amazon Q web experience.
updateWebExperienceAsync in interface AWSQBusinessAsyncpublic Future<UpdateWebExperienceResult> updateWebExperienceAsync(UpdateWebExperienceRequest request, AsyncHandler<UpdateWebExperienceRequest,UpdateWebExperienceResult> asyncHandler)
AWSQBusinessAsyncUpdates an Amazon Q web experience.
updateWebExperienceAsync in interface AWSQBusinessAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSQBusinessshutdown in class AWSQBusinessClientCopyright © 2024. All rights reserved.