qbusiness/aws.sdk.kotlin.services.qbusiness

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associatePermission

inline suspend fun QBusinessClient.associatePermission(crossinline block: AssociatePermissionRequest.Builder.() -> Unit): AssociatePermissionResponse

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.

batchDeleteDocument

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 Business index.

batchPutDocument

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

Adds one or more documents to an Amazon Q Business index.

cancelSubscription

inline suspend fun QBusinessClient.cancelSubscription(crossinline block: CancelSubscriptionRequest.Builder.() -> Unit): CancelSubscriptionResponse

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.

chatSync

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

Starts or continues a non-streaming Amazon Q Business conversation.

checkDocumentAccess

inline suspend fun QBusinessClient.checkDocumentAccess(crossinline block: CheckDocumentAccessRequest.Builder.() -> Unit): CheckDocumentAccessResponse

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.

createAnonymousWebExperienceUrl

inline suspend fun QBusinessClient.createAnonymousWebExperienceUrl(crossinline block: CreateAnonymousWebExperienceUrlRequest.Builder.() -> Unit): CreateAnonymousWebExperienceUrlResponse

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.

createApplication

inline suspend fun QBusinessClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

Creates an Amazon Q Business application.

createChatResponseConfiguration

inline suspend fun QBusinessClient.createChatResponseConfiguration(crossinline block: CreateChatResponseConfigurationRequest.Builder.() -> Unit): CreateChatResponseConfigurationResponse

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.

createDataAccessor

inline suspend fun QBusinessClient.createDataAccessor(crossinline block: CreateDataAccessorRequest.Builder.() -> Unit): CreateDataAccessorResponse

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.

createDataSource

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

Creates a data source connector for an Amazon Q Business application.

createIndex

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

Creates an Amazon Q Business index.

createPlugin

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

Creates an Amazon Q Business plugin.

createRetriever

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

Adds a retriever to your Amazon Q Business application.

createSubscription

inline suspend fun QBusinessClient.createSubscription(crossinline block: CreateSubscriptionRequest.Builder.() -> Unit): CreateSubscriptionResponse

Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.

createUser

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.

createWebExperience

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

Creates an Amazon Q Business web experience.

deleteApplication

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

Deletes an Amazon Q Business application.

deleteAttachment

inline suspend fun QBusinessClient.deleteAttachment(crossinline block: DeleteAttachmentRequest.Builder.() -> Unit): DeleteAttachmentResponse

Deletes an attachment associated with a specific Amazon Q Business conversation.

deleteChatControlsConfiguration

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

Deletes chat controls configured for an existing Amazon Q Business application.

deleteChatResponseConfiguration

inline suspend fun QBusinessClient.deleteChatResponseConfiguration(crossinline block: DeleteChatResponseConfigurationRequest.Builder.() -> Unit): DeleteChatResponseConfigurationResponse

Deletes a specified chat response configuration from an Amazon Q Business application.

deleteConversation

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

Deletes an Amazon Q Business web experience conversation.

deleteDataAccessor

inline suspend fun QBusinessClient.deleteDataAccessor(crossinline block: DeleteDataAccessorRequest.Builder.() -> Unit): DeleteDataAccessorResponse

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.

deleteDataSource

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

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

deleteGroup

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.

deleteIndex

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

Deletes an Amazon Q Business index.

deletePlugin

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

Deletes an Amazon Q Business plugin.

deleteRetriever

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

Deletes the retriever used by an Amazon Q Business application.

deleteUser

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

Deletes a user by email id.

deleteWebExperience

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

Deletes an Amazon Q Business web experience.

disassociatePermission

inline suspend fun QBusinessClient.disassociatePermission(crossinline block: DisassociatePermissionRequest.Builder.() -> Unit): DisassociatePermissionResponse

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.

getApplication

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

Gets information about an existing Amazon Q Business application.

getChatControlsConfiguration

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

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

getChatResponseConfiguration

inline suspend fun QBusinessClient.getChatResponseConfiguration(crossinline block: GetChatResponseConfigurationRequest.Builder.() -> Unit): GetChatResponseConfigurationResponse

Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.

getDataAccessor

inline suspend fun QBusinessClient.getDataAccessor(crossinline block: GetDataAccessorRequest.Builder.() -> Unit): GetDataAccessorResponse

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.

getDataSource

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

Gets information about an existing Amazon Q Business data source connector.

getGroup

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

Describes a group by group name.

getIndex

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

Gets information about an existing Amazon Q Business index.

getMedia

inline suspend fun QBusinessClient.getMedia(crossinline block: GetMediaRequest.Builder.() -> Unit): GetMediaResponse

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.

getPlugin

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

Gets information about an existing Amazon Q Business plugin.

getPolicy

inline suspend fun QBusinessClient.getPolicy(crossinline block: GetPolicyRequest.Builder.() -> Unit): GetPolicyResponse

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.

getRetriever

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

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

getUser

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.

getWebExperience

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

Gets information about an existing Amazon Q Business web experience.

listApplications

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

Lists Amazon Q Business applications.

listAttachments

inline suspend fun QBusinessClient.listAttachments(crossinline block: ListAttachmentsRequest.Builder.() -> Unit): ListAttachmentsResponse

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.

listChatResponseConfigurations

inline suspend fun QBusinessClient.listChatResponseConfigurations(crossinline block: ListChatResponseConfigurationsRequest.Builder.() -> Unit): ListChatResponseConfigurationsResponse

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.

listConversations

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

Lists one or more Amazon Q Business conversations.

listDataAccessors

inline suspend fun QBusinessClient.listDataAccessors(crossinline block: ListDataAccessorsRequest.Builder.() -> Unit): ListDataAccessorsResponse

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.

listDataSources

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

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

listDataSourceSyncJobs

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

Get information about an Amazon Q Business data source connector synchronization.

listDocuments

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

A list of documents attached to an index.

listGroups

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

Provides a list of groups that are mapped to users.

listIndices

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

Lists the Amazon Q Business indices you have created.

listMessages

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

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

listPluginActions

inline suspend fun QBusinessClient.listPluginActions(crossinline block: ListPluginActionsRequest.Builder.() -> Unit): ListPluginActionsResponse

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

listPlugins

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

Lists configured Amazon Q Business plugins.

listPluginTypeActions

inline suspend fun QBusinessClient.listPluginTypeActions(crossinline block: ListPluginTypeActionsRequest.Builder.() -> Unit): ListPluginTypeActionsResponse

Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.

listPluginTypeMetadata

inline suspend fun QBusinessClient.listPluginTypeMetadata(crossinline block: ListPluginTypeMetadataRequest.Builder.() -> Unit): ListPluginTypeMetadataResponse

Lists metadata for all Amazon Q Business plugin types.

listRetrievers

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

Lists the retriever used by an Amazon Q Business application.

listSubscriptions

inline suspend fun QBusinessClient.listSubscriptions(crossinline block: ListSubscriptionsRequest.Builder.() -> Unit): ListSubscriptionsResponse

Lists all subscriptions created in an Amazon Q Business application.

listTagsForResource

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

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

listWebExperiences

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

Lists one or more Amazon Q Business Web Experiences.

putFeedback

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

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

putGroup

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.

searchRelevantContent

inline suspend fun QBusinessClient.searchRelevantContent(crossinline block: SearchRelevantContentRequest.Builder.() -> Unit): SearchRelevantContentResponse

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.

startDataSourceSyncJob

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 Business returns a ConflictException.

stopDataSourceSyncJob

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

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

tagResource

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

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.

untagResource

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

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

updateApplication

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

Updates an existing Amazon Q Business application.

updateChatControlsConfiguration

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

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

updateChatResponseConfiguration

inline suspend fun QBusinessClient.updateChatResponseConfiguration(crossinline block: UpdateChatResponseConfigurationRequest.Builder.() -> Unit): UpdateChatResponseConfigurationResponse

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.

updateDataAccessor

inline suspend fun QBusinessClient.updateDataAccessor(crossinline block: UpdateDataAccessorRequest.Builder.() -> Unit): UpdateDataAccessorResponse

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.

updateDataSource

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

Updates an existing Amazon Q Business data source connector.

updateIndex

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

Updates an Amazon Q Business index.

updatePlugin

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

Updates an Amazon Q Business plugin.

updateRetriever

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

Updates the retriever used for your Amazon Q Business application.

updateSubscription

inline suspend fun QBusinessClient.updateSubscription(crossinline block: UpdateSubscriptionRequest.Builder.() -> Unit): UpdateSubscriptionResponse

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.

updateUser

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

Updates a information associated with a user id.

updateWebExperience

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

Updates an Amazon Q Business web experience.

withConfig

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.