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 Amazon 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.
-
#cancel_subscription(params = {}) ⇒ Types::CancelSubscriptionResponse
Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application.
-
#chat_sync(params = {}) ⇒ Types::ChatSyncOutput
Starts or continues a non-streaming Amazon Q Business conversation.
-
#check_document_access(params = {}) ⇒ Types::CheckDocumentAccessResponse
Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document.
-
#create_anonymous_web_experience_url(params = {}) ⇒ Types::CreateAnonymousWebExperienceUrlResponse
Creates a unique URL for anonymous Amazon Q Business web experience.
-
#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 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_subscription(params = {}) ⇒ Types::CreateSubscriptionResponse
Subscribes an IAM Identity Center user or a group to a pricing tier for an 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_attachment(params = {}) ⇒ Struct
Deletes an attachment associated with a specific Amazon Q Business conversation.
-
#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 Amazon 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 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 Amazon 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 Amazon 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_subscriptions(params = {}) ⇒ Types::ListSubscriptionsResponse
Lists all subscriptions created in 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 Amazon 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 a 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_subscription(params = {}) ⇒ Types::UpdateSubscriptionResponse
Updates the pricing tier for an Amazon Q Business subscription.
-
#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.
477 478 479 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 477 def initialize(*args) super end |
Instance Method Details
#associate_permission(params = {}) ⇒ Types::AssociatePermissionResponse
Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.
525 526 527 528 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 525 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.
579 580 581 582 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 579 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.
756 757 758 759 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 756 def batch_put_document(params = {}, = {}) req = build_request(:batch_put_document, params) req.send_request() end |
#cancel_subscription(params = {}) ⇒ Types::CancelSubscriptionResponse
Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.
795 796 797 798 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 795 def cancel_subscription(params = {}, = {}) req = build_request(:cancel_subscription, params) req.send_request() end |
#chat_sync(params = {}) ⇒ Types::ChatSyncOutput
Starts or continues a non-streaming Amazon Q Business conversation.
1069 1070 1071 1072 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1069 def chat_sync(params = {}, = {}) req = build_request(:chat_sync, params) req.send_request() end |
#check_document_access(params = {}) ⇒ Types::CheckDocumentAccessResponse
Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1151 def check_document_access(params = {}, = {}) req = build_request(:check_document_access, params) req.send_request() end |
#create_anonymous_web_experience_url(params = {}) ⇒ Types::CreateAnonymousWebExperienceUrlResponse
Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1191 def create_anonymous_web_experience_url(params = {}, = {}) req = build_request(:create_anonymous_web_experience_url, 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.
1346 1347 1348 1349 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1346 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 Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon 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 IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
1501 1502 1503 1504 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1501 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.
1718 1719 1720 1721 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1718 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.
1806 1807 1808 1809 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1806 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.
1907 1908 1909 1910 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 1907 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.
2003 2004 2005 2006 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2003 def create_retriever(params = {}, = {}) req = build_request(:create_retriever, params) req.send_request() end |
#create_subscription(params = {}) ⇒ Types::CreateSubscriptionResponse
Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.
Amazon Q Business offers two subscription tiers: Q_LITE
and
Q_BUSINESS
. Subscription tier determines feature access for the
user. For more information on subscriptions and pricing tiers, see
Amazon Q Business pricing.
2069 2070 2071 2072 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2069 def create_subscription(params = {}, = {}) req = build_request(:create_subscription, 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.
2115 2116 2117 2118 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2115 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.
2250 2251 2252 2253 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2250 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.
2272 2273 2274 2275 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2272 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_attachment(params = {}) ⇒ Struct
Deletes an attachment associated with a specific Amazon Q Business conversation.
2308 2309 2310 2311 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2308 def (params = {}, = {}) req = build_request(:delete_attachment, params) req.send_request() end |
#delete_chat_controls_configuration(params = {}) ⇒ Struct
Deletes chat controls configured for an existing Amazon Q Business application.
2332 2333 2334 2335 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2332 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.
2364 2365 2366 2367 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2364 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 IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.
2393 2394 2395 2396 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2393 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
.
2426 2427 2428 2429 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2426 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
.
2480 2481 2482 2483 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2480 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_index(params = {}) ⇒ Struct
Deletes an Amazon Q Business index.
2507 2508 2509 2510 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2507 def delete_index(params = {}, = {}) req = build_request(:delete_index, params) req.send_request() end |
#delete_plugin(params = {}) ⇒ Struct
Deletes an Amazon Q Business plugin.
2534 2535 2536 2537 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2534 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.
2561 2562 2563 2564 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2561 def delete_retriever(params = {}, = {}) req = build_request(:delete_retriever, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user by email id.
2588 2589 2590 2591 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2588 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.
2615 2616 2617 2618 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2615 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 Amazon 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.
2644 2645 2646 2647 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2644 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.
2711 2712 2713 2714 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2711 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_chat_controls_configuration(params = {}) ⇒ Types::GetChatControlsConfigurationResponse
Gets information about 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.
2786 2787 2788 2789 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2786 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 Amazon Q Business application and 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.
2887 2888 2889 2890 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2887 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.
2996 2997 2998 2999 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 2996 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.
3045 3046 3047 3048 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3045 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.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3107 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.
3163 3164 3165 3166 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3163 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.
3228 3229 3230 3231 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3228 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 Amazon 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.
3259 3260 3261 3262 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3259 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.
3321 3322 3323 3324 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3321 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.
3357 3358 3359 3360 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3357 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.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3435 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.
3492 3493 3494 3495 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3492 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.
3558 3559 3560 3561 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3558 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.
3609 3610 3611 3612 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3609 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 Amazon 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.
3660 3661 3662 3663 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3660 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.
3739 3740 3741 3742 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3739 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.
3795 3796 3797 3798 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3795 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.
3852 3853 3854 3855 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3852 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.
3912 3913 3914 3915 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3912 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.
3961 3962 3963 3964 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 3961 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.
4062 4063 4064 4065 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4062 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.
4114 4115 4116 4117 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4114 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.
4161 4162 4163 4164 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4161 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.
4202 4203 4204 4205 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4202 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.
4253 4254 4255 4256 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4253 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.
4301 4302 4303 4304 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4301 def list_retrievers(params = {}, = {}) req = build_request(:list_retrievers, params) req.send_request() end |
#list_subscriptions(params = {}) ⇒ Types::ListSubscriptionsResponse
Lists all subscriptions created in an Amazon Q Business application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4351 4352 4353 4354 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4351 def list_subscriptions(params = {}, = {}) req = build_request(:list_subscriptions, 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.
4384 4385 4386 4387 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4384 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.
4433 4434 4435 4436 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4433 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.
4481 4482 4483 4484 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4481 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.
There are two options for creating groups, either passing group
members inline or using an S3 file via the S3PathForGroupMembers
field. For inline groups, there is a limit of 1000 members per group
and for provided S3 files there is a limit of 100 thousand members.
When creating a group using an S3 file, you provide both an S3 file
and a RoleArn
for Amazon Q Buisness to access the file.
4575 4576 4577 4578 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4575 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 Amazon Q Business application based on a query. This operation takes a search query text, the Amazon 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.
4729 4730 4731 4732 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4729 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
.
4768 4769 4770 4771 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4768 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.
4801 4802 4803 4804 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4801 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.
4837 4838 4839 4840 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4837 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.
4866 4867 4868 4869 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4866 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.
4960 4961 4962 4963 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 4960 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_chat_controls_configuration(params = {}) ⇒ Struct
Updates a set of chat controls configured for an existing Amazon Q Business application.
5098 5099 5100 5101 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5098 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.
5221 5222 5223 5224 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5221 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.
5370 5371 5372 5373 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5370 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.
5430 5431 5432 5433 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5430 def update_index(params = {}, = {}) req = build_request(:update_index, params) req.send_request() end |
#update_plugin(params = {}) ⇒ Struct
Updates an Amazon Q Business plugin.
5503 5504 5505 5506 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5503 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.
5571 5572 5573 5574 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5571 def update_retriever(params = {}, = {}) req = build_request(:update_retriever, params) req.send_request() end |
#update_subscription(params = {}) ⇒ Types::UpdateSubscriptionResponse
Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.
5620 5621 5622 5623 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5620 def update_subscription(params = {}, = {}) req = build_request(:update_subscription, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates a information associated with a user id.
5685 5686 5687 5688 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5685 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.
5804 5805 5806 5807 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb', line 5804 def update_web_experience(params = {}, = {}) req = build_request(:update_web_experience, params) req.send_request() end |