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.
421 422 423 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 421 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.
476 477 478 479 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 476 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.
642 643 644 645 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 642 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.
884 885 886 887 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 884 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.
976 977 978 979 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 976 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.
1158 1159 1160 1161 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1158 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.
1246 1247 1248 1249 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1246 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.
1341 1342 1343 1344 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1341 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.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1437 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.
1483 1484 1485 1486 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1483 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.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1557 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.
1579 1580 1581 1582 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1579 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.
1603 1604 1605 1606 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1603 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.
1635 1636 1637 1638 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1635 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
.
1668 1669 1670 1671 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1668 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
.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1722 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_index(params = {}) ⇒ Struct
Deletes an Amazon Q Business index.
1749 1750 1751 1752 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1749 def delete_index(params = {}, = {}) req = build_request(:delete_index, params) req.send_request() end |
#delete_plugin(params = {}) ⇒ Struct
Deletes an Amazon Q Business plugin.
1776 1777 1778 1779 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1776 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.
1803 1804 1805 1806 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1803 def delete_retriever(params = {}, = {}) req = build_request(:delete_retriever, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user by email id.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1830 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.
1857 1858 1859 1860 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1857 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.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1908 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.
1979 1980 1981 1982 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1979 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.
2084 2085 2086 2087 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2084 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.
2133 2134 2135 2136 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2133 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.
2195 2196 2197 2198 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2195 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.
2256 2257 2258 2259 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2256 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.
2318 2319 2320 2321 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2318 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.
2354 2355 2356 2357 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2354 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.
2417 2418 2419 2420 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2417 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.
2461 2462 2463 2464 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2461 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.
2512 2513 2514 2515 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2512 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.
2591 2592 2593 2594 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2591 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.
2647 2648 2649 2650 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2647 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.
2704 2705 2706 2707 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2704 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.
2764 2765 2766 2767 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2764 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.
2813 2814 2815 2816 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2813 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.
2898 2899 2900 2901 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2898 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.
2949 2950 2951 2952 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2949 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.
2997 2998 2999 3000 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2997 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.
3030 3031 3032 3033 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3030 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.
3079 3080 3081 3082 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3079 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.
3127 3128 3129 3130 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3127 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.
3211 3212 3213 3214 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3211 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
.
3250 3251 3252 3253 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3250 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.
3283 3284 3285 3286 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3283 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.
3319 3320 3321 3322 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3319 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.
3348 3349 3350 3351 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3348 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.
3396 3397 3398 3399 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3396 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.
3522 3523 3524 3525 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3522 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.
3656 3657 3658 3659 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3656 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.
3716 3717 3718 3719 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3716 def update_index(params = {}, = {}) req = build_request(:update_index, params) req.send_request() end |
#update_plugin(params = {}) ⇒ Struct
Updates an Amazon Q Business plugin.
3783 3784 3785 3786 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3783 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.
3851 3852 3853 3854 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3851 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.
3916 3917 3918 3919 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3916 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.
3978 3979 3980 3981 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3978 def update_web_experience(params = {}, = {}) req = build_request(:update_web_experience, params) req.send_request() end |