QBusinessClient

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.

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.

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.

Starts or continues a streaming Amazon Q Business conversation.

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

Creates an Amazon Q Business application.

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.

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.

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.

Creates an Amazon Q Business plugin.

Adds a retriever to your Amazon Q Business application.

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

Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing .

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

Creates an Amazon Q Business web experience.

Deletes an Amazon Q Business application.

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

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

Deletes an Amazon Q Business web experience conversation.

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.

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.

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.

Deletes an Amazon Q Business index.

Deletes an Amazon Q Business plugin.

Deletes the retriever used by an Amazon Q Business application.

Deletes a user by email id.

Deletes an Amazon Q Business web experience.

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.

Gets information about an existing Amazon Q Business application.

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

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.

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

Describes a group by group name.

Gets information about an existing Amazon Q Business index.

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.

For more information, see Extracting semantic meaning from images and visuals .

Gets information about an existing Amazon Q Business plugin.

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.

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

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

Gets information about an existing Amazon Q Business web experience.

Lists Amazon Q Business applications.

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.

Lists one or more Amazon Q Business conversations.

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.

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

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

A list of documents attached to an index.

Provides a list of groups that are mapped to users.

Lists the Amazon Q Business indices you have created.

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

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

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

Lists metadata for all Amazon Q Business plugin types.

Lists configured Amazon Q Business plugins.

Lists the retriever used by an Amazon Q Business application.

Lists all subscriptions created in an Amazon Q Business application.

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

Lists one or more Amazon Q Business Web Experiences.

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

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.

There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.

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.

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

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

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.

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

Updates an existing Amazon Q Business application.

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

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.

Updates an existing Amazon Q Business data source connector.

Updates an Amazon Q Business index.

Updates an Amazon Q Business plugin.

Updates the retriever used for your Amazon Q Business application.

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 .

Updates a information associated with a user id.