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

Amazon Q is in preview release and is subject to change.

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.

You can use the following AWS SDKs to access Amazon Q Business APIs:

AWS SDK for C++

AWS SDK for Go

AWS SDK for Java

AWS SDK for JavaScript

AWS SDK for .NET

AWS SDK for Python (Boto3)

AWS SDK for Ruby

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

Summary

Functions

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

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

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

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

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

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

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

Creates an Amazon Q Business application.

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

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

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

Creates an Amazon Q Business index.

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

Creates an Amazon Q Business plugin.

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

Adds a retriever to your Amazon Q Business application.

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

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

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

Creates an Amazon Q Business web experience.

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

Deletes an Amazon Q Business application.

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

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

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

Deletes an Amazon Q Business web experience conversation.

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

Deletes an Amazon Q Business data source connector.

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

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.

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

Deletes an Amazon Q Business index.

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

Deletes an Amazon Q Business plugin.

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

Deletes the retriever used by an Amazon Q Business application.

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

Deletes a user by email id.

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

Deletes an Amazon Q Business web experience.

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

Gets information about an existing Amazon Q Business application.

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

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

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

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

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

Describes a group by group name.

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

Gets information about an existing Amazon Q Business index.

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

Gets information about an existing Amazon Q Business plugin.

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

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

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

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

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

Gets information about an existing Amazon Q Business web experience.

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

Lists Amazon Q Business applications.

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

Lists one or more Amazon Q Business conversations.

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 \\ [])

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

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

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

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

A list of documents attached to an index.

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

Provides a list of groups that are mapped to users.

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

Lists the Amazon Q Business indices you have created.

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

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

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

Lists configured Amazon Q Business plugins.

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

Lists the retriever used by an Amazon Q Business application.

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

Gets a list of tags associated with a specified resource.

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

Lists one or more Amazon Q Business Web Experiences.

metadata()

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

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

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

Create, or updates, a mapping of users—who have access to a document—to groups.

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

Starts a data source connector synchronization job.

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

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

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

Adds the specified tag to the specified Amazon Q Business application or data source resource.

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

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

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

Updates an existing Amazon Q Business application.

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

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

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

Updates an existing Amazon Q Business data source connector.

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

Updates an Amazon Q Business index.

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

Updates an Amazon Q Business plugin.

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

Updates the retriever used for your Amazon Q Business application.

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

Updates a information associated with a user id.

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

Updates an Amazon Q Business web experience.

Functions

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

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.

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

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.

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

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

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

Creates an Amazon Q Business application.

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

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.

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

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.

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

Creates an Amazon Q Business plugin.

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

Adds a retriever to your Amazon Q Business application.

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

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

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

Creates an Amazon Q Business web experience.

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

Deletes an Amazon Q Business application.

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

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

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

Deletes an Amazon Q Business web experience conversation.

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

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.

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

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.

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

Deletes an Amazon Q Business index.

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

Deletes an Amazon Q Business plugin.

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

Deletes the retriever used by an Amazon Q Business application.

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

Deletes a user by email id.

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

Deletes an Amazon Q Business web experience.

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

Gets information about an existing Amazon Q Business application.

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

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

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

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

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

Describes a group by group name.

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

Gets information about an existing Amazon Q Business index.

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

Gets information about an existing Amazon Q Business plugin.

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

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

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

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

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

Gets information about an existing Amazon Q Business web experience.

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

Lists Amazon Q Business applications.

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

Lists one or more Amazon Q Business conversations.

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 \\ [])

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

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

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

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

A list of documents attached to an index.

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

Provides a list of groups that are mapped to users.

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

Lists the Amazon Q Business indices you have created.

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

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

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

Lists configured Amazon Q Business plugins.

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

Lists the retriever used by an Amazon Q Business application.

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

Gets a list of tags associated with a specified resource.

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

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

Lists one or more Amazon Q Business Web Experiences.

metadata()

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

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

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

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.

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

Starts a data source connector synchronization job.

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

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

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

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

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.

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

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

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

Updates an existing Amazon Q Business application.

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

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

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

Updates an existing Amazon Q Business data source connector.

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

Updates an Amazon Q Business index.

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

Updates an Amazon Q Business plugin.

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

Updates the retriever used for your Amazon Q Business application.

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

Updates a information associated with a user id.

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

Updates an Amazon Q Business web experience.