Interface QBusinessClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface QBusinessClient extends AwsClient
Service client for accessing QBusiness. This can be created using the staticbuilder()method.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default BatchDeleteDocumentResponsebatchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest)Asynchronously deletes one or more documents added using theBatchPutDocumentAPI from an Amazon Q index.default BatchDeleteDocumentResponsebatchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)Asynchronously deletes one or more documents added using theBatchPutDocumentAPI from an Amazon Q index.default BatchPutDocumentResponsebatchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest)Adds one or more documents to an Amazon Q index.default BatchPutDocumentResponsebatchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)Adds one or more documents to an Amazon Q index.static QBusinessClientBuilderbuilder()Create a builder that can be used to configure and create aQBusinessClient.default ChatSyncResponsechatSync(Consumer<ChatSyncRequest.Builder> chatSyncRequest)Starts or continues a non-streaming Amazon Q conversation.default ChatSyncResponsechatSync(ChatSyncRequest chatSyncRequest)Starts or continues a non-streaming Amazon Q conversation.static QBusinessClientcreate()Create aQBusinessClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateApplicationResponsecreateApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)Creates an Amazon Q application.default CreateApplicationResponsecreateApplication(CreateApplicationRequest createApplicationRequest)Creates an Amazon Q application.default CreateDataSourceResponsecreateDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)Creates a data source connector for an Amazon Q application.default CreateDataSourceResponsecreateDataSource(CreateDataSourceRequest createDataSourceRequest)Creates a data source connector for an Amazon Q application.default CreateIndexResponsecreateIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)Creates an Amazon Q index.default CreateIndexResponsecreateIndex(CreateIndexRequest createIndexRequest)Creates an Amazon Q index.default CreatePluginResponsecreatePlugin(Consumer<CreatePluginRequest.Builder> createPluginRequest)Creates an Amazon Q plugin.default CreatePluginResponsecreatePlugin(CreatePluginRequest createPluginRequest)Creates an Amazon Q plugin.default CreateRetrieverResponsecreateRetriever(Consumer<CreateRetrieverRequest.Builder> createRetrieverRequest)Adds a retriever to your Amazon Q application.default CreateRetrieverResponsecreateRetriever(CreateRetrieverRequest createRetrieverRequest)Adds a retriever to your Amazon Q application.default CreateUserResponsecreateUser(Consumer<CreateUserRequest.Builder> createUserRequest)Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.default CreateUserResponsecreateUser(CreateUserRequest createUserRequest)Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.default CreateWebExperienceResponsecreateWebExperience(Consumer<CreateWebExperienceRequest.Builder> createWebExperienceRequest)Creates an Amazon Q web experience.default CreateWebExperienceResponsecreateWebExperience(CreateWebExperienceRequest createWebExperienceRequest)Creates an Amazon Q web experience.default DeleteApplicationResponsedeleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)Deletes an Amazon Q application.default DeleteApplicationResponsedeleteApplication(DeleteApplicationRequest deleteApplicationRequest)Deletes an Amazon Q application.default DeleteChatControlsConfigurationResponsedeleteChatControlsConfiguration(Consumer<DeleteChatControlsConfigurationRequest.Builder> deleteChatControlsConfigurationRequest)Deletes chat controls configured for an existing Amazon Q application.default DeleteChatControlsConfigurationResponsedeleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest)Deletes chat controls configured for an existing Amazon Q application.default DeleteConversationResponsedeleteConversation(Consumer<DeleteConversationRequest.Builder> deleteConversationRequest)Deletes an Amazon Q web experience conversation.default DeleteConversationResponsedeleteConversation(DeleteConversationRequest deleteConversationRequest)Deletes an Amazon Q web experience conversation.default DeleteDataSourceResponsedeleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)Deletes an Amazon Q data source connector.default DeleteDataSourceResponsedeleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)Deletes an Amazon Q data source connector.default DeleteGroupResponsedeleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.default DeleteGroupResponsedeleteGroup(DeleteGroupRequest deleteGroupRequest)Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.default DeleteIndexResponsedeleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)Deletes an Amazon Q index.default DeleteIndexResponsedeleteIndex(DeleteIndexRequest deleteIndexRequest)Deletes an Amazon Q index.default DeletePluginResponsedeletePlugin(Consumer<DeletePluginRequest.Builder> deletePluginRequest)Deletes an Amazon Q plugin.default DeletePluginResponsedeletePlugin(DeletePluginRequest deletePluginRequest)Deletes an Amazon Q plugin.default DeleteRetrieverResponsedeleteRetriever(Consumer<DeleteRetrieverRequest.Builder> deleteRetrieverRequest)Deletes the retriever used by an Amazon Q application.default DeleteRetrieverResponsedeleteRetriever(DeleteRetrieverRequest deleteRetrieverRequest)Deletes the retriever used by an Amazon Q application.default DeleteUserResponsedeleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)Deletes a user by email id.default DeleteUserResponsedeleteUser(DeleteUserRequest deleteUserRequest)Deletes a user by email id.default DeleteWebExperienceResponsedeleteWebExperience(Consumer<DeleteWebExperienceRequest.Builder> deleteWebExperienceRequest)Deletes an Amazon Q web experience.default DeleteWebExperienceResponsedeleteWebExperience(DeleteWebExperienceRequest deleteWebExperienceRequest)Deletes an Amazon Q web experience.default GetApplicationResponsegetApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)Gets information about an existing Amazon Q application.default GetApplicationResponsegetApplication(GetApplicationRequest getApplicationRequest)Gets information about an existing Amazon Q application.default GetChatControlsConfigurationResponsegetChatControlsConfiguration(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest)Gets information about an chat controls configured for an existing Amazon Q application.default GetChatControlsConfigurationResponsegetChatControlsConfiguration(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest)Gets information about an chat controls configured for an existing Amazon Q application.default GetChatControlsConfigurationIterablegetChatControlsConfigurationPaginator(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest)This is a variant ofgetChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest)operation.default GetChatControlsConfigurationIterablegetChatControlsConfigurationPaginator(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest)This is a variant ofgetChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest)operation.default GetDataSourceResponsegetDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest)Gets information about an existing Amazon Q data source connector.default GetDataSourceResponsegetDataSource(GetDataSourceRequest getDataSourceRequest)Gets information about an existing Amazon Q data source connector.default GetGroupResponsegetGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)Describes a group by group name.default GetGroupResponsegetGroup(GetGroupRequest getGroupRequest)Describes a group by group name.default GetIndexResponsegetIndex(Consumer<GetIndexRequest.Builder> getIndexRequest)Gets information about an existing Amazon Q index.default GetIndexResponsegetIndex(GetIndexRequest getIndexRequest)Gets information about an existing Amazon Q index.default GetPluginResponsegetPlugin(Consumer<GetPluginRequest.Builder> getPluginRequest)Gets information about an existing Amazon Q plugin.default GetPluginResponsegetPlugin(GetPluginRequest getPluginRequest)Gets information about an existing Amazon Q plugin.default GetRetrieverResponsegetRetriever(Consumer<GetRetrieverRequest.Builder> getRetrieverRequest)Gets information about an existing retriever used by an Amazon Q application.default GetRetrieverResponsegetRetriever(GetRetrieverRequest getRetrieverRequest)Gets information about an existing retriever used by an Amazon Q application.default GetUserResponsegetUser(Consumer<GetUserRequest.Builder> getUserRequest)Describes the universally unique identifier (UUID) associated with a local user in a data source.default GetUserResponsegetUser(GetUserRequest getUserRequest)Describes the universally unique identifier (UUID) associated with a local user in a data source.default GetWebExperienceResponsegetWebExperience(Consumer<GetWebExperienceRequest.Builder> getWebExperienceRequest)Gets information about an existing Amazon Q web experience.default GetWebExperienceResponsegetWebExperience(GetWebExperienceRequest getWebExperienceRequest)Gets information about an existing Amazon Q web experience.default ListApplicationsResponselistApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)Lists Amazon Q applications.default ListApplicationsResponselistApplications(ListApplicationsRequest listApplicationsRequest)Lists Amazon Q applications.default ListApplicationsIterablelistApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)This is a variant oflistApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)operation.default ListApplicationsIterablelistApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)This is a variant oflistApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)operation.default ListConversationsResponselistConversations(Consumer<ListConversationsRequest.Builder> listConversationsRequest)Lists one or more Amazon Q conversations.default ListConversationsResponselistConversations(ListConversationsRequest listConversationsRequest)Lists one or more Amazon Q conversations.default ListConversationsIterablelistConversationsPaginator(Consumer<ListConversationsRequest.Builder> listConversationsRequest)This is a variant oflistConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest)operation.default ListConversationsIterablelistConversationsPaginator(ListConversationsRequest listConversationsRequest)This is a variant oflistConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest)operation.default ListDataSourcesResponselistDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)Lists the Amazon Q data source connectors that you have created.default ListDataSourcesResponselistDataSources(ListDataSourcesRequest listDataSourcesRequest)Lists the Amazon Q data source connectors that you have created.default ListDataSourcesIterablelistDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)This is a variant oflistDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest)operation.default ListDataSourcesIterablelistDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)This is a variant oflistDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest)operation.default ListDataSourceSyncJobsResponselistDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)Get information about an Amazon Q data source connector synchronization.default ListDataSourceSyncJobsResponselistDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)Get information about an Amazon Q data source connector synchronization.default ListDataSourceSyncJobsIterablelistDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)This is a variant oflistDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest)operation.default ListDataSourceSyncJobsIterablelistDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)This is a variant oflistDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest)operation.default ListDocumentsResponselistDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)A list of documents attached to an index.default ListDocumentsResponselistDocuments(ListDocumentsRequest listDocumentsRequest)A list of documents attached to an index.default ListDocumentsIterablelistDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)This is a variant oflistDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest)operation.default ListDocumentsIterablelistDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)This is a variant oflistDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest)operation.default ListGroupsResponselistGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)Provides a list of groups that are mapped to users.default ListGroupsResponselistGroups(ListGroupsRequest listGroupsRequest)Provides a list of groups that are mapped to users.default ListGroupsIterablelistGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)This is a variant oflistGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest)operation.default ListGroupsIterablelistGroupsPaginator(ListGroupsRequest listGroupsRequest)This is a variant oflistGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest)operation.default ListIndicesResponselistIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)Lists the Amazon Q indices you have created.default ListIndicesResponselistIndices(ListIndicesRequest listIndicesRequest)Lists the Amazon Q indices you have created.default ListIndicesIterablelistIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)This is a variant oflistIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest)operation.default ListIndicesIterablelistIndicesPaginator(ListIndicesRequest listIndicesRequest)This is a variant oflistIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest)operation.default ListMessagesResponselistMessages(Consumer<ListMessagesRequest.Builder> listMessagesRequest)Gets a list of messages associated with an Amazon Q web experience.default ListMessagesResponselistMessages(ListMessagesRequest listMessagesRequest)Gets a list of messages associated with an Amazon Q web experience.default ListMessagesIterablelistMessagesPaginator(Consumer<ListMessagesRequest.Builder> listMessagesRequest)This is a variant oflistMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest)operation.default ListMessagesIterablelistMessagesPaginator(ListMessagesRequest listMessagesRequest)This is a variant oflistMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest)operation.default ListPluginsResponselistPlugins(Consumer<ListPluginsRequest.Builder> listPluginsRequest)Lists configured Amazon Q plugins.default ListPluginsResponselistPlugins(ListPluginsRequest listPluginsRequest)Lists configured Amazon Q plugins.default ListPluginsIterablelistPluginsPaginator(Consumer<ListPluginsRequest.Builder> listPluginsRequest)This is a variant oflistPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest)operation.default ListPluginsIterablelistPluginsPaginator(ListPluginsRequest listPluginsRequest)This is a variant oflistPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest)operation.default ListRetrieversResponselistRetrievers(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest)Lists the retriever used by an Amazon Q application.default ListRetrieversResponselistRetrievers(ListRetrieversRequest listRetrieversRequest)Lists the retriever used by an Amazon Q application.default ListRetrieversIterablelistRetrieversPaginator(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest)This is a variant oflistRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest)operation.default ListRetrieversIterablelistRetrieversPaginator(ListRetrieversRequest listRetrieversRequest)This is a variant oflistRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Gets a list of tags associated with a specified resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Gets a list of tags associated with a specified resource.default ListWebExperiencesResponselistWebExperiences(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest)Lists one or more Amazon Q Web Experiences.default ListWebExperiencesResponselistWebExperiences(ListWebExperiencesRequest listWebExperiencesRequest)Lists one or more Amazon Q Web Experiences.default ListWebExperiencesIterablelistWebExperiencesPaginator(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest)This is a variant oflistWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest)operation.default ListWebExperiencesIterablelistWebExperiencesPaginator(ListWebExperiencesRequest listWebExperiencesRequest)This is a variant oflistWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest)operation.default PutFeedbackResponseputFeedback(Consumer<PutFeedbackRequest.Builder> putFeedbackRequest)Enables your end user to to provide feedback on their Amazon Q generated chat responses.default PutFeedbackResponseputFeedback(PutFeedbackRequest putFeedbackRequest)Enables your end user to to provide feedback on their Amazon Q generated chat responses.default PutGroupResponseputGroup(Consumer<PutGroupRequest.Builder> putGroupRequest)Create, or updates, a mapping of users—who have access to a document—to groups.default PutGroupResponseputGroup(PutGroupRequest putGroupRequest)Create, or updates, a mapping of users—who have access to a document—to groups.default QBusinessServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartDataSourceSyncJobResponsestartDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest)Starts a data source connector synchronization job.default StartDataSourceSyncJobResponsestartDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)Starts a data source connector synchronization job.default StopDataSourceSyncJobResponsestopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest)Stops an Amazon Q data source connector synchronization job already in progress.default StopDataSourceSyncJobResponsestopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)Stops an Amazon Q data source connector synchronization job already in progress.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds the specified tag to the specified Amazon Q application or data source resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds the specified tag to the specified Amazon Q application or data source resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes a tag from an Amazon Q application or a data source.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes a tag from an Amazon Q application or a data source.default UpdateApplicationResponseupdateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)Updates an existing Amazon Q application.default UpdateApplicationResponseupdateApplication(UpdateApplicationRequest updateApplicationRequest)Updates an existing Amazon Q application.default UpdateChatControlsConfigurationResponseupdateChatControlsConfiguration(Consumer<UpdateChatControlsConfigurationRequest.Builder> updateChatControlsConfigurationRequest)Updates an set of chat controls configured for an existing Amazon Q application.default UpdateChatControlsConfigurationResponseupdateChatControlsConfiguration(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest)Updates an set of chat controls configured for an existing Amazon Q application.default UpdateDataSourceResponseupdateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)Updates an existing Amazon Q data source connector.default UpdateDataSourceResponseupdateDataSource(UpdateDataSourceRequest updateDataSourceRequest)Updates an existing Amazon Q data source connector.default UpdateIndexResponseupdateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest)Updates an Amazon Q index.default UpdateIndexResponseupdateIndex(UpdateIndexRequest updateIndexRequest)Updates an Amazon Q index.default UpdatePluginResponseupdatePlugin(Consumer<UpdatePluginRequest.Builder> updatePluginRequest)Updates an Amazon Q plugin.default UpdatePluginResponseupdatePlugin(UpdatePluginRequest updatePluginRequest)Updates an Amazon Q plugin.default UpdateRetrieverResponseupdateRetriever(Consumer<UpdateRetrieverRequest.Builder> updateRetrieverRequest)Updates the retriever used for your Amazon Q application.default UpdateRetrieverResponseupdateRetriever(UpdateRetrieverRequest updateRetrieverRequest)Updates the retriever used for your Amazon Q application.default UpdateUserResponseupdateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)Updates a information associated with a user id.default UpdateUserResponseupdateUser(UpdateUserRequest updateUserRequest)Updates a information associated with a user id.default UpdateWebExperienceResponseupdateWebExperience(Consumer<UpdateWebExperienceRequest.Builder> updateWebExperienceRequest)Updates an Amazon Q web experience.default UpdateWebExperienceResponseupdateWebExperience(UpdateWebExperienceRequest updateWebExperienceRequest)Updates an Amazon Q web experience.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchDeleteDocument
default BatchDeleteDocumentResponse batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Asynchronously deletes one or more documents added using the
BatchPutDocumentAPI from an Amazon Q index.You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
- Parameters:
batchDeleteDocumentRequest-- Returns:
- Result of the BatchDeleteDocument operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteDocument
default BatchDeleteDocumentResponse batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Asynchronously deletes one or more documents added using the
BatchPutDocumentAPI from an Amazon Q index.You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
This is a convenience which creates an instance of the
BatchDeleteDocumentRequest.Builderavoiding the need to create one manually viaBatchDeleteDocumentRequest.builder()- Parameters:
batchDeleteDocumentRequest- AConsumerthat will call methods onBatchDeleteDocumentRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteDocument operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutDocument
default BatchPutDocumentResponse batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Adds 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.
- Parameters:
batchPutDocumentRequest-- Returns:
- Result of the BatchPutDocument operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
batchPutDocument
default BatchPutDocumentResponse batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Adds 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.
This is a convenience which creates an instance of the
BatchPutDocumentRequest.Builderavoiding the need to create one manually viaBatchPutDocumentRequest.builder()- Parameters:
batchPutDocumentRequest- AConsumerthat will call methods onBatchPutDocumentRequest.Builderto create a request.- Returns:
- Result of the BatchPutDocument operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
chatSync
default ChatSyncResponse chatSync(ChatSyncRequest chatSyncRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Starts or continues a non-streaming Amazon Q conversation.
- Parameters:
chatSyncRequest-- Returns:
- Result of the ChatSync operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
chatSync
default ChatSyncResponse chatSync(Consumer<ChatSyncRequest.Builder> chatSyncRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Starts or continues a non-streaming Amazon Q conversation.
This is a convenience which creates an instance of the
ChatSyncRequest.Builderavoiding the need to create one manually viaChatSyncRequest.builder()- Parameters:
chatSyncRequest- AConsumerthat will call methods onChatSyncRequest.Builderto create a request.- Returns:
- Result of the ChatSync operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createApplication
default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates an Amazon Q application.
- Parameters:
createApplicationRequest-- Returns:
- Result of the CreateApplication operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createApplication
default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates an Amazon Q application.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builderavoiding the need to create one manually viaCreateApplicationRequest.builder()- Parameters:
createApplicationRequest- AConsumerthat will call methods onCreateApplicationRequest.Builderto create a request.- Returns:
- Result of the CreateApplication operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDataSource
default CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates a data source connector for an Amazon Q application.
CreateDataSourceis a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.- Parameters:
createDataSourceRequest-- Returns:
- Result of the CreateDataSource operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDataSource
default CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates a data source connector for an Amazon Q application.
CreateDataSourceis a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
This is a convenience which creates an instance of the
CreateDataSourceRequest.Builderavoiding the need to create one manually viaCreateDataSourceRequest.builder()- Parameters:
createDataSourceRequest- AConsumerthat will call methods onCreateDataSourceRequest.Builderto create a request.- Returns:
- Result of the CreateDataSource operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createIndex
default CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates an Amazon Q index.
To determine if index creation has completed, check the
Statusfield returned from a call toDescribeIndex. TheStatusfield is set toACTIVEwhen the index is ready to use.Once the index is active, you can index your documents using the
BatchPutDocumentAPI or theCreateDataSourceAPI.- Parameters:
createIndexRequest-- Returns:
- Result of the CreateIndex operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createIndex
default CreateIndexResponse createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates an Amazon Q index.
To determine if index creation has completed, check the
Statusfield returned from a call toDescribeIndex. TheStatusfield is set toACTIVEwhen the index is ready to use.Once the index is active, you can index your documents using the
BatchPutDocumentAPI or theCreateDataSourceAPI.
This is a convenience which creates an instance of the
CreateIndexRequest.Builderavoiding the need to create one manually viaCreateIndexRequest.builder()- Parameters:
createIndexRequest- AConsumerthat will call methods onCreateIndexRequest.Builderto create a request.- Returns:
- Result of the CreateIndex operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPlugin
default CreatePluginResponse createPlugin(CreatePluginRequest createPluginRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates an Amazon Q plugin.
- Parameters:
createPluginRequest-- Returns:
- Result of the CreatePlugin operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPlugin
default CreatePluginResponse createPlugin(Consumer<CreatePluginRequest.Builder> createPluginRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates an Amazon Q plugin.
This is a convenience which creates an instance of the
CreatePluginRequest.Builderavoiding the need to create one manually viaCreatePluginRequest.builder()- Parameters:
createPluginRequest- AConsumerthat will call methods onCreatePluginRequest.Builderto create a request.- Returns:
- Result of the CreatePlugin operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRetriever
default CreateRetrieverResponse createRetriever(CreateRetrieverRequest createRetrieverRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Adds a retriever to your Amazon Q application.
- Parameters:
createRetrieverRequest-- Returns:
- Result of the CreateRetriever operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRetriever
default CreateRetrieverResponse createRetriever(Consumer<CreateRetrieverRequest.Builder> createRetrieverRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Adds a retriever to your Amazon Q application.
This is a convenience which creates an instance of the
CreateRetrieverRequest.Builderavoiding the need to create one manually viaCreateRetrieverRequest.builder()- Parameters:
createRetrieverRequest- AConsumerthat will call methods onCreateRetrieverRequest.Builderto create a request.- Returns:
- Result of the CreateRetriever operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
- Parameters:
createUserRequest-- Returns:
- Result of the CreateUser operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
This is a convenience which creates an instance of the
CreateUserRequest.Builderavoiding the need to create one manually viaCreateUserRequest.builder()- Parameters:
createUserRequest- AConsumerthat will call methods onCreateUserRequest.Builderto create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWebExperience
default CreateWebExperienceResponse createWebExperience(CreateWebExperienceRequest createWebExperienceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates an Amazon Q web experience.
- Parameters:
createWebExperienceRequest-- Returns:
- Result of the CreateWebExperience operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWebExperience
default CreateWebExperienceResponse createWebExperience(Consumer<CreateWebExperienceRequest.Builder> createWebExperienceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Creates an Amazon Q web experience.
This is a convenience which creates an instance of the
CreateWebExperienceRequest.Builderavoiding the need to create one manually viaCreateWebExperienceRequest.builder()- Parameters:
createWebExperienceRequest- AConsumerthat will call methods onCreateWebExperienceRequest.Builderto create a request.- Returns:
- Result of the CreateWebExperience operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplication
default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q application.
- Parameters:
deleteApplicationRequest-- Returns:
- Result of the DeleteApplication operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplication
default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q application.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builderavoiding the need to create one manually viaDeleteApplicationRequest.builder()- Parameters:
deleteApplicationRequest- AConsumerthat will call methods onDeleteApplicationRequest.Builderto create a request.- Returns:
- Result of the DeleteApplication operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteChatControlsConfiguration
default DeleteChatControlsConfigurationResponse deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes chat controls configured for an existing Amazon Q application.
- Parameters:
deleteChatControlsConfigurationRequest-- Returns:
- Result of the DeleteChatControlsConfiguration operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteChatControlsConfiguration
default DeleteChatControlsConfigurationResponse deleteChatControlsConfiguration(Consumer<DeleteChatControlsConfigurationRequest.Builder> deleteChatControlsConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes chat controls configured for an existing Amazon Q application.
This is a convenience which creates an instance of the
DeleteChatControlsConfigurationRequest.Builderavoiding the need to create one manually viaDeleteChatControlsConfigurationRequest.builder()- Parameters:
deleteChatControlsConfigurationRequest- AConsumerthat will call methods onDeleteChatControlsConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteChatControlsConfiguration operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConversation
default DeleteConversationResponse deleteConversation(DeleteConversationRequest deleteConversationRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q web experience conversation.
- Parameters:
deleteConversationRequest-- Returns:
- Result of the DeleteConversation operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConversation
default DeleteConversationResponse deleteConversation(Consumer<DeleteConversationRequest.Builder> deleteConversationRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q web experience conversation.
This is a convenience which creates an instance of the
DeleteConversationRequest.Builderavoiding the need to create one manually viaDeleteConversationRequest.builder()- Parameters:
deleteConversationRequest- AConsumerthat will call methods onDeleteConversationRequest.Builderto create a request.- Returns:
- Result of the DeleteConversation operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q data source connector. While the data source is being deleted, the
Statusfield returned by a call to theDescribeDataSourceAPI is set toDELETING.- Parameters:
deleteDataSourceRequest-- Returns:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q data source connector. While the data source is being deleted, the
Statusfield returned by a call to theDescribeDataSourceAPI is set toDELETING.
This is a convenience which creates an instance of the
DeleteDataSourceRequest.Builderavoiding the need to create one manually viaDeleteDataSourceRequest.builder()- Parameters:
deleteDataSourceRequest- AConsumerthat will call methods onDeleteDataSourceRequest.Builderto create a request.- Returns:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
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
PutGroupoperation. 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 callingPutGroup.- Parameters:
deleteGroupRequest-- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
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
PutGroupoperation. 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 callingPutGroup.
This is a convenience which creates an instance of the
DeleteGroupRequest.Builderavoiding the need to create one manually viaDeleteGroupRequest.builder()- Parameters:
deleteGroupRequest- AConsumerthat will call methods onDeleteGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteIndex
default DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q index.
- Parameters:
deleteIndexRequest-- Returns:
- Result of the DeleteIndex operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteIndex
default DeleteIndexResponse deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q index.
This is a convenience which creates an instance of the
DeleteIndexRequest.Builderavoiding the need to create one manually viaDeleteIndexRequest.builder()- Parameters:
deleteIndexRequest- AConsumerthat will call methods onDeleteIndexRequest.Builderto create a request.- Returns:
- Result of the DeleteIndex operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePlugin
default DeletePluginResponse deletePlugin(DeletePluginRequest deletePluginRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q plugin.
- Parameters:
deletePluginRequest-- Returns:
- Result of the DeletePlugin operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePlugin
default DeletePluginResponse deletePlugin(Consumer<DeletePluginRequest.Builder> deletePluginRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q plugin.
This is a convenience which creates an instance of the
DeletePluginRequest.Builderavoiding the need to create one manually viaDeletePluginRequest.builder()- Parameters:
deletePluginRequest- AConsumerthat will call methods onDeletePluginRequest.Builderto create a request.- Returns:
- Result of the DeletePlugin operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRetriever
default DeleteRetrieverResponse deleteRetriever(DeleteRetrieverRequest deleteRetrieverRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes the retriever used by an Amazon Q application.
- Parameters:
deleteRetrieverRequest-- Returns:
- Result of the DeleteRetriever operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRetriever
default DeleteRetrieverResponse deleteRetriever(Consumer<DeleteRetrieverRequest.Builder> deleteRetrieverRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes the retriever used by an Amazon Q application.
This is a convenience which creates an instance of the
DeleteRetrieverRequest.Builderavoiding the need to create one manually viaDeleteRetrieverRequest.builder()- Parameters:
deleteRetrieverRequest- AConsumerthat will call methods onDeleteRetrieverRequest.Builderto create a request.- Returns:
- Result of the DeleteRetriever operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes a user by email id.
- Parameters:
deleteUserRequest-- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes a user by email id.
This is a convenience which creates an instance of the
DeleteUserRequest.Builderavoiding the need to create one manually viaDeleteUserRequest.builder()- Parameters:
deleteUserRequest- AConsumerthat will call methods onDeleteUserRequest.Builderto create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWebExperience
default DeleteWebExperienceResponse deleteWebExperience(DeleteWebExperienceRequest deleteWebExperienceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q web experience.
- Parameters:
deleteWebExperienceRequest-- Returns:
- Result of the DeleteWebExperience operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWebExperience
default DeleteWebExperienceResponse deleteWebExperience(Consumer<DeleteWebExperienceRequest.Builder> deleteWebExperienceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Deletes an Amazon Q web experience.
This is a convenience which creates an instance of the
DeleteWebExperienceRequest.Builderavoiding the need to create one manually viaDeleteWebExperienceRequest.builder()- Parameters:
deleteWebExperienceRequest- AConsumerthat will call methods onDeleteWebExperienceRequest.Builderto create a request.- Returns:
- Result of the DeleteWebExperience operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplication
default GetApplicationResponse getApplication(GetApplicationRequest getApplicationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q application.
- Parameters:
getApplicationRequest-- Returns:
- Result of the GetApplication operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApplication
default GetApplicationResponse getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q application.
This is a convenience which creates an instance of the
GetApplicationRequest.Builderavoiding the need to create one manually viaGetApplicationRequest.builder()- Parameters:
getApplicationRequest- AConsumerthat will call methods onGetApplicationRequest.Builderto create a request.- Returns:
- Result of the GetApplication operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getChatControlsConfiguration
default GetChatControlsConfigurationResponse getChatControlsConfiguration(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an chat controls configured for an existing Amazon Q application.
- Parameters:
getChatControlsConfigurationRequest-- Returns:
- Result of the GetChatControlsConfiguration operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getChatControlsConfiguration
default GetChatControlsConfigurationResponse getChatControlsConfiguration(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an chat controls configured for an existing Amazon Q application.
This is a convenience which creates an instance of the
GetChatControlsConfigurationRequest.Builderavoiding the need to create one manually viaGetChatControlsConfigurationRequest.builder()- Parameters:
getChatControlsConfigurationRequest- AConsumerthat will call methods onGetChatControlsConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetChatControlsConfiguration operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getChatControlsConfigurationPaginator
default GetChatControlsConfigurationIterable getChatControlsConfigurationPaginator(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
getChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationIterable responses = client.getChatControlsConfigurationPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationIterable responses = client .getChatControlsConfigurationPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationIterable responses = client.getChatControlsConfigurationPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest)operation.- Parameters:
getChatControlsConfigurationRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getChatControlsConfigurationPaginator
default GetChatControlsConfigurationIterable getChatControlsConfigurationPaginator(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
getChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationIterable responses = client.getChatControlsConfigurationPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationIterable responses = client .getChatControlsConfigurationPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationIterable responses = client.getChatControlsConfigurationPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest)operation.
This is a convenience which creates an instance of the
GetChatControlsConfigurationRequest.Builderavoiding the need to create one manually viaGetChatControlsConfigurationRequest.builder()- Parameters:
getChatControlsConfigurationRequest- AConsumerthat will call methods onGetChatControlsConfigurationRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDataSource
default GetDataSourceResponse getDataSource(GetDataSourceRequest getDataSourceRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q data source connector.
- Parameters:
getDataSourceRequest-- Returns:
- Result of the GetDataSource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDataSource
default GetDataSourceResponse getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q data source connector.
This is a convenience which creates an instance of the
GetDataSourceRequest.Builderavoiding the need to create one manually viaGetDataSourceRequest.builder()- Parameters:
getDataSourceRequest- AConsumerthat will call methods onGetDataSourceRequest.Builderto create a request.- Returns:
- Result of the GetDataSource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getGroup
default GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Describes a group by group name.
- Parameters:
getGroupRequest-- Returns:
- Result of the GetGroup operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getGroup
default GetGroupResponse getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Describes a group by group name.
This is a convenience which creates an instance of the
GetGroupRequest.Builderavoiding the need to create one manually viaGetGroupRequest.builder()- Parameters:
getGroupRequest- AConsumerthat will call methods onGetGroupRequest.Builderto create a request.- Returns:
- Result of the GetGroup operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getIndex
default GetIndexResponse getIndex(GetIndexRequest getIndexRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q index.
- Parameters:
getIndexRequest-- Returns:
- Result of the GetIndex operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getIndex
default GetIndexResponse getIndex(Consumer<GetIndexRequest.Builder> getIndexRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q index.
This is a convenience which creates an instance of the
GetIndexRequest.Builderavoiding the need to create one manually viaGetIndexRequest.builder()- Parameters:
getIndexRequest- AConsumerthat will call methods onGetIndexRequest.Builderto create a request.- Returns:
- Result of the GetIndex operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPlugin
default GetPluginResponse getPlugin(GetPluginRequest getPluginRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q plugin.
- Parameters:
getPluginRequest-- Returns:
- Result of the GetPlugin operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPlugin
default GetPluginResponse getPlugin(Consumer<GetPluginRequest.Builder> getPluginRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q plugin.
This is a convenience which creates an instance of the
GetPluginRequest.Builderavoiding the need to create one manually viaGetPluginRequest.builder()- Parameters:
getPluginRequest- AConsumerthat will call methods onGetPluginRequest.Builderto create a request.- Returns:
- Result of the GetPlugin operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRetriever
default GetRetrieverResponse getRetriever(GetRetrieverRequest getRetrieverRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing retriever used by an Amazon Q application.
- Parameters:
getRetrieverRequest-- Returns:
- Result of the GetRetriever operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRetriever
default GetRetrieverResponse getRetriever(Consumer<GetRetrieverRequest.Builder> getRetrieverRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing retriever used by an Amazon Q application.
This is a convenience which creates an instance of the
GetRetrieverRequest.Builderavoiding the need to create one manually viaGetRetrieverRequest.builder()- Parameters:
getRetrieverRequest- AConsumerthat will call methods onGetRetrieverRequest.Builderto create a request.- Returns:
- Result of the GetRetriever operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getUser
default GetUserResponse getUser(GetUserRequest getUserRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Describes the universally unique identifier (UUID) associated with a local user in a data source.
- Parameters:
getUserRequest-- Returns:
- Result of the GetUser operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getUser
default GetUserResponse getUser(Consumer<GetUserRequest.Builder> getUserRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Describes the universally unique identifier (UUID) associated with a local user in a data source.
This is a convenience which creates an instance of the
GetUserRequest.Builderavoiding the need to create one manually viaGetUserRequest.builder()- Parameters:
getUserRequest- AConsumerthat will call methods onGetUserRequest.Builderto create a request.- Returns:
- Result of the GetUser operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getWebExperience
default GetWebExperienceResponse getWebExperience(GetWebExperienceRequest getWebExperienceRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q web experience.
- Parameters:
getWebExperienceRequest-- Returns:
- Result of the GetWebExperience operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getWebExperience
default GetWebExperienceResponse getWebExperience(Consumer<GetWebExperienceRequest.Builder> getWebExperienceRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets information about an existing Amazon Q web experience.
This is a convenience which creates an instance of the
GetWebExperienceRequest.Builderavoiding the need to create one manually viaGetWebExperienceRequest.builder()- Parameters:
getWebExperienceRequest- AConsumerthat will call methods onGetWebExperienceRequest.Builderto create a request.- Returns:
- Result of the GetWebExperience operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplications
default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists Amazon Q applications.
- Parameters:
listApplicationsRequest-- Returns:
- Result of the ListApplications operation returned by the service.
- Throws:
InternalServerException- An issue occurred with the internal server used for your Amazon Q 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplications
default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists Amazon Q applications.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request.- Returns:
- Result of the ListApplications operation returned by the service.
- Throws:
InternalServerException- An issue occurred with the internal server used for your Amazon Q 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListApplicationsIterable responses = client .listApplicationsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListApplicationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)operation.- Parameters:
listApplicationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An issue occurred with the internal server used for your Amazon Q 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListApplicationsIterable responses = client .listApplicationsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListApplicationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)operation.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerException- An issue occurred with the internal server used for your Amazon Q 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listConversations
default ListConversationsResponse listConversations(ListConversationsRequest listConversationsRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists one or more Amazon Q conversations.
- Parameters:
listConversationsRequest-- Returns:
- Result of the ListConversations operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listConversations
default ListConversationsResponse listConversations(Consumer<ListConversationsRequest.Builder> listConversationsRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists one or more Amazon Q conversations.
This is a convenience which creates an instance of the
ListConversationsRequest.Builderavoiding the need to create one manually viaListConversationsRequest.builder()- Parameters:
listConversationsRequest- AConsumerthat will call methods onListConversationsRequest.Builderto create a request.- Returns:
- Result of the ListConversations operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listConversationsPaginator
default ListConversationsIterable listConversationsPaginator(ListConversationsRequest listConversationsRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListConversationsIterable responses = client.listConversationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListConversationsIterable responses = client .listConversationsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListConversationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListConversationsIterable responses = client.listConversationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest)operation.- Parameters:
listConversationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listConversationsPaginator
default ListConversationsIterable listConversationsPaginator(Consumer<ListConversationsRequest.Builder> listConversationsRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListConversationsIterable responses = client.listConversationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListConversationsIterable responses = client .listConversationsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListConversationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListConversationsIterable responses = client.listConversationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest)operation.
This is a convenience which creates an instance of the
ListConversationsRequest.Builderavoiding the need to create one manually viaListConversationsRequest.builder()- Parameters:
listConversationsRequest- AConsumerthat will call methods onListConversationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourceSyncJobs
default ListDataSourceSyncJobsResponse listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Get information about an Amazon Q data source connector synchronization.
- Parameters:
listDataSourceSyncJobsRequest-- Returns:
- Result of the ListDataSourceSyncJobs operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourceSyncJobs
default ListDataSourceSyncJobsResponse listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Get information about an Amazon Q data source connector synchronization.
This is a convenience which creates an instance of the
ListDataSourceSyncJobsRequest.Builderavoiding the need to create one manually viaListDataSourceSyncJobsRequest.builder()- Parameters:
listDataSourceSyncJobsRequest- AConsumerthat will call methods onListDataSourceSyncJobsRequest.Builderto create a request.- Returns:
- Result of the ListDataSourceSyncJobs operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourceSyncJobsPaginator
default ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsIterable responses = client .listDataSourceSyncJobsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest)operation.- Parameters:
listDataSourceSyncJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourceSyncJobsPaginator
default ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsIterable responses = client .listDataSourceSyncJobsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest)operation.
This is a convenience which creates an instance of the
ListDataSourceSyncJobsRequest.Builderavoiding the need to create one manually viaListDataSourceSyncJobsRequest.builder()- Parameters:
listDataSourceSyncJobsRequest- AConsumerthat will call methods onListDataSourceSyncJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSources
default ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists the Amazon Q data source connectors that you have created.
- Parameters:
listDataSourcesRequest-- Returns:
- Result of the ListDataSources operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSources
default ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists the Amazon Q data source connectors that you have created.
This is a convenience which creates an instance of the
ListDataSourcesRequest.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto create a request.- Returns:
- Result of the ListDataSources operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListDataSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest)operation.- Parameters:
listDataSourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListDataSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest)operation.
This is a convenience which creates an instance of the
ListDataSourcesRequest.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDocuments
default ListDocumentsResponse listDocuments(ListDocumentsRequest listDocumentsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
A list of documents attached to an index.
- Parameters:
listDocumentsRequest-- Returns:
- Result of the ListDocuments operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDocuments
default ListDocumentsResponse listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
A list of documents attached to an index.
This is a convenience which creates an instance of the
ListDocumentsRequest.Builderavoiding the need to create one manually viaListDocumentsRequest.builder()- Parameters:
listDocumentsRequest- AConsumerthat will call methods onListDocumentsRequest.Builderto create a request.- Returns:
- Result of the ListDocuments operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentsPaginator
default ListDocumentsIterable listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListDocumentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest)operation.- Parameters:
listDocumentsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDocumentsPaginator
default ListDocumentsIterable listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListDocumentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest)operation.
This is a convenience which creates an instance of the
ListDocumentsRequest.Builderavoiding the need to create one manually viaListDocumentsRequest.builder()- Parameters:
listDocumentsRequest- AConsumerthat will call methods onListDocumentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Provides a list of groups that are mapped to users.
- Parameters:
listGroupsRequest-- Returns:
- Result of the ListGroups operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Provides a list of groups that are mapped to users.
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- Result of the ListGroups operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest)operation.- Parameters:
listGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest)operation.
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listIndices
default ListIndicesResponse listIndices(ListIndicesRequest listIndicesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists the Amazon Q indices you have created.
- Parameters:
listIndicesRequest-- Returns:
- Result of the ListIndices operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listIndices
default ListIndicesResponse listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists the Amazon Q indices you have created.
This is a convenience which creates an instance of the
ListIndicesRequest.Builderavoiding the need to create one manually viaListIndicesRequest.builder()- Parameters:
listIndicesRequest- AConsumerthat will call methods onListIndicesRequest.Builderto create a request.- Returns:
- Result of the ListIndices operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listIndicesPaginator
default ListIndicesIterable listIndicesPaginator(ListIndicesRequest listIndicesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListIndicesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest)operation.- Parameters:
listIndicesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listIndicesPaginator
default ListIndicesIterable listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListIndicesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest)operation.
This is a convenience which creates an instance of the
ListIndicesRequest.Builderavoiding the need to create one manually viaListIndicesRequest.builder()- Parameters:
listIndicesRequest- AConsumerthat will call methods onListIndicesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessages
default ListMessagesResponse listMessages(ListMessagesRequest listMessagesRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets a list of messages associated with an Amazon Q web experience.
- Parameters:
listMessagesRequest-- Returns:
- Result of the ListMessages operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessages
default ListMessagesResponse listMessages(Consumer<ListMessagesRequest.Builder> listMessagesRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets a list of messages associated with an Amazon Q web experience.
This is a convenience which creates an instance of the
ListMessagesRequest.Builderavoiding the need to create one manually viaListMessagesRequest.builder()- Parameters:
listMessagesRequest- AConsumerthat will call methods onListMessagesRequest.Builderto create a request.- Returns:
- Result of the ListMessages operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessagesPaginator
default ListMessagesIterable listMessagesPaginator(ListMessagesRequest listMessagesRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListMessagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest)operation.- Parameters:
listMessagesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessagesPaginator
default ListMessagesIterable listMessagesPaginator(Consumer<ListMessagesRequest.Builder> listMessagesRequest) throws ResourceNotFoundException, InternalServerException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListMessagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest)operation.
This is a convenience which creates an instance of the
ListMessagesRequest.Builderavoiding the need to create one manually viaListMessagesRequest.builder()- Parameters:
listMessagesRequest- AConsumerthat will call methods onListMessagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPlugins
default ListPluginsResponse listPlugins(ListPluginsRequest listPluginsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists configured Amazon Q plugins.
- Parameters:
listPluginsRequest-- Returns:
- Result of the ListPlugins operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPlugins
default ListPluginsResponse listPlugins(Consumer<ListPluginsRequest.Builder> listPluginsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists configured Amazon Q plugins.
This is a convenience which creates an instance of the
ListPluginsRequest.Builderavoiding the need to create one manually viaListPluginsRequest.builder()- Parameters:
listPluginsRequest- AConsumerthat will call methods onListPluginsRequest.Builderto create a request.- Returns:
- Result of the ListPlugins operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPluginsPaginator
default ListPluginsIterable listPluginsPaginator(ListPluginsRequest listPluginsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginsIterable responses = client.listPluginsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListPluginsIterable responses = client.listPluginsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListPluginsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginsIterable responses = client.listPluginsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest)operation.- Parameters:
listPluginsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPluginsPaginator
default ListPluginsIterable listPluginsPaginator(Consumer<ListPluginsRequest.Builder> listPluginsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginsIterable responses = client.listPluginsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListPluginsIterable responses = client.listPluginsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListPluginsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginsIterable responses = client.listPluginsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest)operation.
This is a convenience which creates an instance of the
ListPluginsRequest.Builderavoiding the need to create one manually viaListPluginsRequest.builder()- Parameters:
listPluginsRequest- AConsumerthat will call methods onListPluginsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRetrievers
default ListRetrieversResponse listRetrievers(ListRetrieversRequest listRetrieversRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists the retriever used by an Amazon Q application.
- Parameters:
listRetrieversRequest-- Returns:
- Result of the ListRetrievers operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRetrievers
default ListRetrieversResponse listRetrievers(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists the retriever used by an Amazon Q application.
This is a convenience which creates an instance of the
ListRetrieversRequest.Builderavoiding the need to create one manually viaListRetrieversRequest.builder()- Parameters:
listRetrieversRequest- AConsumerthat will call methods onListRetrieversRequest.Builderto create a request.- Returns:
- Result of the ListRetrievers operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRetrieversPaginator
default ListRetrieversIterable listRetrieversPaginator(ListRetrieversRequest listRetrieversRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListRetrieversIterable responses = client.listRetrieversPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListRetrieversIterable responses = client .listRetrieversPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListRetrieversResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListRetrieversIterable responses = client.listRetrieversPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest)operation.- Parameters:
listRetrieversRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRetrieversPaginator
default ListRetrieversIterable listRetrieversPaginator(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListRetrieversIterable responses = client.listRetrieversPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListRetrieversIterable responses = client .listRetrieversPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListRetrieversResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListRetrieversIterable responses = client.listRetrieversPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest)operation.
This is a convenience which creates an instance of the
ListRetrieversRequest.Builderavoiding the need to create one manually viaListRetrieversRequest.builder()- Parameters:
listRetrieversRequest- AConsumerthat will call methods onListRetrieversRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Gets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWebExperiences
default ListWebExperiencesResponse listWebExperiences(ListWebExperiencesRequest listWebExperiencesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists one or more Amazon Q Web Experiences.
- Parameters:
listWebExperiencesRequest-- Returns:
- Result of the ListWebExperiences operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWebExperiences
default ListWebExperiencesResponse listWebExperiences(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Lists one or more Amazon Q Web Experiences.
This is a convenience which creates an instance of the
ListWebExperiencesRequest.Builderavoiding the need to create one manually viaListWebExperiencesRequest.builder()- Parameters:
listWebExperiencesRequest- AConsumerthat will call methods onListWebExperiencesRequest.Builderto create a request.- Returns:
- Result of the ListWebExperiences operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWebExperiencesPaginator
default ListWebExperiencesIterable listWebExperiencesPaginator(ListWebExperiencesRequest listWebExperiencesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesIterable responses = client.listWebExperiencesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesIterable responses = client .listWebExperiencesPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesIterable responses = client.listWebExperiencesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest)operation.- Parameters:
listWebExperiencesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWebExperiencesPaginator
default ListWebExperiencesIterable listWebExperiencesPaginator(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
This is a variant of
listWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesIterable responses = client.listWebExperiencesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesIterable responses = client .listWebExperiencesPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesIterable responses = client.listWebExperiencesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest)operation.
This is a convenience which creates an instance of the
ListWebExperiencesRequest.Builderavoiding the need to create one manually viaListWebExperiencesRequest.builder()- Parameters:
listWebExperiencesRequest- AConsumerthat will call methods onListWebExperiencesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putFeedback
default PutFeedbackResponse putFeedback(PutFeedbackRequest putFeedbackRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Enables your end user to to provide feedback on their Amazon Q generated chat responses.
- Parameters:
putFeedbackRequest-- Returns:
- Result of the PutFeedback operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putFeedback
default PutFeedbackResponse putFeedback(Consumer<PutFeedbackRequest.Builder> putFeedbackRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Enables your end user to to provide feedback on their Amazon Q generated chat responses.
This is a convenience which creates an instance of the
PutFeedbackRequest.Builderavoiding the need to create one manually viaPutFeedbackRequest.builder()- Parameters:
putFeedbackRequest- AConsumerthat will call methods onPutFeedbackRequest.Builderto create a request.- Returns:
- Result of the PutFeedback operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putGroup
default PutGroupResponse putGroup(PutGroupRequest putGroupRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
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 chat results.
- Parameters:
putGroupRequest-- Returns:
- Result of the PutGroup operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putGroup
default PutGroupResponse putGroup(Consumer<PutGroupRequest.Builder> putGroupRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
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 chat results.
This is a convenience which creates an instance of the
PutGroupRequest.Builderavoiding the need to create one manually viaPutGroupRequest.builder()- Parameters:
putGroupRequest- AConsumerthat will call methods onPutGroupRequest.Builderto create a request.- Returns:
- Result of the PutGroup operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startDataSourceSyncJob
default StartDataSourceSyncJobResponse startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a
ConflictException.- Parameters:
startDataSourceSyncJobRequest-- Returns:
- Result of the StartDataSourceSyncJob operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startDataSourceSyncJob
default StartDataSourceSyncJobResponse startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a
ConflictException.
This is a convenience which creates an instance of the
StartDataSourceSyncJobRequest.Builderavoiding the need to create one manually viaStartDataSourceSyncJobRequest.builder()- Parameters:
startDataSourceSyncJobRequest- AConsumerthat will call methods onStartDataSourceSyncJobRequest.Builderto create a request.- Returns:
- Result of the StartDataSourceSyncJob operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopDataSourceSyncJob
default StopDataSourceSyncJobResponse stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Stops an Amazon Q data source connector synchronization job already in progress.
- Parameters:
stopDataSourceSyncJobRequest-- Returns:
- Result of the StopDataSourceSyncJob operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopDataSourceSyncJob
default StopDataSourceSyncJobResponse stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Stops an Amazon Q data source connector synchronization job already in progress.
This is a convenience which creates an instance of the
StopDataSourceSyncJobRequest.Builderavoiding the need to create one manually viaStopDataSourceSyncJobRequest.builder()- Parameters:
stopDataSourceSyncJobRequest- AConsumerthat will call methods onStopDataSourceSyncJobRequest.Builderto create a request.- Returns:
- Result of the StopDataSourceSyncJob operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Adds 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.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Adds 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Removes a tag from an Amazon Q application or a data source.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Removes a tag from an Amazon Q application or a data source.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplication
default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Updates an existing Amazon Q application.
- Parameters:
updateApplicationRequest-- Returns:
- Result of the UpdateApplication operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplication
default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Updates an existing Amazon Q application.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builderavoiding the need to create one manually viaUpdateApplicationRequest.builder()- Parameters:
updateApplicationRequest- AConsumerthat will call methods onUpdateApplicationRequest.Builderto create a request.- Returns:
- Result of the UpdateApplication operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateChatControlsConfiguration
default UpdateChatControlsConfigurationResponse updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates an set of chat controls configured for an existing Amazon Q application.
- Parameters:
updateChatControlsConfigurationRequest-- Returns:
- Result of the UpdateChatControlsConfiguration operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateChatControlsConfiguration
default UpdateChatControlsConfigurationResponse updateChatControlsConfiguration(Consumer<UpdateChatControlsConfigurationRequest.Builder> updateChatControlsConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates an set of chat controls configured for an existing Amazon Q application.
This is a convenience which creates an instance of the
UpdateChatControlsConfigurationRequest.Builderavoiding the need to create one manually viaUpdateChatControlsConfigurationRequest.builder()- Parameters:
updateChatControlsConfigurationRequest- AConsumerthat will call methods onUpdateChatControlsConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateChatControlsConfiguration operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Updates an existing Amazon Q data source connector.
- Parameters:
updateDataSourceRequest-- Returns:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Updates an existing Amazon Q data source connector.
This is a convenience which creates an instance of the
UpdateDataSourceRequest.Builderavoiding the need to create one manually viaUpdateDataSourceRequest.builder()- Parameters:
updateDataSourceRequest- AConsumerthat will call methods onUpdateDataSourceRequest.Builderto create a request.- Returns:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateIndex
default UpdateIndexResponse updateIndex(UpdateIndexRequest updateIndexRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates an Amazon Q index.
- Parameters:
updateIndexRequest-- Returns:
- Result of the UpdateIndex operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateIndex
default UpdateIndexResponse updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates an Amazon Q index.
This is a convenience which creates an instance of the
UpdateIndexRequest.Builderavoiding the need to create one manually viaUpdateIndexRequest.builder()- Parameters:
updateIndexRequest- AConsumerthat will call methods onUpdateIndexRequest.Builderto create a request.- Returns:
- Result of the UpdateIndex operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePlugin
default UpdatePluginResponse updatePlugin(UpdatePluginRequest updatePluginRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates an Amazon Q plugin.
- Parameters:
updatePluginRequest-- Returns:
- Result of the UpdatePlugin operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePlugin
default UpdatePluginResponse updatePlugin(Consumer<UpdatePluginRequest.Builder> updatePluginRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates an Amazon Q plugin.
This is a convenience which creates an instance of the
UpdatePluginRequest.Builderavoiding the need to create one manually viaUpdatePluginRequest.builder()- Parameters:
updatePluginRequest- AConsumerthat will call methods onUpdatePluginRequest.Builderto create a request.- Returns:
- Result of the UpdatePlugin operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateRetriever
default UpdateRetrieverResponse updateRetriever(UpdateRetrieverRequest updateRetrieverRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates the retriever used for your Amazon Q application.
- Parameters:
updateRetrieverRequest-- Returns:
- Result of the UpdateRetriever operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateRetriever
default UpdateRetrieverResponse updateRetriever(Consumer<UpdateRetrieverRequest.Builder> updateRetrieverRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates the retriever used for your Amazon Q application.
This is a convenience which creates an instance of the
UpdateRetrieverRequest.Builderavoiding the need to create one manually viaUpdateRetrieverRequest.builder()- Parameters:
updateRetrieverRequest- AConsumerthat will call methods onUpdateRetrieverRequest.Builderto create a request.- Returns:
- Result of the UpdateRetriever operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates a information associated with a user id.
- Parameters:
updateUserRequest-- Returns:
- Result of the UpdateUser operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException
Updates a information associated with a user id.
This is a convenience which creates an instance of the
UpdateUserRequest.Builderavoiding the need to create one manually viaUpdateUserRequest.builder()- Parameters:
updateUserRequest- AConsumerthat will call methods onUpdateUserRequest.Builderto create a request.- Returns:
- Result of the UpdateUser operation returned by the service.
- Throws:
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 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 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 service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWebExperience
default UpdateWebExperienceResponse updateWebExperience(UpdateWebExperienceRequest updateWebExperienceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Updates an Amazon Q web experience.
- Parameters:
updateWebExperienceRequest-- Returns:
- Result of the UpdateWebExperience operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWebExperience
default UpdateWebExperienceResponse updateWebExperience(Consumer<UpdateWebExperienceRequest.Builder> updateWebExperienceRequest) throws ResourceNotFoundException, InternalServerException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException
Updates an Amazon Q web experience.
This is a convenience which creates an instance of the
UpdateWebExperienceRequest.Builderavoiding the need to create one manually viaUpdateWebExperienceRequest.builder()- Parameters:
updateWebExperienceRequest- AConsumerthat will call methods onUpdateWebExperienceRequest.Builderto create a request.- Returns:
- Result of the UpdateWebExperience operation returned by the service.
- Throws:
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 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 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QBusinessException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static QBusinessClient create()
Create aQBusinessClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static QBusinessClientBuilder builder()
Create a builder that can be used to configure and create aQBusinessClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default QBusinessServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-