AWS.QBusiness — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

batchDeleteDocument(params = {}, callback) ⇒ AWS.Request

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.

batchPutDocument(params = {}, callback) ⇒ AWS.Request

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.

chatSync(params = {}, callback) ⇒ AWS.Request

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

createApplication(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Q Business application.

Note: 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.

createDataSource(params = {}, callback) ⇒ AWS.Request

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.

createIndex(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

createPlugin(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Q Business plugin.

createRetriever(params = {}, callback) ⇒ AWS.Request

Adds a retriever to your Amazon Q Business application.

createUser(params = {}, callback) ⇒ AWS.Request

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

createWebExperience(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Q Business web experience.

deleteApplication(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Q Business application.

deleteChatControlsConfiguration(params = {}, callback) ⇒ AWS.Request

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

deleteConversation(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Q Business web experience conversation.

deleteDataSource(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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 calling PutGroup.

deleteIndex(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Q Business index.

deletePlugin(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Q Business plugin.

deleteRetriever(params = {}, callback) ⇒ AWS.Request

Deletes the retriever used by an Amazon Q Business application.

deleteUser(params = {}, callback) ⇒ AWS.Request

Deletes a user by email id.

deleteWebExperience(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Q Business web experience.

getApplication(params = {}, callback) ⇒ AWS.Request

Gets information about an existing Amazon Q Business application.

getChatControlsConfiguration(params = {}, callback) ⇒ AWS.Request

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

getDataSource(params = {}, callback) ⇒ AWS.Request

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

getGroup(params = {}, callback) ⇒ AWS.Request

Describes a group by group name.

getIndex(params = {}, callback) ⇒ AWS.Request

Gets information about an existing Amazon Q Business index.

getPlugin(params = {}, callback) ⇒ AWS.Request

Gets information about an existing Amazon Q Business plugin.

getRetriever(params = {}, callback) ⇒ AWS.Request

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

getUser(params = {}, callback) ⇒ AWS.Request

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

getWebExperience(params = {}, callback) ⇒ AWS.Request

Gets information about an existing Amazon Q Business web experience.

listApplications(params = {}, callback) ⇒ AWS.Request

Lists Amazon Q Business applications.

listConversations(params = {}, callback) ⇒ AWS.Request

Lists one or more Amazon Q Business conversations.

listDataSources(params = {}, callback) ⇒ AWS.Request

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

listDataSourceSyncJobs(params = {}, callback) ⇒ AWS.Request

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

listDocuments(params = {}, callback) ⇒ AWS.Request

A list of documents attached to an index.

listGroups(params = {}, callback) ⇒ AWS.Request

Provides a list of groups that are mapped to users.

listIndices(params = {}, callback) ⇒ AWS.Request

Lists the Amazon Q Business indices you have created.

listMessages(params = {}, callback) ⇒ AWS.Request

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

listPlugins(params = {}, callback) ⇒ AWS.Request

Lists configured Amazon Q Business plugins.

listRetrievers(params = {}, callback) ⇒ AWS.Request

Lists the retriever used by an Amazon Q Business application.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

listWebExperiences(params = {}, callback) ⇒ AWS.Request

Lists one or more Amazon Q Business Web Experiences.

putFeedback(params = {}, callback) ⇒ AWS.Request

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

putGroup(params = {}, callback) ⇒ AWS.Request

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.

startDataSourceSyncJob(params = {}, callback) ⇒ AWS.Request

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

stopDataSourceSyncJob(params = {}, callback) ⇒ AWS.Request

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

tagResource(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

updateApplication(params = {}, callback) ⇒ AWS.Request

Updates an existing Amazon Q Business application.

updateChatControlsConfiguration(params = {}, callback) ⇒ AWS.Request

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

updateDataSource(params = {}, callback) ⇒ AWS.Request

Updates an existing Amazon Q Business data source connector.

updateIndex(params = {}, callback) ⇒ AWS.Request

Updates an Amazon Q Business index.

updatePlugin(params = {}, callback) ⇒ AWS.Request

Updates an Amazon Q Business plugin.

updateRetriever(params = {}, callback) ⇒ AWS.Request

Updates the retriever used for your Amazon Q Business application.

updateUser(params = {}, callback) ⇒ AWS.Request

Updates a information associated with a user id.

updateWebExperience(params = {}, callback) ⇒ AWS.Request

Updates an Amazon Q Business web experience.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given QBusiness resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.