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
-
#associate_permission(params = {}) ⇒ Types::AssociatePermissionResponse
Adds or updates a permission policy for a Q Business application, allowing cross-account access for an ISV.
-
#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_accessor(params = {}) ⇒ Types::CreateDataAccessorResponse
Creates a new data accessor for an ISV to access data from a 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_accessor(params = {}) ⇒ Struct
Deletes a specified data accessor.
-
#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.
-
#disassociate_permission(params = {}) ⇒ Struct
Removes a permission policy from a Q Business application, revoking the cross-account access that was previously granted to an ISV.
-
#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_accessor(params = {}) ⇒ Types::GetDataAccessorResponse
Retrieves information about a specified data accessor.
-
#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_media(params = {}) ⇒ Types::GetMediaResponse
Returns the image bytes corresponding to a media object.
-
#get_plugin(params = {}) ⇒ Types::GetPluginResponse
Gets information about an existing Amazon Q Business plugin.
-
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Retrieves the current permission policy for a Q Business application.
-
#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_attachments(params = {}) ⇒ Types::ListAttachmentsResponse
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.
-
#list_conversations(params = {}) ⇒ Types::ListConversationsResponse
Lists one or more Amazon Q Business conversations.
-
#list_data_accessors(params = {}) ⇒ Types::ListDataAccessorsResponse
Lists the data accessors for a Q Business application.
-
#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_plugin_actions(params = {}) ⇒ Types::ListPluginActionsResponse
Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.
-
#list_plugin_type_actions(params = {}) ⇒ Types::ListPluginTypeActionsResponse
Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.
-
#list_plugin_type_metadata(params = {}) ⇒ Types::ListPluginTypeMetadataResponse
Lists metadata for all Amazon Q Business plugin types.
-
#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.
-
#search_relevant_content(params = {}) ⇒ Types::SearchRelevantContentResponse
Searches for relevant content in a Q Business application based on a query.
-
#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_accessor(params = {}) ⇒ Struct
Updates an existing data accessor.
-
#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.
455 456 457 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 455 def initialize(*args) super end |
Instance Method Details
#associate_permission(params = {}) ⇒ Types::AssociatePermissionResponse
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.
501 502 503 504 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 501 def (params = {}, = {}) req = build_request(:associate_permission, params) req.send_request() end |
#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.
555 556 557 558 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 555 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.
726 727 728 729 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 726 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.
988 989 990 991 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 988 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.
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.
1143 1144 1145 1146 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1143 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_data_accessor(params = {}) ⇒ Types::CreateDataAccessorResponse
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.
1298 1299 1300 1301 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1298 def create_data_accessor(params = {}, = {}) req = build_request(:create_data_accessor, 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.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1509 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.
1597 1598 1599 1600 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1597 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.
1698 1699 1700 1701 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1698 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.
1794 1795 1796 1797 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1794 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.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1840 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.
1973 1974 1975 1976 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1973 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.
1995 1996 1997 1998 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1995 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.
2019 2020 2021 2022 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2019 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.
2051 2052 2053 2054 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2051 def delete_conversation(params = {}, = {}) req = build_request(:delete_conversation, params) req.send_request() end |
#delete_data_accessor(params = {}) ⇒ Struct
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
2080 2081 2082 2083 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2080 def delete_data_accessor(params = {}, = {}) req = build_request(:delete_data_accessor, 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
.
2113 2114 2115 2116 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2113 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
.
2167 2168 2169 2170 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2167 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_index(params = {}) ⇒ Struct
Deletes an Amazon Q Business index.
2194 2195 2196 2197 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2194 def delete_index(params = {}, = {}) req = build_request(:delete_index, params) req.send_request() end |
#delete_plugin(params = {}) ⇒ Struct
Deletes an Amazon Q Business plugin.
2221 2222 2223 2224 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2221 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.
2248 2249 2250 2251 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2248 def delete_retriever(params = {}, = {}) req = build_request(:delete_retriever, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user by email id.
2275 2276 2277 2278 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2275 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.
2302 2303 2304 2305 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2302 def delete_web_experience(params = {}, = {}) req = build_request(:delete_web_experience, params) req.send_request() end |
#disassociate_permission(params = {}) ⇒ Struct
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.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2331 def (params = {}, = {}) req = build_request(:disassociate_permission, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Gets information about an existing Amazon Q Business application.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2398 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.
2469 2470 2471 2472 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2469 def get_chat_controls_configuration(params = {}, = {}) req = build_request(:get_chat_controls_configuration, params) req.send_request() end |
#get_data_accessor(params = {}) ⇒ Types::GetDataAccessorResponse
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.
2570 2571 2572 2573 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2570 def get_data_accessor(params = {}, = {}) req = build_request(:get_data_accessor, params) req.send_request() end |
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Gets information about an existing Amazon Q Business data source connector.
2677 2678 2679 2680 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2677 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.
2726 2727 2728 2729 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2726 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.
2788 2789 2790 2791 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2788 def get_index(params = {}, = {}) req = build_request(:get_index, params) req.send_request() end |
#get_media(params = {}) ⇒ Types::GetMediaResponse
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.
2844 2845 2846 2847 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2844 def get_media(params = {}, = {}) req = build_request(:get_media, params) req.send_request() end |
#get_plugin(params = {}) ⇒ Types::GetPluginResponse
Gets information about an existing Amazon Q Business plugin.
2909 2910 2911 2912 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2909 def get_plugin(params = {}, = {}) req = build_request(:get_plugin, params) req.send_request() end |
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
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.
2939 2940 2941 2942 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2939 def get_policy(params = {}, = {}) req = build_request(:get_policy, params) req.send_request() end |
#get_retriever(params = {}) ⇒ Types::GetRetrieverResponse
Gets information about an existing retriever used by an Amazon Q Business application.
3001 3002 3003 3004 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3001 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.
3037 3038 3039 3040 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3037 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.
3115 3116 3117 3118 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3115 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.
3172 3173 3174 3175 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3172 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_attachments(params = {}) ⇒ Types::ListAttachmentsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3238 3239 3240 3241 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3238 def (params = {}, = {}) req = build_request(:list_attachments, 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.
3289 3290 3291 3292 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3289 def list_conversations(params = {}, = {}) req = build_request(:list_conversations, params) req.send_request() end |
#list_data_accessors(params = {}) ⇒ Types::ListDataAccessorsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3340 3341 3342 3343 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3340 def list_data_accessors(params = {}, = {}) req = build_request(:list_data_accessors, 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.
3419 3420 3421 3422 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3419 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.
3475 3476 3477 3478 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3475 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.
3532 3533 3534 3535 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3532 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.
3592 3593 3594 3595 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3592 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.
3641 3642 3643 3644 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3641 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.
3730 3731 3732 3733 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3730 def (params = {}, = {}) req = build_request(:list_messages, params) req.send_request() end |
#list_plugin_actions(params = {}) ⇒ Types::ListPluginActionsResponse
Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3782 3783 3784 3785 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3782 def list_plugin_actions(params = {}, = {}) req = build_request(:list_plugin_actions, params) req.send_request() end |
#list_plugin_type_actions(params = {}) ⇒ Types::ListPluginTypeActionsResponse
Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3829 3830 3831 3832 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3829 def list_plugin_type_actions(params = {}, = {}) req = build_request(:list_plugin_type_actions, params) req.send_request() end |
#list_plugin_type_metadata(params = {}) ⇒ Types::ListPluginTypeMetadataResponse
Lists metadata for all Amazon Q Business plugin types.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3870 3871 3872 3873 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3870 def (params = {}, = {}) req = build_request(:list_plugin_type_metadata, 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.
3921 3922 3923 3924 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3921 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.
3969 3970 3971 3972 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3969 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.
4002 4003 4004 4005 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4002 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.
4051 4052 4053 4054 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4051 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.
4099 4100 4101 4102 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4099 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.
4188 4189 4190 4191 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4188 def put_group(params = {}, = {}) req = build_request(:put_group, params) req.send_request() end |
#search_relevant_content(params = {}) ⇒ Types::SearchRelevantContentResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4342 4343 4344 4345 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4342 def search_relevant_content(params = {}, = {}) req = build_request(:search_relevant_content, 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
.
4381 4382 4383 4384 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4381 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.
4414 4415 4416 4417 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4414 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.
4450 4451 4452 4453 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4450 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.
4479 4480 4481 4482 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4479 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.
QAppsConfiguration
is
enabled in the request. For more information, see Using
service-linked roles for Q Apps.
4573 4574 4575 4576 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4573 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.
4699 4700 4701 4702 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4699 def update_chat_controls_configuration(params = {}, = {}) req = build_request(:update_chat_controls_configuration, params) req.send_request() end |
#update_data_accessor(params = {}) ⇒ Struct
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.
4822 4823 4824 4825 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4822 def update_data_accessor(params = {}, = {}) req = build_request(:update_data_accessor, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Struct
Updates an existing Amazon Q Business data source connector.
4965 4966 4967 4968 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4965 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.
5025 5026 5027 5028 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5025 def update_index(params = {}, = {}) req = build_request(:update_index, params) req.send_request() end |
#update_plugin(params = {}) ⇒ Struct
Updates an Amazon Q Business plugin.
5098 5099 5100 5101 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5098 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.
5166 5167 5168 5169 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5166 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.
5231 5232 5233 5234 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5231 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.
5347 5348 5349 5350 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5347 def update_web_experience(params = {}, = {}) req = build_request(:update_web_experience, params) req.send_request() end |