@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSQBusinessClient extends AmazonWebServiceClient implements AWSQBusiness
This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .
For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.
The following resources provide additional information about using the Amazon Q Business API:
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchDeleteDocumentResult |
batchDeleteDocument(BatchDeleteDocumentRequest request)
Asynchronously deletes one or more documents added using the
BatchPutDocument API from an Amazon Q
Business index. |
BatchPutDocumentResult |
batchPutDocument(BatchPutDocumentRequest request)
Adds one or more documents to an Amazon Q Business index.
|
static AWSQBusinessClientBuilder |
builder() |
ChatSyncResult |
chatSync(ChatSyncRequest request)
Starts or continues a non-streaming Amazon Q Business conversation.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest request)
Creates an Amazon Q Business application.
|
CreateIndexResult |
createIndex(CreateIndexRequest request)
Creates an Amazon Q Business index.
|
CreatePluginResult |
createPlugin(CreatePluginRequest request)
Creates an Amazon Q Business plugin.
|
CreateRetrieverResult |
createRetriever(CreateRetrieverRequest request)
Adds a retriever to your Amazon Q Business application.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
|
CreateWebExperienceResult |
createWebExperience(CreateWebExperienceRequest request)
Creates an Amazon Q Business web experience.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest request)
Deletes an Amazon Q Business application.
|
DeleteChatControlsConfigurationResult |
deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest request)
Deletes chat controls configured for an existing Amazon Q Business application.
|
DeleteConversationResult |
deleteConversation(DeleteConversationRequest request)
Deletes an Amazon Q Business web experience conversation.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest request)
Deletes an Amazon Q Business data source connector.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only
available to that group.
|
DeleteIndexResult |
deleteIndex(DeleteIndexRequest request)
Deletes an Amazon Q Business index.
|
DeletePluginResult |
deletePlugin(DeletePluginRequest request)
Deletes an Amazon Q Business plugin.
|
DeleteRetrieverResult |
deleteRetriever(DeleteRetrieverRequest request)
Deletes the retriever used by an Amazon Q Business application.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user by email id.
|
DeleteWebExperienceResult |
deleteWebExperience(DeleteWebExperienceRequest request)
Deletes an Amazon Q Business web experience.
|
GetApplicationResult |
getApplication(GetApplicationRequest request)
Gets information about an existing Amazon Q Business application.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetChatControlsConfigurationResult |
getChatControlsConfiguration(GetChatControlsConfigurationRequest request)
Gets information about an chat controls configured for an existing Amazon Q Business application.
|
GetDataSourceResult |
getDataSource(GetDataSourceRequest request)
Gets information about an existing Amazon Q Business data source connector.
|
GetGroupResult |
getGroup(GetGroupRequest request)
Describes a group by group name.
|
GetIndexResult |
getIndex(GetIndexRequest request)
Gets information about an existing Amazon Q Business index.
|
GetPluginResult |
getPlugin(GetPluginRequest request)
Gets information about an existing Amazon Q Business plugin.
|
GetRetrieverResult |
getRetriever(GetRetrieverRequest request)
Gets information about an existing retriever used by an Amazon Q Business application.
|
GetUserResult |
getUser(GetUserRequest request)
Describes the universally unique identifier (UUID) associated with a local user in a data source.
|
GetWebExperienceResult |
getWebExperience(GetWebExperienceRequest request)
Gets information about an existing Amazon Q Business web experience.
|
ListApplicationsResult |
listApplications(ListApplicationsRequest request)
Lists Amazon Q Business applications.
|
ListConversationsResult |
listConversations(ListConversationsRequest request)
Lists one or more Amazon Q Business conversations.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest request)
Lists the Amazon Q Business data source connectors that you have created.
|
ListDataSourceSyncJobsResult |
listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)
Get information about an Amazon Q Business data source connector synchronization.
|
ListDocumentsResult |
listDocuments(ListDocumentsRequest request)
A list of documents attached to an index.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Provides a list of groups that are mapped to users.
|
ListIndicesResult |
listIndices(ListIndicesRequest request)
Lists the Amazon Q Business indices you have created.
|
ListMessagesResult |
listMessages(ListMessagesRequest request)
Gets a list of messages associated with an Amazon Q Business web experience.
|
ListPluginsResult |
listPlugins(ListPluginsRequest request)
Lists configured Amazon Q Business plugins.
|
ListRetrieversResult |
listRetrievers(ListRetrieversRequest request)
Lists the retriever used by an Amazon Q Business application.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Gets a list of tags associated with a specified resource.
|
ListWebExperiencesResult |
listWebExperiences(ListWebExperiencesRequest request)
Lists one or more Amazon Q Business Web Experiences.
|
PutFeedbackResult |
putFeedback(PutFeedbackRequest request)
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
|
PutGroupResult |
putGroup(PutGroupRequest request)
Create, or updates, a mapping of users—who have access to a document—to groups.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartDataSourceSyncJobResult |
startDataSourceSyncJob(StartDataSourceSyncJobRequest request)
Starts a data source connector synchronization job.
|
StopDataSourceSyncJobResult |
stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)
Stops an Amazon Q Business data source connector synchronization job already in progress.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tag to the specified Amazon Q Business application or data source resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from an Amazon Q Business application or a data source.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest request)
Updates an existing Amazon Q Business application.
|
UpdateChatControlsConfigurationResult |
updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest request)
Updates an set of chat controls configured for an existing Amazon Q Business application.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest request)
Updates an existing Amazon Q Business data source connector.
|
UpdateIndexResult |
updateIndex(UpdateIndexRequest request)
Updates an Amazon Q Business index.
|
UpdatePluginResult |
updatePlugin(UpdatePluginRequest request)
Updates an Amazon Q Business plugin.
|
UpdateRetrieverResult |
updateRetriever(UpdateRetrieverRequest request)
Updates the retriever used for your Amazon Q Business application.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Updates a information associated with a user id.
|
UpdateWebExperienceResult |
updateWebExperience(UpdateWebExperienceRequest request)
Updates an Amazon Q Business web experience.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSQBusinessClientBuilder builder()
public BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest request)
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.
batchDeleteDocument
in interface AWSQBusiness
batchDeleteDocumentRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest request)
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.
batchPutDocument
in interface AWSQBusiness
batchPutDocumentRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public ChatSyncResult chatSync(ChatSyncRequest request)
Starts or continues a non-streaming Amazon Q Business conversation.
chatSync
in interface AWSQBusiness
chatSyncRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.LicenseNotFoundException
- You don't have permissions to perform the action because your license is inactive. Ask your admin to
activate your license and try again after your licence is active.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public CreateApplicationResult createApplication(CreateApplicationRequest request)
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.
createApplication
in interface AWSQBusiness
createApplicationRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public CreateIndexResult createIndex(CreateIndexRequest request)
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.
createIndex
in interface AWSQBusiness
createIndexRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public CreatePluginResult createPlugin(CreatePluginRequest request)
Creates an Amazon Q Business plugin.
createPlugin
in interface AWSQBusiness
createPluginRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public CreateRetrieverResult createRetriever(CreateRetrieverRequest request)
Adds a retriever to your Amazon Q Business application.
createRetriever
in interface AWSQBusiness
createRetrieverRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public CreateUserResult createUser(CreateUserRequest request)
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
createUser
in interface AWSQBusiness
createUserRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public CreateWebExperienceResult createWebExperience(CreateWebExperienceRequest request)
Creates an Amazon Q Business web experience.
createWebExperience
in interface AWSQBusiness
createWebExperienceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
Deletes an Amazon Q Business application.
deleteApplication
in interface AWSQBusiness
deleteApplicationRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public DeleteChatControlsConfigurationResult deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest request)
Deletes chat controls configured for an existing Amazon Q Business application.
deleteChatControlsConfiguration
in interface AWSQBusiness
deleteChatControlsConfigurationRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public DeleteConversationResult deleteConversation(DeleteConversationRequest request)
Deletes an Amazon Q Business web experience conversation.
deleteConversation
in interface AWSQBusiness
deleteConversationRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.LicenseNotFoundException
- You don't have permissions to perform the action because your license is inactive. Ask your admin to
activate your license and try again after your licence is active.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
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
.
deleteDataSource
in interface AWSQBusiness
deleteDataSourceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public 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. 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 AWSQBusiness
deleteGroupRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public DeleteIndexResult deleteIndex(DeleteIndexRequest request)
Deletes an Amazon Q Business index.
deleteIndex
in interface AWSQBusiness
deleteIndexRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public DeletePluginResult deletePlugin(DeletePluginRequest request)
Deletes an Amazon Q Business plugin.
deletePlugin
in interface AWSQBusiness
deletePluginRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public DeleteRetrieverResult deleteRetriever(DeleteRetrieverRequest request)
Deletes the retriever used by an Amazon Q Business application.
deleteRetriever
in interface AWSQBusiness
deleteRetrieverRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes a user by email id.
deleteUser
in interface AWSQBusiness
deleteUserRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public DeleteWebExperienceResult deleteWebExperience(DeleteWebExperienceRequest request)
Deletes an Amazon Q Business web experience.
deleteWebExperience
in interface AWSQBusiness
deleteWebExperienceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public GetApplicationResult getApplication(GetApplicationRequest request)
Gets information about an existing Amazon Q Business application.
getApplication
in interface AWSQBusiness
getApplicationRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public GetChatControlsConfigurationResult getChatControlsConfiguration(GetChatControlsConfigurationRequest request)
Gets information about an chat controls configured for an existing Amazon Q Business application.
getChatControlsConfiguration
in interface AWSQBusiness
getChatControlsConfigurationRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public GetDataSourceResult getDataSource(GetDataSourceRequest request)
Gets information about an existing Amazon Q Business data source connector.
getDataSource
in interface AWSQBusiness
getDataSourceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public GetGroupResult getGroup(GetGroupRequest request)
Describes a group by group name.
getGroup
in interface AWSQBusiness
getGroupRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public GetIndexResult getIndex(GetIndexRequest request)
Gets information about an existing Amazon Q Business index.
getIndex
in interface AWSQBusiness
getIndexRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public GetPluginResult getPlugin(GetPluginRequest request)
Gets information about an existing Amazon Q Business plugin.
getPlugin
in interface AWSQBusiness
getPluginRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public GetRetrieverResult getRetriever(GetRetrieverRequest request)
Gets information about an existing retriever used by an Amazon Q Business application.
getRetriever
in interface AWSQBusiness
getRetrieverRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public GetUserResult getUser(GetUserRequest request)
Describes the universally unique identifier (UUID) associated with a local user in a data source.
getUser
in interface AWSQBusiness
getUserRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public GetWebExperienceResult getWebExperience(GetWebExperienceRequest request)
Gets information about an existing Amazon Q Business web experience.
getWebExperience
in interface AWSQBusiness
getWebExperienceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListApplicationsResult listApplications(ListApplicationsRequest request)
Lists Amazon Q Business applications.
listApplications
in interface AWSQBusiness
listApplicationsRequest
- InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListConversationsResult listConversations(ListConversationsRequest request)
Lists one or more Amazon Q Business conversations.
listConversations
in interface AWSQBusiness
listConversationsRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.LicenseNotFoundException
- You don't have permissions to perform the action because your license is inactive. Ask your admin to
activate your license and try again after your licence is active.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)
Get information about an Amazon Q Business data source connector synchronization.
listDataSourceSyncJobs
in interface AWSQBusiness
listDataSourceSyncJobsRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
Lists the Amazon Q Business data source connectors that you have created.
listDataSources
in interface AWSQBusiness
listDataSourcesRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListDocumentsResult listDocuments(ListDocumentsRequest request)
A list of documents attached to an index.
listDocuments
in interface AWSQBusiness
listDocumentsRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListGroupsResult listGroups(ListGroupsRequest request)
Provides a list of groups that are mapped to users.
listGroups
in interface AWSQBusiness
listGroupsRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListIndicesResult listIndices(ListIndicesRequest request)
Lists the Amazon Q Business indices you have created.
listIndices
in interface AWSQBusiness
listIndicesRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListMessagesResult listMessages(ListMessagesRequest request)
Gets a list of messages associated with an Amazon Q Business web experience.
listMessages
in interface AWSQBusiness
listMessagesRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.LicenseNotFoundException
- You don't have permissions to perform the action because your license is inactive. Ask your admin to
activate your license and try again after your licence is active.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListPluginsResult listPlugins(ListPluginsRequest request)
Lists configured Amazon Q Business plugins.
listPlugins
in interface AWSQBusiness
listPluginsRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListRetrieversResult listRetrievers(ListRetrieversRequest request)
Lists the retriever used by an Amazon Q Business application.
listRetrievers
in interface AWSQBusiness
listRetrieversRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
listTagsForResource
in interface AWSQBusiness
listTagsForResourceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ListWebExperiencesResult listWebExperiences(ListWebExperiencesRequest request)
Lists one or more Amazon Q Business Web Experiences.
listWebExperiences
in interface AWSQBusiness
listWebExperiencesRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public PutFeedbackResult putFeedback(PutFeedbackRequest request)
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
putFeedback
in interface AWSQBusiness
putFeedbackRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public PutGroupResult putGroup(PutGroupRequest request)
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.
putGroup
in interface AWSQBusiness
putGroupRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest request)
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q
Business returns a ConflictException
.
startDataSourceSyncJob
in interface AWSQBusiness
startDataSourceSyncJobRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)
Stops an Amazon Q Business data source connector synchronization job already in progress.
stopDataSourceSyncJob
in interface AWSQBusiness
stopDataSourceSyncJobRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AWSQBusiness
tagResourceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag from an Amazon Q Business application or a data source.
untagResource
in interface AWSQBusiness
untagResourceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
Updates an existing Amazon Q Business application.
updateApplication
in interface AWSQBusiness
updateApplicationRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public UpdateChatControlsConfigurationResult updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest request)
Updates an set of chat controls configured for an existing Amazon Q Business application.
updateChatControlsConfiguration
in interface AWSQBusiness
updateChatControlsConfigurationRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
Updates an existing Amazon Q Business data source connector.
updateDataSource
in interface AWSQBusiness
updateDataSourceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public UpdateIndexResult updateIndex(UpdateIndexRequest request)
Updates an Amazon Q Business index.
updateIndex
in interface AWSQBusiness
updateIndexRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public UpdatePluginResult updatePlugin(UpdatePluginRequest request)
Updates an Amazon Q Business plugin.
updatePlugin
in interface AWSQBusiness
updatePluginRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public UpdateRetrieverResult updateRetriever(UpdateRetrieverRequest request)
Updates the retriever used for your Amazon Q Business application.
updateRetriever
in interface AWSQBusiness
updateRetrieverRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public UpdateUserResult updateUser(UpdateUserRequest request)
Updates a information associated with a user id.
updateUser
in interface AWSQBusiness
updateUserRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Q Business service.public UpdateWebExperienceResult updateWebExperience(UpdateWebExperienceRequest request)
Updates an Amazon Q Business web experience.
updateWebExperience
in interface AWSQBusiness
updateWebExperienceRequest
- ResourceNotFoundException
- The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try
again.InternalServerException
- An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and
try again, or contact Support for help.ConflictException
- You are trying to perform an action that conflicts with the current status of your resource. Fix any
inconsistences with your resources and try again.ThrottlingException
- The request was denied due to throttling. Reduce the number of requests and try again.ValidationException
- The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input
and try again.AccessDeniedException
- You don't have access to perform this action. Make sure you have the required permission policies and
user accounts and try again.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSQBusiness
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSQBusiness
shutdown
in class AmazonWebServiceClient