View Source AWS.QBusiness (aws-elixir v0.14.0)

Link to this section Summary

Functions

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

Adds one or more documents to an Amazon Q index.

Starts or continues a non-streaming Amazon Q conversation.

Creates an Amazon Q application.

Adds a retriever to your Amazon Q application.

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

Deletes chat controls configured for an existing Amazon Q application.

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

Gets information about an existing Amazon Q application.

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

Gets information about an existing Amazon Q data source connector.

Gets information about an existing Amazon Q index.

Gets information about an existing Amazon Q plugin.

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

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

Gets information about an existing Amazon Q web experience.

Gets a list of tags associated with a specified resource.

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

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

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

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

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

Updates an existing Amazon Q application.

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

Updates the retriever used for your Amazon Q application.

Updates a information associated with a user id.

Link to this section Functions

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 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 index.

You use this API to:

  • ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q index.

  • add custom attributes to documents in an Amazon Q index.

  • attach an access control list to the documents added to an Amazon Q 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_sync(client, application_id, input, options \\ [])

View Source

Starts or continues a non-streaming Amazon Q conversation.

Link to this function

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

View Source

Creates an Amazon Q application.

Link to this function

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

View Source

Creates an Amazon Q 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 plugin.

Link to this function

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

View Source

Adds a retriever to your Amazon Q 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 web experience.

Link to this function

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

View Source

Deletes an Amazon Q 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 application.

Link to this function

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

View Source

Deletes an Amazon Q web experience conversation.

Link to this function

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

View Source

Deletes an Amazon Q 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 index.

Link to this function

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

View Source

Deletes an Amazon Q plugin.

Link to this function

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

View Source

Deletes the retriever used by an Amazon Q 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 web experience.

Link to this function

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

View Source

Gets information about an existing Amazon Q 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 application.

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 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 index.

Link to this function

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

View Source

Gets information about an existing Amazon Q plugin.

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 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 web experience.

Link to this function

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

View Source

Lists Amazon Q applications.

Link to this function

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

View Source

Lists one or more Amazon Q conversations.

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 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 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 indices you have created.

Link to this function

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

View Source

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

Link to this function

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

View Source

Lists configured Amazon Q 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 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 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 Web Experiences.

Link to this function

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

View Source

Enables your end user to to provide feedback on their Amazon Q 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 chat results.

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 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 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 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 application or a data source.

Link to this function

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

View Source

Updates an existing Amazon Q application.

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

Link to this function

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

View Source

Updates an existing Amazon Q data source connector.

Link to this function

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

View Source

Updates an Amazon Q index.

Link to this function

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

View Source

Updates an Amazon Q plugin.

Link to this function

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

View Source

Updates the retriever used for your Amazon Q 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 web experience.