Class: Aws::QBusiness::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::QBusiness::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb
Overview
An API client for QBusiness. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::QBusiness::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_delete_document(params = {}) ⇒ Types::BatchDeleteDocumentResponse
Asynchronously deletes one or more documents added using the
BatchPutDocument
API from an Amazon Q Business index. -
#batch_put_document(params = {}) ⇒ Types::BatchPutDocumentResponse
Adds one or more documents to an Amazon Q Business index.
-
#chat_sync(params = {}) ⇒ Types::ChatSyncOutput
Starts or continues a non-streaming Amazon Q Business conversation.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an Amazon Q Business application.
-
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a data source connector for an Amazon Q Business application.
-
#create_index(params = {}) ⇒ Types::CreateIndexResponse
Creates an Amazon Q Business index.
-
#create_plugin(params = {}) ⇒ Types::CreatePluginResponse
Creates an Amazon Q Business plugin.
-
#create_retriever(params = {}) ⇒ Types::CreateRetrieverResponse
Adds a retriever to your Amazon Q Business application.
-
#create_user(params = {}) ⇒ Struct
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
-
#create_web_experience(params = {}) ⇒ Types::CreateWebExperienceResponse
Creates an Amazon Q Business web experience.
-
#delete_application(params = {}) ⇒ Struct
Deletes an Amazon Q Business application.
-
#delete_chat_controls_configuration(params = {}) ⇒ Struct
Deletes chat controls configured for an existing Amazon Q Business application.
-
#delete_conversation(params = {}) ⇒ Struct
Deletes an Amazon Q Business web experience conversation.
-
#delete_data_source(params = {}) ⇒ Struct
Deletes an Amazon Q Business data source connector.
-
#delete_group(params = {}) ⇒ Struct
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(params = {}) ⇒ Struct
Deletes an Amazon Q Business index.
-
#delete_plugin(params = {}) ⇒ Struct
Deletes an Amazon Q Business plugin.
-
#delete_retriever(params = {}) ⇒ Struct
Deletes the retriever used by an Amazon Q Business application.
-
#delete_user(params = {}) ⇒ Struct
Deletes a user by email id.
-
#delete_web_experience(params = {}) ⇒ Struct
Deletes an Amazon Q Business web experience.
-
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Gets information about an existing Amazon Q Business application.
-
#get_chat_controls_configuration(params = {}) ⇒ Types::GetChatControlsConfigurationResponse
Gets information about an chat controls configured for an existing Amazon Q Business application.
-
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Gets information about an existing Amazon Q Business data source connector.
-
#get_group(params = {}) ⇒ Types::GetGroupResponse
Describes a group by group name.
-
#get_index(params = {}) ⇒ Types::GetIndexResponse
Gets information about an existing Amazon Q Business index.
-
#get_plugin(params = {}) ⇒ Types::GetPluginResponse
Gets information about an existing Amazon Q Business plugin.
-
#get_retriever(params = {}) ⇒ Types::GetRetrieverResponse
Gets information about an existing retriever used by an Amazon Q Business application.
-
#get_user(params = {}) ⇒ Types::GetUserResponse
Describes the universally unique identifier (UUID) associated with a local user in a data source.
-
#get_web_experience(params = {}) ⇒ Types::GetWebExperienceResponse
Gets information about an existing Amazon Q Business web experience.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists Amazon Q Business applications.
-
#list_conversations(params = {}) ⇒ Types::ListConversationsResponse
Lists one or more Amazon Q Business conversations.
-
#list_data_source_sync_jobs(params = {}) ⇒ Types::ListDataSourceSyncJobsResponse
Get information about an Amazon Q Business data source connector synchronization.
-
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists the Amazon Q Business data source connectors that you have created.
-
#list_documents(params = {}) ⇒ Types::ListDocumentsResponse
A list of documents attached to an index.
-
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Provides a list of groups that are mapped to users.
-
#list_indices(params = {}) ⇒ Types::ListIndicesResponse
Lists the Amazon Q Business indices you have created.
-
#list_messages(params = {}) ⇒ Types::ListMessagesResponse
Gets a list of messages associated with an Amazon Q Business web experience.
-
#list_plugins(params = {}) ⇒ Types::ListPluginsResponse
Lists configured Amazon Q Business plugins.
-
#list_retrievers(params = {}) ⇒ Types::ListRetrieversResponse
Lists the retriever used by an Amazon Q Business application.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags associated with a specified resource.
-
#list_web_experiences(params = {}) ⇒ Types::ListWebExperiencesResponse
Lists one or more Amazon Q Business Web Experiences.
-
#put_feedback(params = {}) ⇒ Struct
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
-
#put_group(params = {}) ⇒ Struct
Create, or updates, a mapping of users—who have access to a document—to groups.
-
#start_data_source_sync_job(params = {}) ⇒ Types::StartDataSourceSyncJobResponse
Starts a data source connector synchronization job.
-
#stop_data_source_sync_job(params = {}) ⇒ Struct
Stops an Amazon Q Business data source connector synchronization job already in progress.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tag to the specified Amazon Q Business application or data source resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from an Amazon Q Business application or a data source.
-
#update_application(params = {}) ⇒ Struct
Updates an existing Amazon Q Business application.
-
#update_chat_controls_configuration(params = {}) ⇒ Struct
Updates an set of chat controls configured for an existing Amazon Q Business application.
-
#update_data_source(params = {}) ⇒ Struct
Updates an existing Amazon Q Business data source connector.
-
#update_index(params = {}) ⇒ Struct
Updates an Amazon Q Business index.
-
#update_plugin(params = {}) ⇒ Struct
Updates an Amazon Q Business plugin.
-
#update_retriever(params = {}) ⇒ Struct
Updates the retriever used for your Amazon Q Business application.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates a information associated with a user id.
-
#update_web_experience(params = {}) ⇒ Struct
Updates an Amazon Q Business web experience.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
433 434 435 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 433 def initialize(*args) super end |
Instance Method Details
#batch_delete_document(params = {}) ⇒ Types::BatchDeleteDocumentResponse
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.
488 489 490 491 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 488 def batch_delete_document(params = {}, = {}) req = build_request(:batch_delete_document, params) req.send_request() end |
#batch_put_document(params = {}) ⇒ Types::BatchPutDocumentResponse
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.
654 655 656 657 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 654 def batch_put_document(params = {}, = {}) req = build_request(:batch_put_document, params) req.send_request() end |
#chat_sync(params = {}) ⇒ Types::ChatSyncOutput
Starts or continues a non-streaming Amazon Q Business conversation.
895 896 897 898 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 895 def chat_sync(params = {}, = {}) req = build_request(:chat_sync, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an Amazon Q Business application.
1018 1019 1020 1021 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1018 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
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.
1220 1221 1222 1223 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1220 def create_data_source(params = {}, = {}) req = build_request(:create_data_source, params) req.send_request() end |
#create_index(params = {}) ⇒ Types::CreateIndexResponse
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.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1308 def create_index(params = {}, = {}) req = build_request(:create_index, params) req.send_request() end |
#create_plugin(params = {}) ⇒ Types::CreatePluginResponse
Creates an Amazon Q Business plugin.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1403 def create_plugin(params = {}, = {}) req = build_request(:create_plugin, params) req.send_request() end |
#create_retriever(params = {}) ⇒ Types::CreateRetrieverResponse
Adds a retriever to your Amazon Q Business application.
1499 1500 1501 1502 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1499 def create_retriever(params = {}, = {}) req = build_request(:create_retriever, params) req.send_request() end |
#create_user(params = {}) ⇒ Struct
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
1545 1546 1547 1548 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1545 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#create_web_experience(params = {}) ⇒ Types::CreateWebExperienceResponse
Creates an Amazon Q Business web experience.
1639 1640 1641 1642 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1639 def create_web_experience(params = {}, = {}) req = build_request(:create_web_experience, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes an Amazon Q Business application.
1661 1662 1663 1664 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1661 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_chat_controls_configuration(params = {}) ⇒ Struct
Deletes chat controls configured for an existing Amazon Q Business application.
1685 1686 1687 1688 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1685 def delete_chat_controls_configuration(params = {}, = {}) req = build_request(:delete_chat_controls_configuration, params) req.send_request() end |
#delete_conversation(params = {}) ⇒ Struct
Deletes an Amazon Q Business web experience conversation.
1717 1718 1719 1720 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1717 def delete_conversation(params = {}, = {}) req = build_request(:delete_conversation, params) req.send_request() end |
#delete_data_source(params = {}) ⇒ Struct
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
.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1750 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
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
.
1804 1805 1806 1807 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1804 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_index(params = {}) ⇒ Struct
Deletes an Amazon Q Business index.
1831 1832 1833 1834 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1831 def delete_index(params = {}, = {}) req = build_request(:delete_index, params) req.send_request() end |
#delete_plugin(params = {}) ⇒ Struct
Deletes an Amazon Q Business plugin.
1858 1859 1860 1861 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1858 def delete_plugin(params = {}, = {}) req = build_request(:delete_plugin, params) req.send_request() end |
#delete_retriever(params = {}) ⇒ Struct
Deletes the retriever used by an Amazon Q Business application.
1885 1886 1887 1888 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1885 def delete_retriever(params = {}, = {}) req = build_request(:delete_retriever, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user by email id.
1912 1913 1914 1915 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1912 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#delete_web_experience(params = {}) ⇒ Struct
Deletes an Amazon Q Business web experience.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1939 def delete_web_experience(params = {}, = {}) req = build_request(:delete_web_experience, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Gets information about an existing Amazon Q Business application.
2004 2005 2006 2007 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2004 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_chat_controls_configuration(params = {}) ⇒ Types::GetChatControlsConfigurationResponse
Gets information about an chat controls configured for an existing Amazon Q Business application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2075 2076 2077 2078 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2075 def get_chat_controls_configuration(params = {}, = {}) req = build_request(:get_chat_controls_configuration, params) req.send_request() end |
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Gets information about an existing Amazon Q Business data source connector.
2180 2181 2182 2183 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2180 def get_data_source(params = {}, = {}) req = build_request(:get_data_source, params) req.send_request() end |
#get_group(params = {}) ⇒ Types::GetGroupResponse
Describes a group by group name.
2229 2230 2231 2232 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2229 def get_group(params = {}, = {}) req = build_request(:get_group, params) req.send_request() end |
#get_index(params = {}) ⇒ Types::GetIndexResponse
Gets information about an existing Amazon Q Business index.
2291 2292 2293 2294 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2291 def get_index(params = {}, = {}) req = build_request(:get_index, params) req.send_request() end |
#get_plugin(params = {}) ⇒ Types::GetPluginResponse
Gets information about an existing Amazon Q Business plugin.
2352 2353 2354 2355 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2352 def get_plugin(params = {}, = {}) req = build_request(:get_plugin, params) req.send_request() end |
#get_retriever(params = {}) ⇒ Types::GetRetrieverResponse
Gets information about an existing retriever used by an Amazon Q Business application.
2414 2415 2416 2417 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2414 def get_retriever(params = {}, = {}) req = build_request(:get_retriever, params) req.send_request() end |
#get_user(params = {}) ⇒ Types::GetUserResponse
Describes the universally unique identifier (UUID) associated with a local user in a data source.
2450 2451 2452 2453 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2450 def get_user(params = {}, = {}) req = build_request(:get_user, params) req.send_request() end |
#get_web_experience(params = {}) ⇒ Types::GetWebExperienceResponse
Gets information about an existing Amazon Q Business web experience.
2517 2518 2519 2520 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2517 def get_web_experience(params = {}, = {}) req = build_request(:get_web_experience, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists Amazon Q Business applications.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2562 2563 2564 2565 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2562 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_conversations(params = {}) ⇒ Types::ListConversationsResponse
Lists one or more Amazon Q Business conversations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2613 2614 2615 2616 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2613 def list_conversations(params = {}, = {}) req = build_request(:list_conversations, params) req.send_request() end |
#list_data_source_sync_jobs(params = {}) ⇒ Types::ListDataSourceSyncJobsResponse
Get information about an Amazon Q Business data source connector synchronization.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2692 2693 2694 2695 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2692 def list_data_source_sync_jobs(params = {}, = {}) req = build_request(:list_data_source_sync_jobs, params) req.send_request() end |
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists the Amazon Q Business data source connectors that you have created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2748 2749 2750 2751 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2748 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_documents(params = {}) ⇒ Types::ListDocumentsResponse
A list of documents attached to an index.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2805 2806 2807 2808 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2805 def list_documents(params = {}, = {}) req = build_request(:list_documents, params) req.send_request() end |
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Provides a list of groups that are mapped to users.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2865 2866 2867 2868 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2865 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() end |
#list_indices(params = {}) ⇒ Types::ListIndicesResponse
Lists the Amazon Q Business indices you have created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2914 2915 2916 2917 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2914 def list_indices(params = {}, = {}) req = build_request(:list_indices, params) req.send_request() end |
#list_messages(params = {}) ⇒ Types::ListMessagesResponse
Gets a list of messages associated with an Amazon Q Business web experience.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2999 3000 3001 3002 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2999 def (params = {}, = {}) req = build_request(:list_messages, params) req.send_request() end |
#list_plugins(params = {}) ⇒ Types::ListPluginsResponse
Lists configured Amazon Q Business plugins.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3050 3051 3052 3053 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3050 def list_plugins(params = {}, = {}) req = build_request(:list_plugins, params) req.send_request() end |
#list_retrievers(params = {}) ⇒ Types::ListRetrieversResponse
Lists the retriever used by an Amazon Q Business application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3098 3099 3100 3101 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3098 def list_retrievers(params = {}, = {}) req = build_request(:list_retrievers, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
3131 3132 3133 3134 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3131 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_web_experiences(params = {}) ⇒ Types::ListWebExperiencesResponse
Lists one or more Amazon Q Business Web Experiences.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3180 3181 3182 3183 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3180 def list_web_experiences(params = {}, = {}) req = build_request(:list_web_experiences, params) req.send_request() end |
#put_feedback(params = {}) ⇒ Struct
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
3228 3229 3230 3231 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3228 def put_feedback(params = {}, = {}) req = build_request(:put_feedback, params) req.send_request() end |
#put_group(params = {}) ⇒ Struct
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.
3306 3307 3308 3309 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3306 def put_group(params = {}, = {}) req = build_request(:put_group, params) req.send_request() end |
#start_data_source_sync_job(params = {}) ⇒ Types::StartDataSourceSyncJobResponse
Starts a data source connector synchronization job. If a
synchronization job is already in progress, Amazon Q Business returns
a ConflictException
.
3345 3346 3347 3348 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3345 def start_data_source_sync_job(params = {}, = {}) req = build_request(:start_data_source_sync_job, params) req.send_request() end |
#stop_data_source_sync_job(params = {}) ⇒ Struct
Stops an Amazon Q Business data source connector synchronization job already in progress.
3378 3379 3380 3381 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3378 def stop_data_source_sync_job(params = {}, = {}) req = build_request(:stop_data_source_sync_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
3414 3415 3416 3417 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3414 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from an Amazon Q Business application or a data source.
3443 3444 3445 3446 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3443 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Struct
Updates an existing Amazon Q Business application.
3518 3519 3520 3521 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3518 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_chat_controls_configuration(params = {}) ⇒ Struct
Updates an set of chat controls configured for an existing Amazon Q Business application.
3644 3645 3646 3647 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3644 def update_chat_controls_configuration(params = {}, = {}) req = build_request(:update_chat_controls_configuration, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Struct
Updates an existing Amazon Q Business data source connector.
3778 3779 3780 3781 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3778 def update_data_source(params = {}, = {}) req = build_request(:update_data_source, params) req.send_request() end |
#update_index(params = {}) ⇒ Struct
Updates an Amazon Q Business index.
3838 3839 3840 3841 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3838 def update_index(params = {}, = {}) req = build_request(:update_index, params) req.send_request() end |
#update_plugin(params = {}) ⇒ Struct
Updates an Amazon Q Business plugin.
3905 3906 3907 3908 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3905 def update_plugin(params = {}, = {}) req = build_request(:update_plugin, params) req.send_request() end |
#update_retriever(params = {}) ⇒ Struct
Updates the retriever used for your Amazon Q Business application.
3973 3974 3975 3976 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3973 def update_retriever(params = {}, = {}) req = build_request(:update_retriever, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates a information associated with a user id.
4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4038 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |
#update_web_experience(params = {}) ⇒ Struct
Updates an Amazon Q Business web experience.
4113 4114 4115 4116 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4113 def update_web_experience(params = {}, = {}) req = build_request(:update_web_experience, params) req.send_request() end |