Amazon Q Business - Supported Actions

Amazon Q Business API references provide various actions and operations that can be used to interact with Amazon Q Business. This action includes the creation of an application, deletion of an application, creation of plugins, creating a retriever, uploading documents, etc.

Q Business Supported Actions

The following actions are supported by QBusiness:

• BatchDeleteDocument: Used to delete one or more documents that were previously added to an index using the BatchPutDocument API from an Amazon Q Business index without interrupting other tasks.
• BatchPutDocument: Used to ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index and also add custom attributes and attach an access control list to the documents
• Chat: Used to start or continues a streaming Amazon Q Business conversation.
• ChatSync: Used to start or continues a non-streaming Amazon Q Business conversation.
• CreateApplication: Used to create an Amazon Q Business application.
• CreateDataSource: Used to create a data source connector for an Amazon Q Business application.
• CreateIndex: Used to create an Amazon Q Business index.
• CreatePlugin: Used to create an Amazon Q Business plugin.
• CreateRetriever: Used to add a retriever to your Amazon Q Business application.
• CreateUser: Used to create a universally unique identifier (UUID) mapped to a list of local user ids within an application.
• CreateWebExperience: Used to create an Amazon Q Business web experience.
• DeleteApplication: Used to delete an Amazon Q Business application.
• DeleteChatControlsConfiguration: Used to delete chat controls configured for an existing Amazon Q Business application.
• DeleteConversation: Used to delete an Amazon Q Business web experience conversation.
• DeleteDataSource: Used to delete an Amazon Q Business data source connector.
• DeleteGroup: Used to delete group and no longer making them available to access resources.
• DeleteIndex: Used to delete an Amazon Q Business index.
• DeletePlugin: Used to delete an Amazon Q Business plugin.
• DeleteRetriever: Used to delete the retriever used by an Amazon Q Business application.
• DeleteUser: Used to delete a user by email id.
• DeleteWebExperience: Used to delete an Amazon Q Business web experience.
• GetApplication: Used to get information about an existing Amazon Q Business application.
• GetChatControlsConfiguration: Used to get information about an chat controls configured for an existing Amazon Q Business application.
• GetDataSource: Used to get information about an existing Amazon Q Business data source connector.
• GetGroup: Used to describe a group by group name.
• GetIndex: Used to get information about an existing Amazon Q Business index.
• GetPlugin: Used to get information about an existing Amazon Q Business plugin.
• GetRetriever: Used to get information about an existing retriever used by an Amazon Q Business application.
• GetUser: Used to describe the universally unique identifier (UUID) associated with a local user in a data source.
• GetWebExperience: Used to get information about an existing Amazon Q Business web experience.
• ListApplications: Used to list Amazon Q Business applications.
• ListConversations: Used to list one or more Amazon Q Business conversations.
• ListDataSources: Used to list the Amazon Q Business data source connectors that you have created.
• ListDataSourceSyncJobs: Used to Get information about an Amazon Q Business data source connector synchronization.
• ListDocuments: is a list of documents attached to an index.
• ListGroups: is a list of groups that are mapped to users.
• ListIndices: is a list of the Amazon Q Business indices you have created.
• ListMessages: Used to get a list of messages associated with an Amazon Q Business web experience.
• ListPlugins:is a list of configured Amazon Q Business plugins.
• ListRetrievers: is a list of the retriever used by an Amazon Q Business application.
• ListTagsForResource: Used to get a list of tags associated with a specified resource.
• ListWebExperiences: Used to list one or more Amazon Q Business Web Experiences.
• PutFeedback: Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
• PutGroup: Used to create, update and mapping of users who have access to a document to groups.
• StartDataSourceSyncJob: is used to start a data source connector synchronization job.
• StopDataSourceSyncJob: Used to stop an Amazon Q Business data source connector synchronization job already in progress.
• TagResource: Used to add a 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: Used to remove a tag from an Amazon Q Business application or a data source.
• UpdateApplication: Used to update an existing Amazon Q Business application.
• UpdateChatControlsConfiguration: Used to update an set of chat controls configured for an existing Amazon Q Business application.
• UpdateDataSource: Used to update an existing Amazon Q Business data source connector.
• UpdateIndex: Used to update an Amazon Q Business index.
• UpdatePlugin: Used to update an Amazon Q Business plugin.
• UpdateRetriever: Used to update the retriever used for your Amazon Q Business application.
• UpdateUser: Used to update a information associated with a user id.
• UpdateWebExperience: Used to update an Amazon Q Business web experience.

QApps Supported Actions

The following actions are supported by QApps:

• AssociateLibraryItemReview: Used to associates a rating or review for a library item with the user submitting the request
• AssociateQAppWithUser: Used to create a link between the user's identity calling the operation and a specific Q App.
• CreateLibraryItem: Used to create a new library item for an Amazon Q App
• CreateQApp: Used to create a new Amazon Q App based on the provided definition.
• DeleteLibraryItem: Used to delete a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.
• DeleteQApp: Used to delete an Amazon Q App owned by the user.
• DisassociateLibraryItemReview: Used to remove a rating or review previously submitted by the user for a library item.
• DisassociateQAppFromUser: Used to disassociate a Q App from a user removing the user's access to run the Q App.
• GetLibraryItem: Used to retrieve details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
• GetQApp: Used to retrieve the full details of an Q App, including its definition specifying the cards and flow.
• GetQAppSession: Used to retrieve the current state and results for an active session of an Amazon Q App.
• ImportDocument: Used to upload a file for use in a Q App, either as a default or within a single run.
• ListLibraryItems: Used to list the library items for Amazon Q Apps that are published and available for users in your AWS account.
• ListQApps: Used to list the Q Apps you own or have used.
• ListTagsForResource: Used to list the tags associated with an Amazon Q Apps resource.
• PredictQApp: Used to create a Q App definition from a conversation or problem statement. This definition can be used to create a Q App later.
• StartQAppSession: Used to start a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.
• StopQAppSession: Used to stop an active session for an Amazon Q App
• TagResource: Used to associate tags with an Amazon Q Apps resource.
• UntagResource: Used to disassociate tags from an Amazon Q Apps resource.
• UpdateLibraryItem: Used to update the library item for an Amazon Q App.
• UpdateLibraryItemMetadata: Used to update the verification status of a library item for an Amazon Q App.
• UpdateQApp: Used to update an existing Amazon Q App, allowing modifications to its title, description, and definition.
• UpdateQAppSession: Used to update the session for a given Q App sessionId.