Interface QBusinessClient
- All Superinterfaces:
- AutoCloseable,- AwsClient,- SdkAutoCloseable,- SdkClient
builder() method.
 This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .
For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.
The following resources provide additional information about using the Amazon Q Business API:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String
- 
Method SummaryModifier and TypeMethodDescriptiondefault AssociatePermissionResponseassociatePermission(Consumer<AssociatePermissionRequest.Builder> associatePermissionRequest) Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.default AssociatePermissionResponseassociatePermission(AssociatePermissionRequest associatePermissionRequest) Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.default BatchDeleteDocumentResponsebatchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest) Asynchronously deletes one or more documents added using theBatchPutDocumentAPI from an Amazon Q Business index.default BatchDeleteDocumentResponsebatchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest) Asynchronously deletes one or more documents added using theBatchPutDocumentAPI from an Amazon Q Business index.default BatchPutDocumentResponsebatchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest) Adds one or more documents to an Amazon Q Business index.default BatchPutDocumentResponsebatchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest) Adds one or more documents to an Amazon Q Business index.static QBusinessClientBuilderbuilder()Create a builder that can be used to configure and create aQBusinessClient.default CancelSubscriptionResponsecancelSubscription(Consumer<CancelSubscriptionRequest.Builder> cancelSubscriptionRequest) Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application.default CancelSubscriptionResponsecancelSubscription(CancelSubscriptionRequest cancelSubscriptionRequest) Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application.default ChatSyncResponsechatSync(Consumer<ChatSyncRequest.Builder> chatSyncRequest) Starts or continues a non-streaming Amazon Q Business conversation.default ChatSyncResponsechatSync(ChatSyncRequest chatSyncRequest) Starts or continues a non-streaming Amazon Q Business conversation.default CheckDocumentAccessResponsecheckDocumentAccess(Consumer<CheckDocumentAccessRequest.Builder> checkDocumentAccessRequest) Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document.default CheckDocumentAccessResponsecheckDocumentAccess(CheckDocumentAccessRequest checkDocumentAccessRequest) Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document.static QBusinessClientcreate()Create aQBusinessClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createAnonymousWebExperienceUrl(Consumer<CreateAnonymousWebExperienceUrlRequest.Builder> createAnonymousWebExperienceUrlRequest) Creates a unique URL for anonymous Amazon Q Business web experience.createAnonymousWebExperienceUrl(CreateAnonymousWebExperienceUrlRequest createAnonymousWebExperienceUrlRequest) Creates a unique URL for anonymous Amazon Q Business web experience.default CreateApplicationResponsecreateApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an Amazon Q Business application.default CreateApplicationResponsecreateApplication(CreateApplicationRequest createApplicationRequest) Creates an Amazon Q Business application.createChatResponseConfiguration(Consumer<CreateChatResponseConfigurationRequest.Builder> createChatResponseConfigurationRequest) Creates a new chat response configuration for an Amazon Q Business application.createChatResponseConfiguration(CreateChatResponseConfigurationRequest createChatResponseConfigurationRequest) Creates a new chat response configuration for an Amazon Q Business application.default CreateDataAccessorResponsecreateDataAccessor(Consumer<CreateDataAccessorRequest.Builder> createDataAccessorRequest) Creates a new data accessor for an ISV to access data from a Amazon Q Business application.default CreateDataAccessorResponsecreateDataAccessor(CreateDataAccessorRequest createDataAccessorRequest) Creates a new data accessor for an ISV to access data from a Amazon Q Business application.default CreateDataSourceResponsecreateDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) Creates a data source connector for an Amazon Q Business application.default CreateDataSourceResponsecreateDataSource(CreateDataSourceRequest createDataSourceRequest) Creates a data source connector for an Amazon Q Business application.default CreateIndexResponsecreateIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest) Creates an Amazon Q Business index.default CreateIndexResponsecreateIndex(CreateIndexRequest createIndexRequest) Creates an Amazon Q Business index.default CreatePluginResponsecreatePlugin(Consumer<CreatePluginRequest.Builder> createPluginRequest) Creates an Amazon Q Business plugin.default CreatePluginResponsecreatePlugin(CreatePluginRequest createPluginRequest) Creates an Amazon Q Business plugin.default CreateRetrieverResponsecreateRetriever(Consumer<CreateRetrieverRequest.Builder> createRetrieverRequest) Adds a retriever to your Amazon Q Business application.default CreateRetrieverResponsecreateRetriever(CreateRetrieverRequest createRetrieverRequest) Adds a retriever to your Amazon Q Business application.default CreateSubscriptionResponsecreateSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.default CreateSubscriptionResponsecreateSubscription(CreateSubscriptionRequest createSubscriptionRequest) Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business 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 Business web experience.default CreateWebExperienceResponsecreateWebExperience(CreateWebExperienceRequest createWebExperienceRequest) Creates an Amazon Q Business web experience.default DeleteApplicationResponsedeleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an Amazon Q Business application.default DeleteApplicationResponsedeleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes an Amazon Q Business application.default DeleteAttachmentResponsedeleteAttachment(Consumer<DeleteAttachmentRequest.Builder> deleteAttachmentRequest) Deletes an attachment associated with a specific Amazon Q Business conversation.default DeleteAttachmentResponsedeleteAttachment(DeleteAttachmentRequest deleteAttachmentRequest) Deletes an attachment associated with a specific Amazon Q Business conversation.deleteChatControlsConfiguration(Consumer<DeleteChatControlsConfigurationRequest.Builder> deleteChatControlsConfigurationRequest) Deletes chat controls configured for an existing Amazon Q Business application.deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest) Deletes chat controls configured for an existing Amazon Q Business application.deleteChatResponseConfiguration(Consumer<DeleteChatResponseConfigurationRequest.Builder> deleteChatResponseConfigurationRequest) Deletes a specified chat response configuration from an Amazon Q Business application.deleteChatResponseConfiguration(DeleteChatResponseConfigurationRequest deleteChatResponseConfigurationRequest) Deletes a specified chat response configuration from an Amazon Q Business application.default DeleteConversationResponsedeleteConversation(Consumer<DeleteConversationRequest.Builder> deleteConversationRequest) Deletes an Amazon Q Business web experience conversation.default DeleteConversationResponsedeleteConversation(DeleteConversationRequest deleteConversationRequest) Deletes an Amazon Q Business web experience conversation.default DeleteDataAccessorResponsedeleteDataAccessor(Consumer<DeleteDataAccessorRequest.Builder> deleteDataAccessorRequest) Deletes a specified data accessor.default DeleteDataAccessorResponsedeleteDataAccessor(DeleteDataAccessorRequest deleteDataAccessorRequest) Deletes a specified data accessor.default DeleteDataSourceResponsedeleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) Deletes an Amazon Q Business data source connector.default DeleteDataSourceResponsedeleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Deletes an Amazon Q Business 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 Business index.default DeleteIndexResponsedeleteIndex(DeleteIndexRequest deleteIndexRequest) Deletes an Amazon Q Business index.default DeletePluginResponsedeletePlugin(Consumer<DeletePluginRequest.Builder> deletePluginRequest) Deletes an Amazon Q Business plugin.default DeletePluginResponsedeletePlugin(DeletePluginRequest deletePluginRequest) Deletes an Amazon Q Business plugin.default DeleteRetrieverResponsedeleteRetriever(Consumer<DeleteRetrieverRequest.Builder> deleteRetrieverRequest) Deletes the retriever used by an Amazon Q Business application.default DeleteRetrieverResponsedeleteRetriever(DeleteRetrieverRequest deleteRetrieverRequest) Deletes the retriever used by an Amazon Q Business 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 Business web experience.default DeleteWebExperienceResponsedeleteWebExperience(DeleteWebExperienceRequest deleteWebExperienceRequest) Deletes an Amazon Q Business web experience.default DisassociatePermissionResponsedisassociatePermission(Consumer<DisassociatePermissionRequest.Builder> disassociatePermissionRequest) Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV.default DisassociatePermissionResponsedisassociatePermission(DisassociatePermissionRequest disassociatePermissionRequest) Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV.default GetApplicationResponsegetApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Gets information about an existing Amazon Q Business application.default GetApplicationResponsegetApplication(GetApplicationRequest getApplicationRequest) Gets information about an existing Amazon Q Business application.getChatControlsConfiguration(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest) Gets information about chat controls configured for an existing Amazon Q Business application.getChatControlsConfiguration(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest) Gets information about chat controls configured for an existing Amazon Q Business application.getChatControlsConfigurationPaginator(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest) This is a variant ofgetChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest)operation.getChatControlsConfigurationPaginator(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest) This is a variant ofgetChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest)operation.getChatResponseConfiguration(Consumer<GetChatResponseConfigurationRequest.Builder> getChatResponseConfigurationRequest) Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application.getChatResponseConfiguration(GetChatResponseConfigurationRequest getChatResponseConfigurationRequest) Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application.default GetDataAccessorResponsegetDataAccessor(Consumer<GetDataAccessorRequest.Builder> getDataAccessorRequest) Retrieves information about a specified data accessor.default GetDataAccessorResponsegetDataAccessor(GetDataAccessorRequest getDataAccessorRequest) Retrieves information about a specified data accessor.default GetDataSourceResponsegetDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) Gets information about an existing Amazon Q Business data source connector.default GetDataSourceResponsegetDataSource(GetDataSourceRequest getDataSourceRequest) Gets information about an existing Amazon Q Business data source connector.default GetDocumentContentResponsegetDocumentContent(Consumer<GetDocumentContentRequest.Builder> getDocumentContentRequest) Retrieves the content of a document that was ingested into Amazon Q Business.default GetDocumentContentResponsegetDocumentContent(GetDocumentContentRequest getDocumentContentRequest) Retrieves the content of a document that was ingested into Amazon Q Business.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 Business index.default GetIndexResponsegetIndex(GetIndexRequest getIndexRequest) Gets information about an existing Amazon Q Business index.default GetMediaResponsegetMedia(Consumer<GetMediaRequest.Builder> getMediaRequest) Returns the image bytes corresponding to a media object.default GetMediaResponsegetMedia(GetMediaRequest getMediaRequest) Returns the image bytes corresponding to a media object.default GetPluginResponsegetPlugin(Consumer<GetPluginRequest.Builder> getPluginRequest) Gets information about an existing Amazon Q Business plugin.default GetPluginResponsegetPlugin(GetPluginRequest getPluginRequest) Gets information about an existing Amazon Q Business plugin.default GetPolicyResponsegetPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Retrieves the current permission policy for a Amazon Q Business application.default GetPolicyResponsegetPolicy(GetPolicyRequest getPolicyRequest) Retrieves the current permission policy for a Amazon Q Business application.default GetRetrieverResponsegetRetriever(Consumer<GetRetrieverRequest.Builder> getRetrieverRequest) Gets information about an existing retriever used by an Amazon Q Business application.default GetRetrieverResponsegetRetriever(GetRetrieverRequest getRetrieverRequest) Gets information about an existing retriever used by an Amazon Q Business 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 Business web experience.default GetWebExperienceResponsegetWebExperience(GetWebExperienceRequest getWebExperienceRequest) Gets information about an existing Amazon Q Business web experience.default ListApplicationsResponselistApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists Amazon Q Business applications.default ListApplicationsResponselistApplications(ListApplicationsRequest listApplicationsRequest) Lists Amazon Q Business 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 ListAttachmentsResponselistAttachments(Consumer<ListAttachmentsRequest.Builder> listAttachmentsRequest) Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.default ListAttachmentsResponselistAttachments(ListAttachmentsRequest listAttachmentsRequest) Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.default ListAttachmentsIterablelistAttachmentsPaginator(Consumer<ListAttachmentsRequest.Builder> listAttachmentsRequest) This is a variant oflistAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest)operation.default ListAttachmentsIterablelistAttachmentsPaginator(ListAttachmentsRequest listAttachmentsRequest) This is a variant oflistAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest)operation.listChatResponseConfigurations(Consumer<ListChatResponseConfigurationsRequest.Builder> listChatResponseConfigurationsRequest) Retrieves a list of all chat response configurations available in a specified Amazon Q Business application.listChatResponseConfigurations(ListChatResponseConfigurationsRequest listChatResponseConfigurationsRequest) Retrieves a list of all chat response configurations available in a specified Amazon Q Business application.listChatResponseConfigurationsPaginator(Consumer<ListChatResponseConfigurationsRequest.Builder> listChatResponseConfigurationsRequest) This is a variant oflistChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest)operation.listChatResponseConfigurationsPaginator(ListChatResponseConfigurationsRequest listChatResponseConfigurationsRequest) This is a variant oflistChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest)operation.default ListConversationsResponselistConversations(Consumer<ListConversationsRequest.Builder> listConversationsRequest) Lists one or more Amazon Q Business conversations.default ListConversationsResponselistConversations(ListConversationsRequest listConversationsRequest) Lists one or more Amazon Q Business 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 ListDataAccessorsResponselistDataAccessors(Consumer<ListDataAccessorsRequest.Builder> listDataAccessorsRequest) Lists the data accessors for a Amazon Q Business application.default ListDataAccessorsResponselistDataAccessors(ListDataAccessorsRequest listDataAccessorsRequest) Lists the data accessors for a Amazon Q Business application.default ListDataAccessorsIterablelistDataAccessorsPaginator(Consumer<ListDataAccessorsRequest.Builder> listDataAccessorsRequest) This is a variant oflistDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest)operation.default ListDataAccessorsIterablelistDataAccessorsPaginator(ListDataAccessorsRequest listDataAccessorsRequest) This is a variant oflistDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest)operation.default ListDataSourcesResponselistDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) Lists the Amazon Q Business data source connectors that you have created.default ListDataSourcesResponselistDataSources(ListDataSourcesRequest listDataSourcesRequest) Lists the Amazon Q Business 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 Business data source connector synchronization.default ListDataSourceSyncJobsResponselistDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) Get information about an Amazon Q Business 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 Business indices you have created.default ListIndicesResponselistIndices(ListIndicesRequest listIndicesRequest) Lists the Amazon Q Business 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 Business web experience.default ListMessagesResponselistMessages(ListMessagesRequest listMessagesRequest) Gets a list of messages associated with an Amazon Q Business 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 ListPluginActionsResponselistPluginActions(Consumer<ListPluginActionsRequest.Builder> listPluginActionsRequest) Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.default ListPluginActionsResponselistPluginActions(ListPluginActionsRequest listPluginActionsRequest) Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.default ListPluginActionsIterablelistPluginActionsPaginator(Consumer<ListPluginActionsRequest.Builder> listPluginActionsRequest) This is a variant oflistPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest)operation.default ListPluginActionsIterablelistPluginActionsPaginator(ListPluginActionsRequest listPluginActionsRequest) This is a variant oflistPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest)operation.default ListPluginsResponselistPlugins(Consumer<ListPluginsRequest.Builder> listPluginsRequest) Lists configured Amazon Q Business plugins.default ListPluginsResponselistPlugins(ListPluginsRequest listPluginsRequest) Lists configured Amazon Q Business 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 ListPluginTypeActionsResponselistPluginTypeActions(Consumer<ListPluginTypeActionsRequest.Builder> listPluginTypeActionsRequest) Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.default ListPluginTypeActionsResponselistPluginTypeActions(ListPluginTypeActionsRequest listPluginTypeActionsRequest) Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.default ListPluginTypeActionsIterablelistPluginTypeActionsPaginator(Consumer<ListPluginTypeActionsRequest.Builder> listPluginTypeActionsRequest) This is a variant oflistPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest)operation.default ListPluginTypeActionsIterablelistPluginTypeActionsPaginator(ListPluginTypeActionsRequest listPluginTypeActionsRequest) This is a variant oflistPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest)operation.default ListPluginTypeMetadataResponselistPluginTypeMetadata(Consumer<ListPluginTypeMetadataRequest.Builder> listPluginTypeMetadataRequest) Lists metadata for all Amazon Q Business plugin types.default ListPluginTypeMetadataResponselistPluginTypeMetadata(ListPluginTypeMetadataRequest listPluginTypeMetadataRequest) Lists metadata for all Amazon Q Business plugin types.default ListPluginTypeMetadataIterablelistPluginTypeMetadataPaginator(Consumer<ListPluginTypeMetadataRequest.Builder> listPluginTypeMetadataRequest) This is a variant oflistPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest)operation.default ListPluginTypeMetadataIterablelistPluginTypeMetadataPaginator(ListPluginTypeMetadataRequest listPluginTypeMetadataRequest) This is a variant oflistPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest)operation.default ListRetrieversResponselistRetrievers(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest) Lists the retriever used by an Amazon Q Business application.default ListRetrieversResponselistRetrievers(ListRetrieversRequest listRetrieversRequest) Lists the retriever used by an Amazon Q Business 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 ListSubscriptionsResponselistSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) Lists all subscriptions created in an Amazon Q Business application.default ListSubscriptionsResponselistSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) Lists all subscriptions created in an Amazon Q Business application.default ListSubscriptionsIterablelistSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) This is a variant oflistSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest)operation.default ListSubscriptionsIterablelistSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest) This is a variant oflistSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest)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 Business Web Experiences.default ListWebExperiencesResponselistWebExperiences(ListWebExperiencesRequest listWebExperiencesRequest) Lists one or more Amazon Q Business 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 provide feedback on their Amazon Q Business generated chat responses.default PutFeedbackResponseputFeedback(PutFeedbackRequest putFeedbackRequest) Enables your end user to provide feedback on their Amazon Q Business 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 SearchRelevantContentResponsesearchRelevantContent(Consumer<SearchRelevantContentRequest.Builder> searchRelevantContentRequest) Searches for relevant content in a Amazon Q Business application based on a query.default SearchRelevantContentResponsesearchRelevantContent(SearchRelevantContentRequest searchRelevantContentRequest) Searches for relevant content in a Amazon Q Business application based on a query.default SearchRelevantContentIterablesearchRelevantContentPaginator(Consumer<SearchRelevantContentRequest.Builder> searchRelevantContentRequest) This is a variant ofsearchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest)operation.default SearchRelevantContentIterablesearchRelevantContentPaginator(SearchRelevantContentRequest searchRelevantContentRequest) This is a variant ofsearchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault 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 Business data source connector synchronization job already in progress.default StopDataSourceSyncJobResponsestopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest) Stops an Amazon Q Business data source connector synchronization job already in progress.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tag to the specified Amazon Q Business application or data source resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Adds the specified tag to the specified Amazon Q Business application or data source resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from an Amazon Q Business application or a data source.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Removes a tag from an Amazon Q Business application or a data source.default UpdateApplicationResponseupdateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates an existing Amazon Q Business application.default UpdateApplicationResponseupdateApplication(UpdateApplicationRequest updateApplicationRequest) Updates an existing Amazon Q Business application.updateChatControlsConfiguration(Consumer<UpdateChatControlsConfigurationRequest.Builder> updateChatControlsConfigurationRequest) Updates a set of chat controls configured for an existing Amazon Q Business application.updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest) Updates a set of chat controls configured for an existing Amazon Q Business application.updateChatResponseConfiguration(Consumer<UpdateChatResponseConfigurationRequest.Builder> updateChatResponseConfigurationRequest) Updates an existing chat response configuration in an Amazon Q Business application.updateChatResponseConfiguration(UpdateChatResponseConfigurationRequest updateChatResponseConfigurationRequest) Updates an existing chat response configuration in an Amazon Q Business application.default UpdateDataAccessorResponseupdateDataAccessor(Consumer<UpdateDataAccessorRequest.Builder> updateDataAccessorRequest) Updates an existing data accessor.default UpdateDataAccessorResponseupdateDataAccessor(UpdateDataAccessorRequest updateDataAccessorRequest) Updates an existing data accessor.default UpdateDataSourceResponseupdateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) Updates an existing Amazon Q Business data source connector.default UpdateDataSourceResponseupdateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates an existing Amazon Q Business data source connector.default UpdateIndexResponseupdateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest) Updates an Amazon Q Business index.default UpdateIndexResponseupdateIndex(UpdateIndexRequest updateIndexRequest) Updates an Amazon Q Business index.default UpdatePluginResponseupdatePlugin(Consumer<UpdatePluginRequest.Builder> updatePluginRequest) Updates an Amazon Q Business plugin.default UpdatePluginResponseupdatePlugin(UpdatePluginRequest updatePluginRequest) Updates an Amazon Q Business plugin.default UpdateRetrieverResponseupdateRetriever(Consumer<UpdateRetrieverRequest.Builder> updateRetrieverRequest) Updates the retriever used for your Amazon Q Business application.default UpdateRetrieverResponseupdateRetriever(UpdateRetrieverRequest updateRetrieverRequest) Updates the retriever used for your Amazon Q Business application.default UpdateSubscriptionResponseupdateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest) Updates the pricing tier for an Amazon Q Business subscription.default UpdateSubscriptionResponseupdateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest) Updates the pricing tier for an Amazon Q Business subscription.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 Business web experience.default UpdateWebExperienceResponseupdateWebExperience(UpdateWebExperienceRequest updateWebExperienceRequest) Updates an Amazon Q Business web experience.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseablecloseMethods inherited from interface software.amazon.awssdk.core.SdkClientserviceName
- 
Field Details- 
SERVICE_NAME- See Also:
 
- 
SERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.- See Also:
 
 
- 
- 
Method Details- 
associatePermissiondefault AssociatePermissionResponse associatePermission(AssociatePermissionRequest associatePermissionRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources. - Parameters:
- associatePermissionRequest-
- Returns:
- Result of the AssociatePermission operation returned by the service.
- See Also:
 
- 
associatePermissiondefault AssociatePermissionResponse associatePermission(Consumer<AssociatePermissionRequest.Builder> associatePermissionRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources. 
 This is a convenience which creates an instance of the AssociatePermissionRequest.Builderavoiding the need to create one manually viaAssociatePermissionRequest.builder()- Parameters:
- associatePermissionRequest- A- Consumerthat will call methods on- AssociatePermissionRequest.Builderto create a request.
- Returns:
- Result of the AssociatePermission operation returned by the service.
- See Also:
 
- 
batchDeleteDocumentdefault BatchDeleteDocumentResponse batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Asynchronously deletes one or more documents added using the BatchPutDocumentAPI from an Amazon Q Business index.You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch. - Parameters:
- batchDeleteDocumentRequest-
- Returns:
- Result of the BatchDeleteDocument operation returned by the service.
- See Also:
 
- 
batchDeleteDocumentdefault BatchDeleteDocumentResponse batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Asynchronously deletes one or more documents added using the BatchPutDocumentAPI from an Amazon Q Business index.You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch. 
 This is a convenience which creates an instance of the BatchDeleteDocumentRequest.Builderavoiding the need to create one manually viaBatchDeleteDocumentRequest.builder()- Parameters:
- batchDeleteDocumentRequest- A- Consumerthat will call methods on- BatchDeleteDocumentRequest.Builderto create a request.
- Returns:
- Result of the BatchDeleteDocument operation returned by the service.
- See Also:
 
- 
batchPutDocumentdefault BatchPutDocumentResponse batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Adds one or more documents to an Amazon Q Business index. You use this API to: - 
 ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index. 
- 
 add custom attributes to documents in an Amazon Q Business index. 
- 
 attach an access control list to the documents added to an Amazon Q Business index. 
 You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch. - Parameters:
- batchPutDocumentRequest-
- Returns:
- Result of the BatchPutDocument operation returned by the service.
- See Also:
 
- 
 
- 
batchPutDocumentdefault BatchPutDocumentResponse batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Adds one or more documents to an Amazon Q Business index. You use this API to: - 
 ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index. 
- 
 add custom attributes to documents in an Amazon Q Business index. 
- 
 attach an access control list to the documents added to an Amazon Q Business index. 
 You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch. 
 This is a convenience which creates an instance of the BatchPutDocumentRequest.Builderavoiding the need to create one manually viaBatchPutDocumentRequest.builder()- Parameters:
- batchPutDocumentRequest- A- Consumerthat will call methods on- BatchPutDocumentRequest.Builderto create a request.
- Returns:
- Result of the BatchPutDocument operation returned by the service.
- See Also:
 
- 
 
- 
cancelSubscriptiondefault CancelSubscriptionResponse cancelSubscription(CancelSubscriptionRequest cancelSubscriptionRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month. - Parameters:
- cancelSubscriptionRequest-
- Returns:
- Result of the CancelSubscription operation returned by the service.
- See Also:
 
- 
cancelSubscriptiondefault CancelSubscriptionResponse cancelSubscription(Consumer<CancelSubscriptionRequest.Builder> cancelSubscriptionRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month. 
 This is a convenience which creates an instance of the CancelSubscriptionRequest.Builderavoiding the need to create one manually viaCancelSubscriptionRequest.builder()- Parameters:
- cancelSubscriptionRequest- A- Consumerthat will call methods on- CancelSubscriptionRequest.Builderto create a request.
- Returns:
- Result of the CancelSubscription operation returned by the service.
- See Also:
 
- 
chatSyncdefault ChatSyncResponse chatSync(ChatSyncRequest chatSyncRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, LicenseNotFoundException, ExternalResourceException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Starts or continues a non-streaming Amazon Q Business conversation. - Parameters:
- chatSyncRequest-
- Returns:
- Result of the ChatSync operation returned by the service.
- See Also:
 
- 
chatSyncdefault ChatSyncResponse chatSync(Consumer<ChatSyncRequest.Builder> chatSyncRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, LicenseNotFoundException, ExternalResourceException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Starts or continues a non-streaming Amazon Q Business conversation. 
 This is a convenience which creates an instance of the ChatSyncRequest.Builderavoiding the need to create one manually viaChatSyncRequest.builder()- Parameters:
- chatSyncRequest- A- Consumerthat will call methods on- ChatSyncRequest.Builderto create a request.
- Returns:
- Result of the ChatSync operation returned by the service.
- See Also:
 
- 
checkDocumentAccessdefault CheckDocumentAccessResponse checkDocumentAccess(CheckDocumentAccessRequest checkDocumentAccessRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access. - Parameters:
- checkDocumentAccessRequest-
- Returns:
- Result of the CheckDocumentAccess operation returned by the service.
- See Also:
 
- 
checkDocumentAccessdefault CheckDocumentAccessResponse checkDocumentAccess(Consumer<CheckDocumentAccessRequest.Builder> checkDocumentAccessRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access. 
 This is a convenience which creates an instance of the CheckDocumentAccessRequest.Builderavoiding the need to create one manually viaCheckDocumentAccessRequest.builder()- Parameters:
- checkDocumentAccessRequest- A- Consumerthat will call methods on- CheckDocumentAccessRequest.Builderto create a request.
- Returns:
- Result of the CheckDocumentAccess operation returned by the service.
- See Also:
 
- 
createAnonymousWebExperienceUrldefault CreateAnonymousWebExperienceUrlResponse createAnonymousWebExperienceUrl(CreateAnonymousWebExperienceUrlRequest createAnonymousWebExperienceUrlRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated. - Parameters:
- createAnonymousWebExperienceUrlRequest-
- Returns:
- Result of the CreateAnonymousWebExperienceUrl operation returned by the service.
- See Also:
 
- 
createAnonymousWebExperienceUrldefault CreateAnonymousWebExperienceUrlResponse createAnonymousWebExperienceUrl(Consumer<CreateAnonymousWebExperienceUrlRequest.Builder> createAnonymousWebExperienceUrlRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated. 
 This is a convenience which creates an instance of the CreateAnonymousWebExperienceUrlRequest.Builderavoiding the need to create one manually viaCreateAnonymousWebExperienceUrlRequest.builder()- Parameters:
- createAnonymousWebExperienceUrlRequest- A- Consumerthat will call methods on- CreateAnonymousWebExperienceUrlRequest.Builderto create a request.
- Returns:
- Result of the CreateAnonymousWebExperienceUrl operation returned by the service.
- See Also:
 
- 
createApplicationdefault CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users. An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfigurationis enabled in the request. For more information, see Using service-linked roles for Q Apps.When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business. - Parameters:
- createApplicationRequest-
- Returns:
- Result of the CreateApplication operation returned by the service.
- See Also:
 
- 
createApplicationdefault CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users. An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfigurationis enabled in the request. For more information, see Using service-linked roles for Q Apps.When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business. 
 This is a convenience which creates an instance of the CreateApplicationRequest.Builderavoiding the need to create one manually viaCreateApplicationRequest.builder()- Parameters:
- createApplicationRequest- A- Consumerthat will call methods on- CreateApplicationRequest.Builderto create a request.
- Returns:
- Result of the CreateApplication operation returned by the service.
- See Also:
 
- 
createChatResponseConfigurationdefault CreateChatResponseConfigurationResponse createChatResponseConfiguration(CreateChatResponseConfigurationRequest createChatResponseConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions. - Parameters:
- createChatResponseConfigurationRequest-
- Returns:
- Result of the CreateChatResponseConfiguration operation returned by the service.
- See Also:
 
- 
createChatResponseConfigurationdefault CreateChatResponseConfigurationResponse createChatResponseConfiguration(Consumer<CreateChatResponseConfigurationRequest.Builder> createChatResponseConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions. 
 This is a convenience which creates an instance of the CreateChatResponseConfigurationRequest.Builderavoiding the need to create one manually viaCreateChatResponseConfigurationRequest.builder()- Parameters:
- createChatResponseConfigurationRequest- A- Consumerthat will call methods on- CreateChatResponseConfigurationRequest.Builderto create a request.
- Returns:
- Result of the CreateChatResponseConfiguration operation returned by the service.
- See Also:
 
- 
createDataAccessordefault CreateDataAccessorResponse createDataAccessor(CreateDataAccessorRequest createDataAccessorRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application. - Parameters:
- createDataAccessorRequest-
- Returns:
- Result of the CreateDataAccessor operation returned by the service.
- See Also:
 
- 
createDataAccessordefault CreateDataAccessorResponse createDataAccessor(Consumer<CreateDataAccessorRequest.Builder> createDataAccessorRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application. 
 This is a convenience which creates an instance of the CreateDataAccessorRequest.Builderavoiding the need to create one manually viaCreateDataAccessorRequest.builder()- Parameters:
- createDataAccessorRequest- A- Consumerthat will call methods on- CreateDataAccessorRequest.Builderto create a request.
- Returns:
- Result of the CreateDataAccessor operation returned by the service.
- See Also:
 
- 
createDataSourcedefault CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates a data source connector for an Amazon Q Business 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.
- See Also:
 
- 
createDataSourcedefault CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates a data source connector for an Amazon Q Business 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- A- Consumerthat will call methods on- CreateDataSourceRequest.Builderto create a request.
- Returns:
- Result of the CreateDataSource operation returned by the service.
- See Also:
 
- 
createIndexdefault CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates an Amazon Q Business 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.
- See Also:
 
- 
createIndexdefault CreateIndexResponse createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates an Amazon Q Business 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- A- Consumerthat will call methods on- CreateIndexRequest.Builderto create a request.
- Returns:
- Result of the CreateIndex operation returned by the service.
- See Also:
 
- 
createPlugindefault CreatePluginResponse createPlugin(CreatePluginRequest createPluginRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates an Amazon Q Business plugin. - Parameters:
- createPluginRequest-
- Returns:
- Result of the CreatePlugin operation returned by the service.
- See Also:
 
- 
createPlugindefault CreatePluginResponse createPlugin(Consumer<CreatePluginRequest.Builder> createPluginRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates an Amazon Q Business plugin. 
 This is a convenience which creates an instance of the CreatePluginRequest.Builderavoiding the need to create one manually viaCreatePluginRequest.builder()- Parameters:
- createPluginRequest- A- Consumerthat will call methods on- CreatePluginRequest.Builderto create a request.
- Returns:
- Result of the CreatePlugin operation returned by the service.
- See Also:
 
- 
createRetrieverdefault CreateRetrieverResponse createRetriever(CreateRetrieverRequest createRetrieverRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Adds a retriever to your Amazon Q Business application. - Parameters:
- createRetrieverRequest-
- Returns:
- Result of the CreateRetriever operation returned by the service.
- See Also:
 
- 
createRetrieverdefault CreateRetrieverResponse createRetriever(Consumer<CreateRetrieverRequest.Builder> createRetrieverRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Adds a retriever to your Amazon Q Business application. 
 This is a convenience which creates an instance of the CreateRetrieverRequest.Builderavoiding the need to create one manually viaCreateRetrieverRequest.builder()- Parameters:
- createRetrieverRequest- A- Consumerthat will call methods on- CreateRetrieverRequest.Builderto create a request.
- Returns:
- Result of the CreateRetriever operation returned by the service.
- See Also:
 
- 
createSubscriptiondefault CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest createSubscriptionRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITEandQ_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide. - Parameters:
- createSubscriptionRequest-
- Returns:
- Result of the CreateSubscription operation returned by the service.
- See Also:
 
- 
createSubscriptiondefault CreateSubscriptionResponse createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITEandQ_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide. 
 This is a convenience which creates an instance of the CreateSubscriptionRequest.Builderavoiding the need to create one manually viaCreateSubscriptionRequest.builder()- Parameters:
- createSubscriptionRequest- A- Consumerthat will call methods on- CreateSubscriptionRequest.Builderto create a request.
- Returns:
- Result of the CreateSubscription operation returned by the service.
- See Also:
 
- 
createUserdefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
createUserdefault CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- CreateUserRequest.Builderto create a request.
- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
 
- 
createWebExperiencedefault CreateWebExperienceResponse createWebExperience(CreateWebExperienceRequest createWebExperienceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates an Amazon Q Business web experience. - Parameters:
- createWebExperienceRequest-
- Returns:
- Result of the CreateWebExperience operation returned by the service.
- See Also:
 
- 
createWebExperiencedefault CreateWebExperienceResponse createWebExperience(Consumer<CreateWebExperienceRequest.Builder> createWebExperienceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Creates an Amazon Q Business web experience. 
 This is a convenience which creates an instance of the CreateWebExperienceRequest.Builderavoiding the need to create one manually viaCreateWebExperienceRequest.builder()- Parameters:
- createWebExperienceRequest- A- Consumerthat will call methods on- CreateWebExperienceRequest.Builderto create a request.
- Returns:
- Result of the CreateWebExperience operation returned by the service.
- See Also:
 
- 
deleteApplicationdefault DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business application. - Parameters:
- deleteApplicationRequest-
- Returns:
- Result of the DeleteApplication operation returned by the service.
- See Also:
 
- 
deleteApplicationdefault DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business application. 
 This is a convenience which creates an instance of the DeleteApplicationRequest.Builderavoiding the need to create one manually viaDeleteApplicationRequest.builder()- Parameters:
- deleteApplicationRequest- A- Consumerthat will call methods on- DeleteApplicationRequest.Builderto create a request.
- Returns:
- Result of the DeleteApplication operation returned by the service.
- See Also:
 
- 
deleteAttachmentdefault DeleteAttachmentResponse deleteAttachment(DeleteAttachmentRequest deleteAttachmentRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an attachment associated with a specific Amazon Q Business conversation. - Parameters:
- deleteAttachmentRequest-
- Returns:
- Result of the DeleteAttachment operation returned by the service.
- See Also:
 
- 
deleteAttachmentdefault DeleteAttachmentResponse deleteAttachment(Consumer<DeleteAttachmentRequest.Builder> deleteAttachmentRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an attachment associated with a specific Amazon Q Business conversation. 
 This is a convenience which creates an instance of the DeleteAttachmentRequest.Builderavoiding the need to create one manually viaDeleteAttachmentRequest.builder()- Parameters:
- deleteAttachmentRequest- A- Consumerthat will call methods on- DeleteAttachmentRequest.Builderto create a request.
- Returns:
- Result of the DeleteAttachment operation returned by the service.
- See Also:
 
- 
deleteChatControlsConfigurationdefault DeleteChatControlsConfigurationResponse deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes chat controls configured for an existing Amazon Q Business application. - Parameters:
- deleteChatControlsConfigurationRequest-
- Returns:
- Result of the DeleteChatControlsConfiguration operation returned by the service.
- See Also:
 
- 
deleteChatControlsConfigurationdefault DeleteChatControlsConfigurationResponse deleteChatControlsConfiguration(Consumer<DeleteChatControlsConfigurationRequest.Builder> deleteChatControlsConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes chat controls configured for an existing Amazon Q Business application. 
 This is a convenience which creates an instance of the DeleteChatControlsConfigurationRequest.Builderavoiding the need to create one manually viaDeleteChatControlsConfigurationRequest.builder()- Parameters:
- deleteChatControlsConfigurationRequest- A- Consumerthat will call methods on- DeleteChatControlsConfigurationRequest.Builderto create a request.
- Returns:
- Result of the DeleteChatControlsConfiguration operation returned by the service.
- See Also:
 
- 
deleteChatResponseConfigurationdefault DeleteChatResponseConfigurationResponse deleteChatResponseConfiguration(DeleteChatResponseConfigurationRequest deleteChatResponseConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes a specified chat response configuration from an Amazon Q Business application. - Parameters:
- deleteChatResponseConfigurationRequest-
- Returns:
- Result of the DeleteChatResponseConfiguration operation returned by the service.
- See Also:
 
- 
deleteChatResponseConfigurationdefault DeleteChatResponseConfigurationResponse deleteChatResponseConfiguration(Consumer<DeleteChatResponseConfigurationRequest.Builder> deleteChatResponseConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes a specified chat response configuration from an Amazon Q Business application. 
 This is a convenience which creates an instance of the DeleteChatResponseConfigurationRequest.Builderavoiding the need to create one manually viaDeleteChatResponseConfigurationRequest.builder()- Parameters:
- deleteChatResponseConfigurationRequest- A- Consumerthat will call methods on- DeleteChatResponseConfigurationRequest.Builderto create a request.
- Returns:
- Result of the DeleteChatResponseConfiguration operation returned by the service.
- See Also:
 
- 
deleteConversationdefault DeleteConversationResponse deleteConversation(DeleteConversationRequest deleteConversationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business web experience conversation. - Parameters:
- deleteConversationRequest-
- Returns:
- Result of the DeleteConversation operation returned by the service.
- See Also:
 
- 
deleteConversationdefault DeleteConversationResponse deleteConversation(Consumer<DeleteConversationRequest.Builder> deleteConversationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business 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- A- Consumerthat will call methods on- DeleteConversationRequest.Builderto create a request.
- Returns:
- Result of the DeleteConversation operation returned by the service.
- See Also:
 
- 
deleteDataAccessordefault DeleteDataAccessorResponse deleteDataAccessor(DeleteDataAccessorRequest deleteDataAccessorRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked. - Parameters:
- deleteDataAccessorRequest-
- Returns:
- Result of the DeleteDataAccessor operation returned by the service.
- See Also:
 
- 
deleteDataAccessordefault DeleteDataAccessorResponse deleteDataAccessor(Consumer<DeleteDataAccessorRequest.Builder> deleteDataAccessorRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked. 
 This is a convenience which creates an instance of the DeleteDataAccessorRequest.Builderavoiding the need to create one manually viaDeleteDataAccessorRequest.builder()- Parameters:
- deleteDataAccessorRequest- A- Consumerthat will call methods on- DeleteDataAccessorRequest.Builderto create a request.
- Returns:
- Result of the DeleteDataAccessor operation returned by the service.
- See Also:
 
- 
deleteDataSourcedefault DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business 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.
- See Also:
 
- 
deleteDataSourcedefault DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business 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- A- Consumerthat will call methods on- DeleteDataSourceRequest.Builderto create a request.
- Returns:
- Result of the DeleteDataSource operation returned by the service.
- See Also:
 
- 
deleteGroupdefault DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
deleteGroupdefault DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- DeleteGroupRequest.Builderto create a request.
- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
 
- 
deleteIndexdefault DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business index. - Parameters:
- deleteIndexRequest-
- Returns:
- Result of the DeleteIndex operation returned by the service.
- See Also:
 
- 
deleteIndexdefault DeleteIndexResponse deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business index. 
 This is a convenience which creates an instance of the DeleteIndexRequest.Builderavoiding the need to create one manually viaDeleteIndexRequest.builder()- Parameters:
- deleteIndexRequest- A- Consumerthat will call methods on- DeleteIndexRequest.Builderto create a request.
- Returns:
- Result of the DeleteIndex operation returned by the service.
- See Also:
 
- 
deletePlugindefault DeletePluginResponse deletePlugin(DeletePluginRequest deletePluginRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business plugin. - Parameters:
- deletePluginRequest-
- Returns:
- Result of the DeletePlugin operation returned by the service.
- See Also:
 
- 
deletePlugindefault DeletePluginResponse deletePlugin(Consumer<DeletePluginRequest.Builder> deletePluginRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business plugin. 
 This is a convenience which creates an instance of the DeletePluginRequest.Builderavoiding the need to create one manually viaDeletePluginRequest.builder()- Parameters:
- deletePluginRequest- A- Consumerthat will call methods on- DeletePluginRequest.Builderto create a request.
- Returns:
- Result of the DeletePlugin operation returned by the service.
- See Also:
 
- 
deleteRetrieverdefault DeleteRetrieverResponse deleteRetriever(DeleteRetrieverRequest deleteRetrieverRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes the retriever used by an Amazon Q Business application. - Parameters:
- deleteRetrieverRequest-
- Returns:
- Result of the DeleteRetriever operation returned by the service.
- See Also:
 
- 
deleteRetrieverdefault DeleteRetrieverResponse deleteRetriever(Consumer<DeleteRetrieverRequest.Builder> deleteRetrieverRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes the retriever used by an Amazon Q Business application. 
 This is a convenience which creates an instance of the DeleteRetrieverRequest.Builderavoiding the need to create one manually viaDeleteRetrieverRequest.builder()- Parameters:
- deleteRetrieverRequest- A- Consumerthat will call methods on- DeleteRetrieverRequest.Builderto create a request.
- Returns:
- Result of the DeleteRetriever operation returned by the service.
- See Also:
 
- 
deleteUserdefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
deleteUserdefault DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- DeleteUserRequest.Builderto create a request.
- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
 
- 
deleteWebExperiencedefault DeleteWebExperienceResponse deleteWebExperience(DeleteWebExperienceRequest deleteWebExperienceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business web experience. - Parameters:
- deleteWebExperienceRequest-
- Returns:
- Result of the DeleteWebExperience operation returned by the service.
- See Also:
 
- 
deleteWebExperiencedefault DeleteWebExperienceResponse deleteWebExperience(Consumer<DeleteWebExperienceRequest.Builder> deleteWebExperienceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Deletes an Amazon Q Business web experience. 
 This is a convenience which creates an instance of the DeleteWebExperienceRequest.Builderavoiding the need to create one manually viaDeleteWebExperienceRequest.builder()- Parameters:
- deleteWebExperienceRequest- A- Consumerthat will call methods on- DeleteWebExperienceRequest.Builderto create a request.
- Returns:
- Result of the DeleteWebExperience operation returned by the service.
- See Also:
 
- 
disassociatePermissiondefault DisassociatePermissionResponse disassociatePermission(DisassociatePermissionRequest disassociatePermissionRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy. - Parameters:
- disassociatePermissionRequest-
- Returns:
- Result of the DisassociatePermission operation returned by the service.
- See Also:
 
- 
disassociatePermissiondefault DisassociatePermissionResponse disassociatePermission(Consumer<DisassociatePermissionRequest.Builder> disassociatePermissionRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy. 
 This is a convenience which creates an instance of the DisassociatePermissionRequest.Builderavoiding the need to create one manually viaDisassociatePermissionRequest.builder()- Parameters:
- disassociatePermissionRequest- A- Consumerthat will call methods on- DisassociatePermissionRequest.Builderto create a request.
- Returns:
- Result of the DisassociatePermission operation returned by the service.
- See Also:
 
- 
getApplicationdefault GetApplicationResponse getApplication(GetApplicationRequest getApplicationRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business application. - Parameters:
- getApplicationRequest-
- Returns:
- Result of the GetApplication operation returned by the service.
- See Also:
 
- 
getApplicationdefault GetApplicationResponse getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business application. 
 This is a convenience which creates an instance of the GetApplicationRequest.Builderavoiding the need to create one manually viaGetApplicationRequest.builder()- Parameters:
- getApplicationRequest- A- Consumerthat will call methods on- GetApplicationRequest.Builderto create a request.
- Returns:
- Result of the GetApplication operation returned by the service.
- See Also:
 
- 
getChatControlsConfigurationdefault GetChatControlsConfigurationResponse getChatControlsConfiguration(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about chat controls configured for an existing Amazon Q Business application. - Parameters:
- getChatControlsConfigurationRequest-
- Returns:
- Result of the GetChatControlsConfiguration operation returned by the service.
- See Also:
 
- 
getChatControlsConfigurationdefault GetChatControlsConfigurationResponse getChatControlsConfiguration(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about chat controls configured for an existing Amazon Q Business application. 
 This is a convenience which creates an instance of the GetChatControlsConfigurationRequest.Builderavoiding the need to create one manually viaGetChatControlsConfigurationRequest.builder()- Parameters:
- getChatControlsConfigurationRequest- A- Consumerthat will call methods on- GetChatControlsConfigurationRequest.Builderto create a request.
- Returns:
- Result of the GetChatControlsConfiguration operation returned by the service.
- See Also:
 
- 
getChatControlsConfigurationPaginatordefault GetChatControlsConfigurationIterable getChatControlsConfigurationPaginator(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
getChatControlsConfigurationPaginatordefault GetChatControlsConfigurationIterable getChatControlsConfigurationPaginator(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- GetChatControlsConfigurationRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
getChatResponseConfigurationdefault GetChatResponseConfigurationResponse getChatResponseConfiguration(GetChatResponseConfigurationRequest getChatResponseConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata. - Parameters:
- getChatResponseConfigurationRequest-
- Returns:
- Result of the GetChatResponseConfiguration operation returned by the service.
- See Also:
 
- 
getChatResponseConfigurationdefault GetChatResponseConfigurationResponse getChatResponseConfiguration(Consumer<GetChatResponseConfigurationRequest.Builder> getChatResponseConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata. 
 This is a convenience which creates an instance of the GetChatResponseConfigurationRequest.Builderavoiding the need to create one manually viaGetChatResponseConfigurationRequest.builder()- Parameters:
- getChatResponseConfigurationRequest- A- Consumerthat will call methods on- GetChatResponseConfigurationRequest.Builderto create a request.
- Returns:
- Result of the GetChatResponseConfiguration operation returned by the service.
- See Also:
 
- 
getDataAccessordefault GetDataAccessorResponse getDataAccessor(GetDataAccessorRequest getDataAccessorRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated. - Parameters:
- getDataAccessorRequest-
- Returns:
- Result of the GetDataAccessor operation returned by the service.
- See Also:
 
- 
getDataAccessordefault GetDataAccessorResponse getDataAccessor(Consumer<GetDataAccessorRequest.Builder> getDataAccessorRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated. 
 This is a convenience which creates an instance of the GetDataAccessorRequest.Builderavoiding the need to create one manually viaGetDataAccessorRequest.builder()- Parameters:
- getDataAccessorRequest- A- Consumerthat will call methods on- GetDataAccessorRequest.Builderto create a request.
- Returns:
- Result of the GetDataAccessor operation returned by the service.
- See Also:
 
- 
getDataSourcedefault GetDataSourceResponse getDataSource(GetDataSourceRequest getDataSourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business data source connector. - Parameters:
- getDataSourceRequest-
- Returns:
- Result of the GetDataSource operation returned by the service.
- See Also:
 
- 
getDataSourcedefault GetDataSourceResponse getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business 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- A- Consumerthat will call methods on- GetDataSourceRequest.Builderto create a request.
- Returns:
- Result of the GetDataSource operation returned by the service.
- See Also:
 
- 
getDocumentContentdefault GetDocumentContentResponse getDocumentContent(GetDocumentContentRequest getDocumentContentRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL. - Parameters:
- getDocumentContentRequest-
- Returns:
- Result of the GetDocumentContent operation returned by the service.
- See Also:
 
- 
getDocumentContentdefault GetDocumentContentResponse getDocumentContent(Consumer<GetDocumentContentRequest.Builder> getDocumentContentRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL. 
 This is a convenience which creates an instance of the GetDocumentContentRequest.Builderavoiding the need to create one manually viaGetDocumentContentRequest.builder()- Parameters:
- getDocumentContentRequest- A- Consumerthat will call methods on- GetDocumentContentRequest.Builderto create a request.
- Returns:
- Result of the GetDocumentContent operation returned by the service.
- See Also:
 
- 
getGroupdefault GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
getGroupdefault GetGroupResponse getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- GetGroupRequest.Builderto create a request.
- Returns:
- Result of the GetGroup operation returned by the service.
- See Also:
 
- 
getIndexdefault GetIndexResponse getIndex(GetIndexRequest getIndexRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business index. - Parameters:
- getIndexRequest-
- Returns:
- Result of the GetIndex operation returned by the service.
- See Also:
 
- 
getIndexdefault GetIndexResponse getIndex(Consumer<GetIndexRequest.Builder> getIndexRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business index. 
 This is a convenience which creates an instance of the GetIndexRequest.Builderavoiding the need to create one manually viaGetIndexRequest.builder()- Parameters:
- getIndexRequest- A- Consumerthat will call methods on- GetIndexRequest.Builderto create a request.
- Returns:
- Result of the GetIndex operation returned by the service.
- See Also:
 
- 
getMediadefault GetMediaResponse getMedia(GetMediaRequest getMediaRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, MediaTooLargeException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals. - Parameters:
- getMediaRequest-
- Returns:
- Result of the GetMedia operation returned by the service.
- See Also:
 
- 
getMediadefault GetMediaResponse getMedia(Consumer<GetMediaRequest.Builder> getMediaRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, MediaTooLargeException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals. 
 This is a convenience which creates an instance of the GetMediaRequest.Builderavoiding the need to create one manually viaGetMediaRequest.builder()- Parameters:
- getMediaRequest- A- Consumerthat will call methods on- GetMediaRequest.Builderto create a request.
- Returns:
- Result of the GetMedia operation returned by the service.
- See Also:
 
- 
getPlugindefault GetPluginResponse getPlugin(GetPluginRequest getPluginRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business plugin. - Parameters:
- getPluginRequest-
- Returns:
- Result of the GetPlugin operation returned by the service.
- See Also:
 
- 
getPlugindefault GetPluginResponse getPlugin(Consumer<GetPluginRequest.Builder> getPluginRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business plugin. 
 This is a convenience which creates an instance of the GetPluginRequest.Builderavoiding the need to create one manually viaGetPluginRequest.builder()- Parameters:
- getPluginRequest- A- Consumerthat will call methods on- GetPluginRequest.Builderto create a request.
- Returns:
- Result of the GetPlugin operation returned by the service.
- See Also:
 
- 
getPolicydefault GetPolicyResponse getPolicy(GetPolicyRequest getPolicyRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources. - Parameters:
- getPolicyRequest-
- Returns:
- Result of the GetPolicy operation returned by the service.
- See Also:
 
- 
getPolicydefault GetPolicyResponse getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources. 
 This is a convenience which creates an instance of the GetPolicyRequest.Builderavoiding the need to create one manually viaGetPolicyRequest.builder()- Parameters:
- getPolicyRequest- A- Consumerthat will call methods on- GetPolicyRequest.Builderto create a request.
- Returns:
- Result of the GetPolicy operation returned by the service.
- See Also:
 
- 
getRetrieverdefault GetRetrieverResponse getRetriever(GetRetrieverRequest getRetrieverRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing retriever used by an Amazon Q Business application. - Parameters:
- getRetrieverRequest-
- Returns:
- Result of the GetRetriever operation returned by the service.
- See Also:
 
- 
getRetrieverdefault GetRetrieverResponse getRetriever(Consumer<GetRetrieverRequest.Builder> getRetrieverRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing retriever used by an Amazon Q Business application. 
 This is a convenience which creates an instance of the GetRetrieverRequest.Builderavoiding the need to create one manually viaGetRetrieverRequest.builder()- Parameters:
- getRetrieverRequest- A- Consumerthat will call methods on- GetRetrieverRequest.Builderto create a request.
- Returns:
- Result of the GetRetriever operation returned by the service.
- See Also:
 
- 
getUserdefault GetUserResponse getUser(GetUserRequest getUserRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
getUserdefault GetUserResponse getUser(Consumer<GetUserRequest.Builder> getUserRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- GetUserRequest.Builderto create a request.
- Returns:
- Result of the GetUser operation returned by the service.
- See Also:
 
- 
getWebExperiencedefault GetWebExperienceResponse getWebExperience(GetWebExperienceRequest getWebExperienceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business web experience. - Parameters:
- getWebExperienceRequest-
- Returns:
- Result of the GetWebExperience operation returned by the service.
- See Also:
 
- 
getWebExperiencedefault GetWebExperienceResponse getWebExperience(Consumer<GetWebExperienceRequest.Builder> getWebExperienceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets information about an existing Amazon Q Business web experience. 
 This is a convenience which creates an instance of the GetWebExperienceRequest.Builderavoiding the need to create one manually viaGetWebExperienceRequest.builder()- Parameters:
- getWebExperienceRequest- A- Consumerthat will call methods on- GetWebExperienceRequest.Builderto create a request.
- Returns:
- Result of the GetWebExperience operation returned by the service.
- See Also:
 
- 
listApplicationsdefault ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists Amazon Q Business applications. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. - Parameters:
- listApplicationsRequest-
- Returns:
- Result of the ListApplications operation returned by the service.
- See Also:
 
- 
listApplicationsdefault ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists Amazon Q Business applications. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. 
 This is a convenience which creates an instance of the ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
- listApplicationsRequest- A- Consumerthat will call methods on- ListApplicationsRequest.Builderto create a request.
- Returns:
- Result of the ListApplications operation returned by the service.
- See Also:
 
- 
listApplicationsPaginatordefault 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.
- See Also:
 
- 
listApplicationsPaginatordefault 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- A- Consumerthat will call methods on- ListApplicationsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listAttachmentsdefault ListAttachmentsResponse listAttachments(ListAttachmentsRequest listAttachmentsRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation. - Parameters:
- listAttachmentsRequest-
- Returns:
- Result of the ListAttachments operation returned by the service.
- See Also:
 
- 
listAttachmentsdefault ListAttachmentsResponse listAttachments(Consumer<ListAttachmentsRequest.Builder> listAttachmentsRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation. 
 This is a convenience which creates an instance of the ListAttachmentsRequest.Builderavoiding the need to create one manually viaListAttachmentsRequest.builder()- Parameters:
- listAttachmentsRequest- A- Consumerthat will call methods on- ListAttachmentsRequest.Builderto create a request.
- Returns:
- Result of the ListAttachments operation returned by the service.
- See Also:
 
- 
listAttachmentsPaginatordefault ListAttachmentsIterable listAttachmentsPaginator(ListAttachmentsRequest listAttachmentsRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest)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.ListAttachmentsIterable responses = client.listAttachmentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListAttachmentsIterable responses = client .listAttachmentsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListAttachmentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListAttachmentsIterable responses = client.listAttachmentsPaginator(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 listAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest)operation.- Parameters:
- listAttachmentsRequest-
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listAttachmentsPaginatordefault ListAttachmentsIterable listAttachmentsPaginator(Consumer<ListAttachmentsRequest.Builder> listAttachmentsRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest)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.ListAttachmentsIterable responses = client.listAttachmentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListAttachmentsIterable responses = client .listAttachmentsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListAttachmentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListAttachmentsIterable responses = client.listAttachmentsPaginator(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 listAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest)operation.
 This is a convenience which creates an instance of the ListAttachmentsRequest.Builderavoiding the need to create one manually viaListAttachmentsRequest.builder()- Parameters:
- listAttachmentsRequest- A- Consumerthat will call methods on- ListAttachmentsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listChatResponseConfigurationsdefault ListChatResponseConfigurationsResponse listChatResponseConfigurations(ListChatResponseConfigurationsRequest listChatResponseConfigurationsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings. - Parameters:
- listChatResponseConfigurationsRequest-
- Returns:
- Result of the ListChatResponseConfigurations operation returned by the service.
- See Also:
 
- 
listChatResponseConfigurationsdefault ListChatResponseConfigurationsResponse listChatResponseConfigurations(Consumer<ListChatResponseConfigurationsRequest.Builder> listChatResponseConfigurationsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings. 
 This is a convenience which creates an instance of the ListChatResponseConfigurationsRequest.Builderavoiding the need to create one manually viaListChatResponseConfigurationsRequest.builder()- Parameters:
- listChatResponseConfigurationsRequest- A- Consumerthat will call methods on- ListChatResponseConfigurationsRequest.Builderto create a request.
- Returns:
- Result of the ListChatResponseConfigurations operation returned by the service.
- See Also:
 
- 
listChatResponseConfigurationsPaginatordefault ListChatResponseConfigurationsIterable listChatResponseConfigurationsPaginator(ListChatResponseConfigurationsRequest listChatResponseConfigurationsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest)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.ListChatResponseConfigurationsIterable responses = client.listChatResponseConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListChatResponseConfigurationsIterable responses = client .listChatResponseConfigurationsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListChatResponseConfigurationsIterable responses = client.listChatResponseConfigurationsPaginator(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 listChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest)operation.- Parameters:
- listChatResponseConfigurationsRequest-
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listChatResponseConfigurationsPaginatordefault ListChatResponseConfigurationsIterable listChatResponseConfigurationsPaginator(Consumer<ListChatResponseConfigurationsRequest.Builder> listChatResponseConfigurationsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest)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.ListChatResponseConfigurationsIterable responses = client.listChatResponseConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListChatResponseConfigurationsIterable responses = client .listChatResponseConfigurationsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListChatResponseConfigurationsIterable responses = client.listChatResponseConfigurationsPaginator(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 listChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest)operation.
 This is a convenience which creates an instance of the ListChatResponseConfigurationsRequest.Builderavoiding the need to create one manually viaListChatResponseConfigurationsRequest.builder()- Parameters:
- listChatResponseConfigurationsRequest- A- Consumerthat will call methods on- ListChatResponseConfigurationsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listConversationsdefault ListConversationsResponse listConversations(ListConversationsRequest listConversationsRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists one or more Amazon Q Business conversations. - Parameters:
- listConversationsRequest-
- Returns:
- Result of the ListConversations operation returned by the service.
- See Also:
 
- 
listConversationsdefault ListConversationsResponse listConversations(Consumer<ListConversationsRequest.Builder> listConversationsRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists one or more Amazon Q Business conversations. 
 This is a convenience which creates an instance of the ListConversationsRequest.Builderavoiding the need to create one manually viaListConversationsRequest.builder()- Parameters:
- listConversationsRequest- A- Consumerthat will call methods on- ListConversationsRequest.Builderto create a request.
- Returns:
- Result of the ListConversations operation returned by the service.
- See Also:
 
- 
listConversationsPaginatordefault ListConversationsIterable listConversationsPaginator(ListConversationsRequest listConversationsRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listConversationsPaginatordefault ListConversationsIterable listConversationsPaginator(Consumer<ListConversationsRequest.Builder> listConversationsRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListConversationsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listDataAccessorsdefault ListDataAccessorsResponse listDataAccessors(ListDataAccessorsRequest listDataAccessorsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor. - Parameters:
- listDataAccessorsRequest-
- Returns:
- Result of the ListDataAccessors operation returned by the service.
- See Also:
 
- 
listDataAccessorsdefault ListDataAccessorsResponse listDataAccessors(Consumer<ListDataAccessorsRequest.Builder> listDataAccessorsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor. 
 This is a convenience which creates an instance of the ListDataAccessorsRequest.Builderavoiding the need to create one manually viaListDataAccessorsRequest.builder()- Parameters:
- listDataAccessorsRequest- A- Consumerthat will call methods on- ListDataAccessorsRequest.Builderto create a request.
- Returns:
- Result of the ListDataAccessors operation returned by the service.
- See Also:
 
- 
listDataAccessorsPaginatordefault ListDataAccessorsIterable listDataAccessorsPaginator(ListDataAccessorsRequest listDataAccessorsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest)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.ListDataAccessorsIterable responses = client.listDataAccessorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListDataAccessorsIterable responses = client .listDataAccessorsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListDataAccessorsIterable responses = client.listDataAccessorsPaginator(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 listDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest)operation.- Parameters:
- listDataAccessorsRequest-
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listDataAccessorsPaginatordefault ListDataAccessorsIterable listDataAccessorsPaginator(Consumer<ListDataAccessorsRequest.Builder> listDataAccessorsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest)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.ListDataAccessorsIterable responses = client.listDataAccessorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListDataAccessorsIterable responses = client .listDataAccessorsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListDataAccessorsIterable responses = client.listDataAccessorsPaginator(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 listDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest)operation.
 This is a convenience which creates an instance of the ListDataAccessorsRequest.Builderavoiding the need to create one manually viaListDataAccessorsRequest.builder()- Parameters:
- listDataAccessorsRequest- A- Consumerthat will call methods on- ListDataAccessorsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listDataSourceSyncJobsdefault ListDataSourceSyncJobsResponse listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Get information about an Amazon Q Business data source connector synchronization. - Parameters:
- listDataSourceSyncJobsRequest-
- Returns:
- Result of the ListDataSourceSyncJobs operation returned by the service.
- See Also:
 
- 
listDataSourceSyncJobsdefault ListDataSourceSyncJobsResponse listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Get information about an Amazon Q Business 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- A- Consumerthat will call methods on- ListDataSourceSyncJobsRequest.Builderto create a request.
- Returns:
- Result of the ListDataSourceSyncJobs operation returned by the service.
- See Also:
 
- 
listDataSourceSyncJobsPaginatordefault ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, 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.
- See Also:
 
- 
listDataSourceSyncJobsPaginatordefault ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, 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- A- Consumerthat will call methods on- ListDataSourceSyncJobsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listDataSourcesdefault ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists the Amazon Q Business data source connectors that you have created. - Parameters:
- listDataSourcesRequest-
- Returns:
- Result of the ListDataSources operation returned by the service.
- See Also:
 
- 
listDataSourcesdefault ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists the Amazon Q Business 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- A- Consumerthat will call methods on- ListDataSourcesRequest.Builderto create a request.
- Returns:
- Result of the ListDataSources operation returned by the service.
- See Also:
 
- 
listDataSourcesPaginatordefault ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listDataSourcesPaginatordefault ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListDataSourcesRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listDocumentsdefault ListDocumentsResponse listDocuments(ListDocumentsRequest listDocumentsRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listDocumentsdefault ListDocumentsResponse listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListDocumentsRequest.Builderto create a request.
- Returns:
- Result of the ListDocuments operation returned by the service.
- See Also:
 
- 
listDocumentsPaginatordefault ListDocumentsIterable listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listDocumentsPaginatordefault ListDocumentsIterable listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListDocumentsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listGroupsdefault ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listGroupsdefault ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListGroupsRequest.Builderto create a request.
- Returns:
- Result of the ListGroups operation returned by the service.
- See Also:
 
- 
listGroupsPaginatordefault ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listGroupsPaginatordefault ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListGroupsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listIndicesdefault ListIndicesResponse listIndices(ListIndicesRequest listIndicesRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists the Amazon Q Business indices you have created. - Parameters:
- listIndicesRequest-
- Returns:
- Result of the ListIndices operation returned by the service.
- See Also:
 
- 
listIndicesdefault ListIndicesResponse listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists the Amazon Q Business 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- A- Consumerthat will call methods on- ListIndicesRequest.Builderto create a request.
- Returns:
- Result of the ListIndices operation returned by the service.
- See Also:
 
- 
listIndicesPaginatordefault ListIndicesIterable listIndicesPaginator(ListIndicesRequest listIndicesRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listIndicesPaginatordefault ListIndicesIterable listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListIndicesRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listMessagesdefault ListMessagesResponse listMessages(ListMessagesRequest listMessagesRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets a list of messages associated with an Amazon Q Business web experience. - Parameters:
- listMessagesRequest-
- Returns:
- Result of the ListMessages operation returned by the service.
- See Also:
 
- 
listMessagesdefault ListMessagesResponse listMessages(Consumer<ListMessagesRequest.Builder> listMessagesRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets a list of messages associated with an Amazon Q Business web experience. 
 This is a convenience which creates an instance of the ListMessagesRequest.Builderavoiding the need to create one manually viaListMessagesRequest.builder()- Parameters:
- listMessagesRequest- A- Consumerthat will call methods on- ListMessagesRequest.Builderto create a request.
- Returns:
- Result of the ListMessages operation returned by the service.
- See Also:
 
- 
listMessagesPaginatordefault ListMessagesIterable listMessagesPaginator(ListMessagesRequest listMessagesRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listMessagesPaginatordefault ListMessagesIterable listMessagesPaginator(Consumer<ListMessagesRequest.Builder> listMessagesRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListMessagesRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listPluginActionsdefault ListPluginActionsResponse listPluginActions(ListPluginActionsRequest listPluginActionsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application. - Parameters:
- listPluginActionsRequest-
- Returns:
- Result of the ListPluginActions operation returned by the service.
- See Also:
 
- 
listPluginActionsdefault ListPluginActionsResponse listPluginActions(Consumer<ListPluginActionsRequest.Builder> listPluginActionsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application. 
 This is a convenience which creates an instance of the ListPluginActionsRequest.Builderavoiding the need to create one manually viaListPluginActionsRequest.builder()- Parameters:
- listPluginActionsRequest- A- Consumerthat will call methods on- ListPluginActionsRequest.Builderto create a request.
- Returns:
- Result of the ListPluginActions operation returned by the service.
- See Also:
 
- 
listPluginActionsPaginatordefault ListPluginActionsIterable listPluginActionsPaginator(ListPluginActionsRequest listPluginActionsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest)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.ListPluginActionsIterable responses = client.listPluginActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListPluginActionsIterable responses = client .listPluginActionsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListPluginActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginActionsIterable responses = client.listPluginActionsPaginator(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 listPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest)operation.- Parameters:
- listPluginActionsRequest-
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listPluginActionsPaginatordefault ListPluginActionsIterable listPluginActionsPaginator(Consumer<ListPluginActionsRequest.Builder> listPluginActionsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest)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.ListPluginActionsIterable responses = client.listPluginActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListPluginActionsIterable responses = client .listPluginActionsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListPluginActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginActionsIterable responses = client.listPluginActionsPaginator(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 listPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest)operation.
 This is a convenience which creates an instance of the ListPluginActionsRequest.Builderavoiding the need to create one manually viaListPluginActionsRequest.builder()- Parameters:
- listPluginActionsRequest- A- Consumerthat will call methods on- ListPluginActionsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listPluginTypeActionsdefault ListPluginTypeActionsResponse listPluginTypeActions(ListPluginTypeActionsRequest listPluginTypeActionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists configured Amazon Q Business actions for any plugin type—both built-in and custom. - Parameters:
- listPluginTypeActionsRequest-
- Returns:
- Result of the ListPluginTypeActions operation returned by the service.
- See Also:
 
- 
listPluginTypeActionsdefault ListPluginTypeActionsResponse listPluginTypeActions(Consumer<ListPluginTypeActionsRequest.Builder> listPluginTypeActionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists configured Amazon Q Business actions for any plugin type—both built-in and custom. 
 This is a convenience which creates an instance of the ListPluginTypeActionsRequest.Builderavoiding the need to create one manually viaListPluginTypeActionsRequest.builder()- Parameters:
- listPluginTypeActionsRequest- A- Consumerthat will call methods on- ListPluginTypeActionsRequest.Builderto create a request.
- Returns:
- Result of the ListPluginTypeActions operation returned by the service.
- See Also:
 
- 
listPluginTypeActionsPaginatordefault ListPluginTypeActionsIterable listPluginTypeActionsPaginator(ListPluginTypeActionsRequest listPluginTypeActionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest)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.ListPluginTypeActionsIterable responses = client.listPluginTypeActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeActionsIterable responses = client .listPluginTypeActionsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeActionsIterable responses = client.listPluginTypeActionsPaginator(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 listPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest)operation.- Parameters:
- listPluginTypeActionsRequest-
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listPluginTypeActionsPaginatordefault ListPluginTypeActionsIterable listPluginTypeActionsPaginator(Consumer<ListPluginTypeActionsRequest.Builder> listPluginTypeActionsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest)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.ListPluginTypeActionsIterable responses = client.listPluginTypeActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeActionsIterable responses = client .listPluginTypeActionsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeActionsIterable responses = client.listPluginTypeActionsPaginator(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 listPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest)operation.
 This is a convenience which creates an instance of the ListPluginTypeActionsRequest.Builderavoiding the need to create one manually viaListPluginTypeActionsRequest.builder()- Parameters:
- listPluginTypeActionsRequest- A- Consumerthat will call methods on- ListPluginTypeActionsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listPluginTypeMetadatadefault ListPluginTypeMetadataResponse listPluginTypeMetadata(ListPluginTypeMetadataRequest listPluginTypeMetadataRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists metadata for all Amazon Q Business plugin types. - Parameters:
- listPluginTypeMetadataRequest-
- Returns:
- Result of the ListPluginTypeMetadata operation returned by the service.
- See Also:
 
- 
listPluginTypeMetadatadefault ListPluginTypeMetadataResponse listPluginTypeMetadata(Consumer<ListPluginTypeMetadataRequest.Builder> listPluginTypeMetadataRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists metadata for all Amazon Q Business plugin types. 
 This is a convenience which creates an instance of the ListPluginTypeMetadataRequest.Builderavoiding the need to create one manually viaListPluginTypeMetadataRequest.builder()- Parameters:
- listPluginTypeMetadataRequest- A- Consumerthat will call methods on- ListPluginTypeMetadataRequest.Builderto create a request.
- Returns:
- Result of the ListPluginTypeMetadata operation returned by the service.
- See Also:
 
- 
listPluginTypeMetadataPaginatordefault ListPluginTypeMetadataIterable listPluginTypeMetadataPaginator(ListPluginTypeMetadataRequest listPluginTypeMetadataRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest)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.ListPluginTypeMetadataIterable responses = client.listPluginTypeMetadataPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeMetadataIterable responses = client .listPluginTypeMetadataPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeMetadataIterable responses = client.listPluginTypeMetadataPaginator(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 listPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest)operation.- Parameters:
- listPluginTypeMetadataRequest-
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listPluginTypeMetadataPaginatordefault ListPluginTypeMetadataIterable listPluginTypeMetadataPaginator(Consumer<ListPluginTypeMetadataRequest.Builder> listPluginTypeMetadataRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest)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.ListPluginTypeMetadataIterable responses = client.listPluginTypeMetadataPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeMetadataIterable responses = client .listPluginTypeMetadataPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeMetadataIterable responses = client.listPluginTypeMetadataPaginator(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 listPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest)operation.
 This is a convenience which creates an instance of the ListPluginTypeMetadataRequest.Builderavoiding the need to create one manually viaListPluginTypeMetadataRequest.builder()- Parameters:
- listPluginTypeMetadataRequest- A- Consumerthat will call methods on- ListPluginTypeMetadataRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listPluginsdefault ListPluginsResponse listPlugins(ListPluginsRequest listPluginsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists configured Amazon Q Business plugins. - Parameters:
- listPluginsRequest-
- Returns:
- Result of the ListPlugins operation returned by the service.
- See Also:
 
- 
listPluginsdefault ListPluginsResponse listPlugins(Consumer<ListPluginsRequest.Builder> listPluginsRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists configured Amazon Q Business plugins. 
 This is a convenience which creates an instance of the ListPluginsRequest.Builderavoiding the need to create one manually viaListPluginsRequest.builder()- Parameters:
- listPluginsRequest- A- Consumerthat will call methods on- ListPluginsRequest.Builderto create a request.
- Returns:
- Result of the ListPlugins operation returned by the service.
- See Also:
 
- 
listPluginsPaginatordefault ListPluginsIterable listPluginsPaginator(ListPluginsRequest listPluginsRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listPluginsPaginatordefault ListPluginsIterable listPluginsPaginator(Consumer<ListPluginsRequest.Builder> listPluginsRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListPluginsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listRetrieversdefault ListRetrieversResponse listRetrievers(ListRetrieversRequest listRetrieversRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists the retriever used by an Amazon Q Business application. - Parameters:
- listRetrieversRequest-
- Returns:
- Result of the ListRetrievers operation returned by the service.
- See Also:
 
- 
listRetrieversdefault ListRetrieversResponse listRetrievers(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists the retriever used by an Amazon Q Business application. 
 This is a convenience which creates an instance of the ListRetrieversRequest.Builderavoiding the need to create one manually viaListRetrieversRequest.builder()- Parameters:
- listRetrieversRequest- A- Consumerthat will call methods on- ListRetrieversRequest.Builderto create a request.
- Returns:
- Result of the ListRetrievers operation returned by the service.
- See Also:
 
- 
listRetrieversPaginatordefault ListRetrieversIterable listRetrieversPaginator(ListRetrieversRequest listRetrieversRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listRetrieversPaginatordefault ListRetrieversIterable listRetrieversPaginator(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListRetrieversRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listSubscriptionsdefault ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists all subscriptions created in an Amazon Q Business application. - Parameters:
- listSubscriptionsRequest-
- Returns:
- Result of the ListSubscriptions operation returned by the service.
- See Also:
 
- 
listSubscriptionsdefault ListSubscriptionsResponse listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists all subscriptions created in an Amazon Q Business application. 
 This is a convenience which creates an instance of the ListSubscriptionsRequest.Builderavoiding the need to create one manually viaListSubscriptionsRequest.builder()- Parameters:
- listSubscriptionsRequest- A- Consumerthat will call methods on- ListSubscriptionsRequest.Builderto create a request.
- Returns:
- Result of the ListSubscriptions operation returned by the service.
- See Also:
 
- 
listSubscriptionsPaginatordefault ListSubscriptionsIterable listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest)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.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListSubscriptionsIterable responses = client .listSubscriptionsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(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 listSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest)operation.- Parameters:
- listSubscriptionsRequest-
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listSubscriptionsPaginatordefault ListSubscriptionsIterable listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of listSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest)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.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.ListSubscriptionsIterable responses = client .listSubscriptionsPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(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 listSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest)operation.
 This is a convenience which creates an instance of the ListSubscriptionsRequest.Builderavoiding the need to create one manually viaListSubscriptionsRequest.builder()- Parameters:
- listSubscriptionsRequest- A- Consumerthat will call methods on- ListSubscriptionsRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
listTagsForResourcedefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them. - Parameters:
- listTagsForResourceRequest-
- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
 
- 
listTagsForResourcedefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Gets a list of tags associated with a specified resource. Amazon Q Business 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- A- Consumerthat will call methods on- ListTagsForResourceRequest.Builderto create a request.
- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
 
- 
listWebExperiencesdefault ListWebExperiencesResponse listWebExperiences(ListWebExperiencesRequest listWebExperiencesRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists one or more Amazon Q Business Web Experiences. - Parameters:
- listWebExperiencesRequest-
- Returns:
- Result of the ListWebExperiences operation returned by the service.
- See Also:
 
- 
listWebExperiencesdefault ListWebExperiencesResponse listWebExperiences(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Lists one or more Amazon Q Business Web Experiences. 
 This is a convenience which creates an instance of the ListWebExperiencesRequest.Builderavoiding the need to create one manually viaListWebExperiencesRequest.builder()- Parameters:
- listWebExperiencesRequest- A- Consumerthat will call methods on- ListWebExperiencesRequest.Builderto create a request.
- Returns:
- Result of the ListWebExperiences operation returned by the service.
- See Also:
 
- 
listWebExperiencesPaginatordefault ListWebExperiencesIterable listWebExperiencesPaginator(ListWebExperiencesRequest listWebExperiencesRequest) throws InternalServerException, ResourceNotFoundException, 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.
- See Also:
 
- 
listWebExperiencesPaginatordefault ListWebExperiencesIterable listWebExperiencesPaginator(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest) throws InternalServerException, ResourceNotFoundException, 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- A- Consumerthat will call methods on- ListWebExperiencesRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
putFeedbackdefault PutFeedbackResponse putFeedback(PutFeedbackRequest putFeedbackRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Enables your end user to provide feedback on their Amazon Q Business generated chat responses. - Parameters:
- putFeedbackRequest-
- Returns:
- Result of the PutFeedback operation returned by the service.
- See Also:
 
- 
putFeedbackdefault PutFeedbackResponse putFeedback(Consumer<PutFeedbackRequest.Builder> putFeedbackRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Enables your end user to provide feedback on their Amazon Q Business 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- A- Consumerthat will call methods on- PutFeedbackRequest.Builderto create a request.
- Returns:
- Result of the PutFeedback operation returned by the service.
- See Also:
 
- 
putGroupdefault PutGroupResponse putGroup(PutGroupRequest putGroupRequest) throws InternalServerException, ResourceNotFoundException, 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 Business chat results. There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArnfor Amazon Q Buisness to access the file.- Parameters:
- putGroupRequest-
- Returns:
- Result of the PutGroup operation returned by the service.
- See Also:
 
- 
putGroupdefault PutGroupResponse putGroup(Consumer<PutGroupRequest.Builder> putGroupRequest) throws InternalServerException, ResourceNotFoundException, 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 Business chat results. There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArnfor Amazon Q Buisness to access the file.
 This is a convenience which creates an instance of the PutGroupRequest.Builderavoiding the need to create one manually viaPutGroupRequest.builder()- Parameters:
- putGroupRequest- A- Consumerthat will call methods on- PutGroupRequest.Builderto create a request.
- Returns:
- Result of the PutGroup operation returned by the service.
- See Also:
 
- 
searchRelevantContentdefault SearchRelevantContentResponse searchRelevantContent(SearchRelevantContentRequest searchRelevantContentRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance. - Parameters:
- searchRelevantContentRequest-
- Returns:
- Result of the SearchRelevantContent operation returned by the service.
- See Also:
 
- 
searchRelevantContentdefault SearchRelevantContentResponse searchRelevantContent(Consumer<SearchRelevantContentRequest.Builder> searchRelevantContentRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance. 
 This is a convenience which creates an instance of the SearchRelevantContentRequest.Builderavoiding the need to create one manually viaSearchRelevantContentRequest.builder()- Parameters:
- searchRelevantContentRequest- A- Consumerthat will call methods on- SearchRelevantContentRequest.Builderto create a request.
- Returns:
- Result of the SearchRelevantContent operation returned by the service.
- See Also:
 
- 
searchRelevantContentPaginatordefault SearchRelevantContentIterable searchRelevantContentPaginator(SearchRelevantContentRequest searchRelevantContentRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of searchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest)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.SearchRelevantContentIterable responses = client.searchRelevantContentPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.SearchRelevantContentIterable responses = client .searchRelevantContentPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.SearchRelevantContentIterable responses = client.searchRelevantContentPaginator(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 searchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest)operation.- Parameters:
- searchRelevantContentRequest-
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
searchRelevantContentPaginatordefault SearchRelevantContentIterable searchRelevantContentPaginator(Consumer<SearchRelevantContentRequest.Builder> searchRelevantContentRequest) throws InternalServerException, ResourceNotFoundException, LicenseNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of searchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest)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.SearchRelevantContentIterable responses = client.searchRelevantContentPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qbusiness.paginators.SearchRelevantContentIterable responses = client .searchRelevantContentPaginator(request); for (software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qbusiness.paginators.SearchRelevantContentIterable responses = client.searchRelevantContentPaginator(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 searchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest)operation.
 This is a convenience which creates an instance of the SearchRelevantContentRequest.Builderavoiding the need to create one manually viaSearchRelevantContentRequest.builder()- Parameters:
- searchRelevantContentRequest- A- Consumerthat will call methods on- SearchRelevantContentRequest.Builderto create a request.
- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
 
- 
startDataSourceSyncJobdefault StartDataSourceSyncJobResponse startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest) throws InternalServerException, ResourceNotFoundException, 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 Business returns a ConflictException.- Parameters:
- startDataSourceSyncJobRequest-
- Returns:
- Result of the StartDataSourceSyncJob operation returned by the service.
- See Also:
 
- 
startDataSourceSyncJobdefault StartDataSourceSyncJobResponse startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest) throws InternalServerException, ResourceNotFoundException, 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 Business 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- A- Consumerthat will call methods on- StartDataSourceSyncJobRequest.Builderto create a request.
- Returns:
- Result of the StartDataSourceSyncJob operation returned by the service.
- See Also:
 
- 
stopDataSourceSyncJobdefault StopDataSourceSyncJobResponse stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Stops an Amazon Q Business data source connector synchronization job already in progress. - Parameters:
- stopDataSourceSyncJobRequest-
- Returns:
- Result of the StopDataSourceSyncJob operation returned by the service.
- See Also:
 
- 
stopDataSourceSyncJobdefault StopDataSourceSyncJobResponse stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Stops an Amazon Q Business 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- A- Consumerthat will call methods on- StopDataSourceSyncJobRequest.Builderto create a request.
- Returns:
- Result of the StopDataSourceSyncJob operation returned by the service.
- See Also:
 
- 
tagResourcedefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value. - Parameters:
- tagResourceRequest-
- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
 
- 
tagResourcedefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value. 
 This is a convenience which creates an instance of the TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
- tagResourceRequest- A- Consumerthat will call methods on- TagResourceRequest.Builderto create a request.
- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
 
- 
untagResourcedefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Removes a tag from an Amazon Q Business application or a data source. - Parameters:
- untagResourceRequest-
- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
 
- 
untagResourcedefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Removes a tag from an Amazon Q Business 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- A- Consumerthat will call methods on- UntagResourceRequest.Builderto create a request.
- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
 
- 
updateApplicationdefault UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an existing Amazon Q Business application. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfigurationis enabled in the request. For more information, see Using service-linked roles for Q Apps.- Parameters:
- updateApplicationRequest-
- Returns:
- Result of the UpdateApplication operation returned by the service.
- See Also:
 
- 
updateApplicationdefault UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an existing Amazon Q Business application. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfigurationis enabled in the request. For more information, see Using service-linked roles for Q Apps.
 This is a convenience which creates an instance of the UpdateApplicationRequest.Builderavoiding the need to create one manually viaUpdateApplicationRequest.builder()- Parameters:
- updateApplicationRequest- A- Consumerthat will call methods on- UpdateApplicationRequest.Builderto create a request.
- Returns:
- Result of the UpdateApplication operation returned by the service.
- See Also:
 
- 
updateChatControlsConfigurationdefault UpdateChatControlsConfigurationResponse updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Updates a set of chat controls configured for an existing Amazon Q Business application. - Parameters:
- updateChatControlsConfigurationRequest-
- Returns:
- Result of the UpdateChatControlsConfiguration operation returned by the service.
- See Also:
 
- 
updateChatControlsConfigurationdefault UpdateChatControlsConfigurationResponse updateChatControlsConfiguration(Consumer<UpdateChatControlsConfigurationRequest.Builder> updateChatControlsConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Updates a set of chat controls configured for an existing Amazon Q Business application. 
 This is a convenience which creates an instance of the UpdateChatControlsConfigurationRequest.Builderavoiding the need to create one manually viaUpdateChatControlsConfigurationRequest.builder()- Parameters:
- updateChatControlsConfigurationRequest- A- Consumerthat will call methods on- UpdateChatControlsConfigurationRequest.Builderto create a request.
- Returns:
- Result of the UpdateChatControlsConfiguration operation returned by the service.
- See Also:
 
- 
updateChatResponseConfigurationdefault UpdateChatResponseConfigurationResponse updateChatResponseConfiguration(UpdateChatResponseConfigurationRequest updateChatResponseConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses. - Parameters:
- updateChatResponseConfigurationRequest-
- Returns:
- Result of the UpdateChatResponseConfiguration operation returned by the service.
- See Also:
 
- 
updateChatResponseConfigurationdefault UpdateChatResponseConfigurationResponse updateChatResponseConfiguration(Consumer<UpdateChatResponseConfigurationRequest.Builder> updateChatResponseConfigurationRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses. 
 This is a convenience which creates an instance of the UpdateChatResponseConfigurationRequest.Builderavoiding the need to create one manually viaUpdateChatResponseConfigurationRequest.builder()- Parameters:
- updateChatResponseConfigurationRequest- A- Consumerthat will call methods on- UpdateChatResponseConfigurationRequest.Builderto create a request.
- Returns:
- Result of the UpdateChatResponseConfiguration operation returned by the service.
- See Also:
 
- 
updateDataAccessordefault UpdateDataAccessorResponse updateDataAccessor(UpdateDataAccessorRequest updateDataAccessorRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor. - Parameters:
- updateDataAccessorRequest-
- Returns:
- Result of the UpdateDataAccessor operation returned by the service.
- See Also:
 
- 
updateDataAccessordefault UpdateDataAccessorResponse updateDataAccessor(Consumer<UpdateDataAccessorRequest.Builder> updateDataAccessorRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor. 
 This is a convenience which creates an instance of the UpdateDataAccessorRequest.Builderavoiding the need to create one manually viaUpdateDataAccessorRequest.builder()- Parameters:
- updateDataAccessorRequest- A- Consumerthat will call methods on- UpdateDataAccessorRequest.Builderto create a request.
- Returns:
- Result of the UpdateDataAccessor operation returned by the service.
- See Also:
 
- 
updateDataSourcedefault UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an existing Amazon Q Business data source connector. - Parameters:
- updateDataSourceRequest-
- Returns:
- Result of the UpdateDataSource operation returned by the service.
- See Also:
 
- 
updateDataSourcedefault UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an existing Amazon Q Business 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- A- Consumerthat will call methods on- UpdateDataSourceRequest.Builderto create a request.
- Returns:
- Result of the UpdateDataSource operation returned by the service.
- See Also:
 
- 
updateIndexdefault UpdateIndexResponse updateIndex(UpdateIndexRequest updateIndexRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Updates an Amazon Q Business index. - Parameters:
- updateIndexRequest-
- Returns:
- Result of the UpdateIndex operation returned by the service.
- See Also:
 
- 
updateIndexdefault UpdateIndexResponse updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Updates an Amazon Q Business index. 
 This is a convenience which creates an instance of the UpdateIndexRequest.Builderavoiding the need to create one manually viaUpdateIndexRequest.builder()- Parameters:
- updateIndexRequest- A- Consumerthat will call methods on- UpdateIndexRequest.Builderto create a request.
- Returns:
- Result of the UpdateIndex operation returned by the service.
- See Also:
 
- 
updatePlugindefault UpdatePluginResponse updatePlugin(UpdatePluginRequest updatePluginRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Updates an Amazon Q Business plugin. - Parameters:
- updatePluginRequest-
- Returns:
- Result of the UpdatePlugin operation returned by the service.
- See Also:
 
- 
updatePlugindefault UpdatePluginResponse updatePlugin(Consumer<UpdatePluginRequest.Builder> updatePluginRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Updates an Amazon Q Business plugin. 
 This is a convenience which creates an instance of the UpdatePluginRequest.Builderavoiding the need to create one manually viaUpdatePluginRequest.builder()- Parameters:
- updatePluginRequest- A- Consumerthat will call methods on- UpdatePluginRequest.Builderto create a request.
- Returns:
- Result of the UpdatePlugin operation returned by the service.
- See Also:
 
- 
updateRetrieverdefault UpdateRetrieverResponse updateRetriever(UpdateRetrieverRequest updateRetrieverRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Updates the retriever used for your Amazon Q Business application. - Parameters:
- updateRetrieverRequest-
- Returns:
- Result of the UpdateRetriever operation returned by the service.
- See Also:
 
- 
updateRetrieverdefault UpdateRetrieverResponse updateRetriever(Consumer<UpdateRetrieverRequest.Builder> updateRetrieverRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, QBusinessException Updates the retriever used for your Amazon Q Business application. 
 This is a convenience which creates an instance of the UpdateRetrieverRequest.Builderavoiding the need to create one manually viaUpdateRetrieverRequest.builder()- Parameters:
- updateRetrieverRequest- A- Consumerthat will call methods on- UpdateRetrieverRequest.Builderto create a request.
- Returns:
- Result of the UpdateRetriever operation returned by the service.
- See Also:
 
- 
updateSubscriptiondefault UpdateSubscriptionResponse updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. - Parameters:
- updateSubscriptionRequest-
- Returns:
- Result of the UpdateSubscription operation returned by the service.
- See Also:
 
- 
updateSubscriptiondefault UpdateSubscriptionResponse updateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. 
 This is a convenience which creates an instance of the UpdateSubscriptionRequest.Builderavoiding the need to create one manually viaUpdateSubscriptionRequest.builder()- Parameters:
- updateSubscriptionRequest- A- Consumerthat will call methods on- UpdateSubscriptionRequest.Builderto create a request.
- Returns:
- Result of the UpdateSubscription operation returned by the service.
- See Also:
 
- 
updateUserdefault UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, 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.
- See Also:
 
- 
updateUserdefault UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, 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- A- Consumerthat will call methods on- UpdateUserRequest.Builderto create a request.
- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
 
- 
updateWebExperiencedefault UpdateWebExperienceResponse updateWebExperience(UpdateWebExperienceRequest updateWebExperienceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an Amazon Q Business web experience. - Parameters:
- updateWebExperienceRequest-
- Returns:
- Result of the UpdateWebExperience operation returned by the service.
- See Also:
 
- 
updateWebExperiencedefault UpdateWebExperienceResponse updateWebExperience(Consumer<UpdateWebExperienceRequest.Builder> updateWebExperienceRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Updates an Amazon Q Business web experience. 
 This is a convenience which creates an instance of the UpdateWebExperienceRequest.Builderavoiding the need to create one manually viaUpdateWebExperienceRequest.builder()- Parameters:
- updateWebExperienceRequest- A- Consumerthat will call methods on- UpdateWebExperienceRequest.Builderto create a request.
- Returns:
- Result of the UpdateWebExperience operation returned by the service.
- See Also:
 
- 
createCreate aQBusinessClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
- 
builderCreate a builder that can be used to configure and create aQBusinessClient.
- 
serviceMetadata
- 
serviceClientConfigurationDescription copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
- serviceClientConfigurationin interface- AwsClient
- Specified by:
- serviceClientConfigurationin interface- SdkClient
- Returns:
- SdkServiceClientConfiguration
 
 
-