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 Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AssociatePermissionResponse
associatePermission
(Consumer<AssociatePermissionRequest.Builder> associatePermissionRequest) Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.default AssociatePermissionResponse
associatePermission
(AssociatePermissionRequest associatePermissionRequest) Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.default BatchDeleteDocumentResponse
batchDeleteDocument
(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest) Asynchronously deletes one or more documents added using theBatchPutDocument
API from an Amazon Q Business index.default BatchDeleteDocumentResponse
batchDeleteDocument
(BatchDeleteDocumentRequest batchDeleteDocumentRequest) Asynchronously deletes one or more documents added using theBatchPutDocument
API from an Amazon Q Business index.default BatchPutDocumentResponse
batchPutDocument
(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest) Adds one or more documents to an Amazon Q Business index.default BatchPutDocumentResponse
batchPutDocument
(BatchPutDocumentRequest batchPutDocumentRequest) Adds one or more documents to an Amazon Q Business index.static QBusinessClientBuilder
builder()
Create a builder that can be used to configure and create aQBusinessClient
.default CancelSubscriptionResponse
cancelSubscription
(Consumer<CancelSubscriptionRequest.Builder> cancelSubscriptionRequest) Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application.default CancelSubscriptionResponse
cancelSubscription
(CancelSubscriptionRequest cancelSubscriptionRequest) Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application.default ChatSyncResponse
chatSync
(Consumer<ChatSyncRequest.Builder> chatSyncRequest) Starts or continues a non-streaming Amazon Q Business conversation.default ChatSyncResponse
chatSync
(ChatSyncRequest chatSyncRequest) Starts or continues a non-streaming Amazon Q Business conversation.default CheckDocumentAccessResponse
checkDocumentAccess
(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 CheckDocumentAccessResponse
checkDocumentAccess
(CheckDocumentAccessRequest checkDocumentAccessRequest) Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document.static QBusinessClient
create()
Create aQBusinessClient
with the region loaded from theDefaultAwsRegionProviderChain
and 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 CreateApplicationResponse
createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an Amazon Q Business application.default CreateApplicationResponse
createApplication
(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 CreateDataAccessorResponse
createDataAccessor
(Consumer<CreateDataAccessorRequest.Builder> createDataAccessorRequest) Creates a new data accessor for an ISV to access data from a Amazon Q Business application.default CreateDataAccessorResponse
createDataAccessor
(CreateDataAccessorRequest createDataAccessorRequest) Creates a new data accessor for an ISV to access data from a Amazon Q Business application.default CreateDataSourceResponse
createDataSource
(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) Creates a data source connector for an Amazon Q Business application.default CreateDataSourceResponse
createDataSource
(CreateDataSourceRequest createDataSourceRequest) Creates a data source connector for an Amazon Q Business application.default CreateIndexResponse
createIndex
(Consumer<CreateIndexRequest.Builder> createIndexRequest) Creates an Amazon Q Business index.default CreateIndexResponse
createIndex
(CreateIndexRequest createIndexRequest) Creates an Amazon Q Business index.default CreatePluginResponse
createPlugin
(Consumer<CreatePluginRequest.Builder> createPluginRequest) Creates an Amazon Q Business plugin.default CreatePluginResponse
createPlugin
(CreatePluginRequest createPluginRequest) Creates an Amazon Q Business plugin.default CreateRetrieverResponse
createRetriever
(Consumer<CreateRetrieverRequest.Builder> createRetrieverRequest) Adds a retriever to your Amazon Q Business application.default CreateRetrieverResponse
createRetriever
(CreateRetrieverRequest createRetrieverRequest) Adds a retriever to your Amazon Q Business application.default CreateSubscriptionResponse
createSubscription
(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.default CreateSubscriptionResponse
createSubscription
(CreateSubscriptionRequest createSubscriptionRequest) Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.default CreateUserResponse
createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.default CreateUserResponse
createUser
(CreateUserRequest createUserRequest) Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.default CreateWebExperienceResponse
createWebExperience
(Consumer<CreateWebExperienceRequest.Builder> createWebExperienceRequest) Creates an Amazon Q Business web experience.default CreateWebExperienceResponse
createWebExperience
(CreateWebExperienceRequest createWebExperienceRequest) Creates an Amazon Q Business web experience.default DeleteApplicationResponse
deleteApplication
(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an Amazon Q Business application.default DeleteApplicationResponse
deleteApplication
(DeleteApplicationRequest deleteApplicationRequest) Deletes an Amazon Q Business application.default DeleteAttachmentResponse
deleteAttachment
(Consumer<DeleteAttachmentRequest.Builder> deleteAttachmentRequest) Deletes an attachment associated with a specific Amazon Q Business conversation.default DeleteAttachmentResponse
deleteAttachment
(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 DeleteConversationResponse
deleteConversation
(Consumer<DeleteConversationRequest.Builder> deleteConversationRequest) Deletes an Amazon Q Business web experience conversation.default DeleteConversationResponse
deleteConversation
(DeleteConversationRequest deleteConversationRequest) Deletes an Amazon Q Business web experience conversation.default DeleteDataAccessorResponse
deleteDataAccessor
(Consumer<DeleteDataAccessorRequest.Builder> deleteDataAccessorRequest) Deletes a specified data accessor.default DeleteDataAccessorResponse
deleteDataAccessor
(DeleteDataAccessorRequest deleteDataAccessorRequest) Deletes a specified data accessor.default DeleteDataSourceResponse
deleteDataSource
(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) Deletes an Amazon Q Business data source connector.default DeleteDataSourceResponse
deleteDataSource
(DeleteDataSourceRequest deleteDataSourceRequest) Deletes an Amazon Q Business data source connector.default DeleteGroupResponse
deleteGroup
(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 DeleteGroupResponse
deleteGroup
(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 DeleteIndexResponse
deleteIndex
(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest) Deletes an Amazon Q Business index.default DeleteIndexResponse
deleteIndex
(DeleteIndexRequest deleteIndexRequest) Deletes an Amazon Q Business index.default DeletePluginResponse
deletePlugin
(Consumer<DeletePluginRequest.Builder> deletePluginRequest) Deletes an Amazon Q Business plugin.default DeletePluginResponse
deletePlugin
(DeletePluginRequest deletePluginRequest) Deletes an Amazon Q Business plugin.default DeleteRetrieverResponse
deleteRetriever
(Consumer<DeleteRetrieverRequest.Builder> deleteRetrieverRequest) Deletes the retriever used by an Amazon Q Business application.default DeleteRetrieverResponse
deleteRetriever
(DeleteRetrieverRequest deleteRetrieverRequest) Deletes the retriever used by an Amazon Q Business application.default DeleteUserResponse
deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user by email id.default DeleteUserResponse
deleteUser
(DeleteUserRequest deleteUserRequest) Deletes a user by email id.default DeleteWebExperienceResponse
deleteWebExperience
(Consumer<DeleteWebExperienceRequest.Builder> deleteWebExperienceRequest) Deletes an Amazon Q Business web experience.default DeleteWebExperienceResponse
deleteWebExperience
(DeleteWebExperienceRequest deleteWebExperienceRequest) Deletes an Amazon Q Business web experience.default DisassociatePermissionResponse
disassociatePermission
(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 DisassociatePermissionResponse
disassociatePermission
(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 GetApplicationResponse
getApplication
(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Gets information about an existing Amazon Q Business application.default GetApplicationResponse
getApplication
(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 GetDataAccessorResponse
getDataAccessor
(Consumer<GetDataAccessorRequest.Builder> getDataAccessorRequest) Retrieves information about a specified data accessor.default GetDataAccessorResponse
getDataAccessor
(GetDataAccessorRequest getDataAccessorRequest) Retrieves information about a specified data accessor.default GetDataSourceResponse
getDataSource
(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) Gets information about an existing Amazon Q Business data source connector.default GetDataSourceResponse
getDataSource
(GetDataSourceRequest getDataSourceRequest) Gets information about an existing Amazon Q Business data source connector.default GetGroupResponse
getGroup
(Consumer<GetGroupRequest.Builder> getGroupRequest) Describes a group by group name.default GetGroupResponse
getGroup
(GetGroupRequest getGroupRequest) Describes a group by group name.default GetIndexResponse
getIndex
(Consumer<GetIndexRequest.Builder> getIndexRequest) Gets information about an existing Amazon Q Business index.default GetIndexResponse
getIndex
(GetIndexRequest getIndexRequest) Gets information about an existing Amazon Q Business index.default GetMediaResponse
getMedia
(Consumer<GetMediaRequest.Builder> getMediaRequest) Returns the image bytes corresponding to a media object.default GetMediaResponse
getMedia
(GetMediaRequest getMediaRequest) Returns the image bytes corresponding to a media object.default GetPluginResponse
getPlugin
(Consumer<GetPluginRequest.Builder> getPluginRequest) Gets information about an existing Amazon Q Business plugin.default GetPluginResponse
getPlugin
(GetPluginRequest getPluginRequest) Gets information about an existing Amazon Q Business plugin.default GetPolicyResponse
getPolicy
(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Retrieves the current permission policy for a Amazon Q Business application.default GetPolicyResponse
getPolicy
(GetPolicyRequest getPolicyRequest) Retrieves the current permission policy for a Amazon Q Business application.default GetRetrieverResponse
getRetriever
(Consumer<GetRetrieverRequest.Builder> getRetrieverRequest) Gets information about an existing retriever used by an Amazon Q Business application.default GetRetrieverResponse
getRetriever
(GetRetrieverRequest getRetrieverRequest) Gets information about an existing retriever used by an Amazon Q Business application.default GetUserResponse
getUser
(Consumer<GetUserRequest.Builder> getUserRequest) Describes the universally unique identifier (UUID) associated with a local user in a data source.default GetUserResponse
getUser
(GetUserRequest getUserRequest) Describes the universally unique identifier (UUID) associated with a local user in a data source.default GetWebExperienceResponse
getWebExperience
(Consumer<GetWebExperienceRequest.Builder> getWebExperienceRequest) Gets information about an existing Amazon Q Business web experience.default GetWebExperienceResponse
getWebExperience
(GetWebExperienceRequest getWebExperienceRequest) Gets information about an existing Amazon Q Business web experience.default ListApplicationsResponse
listApplications
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists Amazon Q Business applications.default ListApplicationsResponse
listApplications
(ListApplicationsRequest listApplicationsRequest) Lists Amazon Q Business applications.default ListApplicationsIterable
listApplicationsPaginator
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)
operation.default ListApplicationsIterable
listApplicationsPaginator
(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)
operation.default ListAttachmentsResponse
listAttachments
(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 ListAttachmentsResponse
listAttachments
(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 ListAttachmentsIterable
listAttachmentsPaginator
(Consumer<ListAttachmentsRequest.Builder> listAttachmentsRequest) This is a variant oflistAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest)
operation.default ListAttachmentsIterable
listAttachmentsPaginator
(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 ListConversationsResponse
listConversations
(Consumer<ListConversationsRequest.Builder> listConversationsRequest) Lists one or more Amazon Q Business conversations.default ListConversationsResponse
listConversations
(ListConversationsRequest listConversationsRequest) Lists one or more Amazon Q Business conversations.default ListConversationsIterable
listConversationsPaginator
(Consumer<ListConversationsRequest.Builder> listConversationsRequest) This is a variant oflistConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest)
operation.default ListConversationsIterable
listConversationsPaginator
(ListConversationsRequest listConversationsRequest) This is a variant oflistConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest)
operation.default ListDataAccessorsResponse
listDataAccessors
(Consumer<ListDataAccessorsRequest.Builder> listDataAccessorsRequest) Lists the data accessors for a Amazon Q Business application.default ListDataAccessorsResponse
listDataAccessors
(ListDataAccessorsRequest listDataAccessorsRequest) Lists the data accessors for a Amazon Q Business application.default ListDataAccessorsIterable
listDataAccessorsPaginator
(Consumer<ListDataAccessorsRequest.Builder> listDataAccessorsRequest) This is a variant oflistDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest)
operation.default ListDataAccessorsIterable
listDataAccessorsPaginator
(ListDataAccessorsRequest listDataAccessorsRequest) This is a variant oflistDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest)
operation.default ListDataSourcesResponse
listDataSources
(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) Lists the Amazon Q Business data source connectors that you have created.default ListDataSourcesResponse
listDataSources
(ListDataSourcesRequest listDataSourcesRequest) Lists the Amazon Q Business data source connectors that you have created.default ListDataSourcesIterable
listDataSourcesPaginator
(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) This is a variant oflistDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest)
operation.default ListDataSourcesIterable
listDataSourcesPaginator
(ListDataSourcesRequest listDataSourcesRequest) This is a variant oflistDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest)
operation.default ListDataSourceSyncJobsResponse
listDataSourceSyncJobs
(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) Get information about an Amazon Q Business data source connector synchronization.default ListDataSourceSyncJobsResponse
listDataSourceSyncJobs
(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) Get information about an Amazon Q Business data source connector synchronization.default ListDataSourceSyncJobsIterable
listDataSourceSyncJobsPaginator
(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) This is a variant oflistDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest)
operation.default ListDataSourceSyncJobsIterable
listDataSourceSyncJobsPaginator
(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) This is a variant oflistDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest)
operation.default ListDocumentsResponse
listDocuments
(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) A list of documents attached to an index.default ListDocumentsResponse
listDocuments
(ListDocumentsRequest listDocumentsRequest) A list of documents attached to an index.default ListDocumentsIterable
listDocumentsPaginator
(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) This is a variant oflistDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest)
operation.default ListDocumentsIterable
listDocumentsPaginator
(ListDocumentsRequest listDocumentsRequest) This is a variant oflistDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest)
operation.default ListGroupsResponse
listGroups
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Provides a list of groups that are mapped to users.default ListGroupsResponse
listGroups
(ListGroupsRequest listGroupsRequest) Provides a list of groups that are mapped to users.default ListGroupsIterable
listGroupsPaginator
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest)
operation.default ListGroupsIterable
listGroupsPaginator
(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest)
operation.default ListIndicesResponse
listIndices
(Consumer<ListIndicesRequest.Builder> listIndicesRequest) Lists the Amazon Q Business indices you have created.default ListIndicesResponse
listIndices
(ListIndicesRequest listIndicesRequest) Lists the Amazon Q Business indices you have created.default ListIndicesIterable
listIndicesPaginator
(Consumer<ListIndicesRequest.Builder> listIndicesRequest) This is a variant oflistIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest)
operation.default ListIndicesIterable
listIndicesPaginator
(ListIndicesRequest listIndicesRequest) This is a variant oflistIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest)
operation.default ListMessagesResponse
listMessages
(Consumer<ListMessagesRequest.Builder> listMessagesRequest) Gets a list of messages associated with an Amazon Q Business web experience.default ListMessagesResponse
listMessages
(ListMessagesRequest listMessagesRequest) Gets a list of messages associated with an Amazon Q Business web experience.default ListMessagesIterable
listMessagesPaginator
(Consumer<ListMessagesRequest.Builder> listMessagesRequest) This is a variant oflistMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest)
operation.default ListMessagesIterable
listMessagesPaginator
(ListMessagesRequest listMessagesRequest) This is a variant oflistMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest)
operation.default ListPluginActionsResponse
listPluginActions
(Consumer<ListPluginActionsRequest.Builder> listPluginActionsRequest) Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.default ListPluginActionsResponse
listPluginActions
(ListPluginActionsRequest listPluginActionsRequest) Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.default ListPluginActionsIterable
listPluginActionsPaginator
(Consumer<ListPluginActionsRequest.Builder> listPluginActionsRequest) This is a variant oflistPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest)
operation.default ListPluginActionsIterable
listPluginActionsPaginator
(ListPluginActionsRequest listPluginActionsRequest) This is a variant oflistPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest)
operation.default ListPluginsResponse
listPlugins
(Consumer<ListPluginsRequest.Builder> listPluginsRequest) Lists configured Amazon Q Business plugins.default ListPluginsResponse
listPlugins
(ListPluginsRequest listPluginsRequest) Lists configured Amazon Q Business plugins.default ListPluginsIterable
listPluginsPaginator
(Consumer<ListPluginsRequest.Builder> listPluginsRequest) This is a variant oflistPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest)
operation.default ListPluginsIterable
listPluginsPaginator
(ListPluginsRequest listPluginsRequest) This is a variant oflistPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest)
operation.default ListPluginTypeActionsResponse
listPluginTypeActions
(Consumer<ListPluginTypeActionsRequest.Builder> listPluginTypeActionsRequest) Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.default ListPluginTypeActionsResponse
listPluginTypeActions
(ListPluginTypeActionsRequest listPluginTypeActionsRequest) Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.default ListPluginTypeActionsIterable
listPluginTypeActionsPaginator
(Consumer<ListPluginTypeActionsRequest.Builder> listPluginTypeActionsRequest) This is a variant oflistPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest)
operation.default ListPluginTypeActionsIterable
listPluginTypeActionsPaginator
(ListPluginTypeActionsRequest listPluginTypeActionsRequest) This is a variant oflistPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest)
operation.default ListPluginTypeMetadataResponse
listPluginTypeMetadata
(Consumer<ListPluginTypeMetadataRequest.Builder> listPluginTypeMetadataRequest) Lists metadata for all Amazon Q Business plugin types.default ListPluginTypeMetadataResponse
listPluginTypeMetadata
(ListPluginTypeMetadataRequest listPluginTypeMetadataRequest) Lists metadata for all Amazon Q Business plugin types.default ListPluginTypeMetadataIterable
listPluginTypeMetadataPaginator
(Consumer<ListPluginTypeMetadataRequest.Builder> listPluginTypeMetadataRequest) This is a variant oflistPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest)
operation.default ListPluginTypeMetadataIterable
listPluginTypeMetadataPaginator
(ListPluginTypeMetadataRequest listPluginTypeMetadataRequest) This is a variant oflistPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest)
operation.default ListRetrieversResponse
listRetrievers
(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest) Lists the retriever used by an Amazon Q Business application.default ListRetrieversResponse
listRetrievers
(ListRetrieversRequest listRetrieversRequest) Lists the retriever used by an Amazon Q Business application.default ListRetrieversIterable
listRetrieversPaginator
(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest) This is a variant oflistRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest)
operation.default ListRetrieversIterable
listRetrieversPaginator
(ListRetrieversRequest listRetrieversRequest) This is a variant oflistRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest)
operation.default ListSubscriptionsResponse
listSubscriptions
(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) Lists all subscriptions created in an Amazon Q Business application.default ListSubscriptionsResponse
listSubscriptions
(ListSubscriptionsRequest listSubscriptionsRequest) Lists all subscriptions created in an Amazon Q Business application.default ListSubscriptionsIterable
listSubscriptionsPaginator
(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) This is a variant oflistSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest)
operation.default ListSubscriptionsIterable
listSubscriptionsPaginator
(ListSubscriptionsRequest listSubscriptionsRequest) This is a variant oflistSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets a list of tags associated with a specified resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets a list of tags associated with a specified resource.default ListWebExperiencesResponse
listWebExperiences
(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest) Lists one or more Amazon Q Business Web Experiences.default ListWebExperiencesResponse
listWebExperiences
(ListWebExperiencesRequest listWebExperiencesRequest) Lists one or more Amazon Q Business Web Experiences.default ListWebExperiencesIterable
listWebExperiencesPaginator
(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest) This is a variant oflistWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest)
operation.default ListWebExperiencesIterable
listWebExperiencesPaginator
(ListWebExperiencesRequest listWebExperiencesRequest) This is a variant oflistWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest)
operation.default PutFeedbackResponse
putFeedback
(Consumer<PutFeedbackRequest.Builder> putFeedbackRequest) Enables your end user to provide feedback on their Amazon Q Business generated chat responses.default PutFeedbackResponse
putFeedback
(PutFeedbackRequest putFeedbackRequest) Enables your end user to provide feedback on their Amazon Q Business generated chat responses.default PutGroupResponse
putGroup
(Consumer<PutGroupRequest.Builder> putGroupRequest) Create, or updates, a mapping of users—who have access to a document—to groups.default PutGroupResponse
putGroup
(PutGroupRequest putGroupRequest) Create, or updates, a mapping of users—who have access to a document—to groups.default SearchRelevantContentResponse
searchRelevantContent
(Consumer<SearchRelevantContentRequest.Builder> searchRelevantContentRequest) Searches for relevant content in a Amazon Q Business application based on a query.default SearchRelevantContentResponse
searchRelevantContent
(SearchRelevantContentRequest searchRelevantContentRequest) Searches for relevant content in a Amazon Q Business application based on a query.default SearchRelevantContentIterable
searchRelevantContentPaginator
(Consumer<SearchRelevantContentRequest.Builder> searchRelevantContentRequest) This is a variant ofsearchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest)
operation.default SearchRelevantContentIterable
searchRelevantContentPaginator
(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 ServiceMetadata
default StartDataSourceSyncJobResponse
startDataSourceSyncJob
(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest) Starts a data source connector synchronization job.default StartDataSourceSyncJobResponse
startDataSourceSyncJob
(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest) Starts a data source connector synchronization job.default StopDataSourceSyncJobResponse
stopDataSourceSyncJob
(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest) Stops an Amazon Q Business data source connector synchronization job already in progress.default StopDataSourceSyncJobResponse
stopDataSourceSyncJob
(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest) Stops an Amazon Q Business data source connector synchronization job already in progress.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tag to the specified Amazon Q Business application or data source resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds the specified tag to the specified Amazon Q Business application or data source resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from an Amazon Q Business application or a data source.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag from an Amazon Q Business application or a data source.default UpdateApplicationResponse
updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates an existing Amazon Q Business application.default UpdateApplicationResponse
updateApplication
(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 UpdateDataAccessorResponse
updateDataAccessor
(Consumer<UpdateDataAccessorRequest.Builder> updateDataAccessorRequest) Updates an existing data accessor.default UpdateDataAccessorResponse
updateDataAccessor
(UpdateDataAccessorRequest updateDataAccessorRequest) Updates an existing data accessor.default UpdateDataSourceResponse
updateDataSource
(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) Updates an existing Amazon Q Business data source connector.default UpdateDataSourceResponse
updateDataSource
(UpdateDataSourceRequest updateDataSourceRequest) Updates an existing Amazon Q Business data source connector.default UpdateIndexResponse
updateIndex
(Consumer<UpdateIndexRequest.Builder> updateIndexRequest) Updates an Amazon Q Business index.default UpdateIndexResponse
updateIndex
(UpdateIndexRequest updateIndexRequest) Updates an Amazon Q Business index.default UpdatePluginResponse
updatePlugin
(Consumer<UpdatePluginRequest.Builder> updatePluginRequest) Updates an Amazon Q Business plugin.default UpdatePluginResponse
updatePlugin
(UpdatePluginRequest updatePluginRequest) Updates an Amazon Q Business plugin.default UpdateRetrieverResponse
updateRetriever
(Consumer<UpdateRetrieverRequest.Builder> updateRetrieverRequest) Updates the retriever used for your Amazon Q Business application.default UpdateRetrieverResponse
updateRetriever
(UpdateRetrieverRequest updateRetrieverRequest) Updates the retriever used for your Amazon Q Business application.default UpdateSubscriptionResponse
updateSubscription
(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest) Updates the pricing tier for an Amazon Q Business subscription.default UpdateSubscriptionResponse
updateSubscription
(UpdateSubscriptionRequest updateSubscriptionRequest) Updates the pricing tier for an Amazon Q Business subscription.default UpdateUserResponse
updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates a information associated with a user id.default UpdateUserResponse
updateUser
(UpdateUserRequest updateUserRequest) Updates a information associated with a user id.default UpdateWebExperienceResponse
updateWebExperience
(Consumer<UpdateWebExperienceRequest.Builder> updateWebExperienceRequest) Updates an Amazon Q Business web experience.default UpdateWebExperienceResponse
updateWebExperience
(UpdateWebExperienceRequest updateWebExperienceRequest) Updates an Amazon Q Business web experience.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associatePermission
default 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:
-
associatePermission
default 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.Builder
avoiding the need to create one manually viaAssociatePermissionRequest.builder()
- Parameters:
associatePermissionRequest
- AConsumer
that will call methods onAssociatePermissionRequest.Builder
to create a request.- Returns:
- Result of the AssociatePermission operation returned by the service.
- See Also:
-
batchDeleteDocument
default BatchDeleteDocumentResponse batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException Asynchronously deletes one or more documents added using the
BatchPutDocument
API from an Amazon Q Business index.You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
- Parameters:
batchDeleteDocumentRequest
-- Returns:
- Result of the BatchDeleteDocument operation returned by the service.
- See Also:
-
batchDeleteDocument
default 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
BatchPutDocument
API from an Amazon Q Business index.You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
This is a convenience which creates an instance of the
BatchDeleteDocumentRequest.Builder
avoiding the need to create one manually viaBatchDeleteDocumentRequest.builder()
- Parameters:
batchDeleteDocumentRequest
- AConsumer
that will call methods onBatchDeleteDocumentRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteDocument operation returned by the service.
- See Also:
-
batchPutDocument
default 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:
-
-
batchPutDocument
default 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.Builder
avoiding the need to create one manually viaBatchPutDocumentRequest.builder()
- Parameters:
batchPutDocumentRequest
- AConsumer
that will call methods onBatchPutDocumentRequest.Builder
to create a request.- Returns:
- Result of the BatchPutDocument operation returned by the service.
- See Also:
-
-
cancelSubscription
default 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:
-
cancelSubscription
default 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.Builder
avoiding the need to create one manually viaCancelSubscriptionRequest.builder()
- Parameters:
cancelSubscriptionRequest
- AConsumer
that will call methods onCancelSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the CancelSubscription operation returned by the service.
- See Also:
-
chatSync
default 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:
-
chatSync
default 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.Builder
avoiding the need to create one manually viaChatSyncRequest.builder()
- Parameters:
chatSyncRequest
- AConsumer
that will call methods onChatSyncRequest.Builder
to create a request.- Returns:
- Result of the ChatSync operation returned by the service.
- See Also:
-
checkDocumentAccess
default 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:
-
checkDocumentAccess
default 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.Builder
avoiding the need to create one manually viaCheckDocumentAccessRequest.builder()
- Parameters:
checkDocumentAccessRequest
- AConsumer
that will call methods onCheckDocumentAccessRequest.Builder
to create a request.- Returns:
- Result of the CheckDocumentAccess operation returned by the service.
- See Also:
-
createAnonymousWebExperienceUrl
default 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:
-
createAnonymousWebExperienceUrl
default 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.Builder
avoiding the need to create one manually viaCreateAnonymousWebExperienceUrlRequest.builder()
- Parameters:
createAnonymousWebExperienceUrlRequest
- AConsumer
that will call methods onCreateAnonymousWebExperienceUrlRequest.Builder
to create a request.- Returns:
- Result of the CreateAnonymousWebExperienceUrl operation returned by the service.
- See Also:
-
createApplication
default 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
QAppsConfiguration
is 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:
-
createApplication
default 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
QAppsConfiguration
is 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.Builder
avoiding the need to create one manually viaCreateApplicationRequest.builder()
- Parameters:
createApplicationRequest
- AConsumer
that will call methods onCreateApplicationRequest.Builder
to create a request.- Returns:
- Result of the CreateApplication operation returned by the service.
- See Also:
-
createChatResponseConfiguration
default 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:
-
createChatResponseConfiguration
default 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.Builder
avoiding the need to create one manually viaCreateChatResponseConfigurationRequest.builder()
- Parameters:
createChatResponseConfigurationRequest
- AConsumer
that will call methods onCreateChatResponseConfigurationRequest.Builder
to create a request.- Returns:
- Result of the CreateChatResponseConfiguration operation returned by the service.
- See Also:
-
createDataAccessor
default 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:
-
createDataAccessor
default 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.Builder
avoiding the need to create one manually viaCreateDataAccessorRequest.builder()
- Parameters:
createDataAccessorRequest
- AConsumer
that will call methods onCreateDataAccessorRequest.Builder
to create a request.- Returns:
- Result of the CreateDataAccessor operation returned by the service.
- See Also:
-
createDataSource
default 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.
CreateDataSource
is 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:
-
createDataSource
default 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.
CreateDataSource
is 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.Builder
avoiding the need to create one manually viaCreateDataSourceRequest.builder()
- Parameters:
createDataSourceRequest
- AConsumer
that will call methods onCreateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the CreateDataSource operation returned by the service.
- See Also:
-
createIndex
default 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
Status
field returned from a call toDescribeIndex
. TheStatus
field is set toACTIVE
when the index is ready to use.Once the index is active, you can index your documents using the
BatchPutDocument
API or theCreateDataSource
API.- Parameters:
createIndexRequest
-- Returns:
- Result of the CreateIndex operation returned by the service.
- See Also:
-
createIndex
default 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
Status
field returned from a call toDescribeIndex
. TheStatus
field is set toACTIVE
when the index is ready to use.Once the index is active, you can index your documents using the
BatchPutDocument
API or theCreateDataSource
API.
This is a convenience which creates an instance of the
CreateIndexRequest.Builder
avoiding the need to create one manually viaCreateIndexRequest.builder()
- Parameters:
createIndexRequest
- AConsumer
that will call methods onCreateIndexRequest.Builder
to create a request.- Returns:
- Result of the CreateIndex operation returned by the service.
- See Also:
-
createPlugin
default 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:
-
createPlugin
default 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.Builder
avoiding the need to create one manually viaCreatePluginRequest.builder()
- Parameters:
createPluginRequest
- AConsumer
that will call methods onCreatePluginRequest.Builder
to create a request.- Returns:
- Result of the CreatePlugin operation returned by the service.
- See Also:
-
createRetriever
default 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:
-
createRetriever
default 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.Builder
avoiding the need to create one manually viaCreateRetrieverRequest.builder()
- Parameters:
createRetrieverRequest
- AConsumer
that will call methods onCreateRetrieverRequest.Builder
to create a request.- Returns:
- Result of the CreateRetriever operation returned by the service.
- See Also:
-
createSubscription
default 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_LITE
andQ_BUSINESS
. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.- Parameters:
createSubscriptionRequest
-- Returns:
- Result of the CreateSubscription operation returned by the service.
- See Also:
-
createSubscription
default 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_LITE
andQ_BUSINESS
. 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
CreateSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateSubscriptionRequest.builder()
- Parameters:
createSubscriptionRequest
- AConsumer
that will call methods onCreateSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the CreateSubscription operation returned by the service.
- See Also:
-
createUser
default 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:
-
createUser
default 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.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
createWebExperience
default 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:
-
createWebExperience
default 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.Builder
avoiding the need to create one manually viaCreateWebExperienceRequest.builder()
- Parameters:
createWebExperienceRequest
- AConsumer
that will call methods onCreateWebExperienceRequest.Builder
to create a request.- Returns:
- Result of the CreateWebExperience operation returned by the service.
- See Also:
-
deleteApplication
default 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:
-
deleteApplication
default 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.Builder
avoiding the need to create one manually viaDeleteApplicationRequest.builder()
- Parameters:
deleteApplicationRequest
- AConsumer
that will call methods onDeleteApplicationRequest.Builder
to create a request.- Returns:
- Result of the DeleteApplication operation returned by the service.
- See Also:
-
deleteAttachment
default 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:
-
deleteAttachment
default 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.Builder
avoiding the need to create one manually viaDeleteAttachmentRequest.builder()
- Parameters:
deleteAttachmentRequest
- AConsumer
that will call methods onDeleteAttachmentRequest.Builder
to create a request.- Returns:
- Result of the DeleteAttachment operation returned by the service.
- See Also:
-
deleteChatControlsConfiguration
default 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:
-
deleteChatControlsConfiguration
default 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.Builder
avoiding the need to create one manually viaDeleteChatControlsConfigurationRequest.builder()
- Parameters:
deleteChatControlsConfigurationRequest
- AConsumer
that will call methods onDeleteChatControlsConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteChatControlsConfiguration operation returned by the service.
- See Also:
-
deleteChatResponseConfiguration
default 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:
-
deleteChatResponseConfiguration
default 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.Builder
avoiding the need to create one manually viaDeleteChatResponseConfigurationRequest.builder()
- Parameters:
deleteChatResponseConfigurationRequest
- AConsumer
that will call methods onDeleteChatResponseConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteChatResponseConfiguration operation returned by the service.
- See Also:
-
deleteConversation
default DeleteConversationResponse deleteConversation(DeleteConversationRequest deleteConversationRequest) throws InternalServerException, ResourceNotFoundException, 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:
-
deleteConversation
default DeleteConversationResponse deleteConversation(Consumer<DeleteConversationRequest.Builder> deleteConversationRequest) throws InternalServerException, ResourceNotFoundException, 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.Builder
avoiding the need to create one manually viaDeleteConversationRequest.builder()
- Parameters:
deleteConversationRequest
- AConsumer
that will call methods onDeleteConversationRequest.Builder
to create a request.- Returns:
- Result of the DeleteConversation operation returned by the service.
- See Also:
-
deleteDataAccessor
default 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:
-
deleteDataAccessor
default 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.Builder
avoiding the need to create one manually viaDeleteDataAccessorRequest.builder()
- Parameters:
deleteDataAccessorRequest
- AConsumer
that will call methods onDeleteDataAccessorRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataAccessor operation returned by the service.
- See Also:
-
deleteDataSource
default 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
Status
field returned by a call to theDescribeDataSource
API is set toDELETING
.- Parameters:
deleteDataSourceRequest
-- Returns:
- Result of the DeleteDataSource operation returned by the service.
- See Also:
-
deleteDataSource
default 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
Status
field returned by a call to theDescribeDataSource
API is set toDELETING
.
This is a convenience which creates an instance of the
DeleteDataSourceRequest.Builder
avoiding the need to create one manually viaDeleteDataSourceRequest.builder()
- Parameters:
deleteDataSourceRequest
- AConsumer
that will call methods onDeleteDataSourceRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataSource operation returned by the service.
- See Also:
-
deleteGroup
default 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
PutGroup
operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when callingPutGroup
.- Parameters:
deleteGroupRequest
-- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
deleteGroup
default 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
PutGroup
operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when callingPutGroup
.
This is a convenience which creates an instance of the
DeleteGroupRequest.Builder
avoiding the need to create one manually viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
deleteIndex
default 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:
-
deleteIndex
default 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.Builder
avoiding the need to create one manually viaDeleteIndexRequest.builder()
- Parameters:
deleteIndexRequest
- AConsumer
that will call methods onDeleteIndexRequest.Builder
to create a request.- Returns:
- Result of the DeleteIndex operation returned by the service.
- See Also:
-
deletePlugin
default 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:
-
deletePlugin
default 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.Builder
avoiding the need to create one manually viaDeletePluginRequest.builder()
- Parameters:
deletePluginRequest
- AConsumer
that will call methods onDeletePluginRequest.Builder
to create a request.- Returns:
- Result of the DeletePlugin operation returned by the service.
- See Also:
-
deleteRetriever
default 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:
-
deleteRetriever
default 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.Builder
avoiding the need to create one manually viaDeleteRetrieverRequest.builder()
- Parameters:
deleteRetrieverRequest
- AConsumer
that will call methods onDeleteRetrieverRequest.Builder
to create a request.- Returns:
- Result of the DeleteRetriever operation returned by the service.
- See Also:
-
deleteUser
default 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:
-
deleteUser
default 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.Builder
avoiding the need to create one manually viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
deleteWebExperience
default 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:
-
deleteWebExperience
default 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.Builder
avoiding the need to create one manually viaDeleteWebExperienceRequest.builder()
- Parameters:
deleteWebExperienceRequest
- AConsumer
that will call methods onDeleteWebExperienceRequest.Builder
to create a request.- Returns:
- Result of the DeleteWebExperience operation returned by the service.
- See Also:
-
disassociatePermission
default 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:
-
disassociatePermission
default 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.Builder
avoiding the need to create one manually viaDisassociatePermissionRequest.builder()
- Parameters:
disassociatePermissionRequest
- AConsumer
that will call methods onDisassociatePermissionRequest.Builder
to create a request.- Returns:
- Result of the DisassociatePermission operation returned by the service.
- See Also:
-
getApplication
default 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:
-
getApplication
default 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.Builder
avoiding the need to create one manually viaGetApplicationRequest.builder()
- Parameters:
getApplicationRequest
- AConsumer
that will call methods onGetApplicationRequest.Builder
to create a request.- Returns:
- Result of the GetApplication operation returned by the service.
- See Also:
-
getChatControlsConfiguration
default 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:
-
getChatControlsConfiguration
default 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.Builder
avoiding the need to create one manually viaGetChatControlsConfigurationRequest.builder()
- Parameters:
getChatControlsConfigurationRequest
- AConsumer
that will call methods onGetChatControlsConfigurationRequest.Builder
to create a request.- Returns:
- Result of the GetChatControlsConfiguration operation returned by the service.
- See Also:
-
getChatControlsConfigurationPaginator
default 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 Streamsoftware.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:
-
getChatControlsConfigurationPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaGetChatControlsConfigurationRequest.builder()
- Parameters:
getChatControlsConfigurationRequest
- AConsumer
that will call methods onGetChatControlsConfigurationRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getChatResponseConfiguration
default 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:
-
getChatResponseConfiguration
default 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.Builder
avoiding the need to create one manually viaGetChatResponseConfigurationRequest.builder()
- Parameters:
getChatResponseConfigurationRequest
- AConsumer
that will call methods onGetChatResponseConfigurationRequest.Builder
to create a request.- Returns:
- Result of the GetChatResponseConfiguration operation returned by the service.
- See Also:
-
getDataAccessor
default 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:
-
getDataAccessor
default 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.Builder
avoiding the need to create one manually viaGetDataAccessorRequest.builder()
- Parameters:
getDataAccessorRequest
- AConsumer
that will call methods onGetDataAccessorRequest.Builder
to create a request.- Returns:
- Result of the GetDataAccessor operation returned by the service.
- See Also:
-
getDataSource
default 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:
-
getDataSource
default 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.Builder
avoiding the need to create one manually viaGetDataSourceRequest.builder()
- Parameters:
getDataSourceRequest
- AConsumer
that will call methods onGetDataSourceRequest.Builder
to create a request.- Returns:
- Result of the GetDataSource operation returned by the service.
- See Also:
-
getGroup
default 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:
-
getGroup
default 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.Builder
avoiding the need to create one manually viaGetGroupRequest.builder()
- Parameters:
getGroupRequest
- AConsumer
that will call methods onGetGroupRequest.Builder
to create a request.- Returns:
- Result of the GetGroup operation returned by the service.
- See Also:
-
getIndex
default 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:
-
getIndex
default 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.Builder
avoiding the need to create one manually viaGetIndexRequest.builder()
- Parameters:
getIndexRequest
- AConsumer
that will call methods onGetIndexRequest.Builder
to create a request.- Returns:
- Result of the GetIndex operation returned by the service.
- See Also:
-
getMedia
default 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:
-
getMedia
default 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.Builder
avoiding the need to create one manually viaGetMediaRequest.builder()
- Parameters:
getMediaRequest
- AConsumer
that will call methods onGetMediaRequest.Builder
to create a request.- Returns:
- Result of the GetMedia operation returned by the service.
- See Also:
-
getPlugin
default 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:
-
getPlugin
default 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.Builder
avoiding the need to create one manually viaGetPluginRequest.builder()
- Parameters:
getPluginRequest
- AConsumer
that will call methods onGetPluginRequest.Builder
to create a request.- Returns:
- Result of the GetPlugin operation returned by the service.
- See Also:
-
getPolicy
default 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:
-
getPolicy
default 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.Builder
avoiding the need to create one manually viaGetPolicyRequest.builder()
- Parameters:
getPolicyRequest
- AConsumer
that will call methods onGetPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetPolicy operation returned by the service.
- See Also:
-
getRetriever
default 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:
-
getRetriever
default 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.Builder
avoiding the need to create one manually viaGetRetrieverRequest.builder()
- Parameters:
getRetrieverRequest
- AConsumer
that will call methods onGetRetrieverRequest.Builder
to create a request.- Returns:
- Result of the GetRetriever operation returned by the service.
- See Also:
-
getUser
default 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:
-
getUser
default 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.Builder
avoiding the need to create one manually viaGetUserRequest.builder()
- Parameters:
getUserRequest
- AConsumer
that will call methods onGetUserRequest.Builder
to create a request.- Returns:
- Result of the GetUser operation returned by the service.
- See Also:
-
getWebExperience
default 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:
-
getWebExperience
default 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.Builder
avoiding the need to create one manually viaGetWebExperienceRequest.builder()
- Parameters:
getWebExperienceRequest
- AConsumer
that will call methods onGetWebExperienceRequest.Builder
to create a request.- Returns:
- Result of the GetWebExperience operation returned by the service.
- See Also:
-
listApplications
default 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:
-
listApplications
default 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.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- Result of the ListApplications operation returned by the service.
- See Also:
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of
listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.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:
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QBusinessException This is a variant of
listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.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.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAttachments
default 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:
-
listAttachments
default 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.Builder
avoiding the need to create one manually viaListAttachmentsRequest.builder()
- Parameters:
listAttachmentsRequest
- AConsumer
that will call methods onListAttachmentsRequest.Builder
to create a request.- Returns:
- Result of the ListAttachments operation returned by the service.
- See Also:
-
listAttachmentsPaginator
default 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 Streamsoftware.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:
-
listAttachmentsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListAttachmentsRequest.builder()
- Parameters:
listAttachmentsRequest
- AConsumer
that will call methods onListAttachmentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listChatResponseConfigurations
default 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:
-
listChatResponseConfigurations
default 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.Builder
avoiding the need to create one manually viaListChatResponseConfigurationsRequest.builder()
- Parameters:
listChatResponseConfigurationsRequest
- AConsumer
that will call methods onListChatResponseConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the ListChatResponseConfigurations operation returned by the service.
- See Also:
-
listChatResponseConfigurationsPaginator
default 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 Streamsoftware.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:
-
listChatResponseConfigurationsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListChatResponseConfigurationsRequest.builder()
- Parameters:
listChatResponseConfigurationsRequest
- AConsumer
that will call methods onListChatResponseConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listConversations
default 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:
-
listConversations
default 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.Builder
avoiding the need to create one manually viaListConversationsRequest.builder()
- Parameters:
listConversationsRequest
- AConsumer
that will call methods onListConversationsRequest.Builder
to create a request.- Returns:
- Result of the ListConversations operation returned by the service.
- See Also:
-
listConversationsPaginator
default 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 Streamsoftware.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:
-
listConversationsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListConversationsRequest.builder()
- Parameters:
listConversationsRequest
- AConsumer
that will call methods onListConversationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataAccessors
default 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:
-
listDataAccessors
default 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.Builder
avoiding the need to create one manually viaListDataAccessorsRequest.builder()
- Parameters:
listDataAccessorsRequest
- AConsumer
that will call methods onListDataAccessorsRequest.Builder
to create a request.- Returns:
- Result of the ListDataAccessors operation returned by the service.
- See Also:
-
listDataAccessorsPaginator
default 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 Streamsoftware.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:
-
listDataAccessorsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListDataAccessorsRequest.builder()
- Parameters:
listDataAccessorsRequest
- AConsumer
that will call methods onListDataAccessorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataSourceSyncJobs
default 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:
-
listDataSourceSyncJobs
default 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.Builder
avoiding the need to create one manually viaListDataSourceSyncJobsRequest.builder()
- Parameters:
listDataSourceSyncJobsRequest
- AConsumer
that will call methods onListDataSourceSyncJobsRequest.Builder
to create a request.- Returns:
- Result of the ListDataSourceSyncJobs operation returned by the service.
- See Also:
-
listDataSourceSyncJobsPaginator
default 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 Streamsoftware.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:
-
listDataSourceSyncJobsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListDataSourceSyncJobsRequest.builder()
- Parameters:
listDataSourceSyncJobsRequest
- AConsumer
that will call methods onListDataSourceSyncJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataSources
default 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:
-
listDataSources
default 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.Builder
avoiding the need to create one manually viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- Result of the ListDataSources operation returned by the service.
- See Also:
-
listDataSourcesPaginator
default 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 Streamsoftware.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:
-
listDataSourcesPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDocuments
default 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:
-
listDocuments
default 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.Builder
avoiding the need to create one manually viaListDocumentsRequest.builder()
- Parameters:
listDocumentsRequest
- AConsumer
that will call methods onListDocumentsRequest.Builder
to create a request.- Returns:
- Result of the ListDocuments operation returned by the service.
- See Also:
-
listDocumentsPaginator
default 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 Streamsoftware.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:
-
listDocumentsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListDocumentsRequest.builder()
- Parameters:
listDocumentsRequest
- AConsumer
that will call methods onListDocumentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroups
default 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:
-
listGroups
default 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.Builder
avoiding the need to create one manually viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListGroups operation returned by the service.
- See Also:
-
listGroupsPaginator
default 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 Streamsoftware.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:
-
listGroupsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIndices
default 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:
-
listIndices
default 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.Builder
avoiding the need to create one manually viaListIndicesRequest.builder()
- Parameters:
listIndicesRequest
- AConsumer
that will call methods onListIndicesRequest.Builder
to create a request.- Returns:
- Result of the ListIndices operation returned by the service.
- See Also:
-
listIndicesPaginator
default 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 Streamsoftware.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:
-
listIndicesPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListIndicesRequest.builder()
- Parameters:
listIndicesRequest
- AConsumer
that will call methods onListIndicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMessages
default 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:
-
listMessages
default 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.Builder
avoiding the need to create one manually viaListMessagesRequest.builder()
- Parameters:
listMessagesRequest
- AConsumer
that will call methods onListMessagesRequest.Builder
to create a request.- Returns:
- Result of the ListMessages operation returned by the service.
- See Also:
-
listMessagesPaginator
default 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 Streamsoftware.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:
-
listMessagesPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListMessagesRequest.builder()
- Parameters:
listMessagesRequest
- AConsumer
that will call methods onListMessagesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPluginActions
default 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:
-
listPluginActions
default 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.Builder
avoiding the need to create one manually viaListPluginActionsRequest.builder()
- Parameters:
listPluginActionsRequest
- AConsumer
that will call methods onListPluginActionsRequest.Builder
to create a request.- Returns:
- Result of the ListPluginActions operation returned by the service.
- See Also:
-
listPluginActionsPaginator
default 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 Streamsoftware.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:
-
listPluginActionsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListPluginActionsRequest.builder()
- Parameters:
listPluginActionsRequest
- AConsumer
that will call methods onListPluginActionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPluginTypeActions
default 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:
-
listPluginTypeActions
default 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.Builder
avoiding the need to create one manually viaListPluginTypeActionsRequest.builder()
- Parameters:
listPluginTypeActionsRequest
- AConsumer
that will call methods onListPluginTypeActionsRequest.Builder
to create a request.- Returns:
- Result of the ListPluginTypeActions operation returned by the service.
- See Also:
-
listPluginTypeActionsPaginator
default 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 Streamsoftware.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:
-
listPluginTypeActionsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListPluginTypeActionsRequest.builder()
- Parameters:
listPluginTypeActionsRequest
- AConsumer
that will call methods onListPluginTypeActionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPluginTypeMetadata
default 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:
-
listPluginTypeMetadata
default 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.Builder
avoiding the need to create one manually viaListPluginTypeMetadataRequest.builder()
- Parameters:
listPluginTypeMetadataRequest
- AConsumer
that will call methods onListPluginTypeMetadataRequest.Builder
to create a request.- Returns:
- Result of the ListPluginTypeMetadata operation returned by the service.
- See Also:
-
listPluginTypeMetadataPaginator
default 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 Streamsoftware.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:
-
listPluginTypeMetadataPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListPluginTypeMetadataRequest.builder()
- Parameters:
listPluginTypeMetadataRequest
- AConsumer
that will call methods onListPluginTypeMetadataRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPlugins
default 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:
-
listPlugins
default 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.Builder
avoiding the need to create one manually viaListPluginsRequest.builder()
- Parameters:
listPluginsRequest
- AConsumer
that will call methods onListPluginsRequest.Builder
to create a request.- Returns:
- Result of the ListPlugins operation returned by the service.
- See Also:
-
listPluginsPaginator
default 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 Streamsoftware.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:
-
listPluginsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListPluginsRequest.builder()
- Parameters:
listPluginsRequest
- AConsumer
that will call methods onListPluginsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRetrievers
default 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:
-
listRetrievers
default 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.Builder
avoiding the need to create one manually viaListRetrieversRequest.builder()
- Parameters:
listRetrieversRequest
- AConsumer
that will call methods onListRetrieversRequest.Builder
to create a request.- Returns:
- Result of the ListRetrievers operation returned by the service.
- See Also:
-
listRetrieversPaginator
default 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 Streamsoftware.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:
-
listRetrieversPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListRetrieversRequest.builder()
- Parameters:
listRetrieversRequest
- AConsumer
that will call methods onListRetrieversRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubscriptions
default 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:
-
listSubscriptions
default 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.Builder
avoiding the need to create one manually viaListSubscriptionsRequest.builder()
- Parameters:
listSubscriptionsRequest
- AConsumer
that will call methods onListSubscriptionsRequest.Builder
to create a request.- Returns:
- Result of the ListSubscriptions operation returned by the service.
- See Also:
-
listSubscriptionsPaginator
default 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 Streamsoftware.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:
-
listSubscriptionsPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListSubscriptionsRequest.builder()
- Parameters:
listSubscriptionsRequest
- AConsumer
that will call methods onListSubscriptionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default 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:
-
listTagsForResource
default 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.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listWebExperiences
default 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:
-
listWebExperiences
default 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.Builder
avoiding the need to create one manually viaListWebExperiencesRequest.builder()
- Parameters:
listWebExperiencesRequest
- AConsumer
that will call methods onListWebExperiencesRequest.Builder
to create a request.- Returns:
- Result of the ListWebExperiences operation returned by the service.
- See Also:
-
listWebExperiencesPaginator
default 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 Streamsoftware.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:
-
listWebExperiencesPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListWebExperiencesRequest.builder()
- Parameters:
listWebExperiencesRequest
- AConsumer
that will call methods onListWebExperiencesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putFeedback
default 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:
-
putFeedback
default 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.Builder
avoiding the need to create one manually viaPutFeedbackRequest.builder()
- Parameters:
putFeedbackRequest
- AConsumer
that will call methods onPutFeedbackRequest.Builder
to create a request.- Returns:
- Result of the PutFeedback operation returned by the service.
- See Also:
-
putGroup
default 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
RoleArn
for Amazon Q Buisness to access the file.- Parameters:
putGroupRequest
-- Returns:
- Result of the PutGroup operation returned by the service.
- See Also:
-
putGroup
default 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
RoleArn
for Amazon Q Buisness to access the file.
This is a convenience which creates an instance of the
PutGroupRequest.Builder
avoiding the need to create one manually viaPutGroupRequest.builder()
- Parameters:
putGroupRequest
- AConsumer
that will call methods onPutGroupRequest.Builder
to create a request.- Returns:
- Result of the PutGroup operation returned by the service.
- See Also:
-
searchRelevantContent
default 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:
-
searchRelevantContent
default 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.Builder
avoiding the need to create one manually viaSearchRelevantContentRequest.builder()
- Parameters:
searchRelevantContentRequest
- AConsumer
that will call methods onSearchRelevantContentRequest.Builder
to create a request.- Returns:
- Result of the SearchRelevantContent operation returned by the service.
- See Also:
-
searchRelevantContentPaginator
default 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 Streamsoftware.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:
-
searchRelevantContentPaginator
default 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaSearchRelevantContentRequest.builder()
- Parameters:
searchRelevantContentRequest
- AConsumer
that will call methods onSearchRelevantContentRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
startDataSourceSyncJob
default 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:
-
startDataSourceSyncJob
default 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.Builder
avoiding the need to create one manually viaStartDataSourceSyncJobRequest.builder()
- Parameters:
startDataSourceSyncJobRequest
- AConsumer
that will call methods onStartDataSourceSyncJobRequest.Builder
to create a request.- Returns:
- Result of the StartDataSourceSyncJob operation returned by the service.
- See Also:
-
stopDataSourceSyncJob
default 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:
-
stopDataSourceSyncJob
default 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.Builder
avoiding the need to create one manually viaStopDataSourceSyncJobRequest.builder()
- Parameters:
stopDataSourceSyncJobRequest
- AConsumer
that will call methods onStopDataSourceSyncJobRequest.Builder
to create a request.- Returns:
- Result of the StopDataSourceSyncJob operation returned by the service.
- See Also:
-
tagResource
default 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:
-
tagResource
default 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.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default 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:
-
untagResource
default 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.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateApplication
default 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
QAppsConfiguration
is 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:
-
updateApplication
default 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
QAppsConfiguration
is 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.Builder
avoiding the need to create one manually viaUpdateApplicationRequest.builder()
- Parameters:
updateApplicationRequest
- AConsumer
that will call methods onUpdateApplicationRequest.Builder
to create a request.- Returns:
- Result of the UpdateApplication operation returned by the service.
- See Also:
-
updateChatControlsConfiguration
default 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:
-
updateChatControlsConfiguration
default 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.Builder
avoiding the need to create one manually viaUpdateChatControlsConfigurationRequest.builder()
- Parameters:
updateChatControlsConfigurationRequest
- AConsumer
that will call methods onUpdateChatControlsConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateChatControlsConfiguration operation returned by the service.
- See Also:
-
updateChatResponseConfiguration
default 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:
-
updateChatResponseConfiguration
default 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.Builder
avoiding the need to create one manually viaUpdateChatResponseConfigurationRequest.builder()
- Parameters:
updateChatResponseConfigurationRequest
- AConsumer
that will call methods onUpdateChatResponseConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateChatResponseConfiguration operation returned by the service.
- See Also:
-
updateDataAccessor
default 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:
-
updateDataAccessor
default 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.Builder
avoiding the need to create one manually viaUpdateDataAccessorRequest.builder()
- Parameters:
updateDataAccessorRequest
- AConsumer
that will call methods onUpdateDataAccessorRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataAccessor operation returned by the service.
- See Also:
-
updateDataSource
default 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:
-
updateDataSource
default 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.Builder
avoiding the need to create one manually viaUpdateDataSourceRequest.builder()
- Parameters:
updateDataSourceRequest
- AConsumer
that will call methods onUpdateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataSource operation returned by the service.
- See Also:
-
updateIndex
default 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:
-
updateIndex
default 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.Builder
avoiding the need to create one manually viaUpdateIndexRequest.builder()
- Parameters:
updateIndexRequest
- AConsumer
that will call methods onUpdateIndexRequest.Builder
to create a request.- Returns:
- Result of the UpdateIndex operation returned by the service.
- See Also:
-
updatePlugin
default 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:
-
updatePlugin
default 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.Builder
avoiding the need to create one manually viaUpdatePluginRequest.builder()
- Parameters:
updatePluginRequest
- AConsumer
that will call methods onUpdatePluginRequest.Builder
to create a request.- Returns:
- Result of the UpdatePlugin operation returned by the service.
- See Also:
-
updateRetriever
default 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:
-
updateRetriever
default 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.Builder
avoiding the need to create one manually viaUpdateRetrieverRequest.builder()
- Parameters:
updateRetrieverRequest
- AConsumer
that will call methods onUpdateRetrieverRequest.Builder
to create a request.- Returns:
- Result of the UpdateRetriever operation returned by the service.
- See Also:
-
updateSubscription
default 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:
-
updateSubscription
default 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.Builder
avoiding the need to create one manually viaUpdateSubscriptionRequest.builder()
- Parameters:
updateSubscriptionRequest
- AConsumer
that will call methods onUpdateSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the UpdateSubscription operation returned by the service.
- See Also:
-
updateUser
default 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:
-
updateUser
default 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.Builder
avoiding the need to create one manually viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
updateWebExperience
default 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:
-
updateWebExperience
default 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.Builder
avoiding the need to create one manually viaUpdateWebExperienceRequest.builder()
- Parameters:
updateWebExperienceRequest
- AConsumer
that will call methods onUpdateWebExperienceRequest.Builder
to create a request.- Returns:
- Result of the UpdateWebExperience operation returned by the service.
- See Also:
-
create
Create aQBusinessClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aQBusinessClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-