aws qbusiness
This is the Amazon Q Business API Reference. AWS CLI reference
83 commands Its page in the AWS CLI reference
Commands
associate-permissionAdds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.batch-delete-documentAsynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.batch-put-documentAdds one or more documents to an Amazon Q Business index.cancel-subscriptionUnsubscribes a user or a group from their pricing tier in an Amazon Q Business application.chatStarts or continues a streaming Amazon Q Business conversation.chat-syncStarts or continues a non-streaming Amazon Q Business conversation.check-document-accessVerifies if a user has access permissions for a specified document and returns the actual ACL attached to the document.create-anonymous-web-experience-urlCreates a unique URL for anonymous Amazon Q Business web experience.create-applicationCreates an Amazon Q Business application.create-chat-response-configurationCreates a new chat response configuration for an Amazon Q Business application.create-data-accessorCreates a new data accessor for an ISV to access data from a Amazon Q Business application.create-data-sourceCreates a data source connector for an Amazon Q Business application.create-indexCreates an Amazon Q Business index.create-pluginCreates an Amazon Q Business plugin.create-retrieverAdds a retriever to your Amazon Q Business application.create-subscriptionSubscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.create-userCreates a universally unique identifier (UUID) mapped to a list of local user ids within an application.create-web-experienceCreates an Amazon Q Business web experience.delete-applicationDeletes an Amazon Q Business application.delete-attachmentDeletes an attachment associated with a specific Amazon Q Business conversation.delete-chat-controls-configurationDeletes chat controls configured for an existing Amazon Q Business application.delete-chat-response-configurationDeletes a specified chat response configuration from an Amazon Q Business application.delete-conversationDeletes an Amazon Q Business web experience conversation.delete-data-accessorDeletes a specified data accessor.delete-data-sourceDeletes an Amazon Q Business data source connector.delete-groupDeletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.delete-indexDeletes an Amazon Q Business index.delete-pluginDeletes an Amazon Q Business plugin.delete-retrieverDeletes the retriever used by an Amazon Q Business application.delete-userDeletes a user by email id.delete-web-experienceDeletes an Amazon Q Business web experience.disassociate-permissionRemoves a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV.get-applicationGets information about an existing Amazon Q Business application.get-chat-controls-configurationGets information about chat controls configured for an existing Amazon Q Business application.get-chat-response-configurationRetrieves detailed information about a specific chat response configuration from an Amazon Q Business application.get-data-accessorRetrieves information about a specified data accessor.get-data-sourceGets information about an existing Amazon Q Business data source connector.get-document-contentRetrieves the content of a document that was ingested into Amazon Q Business.get-groupDescribes a group by group name.get-indexGets information about an existing Amazon Q Business index.get-mediaReturns the image bytes corresponding to a media object.get-pluginGets information about an existing Amazon Q Business plugin.get-policyRetrieves the current permission policy for a Amazon Q Business application.get-retrieverGets information about an existing retriever used by an Amazon Q Business application.get-userDescribes the universally unique identifier (UUID) associated with a local user in a data source.get-web-experienceGets information about an existing Amazon Q Business web experience.list-applicationsLists Amazon Q Business applications.list-attachmentsGets 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.list-chat-response-configurationsRetrieves a list of all chat response configurations available in a specified Amazon Q Business application.list-conversationsLists one or more Amazon Q Business conversations.list-data-accessorsLists the data accessors for a Amazon Q Business application.list-data-source-sync-jobsGet information about an Amazon Q Business data source connector synchronization.list-data-sourcesLists the Amazon Q Business data source connectors that you have created.list-documentsA list of documents attached to an index.list-groupsProvides a list of groups that are mapped to users.list-indicesLists the Amazon Q Business indices you have created.list-messagesGets a list of messages associated with an Amazon Q Business web experience.list-plugin-actionsLists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.list-plugin-type-actionsLists configured Amazon Q Business actions for any plugin type—both built-in and custom.list-plugin-type-metadataLists metadata for all Amazon Q Business plugin types.list-pluginsLists configured Amazon Q Business plugins.list-retrieversLists the retriever used by an Amazon Q Business application.list-subscriptionsLists all subscriptions created in an Amazon Q Business application.list-tags-for-resourceGets a list of tags associated with a specified resource.list-web-experiencesLists one or more Amazon Q Business Web Experiences.put-feedbackEnables your end user to provide feedback on their Amazon Q Business generated chat responses.put-groupCreate, or updates, a mapping of users—who have access to a document—to groups.search-relevant-contentSearches for relevant content in a Amazon Q Business application based on a query.start-data-source-sync-jobStarts a data source connector synchronization job.stop-data-source-sync-jobStops an Amazon Q Business data source connector synchronization job already in progress.tag-resourceAdds the specified tag to the specified Amazon Q Business application or data source resource.untag-resourceRemoves a tag from an Amazon Q Business application or a data source.update-applicationUpdates an existing Amazon Q Business application.update-chat-controls-configurationUpdates a set of chat controls configured for an existing Amazon Q Business application.update-chat-response-configurationUpdates an existing chat response configuration in an Amazon Q Business application.update-data-accessorUpdates an existing data accessor.update-data-sourceUpdates an existing Amazon Q Business data source connector.update-indexUpdates an Amazon Q Business index.update-pluginUpdates an Amazon Q Business plugin.update-retrieverUpdates the retriever used for your Amazon Q Business application.update-subscriptionUpdates the pricing tier for an Amazon Q Business subscription.update-userUpdates a information associated with a user id.update-web-experienceUpdates an Amazon Q Business web experience.