qbusiness/aws.sdk.kotlin.services.qbusiness/QBusinessClient

QBusinessClient

interface QBusinessClient : SdkClient

Amazon Q is in preview release and is subject to change.

This is the Amazon Q (for business use) API Reference. Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q 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 and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q (for business use) Developer Guide.

For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q in the Amazon Q (for business use) Developer Guide.

You can use the following AWS SDKs to access Amazon Q APIs:

The following resources provide additional information about using the Amazon Q API:

Properties

Link copied to clipboard
abstract override val config: QBusinessClient.Config

QBusinessClient's configuration

Functions

Link copied to clipboard
abstract suspend fun batchDeleteDocument(input: BatchDeleteDocumentRequest): BatchDeleteDocumentResponse

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q index.

Link copied to clipboard
abstract suspend fun batchPutDocument(input: BatchPutDocumentRequest): BatchPutDocumentResponse

Adds one or more documents to an Amazon Q index.

Link copied to clipboard
abstract suspend fun chatSync(input: ChatSyncRequest): ChatSyncResponse

Starts or continues a non-streaming Amazon Q conversation.

Link copied to clipboard
abstract suspend fun createApplication(input: CreateApplicationRequest): CreateApplicationResponse

Creates an Amazon Q application.

Link copied to clipboard
abstract suspend fun createDataSource(input: CreateDataSourceRequest): CreateDataSourceResponse

Creates a data source connector for an Amazon Q application.

Link copied to clipboard
abstract suspend fun createIndex(input: CreateIndexRequest): CreateIndexResponse

Creates an Amazon Q index.

Link copied to clipboard
abstract suspend fun createPlugin(input: CreatePluginRequest): CreatePluginResponse

Creates an Amazon Q plugin.

Link copied to clipboard
abstract suspend fun createRetriever(input: CreateRetrieverRequest): CreateRetrieverResponse

Adds a retriever to your Amazon Q application.

Link copied to clipboard
abstract suspend fun createUser(input: CreateUserRequest): CreateUserResponse

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

Link copied to clipboard
abstract suspend fun createWebExperience(input: CreateWebExperienceRequest): CreateWebExperienceResponse

Creates an Amazon Q web experience.

Link copied to clipboard
abstract suspend fun deleteApplication(input: DeleteApplicationRequest): DeleteApplicationResponse

Deletes an Amazon Q application.

Link copied to clipboard
abstract suspend fun deleteChatControlsConfiguration(input: DeleteChatControlsConfigurationRequest): DeleteChatControlsConfigurationResponse

Deletes chat controls configured for an existing Amazon Q application.

Link copied to clipboard
abstract suspend fun deleteConversation(input: DeleteConversationRequest): DeleteConversationResponse

Deletes an Amazon Q web experience conversation.

Link copied to clipboard
abstract suspend fun deleteDataSource(input: DeleteDataSourceRequest): DeleteDataSourceResponse

Deletes an Amazon Q data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

Link copied to clipboard
abstract suspend fun deleteGroup(input: DeleteGroupRequest): DeleteGroupResponse

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.

Link copied to clipboard
abstract suspend fun deleteIndex(input: DeleteIndexRequest): DeleteIndexResponse

Deletes an Amazon Q index.

Link copied to clipboard
abstract suspend fun deletePlugin(input: DeletePluginRequest): DeletePluginResponse

Deletes an Amazon Q plugin.

Link copied to clipboard
abstract suspend fun deleteRetriever(input: DeleteRetrieverRequest): DeleteRetrieverResponse

Deletes the retriever used by an Amazon Q application.

Link copied to clipboard
abstract suspend fun deleteUser(input: DeleteUserRequest): DeleteUserResponse

Deletes a user by email id.

Link copied to clipboard
abstract suspend fun deleteWebExperience(input: DeleteWebExperienceRequest): DeleteWebExperienceResponse

Deletes an Amazon Q web experience.

Link copied to clipboard
abstract suspend fun getApplication(input: GetApplicationRequest): GetApplicationResponse

Gets information about an existing Amazon Q application.

Link copied to clipboard
abstract suspend fun getChatControlsConfiguration(input: GetChatControlsConfigurationRequest): GetChatControlsConfigurationResponse

Gets information about an chat controls configured for an existing Amazon Q application.

Link copied to clipboard
abstract suspend fun getDataSource(input: GetDataSourceRequest): GetDataSourceResponse

Gets information about an existing Amazon Q data source connector.

Link copied to clipboard
abstract suspend fun getGroup(input: GetGroupRequest): GetGroupResponse

Describes a group by group name.

Link copied to clipboard
abstract suspend fun getIndex(input: GetIndexRequest): GetIndexResponse

Gets information about an existing Amazon Q index.

Link copied to clipboard
abstract suspend fun getPlugin(input: GetPluginRequest): GetPluginResponse

Gets information about an existing Amazon Q plugin.

Link copied to clipboard
abstract suspend fun getRetriever(input: GetRetrieverRequest): GetRetrieverResponse

Gets information about an existing retriever used by an Amazon Q application.

Link copied to clipboard
abstract suspend fun getUser(input: GetUserRequest): GetUserResponse

Describes the universally unique identifier (UUID) associated with a local user in a data source.

Link copied to clipboard
abstract suspend fun getWebExperience(input: GetWebExperienceRequest): GetWebExperienceResponse

Gets information about an existing Amazon Q web experience.

Link copied to clipboard
abstract suspend fun listApplications(input: ListApplicationsRequest = ListApplicationsRequest { }): ListApplicationsResponse

Lists Amazon Q applications.

Link copied to clipboard
abstract suspend fun listConversations(input: ListConversationsRequest): ListConversationsResponse

Lists one or more Amazon Q conversations.

Link copied to clipboard
abstract suspend fun listDataSources(input: ListDataSourcesRequest): ListDataSourcesResponse

Lists the Amazon Q data source connectors that you have created.

Link copied to clipboard
abstract suspend fun listDataSourceSyncJobs(input: ListDataSourceSyncJobsRequest): ListDataSourceSyncJobsResponse

Get information about an Amazon Q data source connector synchronization.

Link copied to clipboard
abstract suspend fun listDocuments(input: ListDocumentsRequest): ListDocumentsResponse

A list of documents attached to an index.

Link copied to clipboard
abstract suspend fun listGroups(input: ListGroupsRequest): ListGroupsResponse

Provides a list of groups that are mapped to users.

Link copied to clipboard
abstract suspend fun listIndices(input: ListIndicesRequest): ListIndicesResponse

Lists the Amazon Q indices you have created.

Link copied to clipboard
abstract suspend fun listMessages(input: ListMessagesRequest): ListMessagesResponse

Gets a list of messages associated with an Amazon Q web experience.

Link copied to clipboard
abstract suspend fun listPlugins(input: ListPluginsRequest): ListPluginsResponse

Lists configured Amazon Q plugins.

Link copied to clipboard
abstract suspend fun listRetrievers(input: ListRetrieversRequest): ListRetrieversResponse

Lists the retriever used by an Amazon Q application.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Gets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.

Link copied to clipboard
abstract suspend fun listWebExperiences(input: ListWebExperiencesRequest): ListWebExperiencesResponse

Lists one or more Amazon Q Web Experiences.

Link copied to clipboard
abstract suspend fun putFeedback(input: PutFeedbackRequest): PutFeedbackResponse

Enables your end user to to provide feedback on their Amazon Q generated chat responses.

Link copied to clipboard
abstract suspend fun putGroup(input: PutGroupRequest): PutGroupResponse

Create, or updates, a mapping of users—who have access to a document—to groups.

Link copied to clipboard
abstract suspend fun startDataSourceSyncJob(input: StartDataSourceSyncJobRequest): StartDataSourceSyncJobResponse

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a ConflictException.

Link copied to clipboard
abstract suspend fun stopDataSourceSyncJob(input: StopDataSourceSyncJobRequest): StopDataSourceSyncJobResponse

Stops an Amazon Q data source connector synchronization job already in progress.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds the specified tag to the specified Amazon Q application or data source resource. If the tag already exists, the existing value is replaced with the new value.

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag from an Amazon Q application or a data source.

Link copied to clipboard
abstract suspend fun updateApplication(input: UpdateApplicationRequest): UpdateApplicationResponse

Updates an existing Amazon Q application.

Link copied to clipboard
abstract suspend fun updateChatControlsConfiguration(input: UpdateChatControlsConfigurationRequest): UpdateChatControlsConfigurationResponse

Updates an set of chat controls configured for an existing Amazon Q application.

Link copied to clipboard
abstract suspend fun updateDataSource(input: UpdateDataSourceRequest): UpdateDataSourceResponse

Updates an existing Amazon Q data source connector.

Link copied to clipboard
abstract suspend fun updateIndex(input: UpdateIndexRequest): UpdateIndexResponse

Updates an Amazon Q index.

Link copied to clipboard
abstract suspend fun updatePlugin(input: UpdatePluginRequest): UpdatePluginResponse

Updates an Amazon Q plugin.

Link copied to clipboard
abstract suspend fun updateRetriever(input: UpdateRetrieverRequest): UpdateRetrieverResponse

Updates the retriever used for your Amazon Q application.

Link copied to clipboard
abstract suspend fun updateUser(input: UpdateUserRequest): UpdateUserResponse

Updates a information associated with a user id.

Link copied to clipboard
abstract suspend fun updateWebExperience(input: UpdateWebExperienceRequest): UpdateWebExperienceResponse

Updates an Amazon Q web experience.

Inherited functions

Link copied to clipboard
inline suspend fun QBusinessClient.batchDeleteDocument(crossinline block: BatchDeleteDocumentRequest.Builder.() -> Unit): BatchDeleteDocumentResponse

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q index.

Link copied to clipboard
inline suspend fun QBusinessClient.batchPutDocument(crossinline block: BatchPutDocumentRequest.Builder.() -> Unit): BatchPutDocumentResponse

Adds one or more documents to an Amazon Q index.

Link copied to clipboard
inline suspend fun QBusinessClient.chatSync(crossinline block: ChatSyncRequest.Builder.() -> Unit): ChatSyncResponse

Starts or continues a non-streaming Amazon Q conversation.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun QBusinessClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

Creates an Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.createDataSource(crossinline block: CreateDataSourceRequest.Builder.() -> Unit): CreateDataSourceResponse

Creates a data source connector for an Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.createIndex(crossinline block: CreateIndexRequest.Builder.() -> Unit): CreateIndexResponse

Creates an Amazon Q index.

Link copied to clipboard
inline suspend fun QBusinessClient.createPlugin(crossinline block: CreatePluginRequest.Builder.() -> Unit): CreatePluginResponse

Creates an Amazon Q plugin.

Link copied to clipboard
inline suspend fun QBusinessClient.createRetriever(crossinline block: CreateRetrieverRequest.Builder.() -> Unit): CreateRetrieverResponse

Adds a retriever to your Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.createUser(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

Link copied to clipboard
inline suspend fun QBusinessClient.createWebExperience(crossinline block: CreateWebExperienceRequest.Builder.() -> Unit): CreateWebExperienceResponse

Creates an Amazon Q web experience.

Link copied to clipboard
inline suspend fun QBusinessClient.deleteApplication(crossinline block: DeleteApplicationRequest.Builder.() -> Unit): DeleteApplicationResponse

Deletes an Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.deleteChatControlsConfiguration(crossinline block: DeleteChatControlsConfigurationRequest.Builder.() -> Unit): DeleteChatControlsConfigurationResponse

Deletes chat controls configured for an existing Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.deleteConversation(crossinline block: DeleteConversationRequest.Builder.() -> Unit): DeleteConversationResponse

Deletes an Amazon Q web experience conversation.

Link copied to clipboard
inline suspend fun QBusinessClient.deleteDataSource(crossinline block: DeleteDataSourceRequest.Builder.() -> Unit): DeleteDataSourceResponse

Deletes an Amazon Q data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

Link copied to clipboard
inline suspend fun QBusinessClient.deleteGroup(crossinline block: DeleteGroupRequest.Builder.() -> Unit): DeleteGroupResponse

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.

Link copied to clipboard
inline suspend fun QBusinessClient.deleteIndex(crossinline block: DeleteIndexRequest.Builder.() -> Unit): DeleteIndexResponse

Deletes an Amazon Q index.

Link copied to clipboard
inline suspend fun QBusinessClient.deletePlugin(crossinline block: DeletePluginRequest.Builder.() -> Unit): DeletePluginResponse

Deletes an Amazon Q plugin.

Link copied to clipboard
inline suspend fun QBusinessClient.deleteRetriever(crossinline block: DeleteRetrieverRequest.Builder.() -> Unit): DeleteRetrieverResponse

Deletes the retriever used by an Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.deleteUser(crossinline block: DeleteUserRequest.Builder.() -> Unit): DeleteUserResponse

Deletes a user by email id.

Link copied to clipboard
inline suspend fun QBusinessClient.deleteWebExperience(crossinline block: DeleteWebExperienceRequest.Builder.() -> Unit): DeleteWebExperienceResponse

Deletes an Amazon Q web experience.

Link copied to clipboard
inline suspend fun QBusinessClient.getApplication(crossinline block: GetApplicationRequest.Builder.() -> Unit): GetApplicationResponse

Gets information about an existing Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.getChatControlsConfiguration(crossinline block: GetChatControlsConfigurationRequest.Builder.() -> Unit): GetChatControlsConfigurationResponse

Gets information about an chat controls configured for an existing Amazon Q application.

Link copied to clipboard
Link copied to clipboard
inline suspend fun QBusinessClient.getDataSource(crossinline block: GetDataSourceRequest.Builder.() -> Unit): GetDataSourceResponse

Gets information about an existing Amazon Q data source connector.

Link copied to clipboard
inline suspend fun QBusinessClient.getGroup(crossinline block: GetGroupRequest.Builder.() -> Unit): GetGroupResponse

Describes a group by group name.

Link copied to clipboard
inline suspend fun QBusinessClient.getIndex(crossinline block: GetIndexRequest.Builder.() -> Unit): GetIndexResponse

Gets information about an existing Amazon Q index.

Link copied to clipboard
inline suspend fun QBusinessClient.getPlugin(crossinline block: GetPluginRequest.Builder.() -> Unit): GetPluginResponse

Gets information about an existing Amazon Q plugin.

Link copied to clipboard
inline suspend fun QBusinessClient.getRetriever(crossinline block: GetRetrieverRequest.Builder.() -> Unit): GetRetrieverResponse

Gets information about an existing retriever used by an Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.getUser(crossinline block: GetUserRequest.Builder.() -> Unit): GetUserResponse

Describes the universally unique identifier (UUID) associated with a local user in a data source.

Link copied to clipboard
inline suspend fun QBusinessClient.getWebExperience(crossinline block: GetWebExperienceRequest.Builder.() -> Unit): GetWebExperienceResponse

Gets information about an existing Amazon Q web experience.

Link copied to clipboard
inline suspend fun QBusinessClient.listApplications(crossinline block: ListApplicationsRequest.Builder.() -> Unit): ListApplicationsResponse

Lists Amazon Q applications.

Link copied to clipboard
inline suspend fun QBusinessClient.listConversations(crossinline block: ListConversationsRequest.Builder.() -> Unit): ListConversationsResponse

Lists one or more Amazon Q conversations.

Link copied to clipboard
Link copied to clipboard
inline suspend fun QBusinessClient.listDataSources(crossinline block: ListDataSourcesRequest.Builder.() -> Unit): ListDataSourcesResponse

Lists the Amazon Q data source connectors that you have created.

Link copied to clipboard
inline suspend fun QBusinessClient.listDataSourceSyncJobs(crossinline block: ListDataSourceSyncJobsRequest.Builder.() -> Unit): ListDataSourceSyncJobsResponse

Get information about an Amazon Q data source connector synchronization.

Link copied to clipboard
Link copied to clipboard
inline suspend fun QBusinessClient.listDocuments(crossinline block: ListDocumentsRequest.Builder.() -> Unit): ListDocumentsResponse

A list of documents attached to an index.

Link copied to clipboard
Link copied to clipboard
inline suspend fun QBusinessClient.listGroups(crossinline block: ListGroupsRequest.Builder.() -> Unit): ListGroupsResponse

Provides a list of groups that are mapped to users.

Link copied to clipboard
Link copied to clipboard
inline suspend fun QBusinessClient.listIndices(crossinline block: ListIndicesRequest.Builder.() -> Unit): ListIndicesResponse

Lists the Amazon Q indices you have created.

Link copied to clipboard
inline suspend fun QBusinessClient.listMessages(crossinline block: ListMessagesRequest.Builder.() -> Unit): ListMessagesResponse

Gets a list of messages associated with an Amazon Q web experience.

Link copied to clipboard
Link copied to clipboard
inline suspend fun QBusinessClient.listPlugins(crossinline block: ListPluginsRequest.Builder.() -> Unit): ListPluginsResponse

Lists configured Amazon Q plugins.

Link copied to clipboard
inline suspend fun QBusinessClient.listRetrievers(crossinline block: ListRetrieversRequest.Builder.() -> Unit): ListRetrieversResponse

Lists the retriever used by an Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Gets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.

Link copied to clipboard
inline suspend fun QBusinessClient.listWebExperiences(crossinline block: ListWebExperiencesRequest.Builder.() -> Unit): ListWebExperiencesResponse

Lists one or more Amazon Q Web Experiences.

Link copied to clipboard
inline suspend fun QBusinessClient.putFeedback(crossinline block: PutFeedbackRequest.Builder.() -> Unit): PutFeedbackResponse

Enables your end user to to provide feedback on their Amazon Q generated chat responses.

Link copied to clipboard
inline suspend fun QBusinessClient.putGroup(crossinline block: PutGroupRequest.Builder.() -> Unit): PutGroupResponse

Create, or updates, a mapping of users—who have access to a document—to groups.

Link copied to clipboard
inline suspend fun QBusinessClient.startDataSourceSyncJob(crossinline block: StartDataSourceSyncJobRequest.Builder.() -> Unit): StartDataSourceSyncJobResponse

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a ConflictException.

Link copied to clipboard
inline suspend fun QBusinessClient.stopDataSourceSyncJob(crossinline block: StopDataSourceSyncJobRequest.Builder.() -> Unit): StopDataSourceSyncJobResponse

Stops an Amazon Q data source connector synchronization job already in progress.

Link copied to clipboard
inline suspend fun QBusinessClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds the specified tag to the specified Amazon Q application or data source resource. If the tag already exists, the existing value is replaced with the new value.

Link copied to clipboard
inline suspend fun QBusinessClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a tag from an Amazon Q application or a data source.

Link copied to clipboard
inline suspend fun QBusinessClient.updateApplication(crossinline block: UpdateApplicationRequest.Builder.() -> Unit): UpdateApplicationResponse

Updates an existing Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.updateChatControlsConfiguration(crossinline block: UpdateChatControlsConfigurationRequest.Builder.() -> Unit): UpdateChatControlsConfigurationResponse

Updates an set of chat controls configured for an existing Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.updateDataSource(crossinline block: UpdateDataSourceRequest.Builder.() -> Unit): UpdateDataSourceResponse

Updates an existing Amazon Q data source connector.

Link copied to clipboard
inline suspend fun QBusinessClient.updateIndex(crossinline block: UpdateIndexRequest.Builder.() -> Unit): UpdateIndexResponse

Updates an Amazon Q index.

Link copied to clipboard
inline suspend fun QBusinessClient.updatePlugin(crossinline block: UpdatePluginRequest.Builder.() -> Unit): UpdatePluginResponse

Updates an Amazon Q plugin.

Link copied to clipboard
inline suspend fun QBusinessClient.updateRetriever(crossinline block: UpdateRetrieverRequest.Builder.() -> Unit): UpdateRetrieverResponse

Updates the retriever used for your Amazon Q application.

Link copied to clipboard
inline suspend fun QBusinessClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

Updates a information associated with a user id.

Link copied to clipboard
inline suspend fun QBusinessClient.updateWebExperience(crossinline block: UpdateWebExperienceRequest.Builder.() -> Unit): UpdateWebExperienceResponse

Updates an Amazon Q web experience.

Link copied to clipboard
fun QBusinessClient.withConfig(block: QBusinessClient.Config.Builder.() -> Unit): QBusinessClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.