View Source AWS.QBusiness (aws-elixir v1.0.4)

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 .

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.

The following resources provide additional information about using the Amazon Q Business API:

*

Setting up for Amazon Q Business

*

Amazon Q Business CLI Reference

*

Amazon Web Services General Reference

Link to this section Summary

Functions

Adds or updates a permission policy for a Q Business application, allowing cross-account access for an ISV.

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

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

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 Q Business application.

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

Adds a retriever to your Amazon Q Business application.

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 chat controls configured for an existing Amazon Q Business application.

Deletes an Amazon Q Business web experience conversation.

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.

Deletes the retriever used by an Amazon Q Business application.

Removes a permission policy from a Q Business application, revoking the cross-account access that was previously granted to an ISV.

Gets information about an existing Amazon Q Business application.

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

Retrieves information about a specified data accessor.

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

Gets information about an existing Amazon Q Business index.

Returns the image bytes corresponding to a media object.

Gets information about an existing Amazon Q Business plugin.

Retrieves the current permission policy for a Q Business application.

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.

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 the Amazon Q Business data source connectors that you have created.

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 the retriever used by an Amazon Q Business application.

Gets a list of tags associated with a specified resource.

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.

Searches for relevant content in a Q Business application based on a query.

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.

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

Updates an existing Amazon Q Business application.

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

Updates an existing Amazon Q Business data source connector.

Updates the retriever used for your Amazon Q Business application.

Updates a information associated with a user id.

Link to this section Functions

Link to this function

associate_permission(client, application_id, input, options \\ [])

View Source

Adds or updates a permission policy for a Q Business application, allowing cross-account access for an ISV.

This operation creates a new policy statement for the specified Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Q Business application's resources.

Link to this function

batch_delete_document(client, application_id, index_id, input, options \\ [])

View Source

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.

Link to this function

batch_put_document(client, application_id, index_id, input, options \\ [])

View Source

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.

Link to this function

chat(client, application_id, input, options \\ [])

View Source

Starts or continues a streaming Amazon Q Business conversation.

Link to this function

chat_sync(client, application_id, input, options \\ [])

View Source

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

Link to this function

create_application(client, input, options \\ [])

View Source

Creates an Amazon Q Business application.

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.

An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.

Link to this function

create_data_accessor(client, application_id, input, options \\ [])

View Source

Creates a new data accessor for an ISV to access data from a Q Business application.

The data accessor is an entity that represents the ISV's access to the 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 AWS IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Q Business application.

Link to this function

create_data_source(client, application_id, index_id, input, options \\ [])

View Source

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.

Link to this function

create_index(client, application_id, input, options \\ [])

View Source

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.

Link to this function

create_plugin(client, application_id, input, options \\ [])

View Source

Creates an Amazon Q Business plugin.

Link to this function

create_retriever(client, application_id, input, options \\ [])

View Source

Adds a retriever to your Amazon Q Business application.

Link to this function

create_user(client, application_id, input, options \\ [])

View Source

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

Link to this function

create_web_experience(client, application_id, input, options \\ [])

View Source

Creates an Amazon Q Business web experience.

Link to this function

delete_application(client, application_id, input, options \\ [])

View Source

Deletes an Amazon Q Business application.

Link to this function

delete_chat_controls_configuration(client, application_id, input, options \\ [])

View Source

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

Link to this function

delete_conversation(client, application_id, conversation_id, input, options \\ [])

View Source

Deletes an Amazon Q Business web experience conversation.

Link to this function

delete_data_accessor(client, application_id, data_accessor_id, input, options \\ [])

View Source

Deletes a specified data accessor.

This operation permanently removes the data accessor and its associated AWS IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked

Link to this function

delete_data_source(client, application_id, data_source_id, index_id, input, options \\ [])

View Source

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.

Link to this function

delete_group(client, application_id, group_name, index_id, input, options \\ [])

View Source

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.

Link to this function

delete_index(client, application_id, index_id, input, options \\ [])

View Source

Deletes an Amazon Q Business index.

Link to this function

delete_plugin(client, application_id, plugin_id, input, options \\ [])

View Source

Deletes an Amazon Q Business plugin.

Link to this function

delete_retriever(client, application_id, retriever_id, input, options \\ [])

View Source

Deletes the retriever used by an Amazon Q Business application.

Link to this function

delete_user(client, application_id, user_id, input, options \\ [])

View Source

Deletes a user by email id.

Link to this function

delete_web_experience(client, application_id, web_experience_id, input, options \\ [])

View Source

Deletes an Amazon Q Business web experience.

Link to this function

disassociate_permission(client, application_id, statement_id, input, options \\ [])

View Source

Removes a permission policy from a 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.

Link to this function

get_application(client, application_id, options \\ [])

View Source

Gets information about an existing Amazon Q Business application.

Link to this function

get_chat_controls_configuration(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

get_data_accessor(client, application_id, data_accessor_id, options \\ [])

View Source

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 Q Business application and AWS 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.

Link to this function

get_data_source(client, application_id, data_source_id, index_id, options \\ [])

View Source

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

Link to this function

get_group(client, application_id, group_name, index_id, data_source_id \\ nil, options \\ [])

View Source

Describes a group by group name.

Link to this function

get_index(client, application_id, index_id, options \\ [])

View Source

Gets information about an existing Amazon Q Business index.

Link to this function

get_media(client, application_id, conversation_id, media_id, message_id, options \\ [])

View Source

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.

Link to this function

get_plugin(client, application_id, plugin_id, options \\ [])

View Source

Gets information about an existing Amazon Q Business plugin.

Link to this function

get_policy(client, application_id, options \\ [])

View Source

Retrieves the current permission policy for a 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.

Link to this function

get_retriever(client, application_id, retriever_id, options \\ [])

View Source

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

Link to this function

get_user(client, application_id, user_id, options \\ [])

View Source

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

Link to this function

get_web_experience(client, application_id, web_experience_id, options \\ [])

View Source

Gets information about an existing Amazon Q Business web experience.

Link to this function

list_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists Amazon Q Business applications.

Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

Link to this function

list_attachments(client, application_id, conversation_id \\ nil, max_results \\ nil, next_token \\ nil, user_id \\ nil, options \\ [])

View Source

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.

Link to this function

list_conversations(client, application_id, max_results \\ nil, next_token \\ nil, user_id \\ nil, options \\ [])

View Source

Lists one or more Amazon Q Business conversations.

Link to this function

list_data_accessors(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the data accessors for a 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.

Link to this function

list_data_source_sync_jobs(client, application_id, data_source_id, index_id, end_time \\ nil, max_results \\ nil, next_token \\ nil, start_time \\ nil, status_filter \\ nil, options \\ [])

View Source

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

Link to this function

list_data_sources(client, application_id, index_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_documents(client, application_id, index_id, data_source_ids \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

A list of documents attached to an index.

Link to this function

list_groups(client, application_id, index_id, data_source_id \\ nil, max_results \\ nil, next_token \\ nil, updated_earlier_than, options \\ [])

View Source

Provides a list of groups that are mapped to users.

Link to this function

list_indices(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the Amazon Q Business indices you have created.

Link to this function

list_messages(client, application_id, conversation_id, max_results \\ nil, next_token \\ nil, user_id \\ nil, options \\ [])

View Source

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

Link to this function

list_plugin_actions(client, application_id, plugin_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_plugin_type_actions(client, plugin_type, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_plugin_type_metadata(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists metadata for all Amazon Q Business plugin types.

Link to this function

list_plugins(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists configured Amazon Q Business plugins.

Link to this function

list_retrievers(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the retriever used by an Amazon Q Business application.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Gets a list of tags associated with a specified resource.

Amazon Q Business applications and data sources can have tags associated with them.

Link to this function

list_web_experiences(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists one or more Amazon Q Business Web Experiences.

Link to this function

put_feedback(client, application_id, conversation_id, message_id, input, options \\ [])

View Source

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

Link to this function

put_group(client, application_id, index_id, input, options \\ [])

View Source

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.

Link to this function

search_relevant_content(client, application_id, input, options \\ [])

View Source

Searches for relevant content in a Q Business application based on a query.

This operation takes a search query text, the 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.

Link to this function

start_data_source_sync_job(client, application_id, data_source_id, index_id, input, options \\ [])

View Source

Starts a data source connector synchronization job.

If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.

Link to this function

stop_data_source_sync_job(client, application_id, data_source_id, index_id, input, options \\ [])

View Source

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

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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

Link to this function

update_application(client, application_id, input, options \\ [])

View Source

Updates an existing Amazon Q Business application.

Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

Link to this function

update_chat_controls_configuration(client, application_id, input, options \\ [])

View Source

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

Link to this function

update_data_accessor(client, application_id, data_accessor_id, input, options \\ [])

View Source

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.

Link to this function

update_data_source(client, application_id, data_source_id, index_id, input, options \\ [])

View Source

Updates an existing Amazon Q Business data source connector.

Link to this function

update_index(client, application_id, index_id, input, options \\ [])

View Source

Updates an Amazon Q Business index.

Link to this function

update_plugin(client, application_id, plugin_id, input, options \\ [])

View Source

Updates an Amazon Q Business plugin.

Link to this function

update_retriever(client, application_id, retriever_id, input, options \\ [])

View Source

Updates the retriever used for your Amazon Q Business application.

Link to this function

update_user(client, application_id, user_id, input, options \\ [])

View Source

Updates a information associated with a user id.

Link to this function

update_web_experience(client, application_id, web_experience_id, input, options \\ [])

View Source

Updates an Amazon Q Business web experience.