@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSQBusiness extends Object implements AWSQBusiness
AWSQBusiness. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSQBusiness() |
| Modifier and Type | Method and Description |
|---|---|
BatchDeleteDocumentResult |
batchDeleteDocument(BatchDeleteDocumentRequest request)
Asynchronously deletes one or more documents added using the
BatchPutDocument API from an Amazon Q
index. |
BatchPutDocumentResult |
batchPutDocument(BatchPutDocumentRequest request)
Adds one or more documents to an Amazon Q index.
|
ChatSyncResult |
chatSync(ChatSyncRequest request)
Starts or continues a non-streaming Amazon Q conversation.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest request)
Creates an Amazon Q application.
|
CreateIndexResult |
createIndex(CreateIndexRequest request)
Creates an Amazon Q index.
|
CreatePluginResult |
createPlugin(CreatePluginRequest request)
Creates an Amazon Q plugin.
|
CreateRetrieverResult |
createRetriever(CreateRetrieverRequest request)
Adds a retriever to your Amazon Q application.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
|
CreateWebExperienceResult |
createWebExperience(CreateWebExperienceRequest request)
Creates an Amazon Q web experience.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest request)
Deletes an Amazon Q application.
|
DeleteChatControlsConfigurationResult |
deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest request)
Deletes chat controls configured for an existing Amazon Q application.
|
DeleteConversationResult |
deleteConversation(DeleteConversationRequest request)
Deletes an Amazon Q web experience conversation.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest request)
Deletes an Amazon Q data source connector.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only
available to that group.
|
DeleteIndexResult |
deleteIndex(DeleteIndexRequest request)
Deletes an Amazon Q index.
|
DeletePluginResult |
deletePlugin(DeletePluginRequest request)
Deletes an Amazon Q plugin.
|
DeleteRetrieverResult |
deleteRetriever(DeleteRetrieverRequest request)
Deletes the retriever used by an Amazon Q application.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user by email id.
|
DeleteWebExperienceResult |
deleteWebExperience(DeleteWebExperienceRequest request)
Deletes an Amazon Q web experience.
|
GetApplicationResult |
getApplication(GetApplicationRequest request)
Gets information about an existing Amazon Q application.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetChatControlsConfigurationResult |
getChatControlsConfiguration(GetChatControlsConfigurationRequest request)
Gets information about an chat controls configured for an existing Amazon Q application.
|
GetDataSourceResult |
getDataSource(GetDataSourceRequest request)
Gets information about an existing Amazon Q data source connector.
|
GetGroupResult |
getGroup(GetGroupRequest request)
Describes a group by group name.
|
GetIndexResult |
getIndex(GetIndexRequest request)
Gets information about an existing Amazon Q index.
|
GetPluginResult |
getPlugin(GetPluginRequest request)
Gets information about an existing Amazon Q plugin.
|
GetRetrieverResult |
getRetriever(GetRetrieverRequest request)
Gets information about an existing retriever used by an Amazon Q application.
|
GetUserResult |
getUser(GetUserRequest request)
Describes the universally unique identifier (UUID) associated with a local user in a data source.
|
GetWebExperienceResult |
getWebExperience(GetWebExperienceRequest request)
Gets information about an existing Amazon Q web experience.
|
ListApplicationsResult |
listApplications(ListApplicationsRequest request)
Lists Amazon Q applications.
|
ListConversationsResult |
listConversations(ListConversationsRequest request)
Lists one or more Amazon Q conversations.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest request)
Lists the Amazon Q data source connectors that you have created.
|
ListDataSourceSyncJobsResult |
listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)
Get information about an Amazon Q data source connector synchronization.
|
ListDocumentsResult |
listDocuments(ListDocumentsRequest request)
A list of documents attached to an index.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Provides a list of groups that are mapped to users.
|
ListIndicesResult |
listIndices(ListIndicesRequest request)
Lists the Amazon Q indices you have created.
|
ListMessagesResult |
listMessages(ListMessagesRequest request)
Gets a list of messages associated with an Amazon Q web experience.
|
ListPluginsResult |
listPlugins(ListPluginsRequest request)
Lists configured Amazon Q plugins.
|
ListRetrieversResult |
listRetrievers(ListRetrieversRequest request)
Lists the retriever used by an Amazon Q application.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Gets a list of tags associated with a specified resource.
|
ListWebExperiencesResult |
listWebExperiences(ListWebExperiencesRequest request)
Lists one or more Amazon Q Web Experiences.
|
PutFeedbackResult |
putFeedback(PutFeedbackRequest request)
Enables your end user to to provide feedback on their Amazon Q generated chat responses.
|
PutGroupResult |
putGroup(PutGroupRequest request)
Create, or updates, a mapping of users—who have access to a document—to groups.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartDataSourceSyncJobResult |
startDataSourceSyncJob(StartDataSourceSyncJobRequest request)
Starts a data source connector synchronization job.
|
StopDataSourceSyncJobResult |
stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)
Stops an Amazon Q data source connector synchronization job already in progress.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tag to the specified Amazon Q application or data source resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from an Amazon Q application or a data source.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest request)
Updates an existing Amazon Q application.
|
UpdateChatControlsConfigurationResult |
updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest request)
Updates an set of chat controls configured for an existing Amazon Q application.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest request)
Updates an existing Amazon Q data source connector.
|
UpdateIndexResult |
updateIndex(UpdateIndexRequest request)
Updates an Amazon Q index.
|
UpdatePluginResult |
updatePlugin(UpdatePluginRequest request)
Updates an Amazon Q plugin.
|
UpdateRetrieverResult |
updateRetriever(UpdateRetrieverRequest request)
Updates the retriever used for your Amazon Q application.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Updates a information associated with a user id.
|
UpdateWebExperienceResult |
updateWebExperience(UpdateWebExperienceRequest request)
Updates an Amazon Q web experience.
|
public BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest request)
AWSQBusiness
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.
batchDeleteDocument in interface AWSQBusinesspublic BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest request)
AWSQBusinessAdds 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.
batchPutDocument in interface AWSQBusinesspublic ChatSyncResult chatSync(ChatSyncRequest request)
AWSQBusinessStarts or continues a non-streaming Amazon Q conversation.
chatSync in interface AWSQBusinesspublic CreateApplicationResult createApplication(CreateApplicationRequest request)
AWSQBusinessCreates an Amazon Q application.
createApplication in interface AWSQBusinesspublic CreateIndexResult createIndex(CreateIndexRequest request)
AWSQBusinessCreates 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.
createIndex in interface AWSQBusinesspublic CreatePluginResult createPlugin(CreatePluginRequest request)
AWSQBusinessCreates an Amazon Q plugin.
createPlugin in interface AWSQBusinesspublic CreateRetrieverResult createRetriever(CreateRetrieverRequest request)
AWSQBusinessAdds a retriever to your Amazon Q application.
createRetriever in interface AWSQBusinesspublic CreateUserResult createUser(CreateUserRequest request)
AWSQBusinessCreates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
createUser in interface AWSQBusinesspublic CreateWebExperienceResult createWebExperience(CreateWebExperienceRequest request)
AWSQBusinessCreates an Amazon Q web experience.
createWebExperience in interface AWSQBusinesspublic DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
AWSQBusinessDeletes an Amazon Q application.
deleteApplication in interface AWSQBusinesspublic DeleteChatControlsConfigurationResult deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest request)
AWSQBusinessDeletes chat controls configured for an existing Amazon Q application.
deleteChatControlsConfiguration in interface AWSQBusinesspublic DeleteConversationResult deleteConversation(DeleteConversationRequest request)
AWSQBusinessDeletes an Amazon Q web experience conversation.
deleteConversation in interface AWSQBusinesspublic DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
AWSQBusiness
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.
deleteDataSource in interface AWSQBusinesspublic DeleteGroupResult deleteGroup(DeleteGroupRequest request)
AWSQBusinessDeletes 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.
deleteGroup in interface AWSQBusinesspublic DeleteIndexResult deleteIndex(DeleteIndexRequest request)
AWSQBusinessDeletes an Amazon Q index.
deleteIndex in interface AWSQBusinesspublic DeletePluginResult deletePlugin(DeletePluginRequest request)
AWSQBusinessDeletes an Amazon Q plugin.
deletePlugin in interface AWSQBusinesspublic DeleteRetrieverResult deleteRetriever(DeleteRetrieverRequest request)
AWSQBusinessDeletes the retriever used by an Amazon Q application.
deleteRetriever in interface AWSQBusinesspublic DeleteUserResult deleteUser(DeleteUserRequest request)
AWSQBusinessDeletes a user by email id.
deleteUser in interface AWSQBusinesspublic DeleteWebExperienceResult deleteWebExperience(DeleteWebExperienceRequest request)
AWSQBusinessDeletes an Amazon Q web experience.
deleteWebExperience in interface AWSQBusinesspublic GetApplicationResult getApplication(GetApplicationRequest request)
AWSQBusinessGets information about an existing Amazon Q application.
getApplication in interface AWSQBusinesspublic GetChatControlsConfigurationResult getChatControlsConfiguration(GetChatControlsConfigurationRequest request)
AWSQBusinessGets information about an chat controls configured for an existing Amazon Q application.
getChatControlsConfiguration in interface AWSQBusinesspublic GetDataSourceResult getDataSource(GetDataSourceRequest request)
AWSQBusinessGets information about an existing Amazon Q data source connector.
getDataSource in interface AWSQBusinesspublic GetGroupResult getGroup(GetGroupRequest request)
AWSQBusinessDescribes a group by group name.
getGroup in interface AWSQBusinesspublic GetIndexResult getIndex(GetIndexRequest request)
AWSQBusinessGets information about an existing Amazon Q index.
getIndex in interface AWSQBusinesspublic GetPluginResult getPlugin(GetPluginRequest request)
AWSQBusinessGets information about an existing Amazon Q plugin.
getPlugin in interface AWSQBusinesspublic GetRetrieverResult getRetriever(GetRetrieverRequest request)
AWSQBusinessGets information about an existing retriever used by an Amazon Q application.
getRetriever in interface AWSQBusinesspublic GetUserResult getUser(GetUserRequest request)
AWSQBusinessDescribes the universally unique identifier (UUID) associated with a local user in a data source.
getUser in interface AWSQBusinesspublic GetWebExperienceResult getWebExperience(GetWebExperienceRequest request)
AWSQBusinessGets information about an existing Amazon Q web experience.
getWebExperience in interface AWSQBusinesspublic ListApplicationsResult listApplications(ListApplicationsRequest request)
AWSQBusinessLists Amazon Q applications.
listApplications in interface AWSQBusinesspublic ListConversationsResult listConversations(ListConversationsRequest request)
AWSQBusinessLists one or more Amazon Q conversations.
listConversations in interface AWSQBusinesspublic ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)
AWSQBusinessGet information about an Amazon Q data source connector synchronization.
listDataSourceSyncJobs in interface AWSQBusinesspublic ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
AWSQBusinessLists the Amazon Q data source connectors that you have created.
listDataSources in interface AWSQBusinesspublic ListDocumentsResult listDocuments(ListDocumentsRequest request)
AWSQBusinessA list of documents attached to an index.
listDocuments in interface AWSQBusinesspublic ListGroupsResult listGroups(ListGroupsRequest request)
AWSQBusinessProvides a list of groups that are mapped to users.
listGroups in interface AWSQBusinesspublic ListIndicesResult listIndices(ListIndicesRequest request)
AWSQBusinessLists the Amazon Q indices you have created.
listIndices in interface AWSQBusinesspublic ListMessagesResult listMessages(ListMessagesRequest request)
AWSQBusinessGets a list of messages associated with an Amazon Q web experience.
listMessages in interface AWSQBusinesspublic ListPluginsResult listPlugins(ListPluginsRequest request)
AWSQBusinessLists configured Amazon Q plugins.
listPlugins in interface AWSQBusinesspublic ListRetrieversResult listRetrievers(ListRetrieversRequest request)
AWSQBusinessLists the retriever used by an Amazon Q application.
listRetrievers in interface AWSQBusinesspublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSQBusinessGets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.
listTagsForResource in interface AWSQBusinesspublic ListWebExperiencesResult listWebExperiences(ListWebExperiencesRequest request)
AWSQBusinessLists one or more Amazon Q Web Experiences.
listWebExperiences in interface AWSQBusinesspublic PutFeedbackResult putFeedback(PutFeedbackRequest request)
AWSQBusinessEnables your end user to to provide feedback on their Amazon Q generated chat responses.
putFeedback in interface AWSQBusinesspublic PutGroupResult putGroup(PutGroupRequest request)
AWSQBusinessCreate, 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.
putGroup in interface AWSQBusinesspublic StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest request)
AWSQBusiness
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q
returns a ConflictException.
startDataSourceSyncJob in interface AWSQBusinesspublic StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)
AWSQBusinessStops an Amazon Q data source connector synchronization job already in progress.
stopDataSourceSyncJob in interface AWSQBusinesspublic TagResourceResult tagResource(TagResourceRequest request)
AWSQBusinessAdds 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.
tagResource in interface AWSQBusinesspublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSQBusinessRemoves a tag from an Amazon Q application or a data source.
untagResource in interface AWSQBusinesspublic UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AWSQBusinessUpdates an existing Amazon Q application.
updateApplication in interface AWSQBusinesspublic UpdateChatControlsConfigurationResult updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest request)
AWSQBusinessUpdates an set of chat controls configured for an existing Amazon Q application.
updateChatControlsConfiguration in interface AWSQBusinesspublic UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
AWSQBusinessUpdates an existing Amazon Q data source connector.
updateDataSource in interface AWSQBusinesspublic UpdateIndexResult updateIndex(UpdateIndexRequest request)
AWSQBusinessUpdates an Amazon Q index.
updateIndex in interface AWSQBusinesspublic UpdatePluginResult updatePlugin(UpdatePluginRequest request)
AWSQBusinessUpdates an Amazon Q plugin.
updatePlugin in interface AWSQBusinesspublic UpdateRetrieverResult updateRetriever(UpdateRetrieverRequest request)
AWSQBusinessUpdates the retriever used for your Amazon Q application.
updateRetriever in interface AWSQBusinesspublic UpdateUserResult updateUser(UpdateUserRequest request)
AWSQBusinessUpdates a information associated with a user id.
updateUser in interface AWSQBusinesspublic UpdateWebExperienceResult updateWebExperience(UpdateWebExperienceRequest request)
AWSQBusinessUpdates an Amazon Q web experience.
updateWebExperience in interface AWSQBusinesspublic void shutdown()
AWSQBusinessshutdown in interface AWSQBusinesspublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSQBusinessResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSQBusinessrequest - The originally executed request.Copyright © 2024. All rights reserved.