Class: Aws::QApps::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::QApps::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb
Overview
An API client for QApps. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::QApps::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_library_item_review(params = {}) ⇒ Struct
Associates a rating or review for a library item with the user submitting the request.
-
#associate_q_app_with_user(params = {}) ⇒ Struct
This operation creates a link between the user's identity calling the operation and a specific Q App.
-
#batch_create_category(params = {}) ⇒ Struct
Creates Categories for the Amazon Q Business application environment instance.
-
#batch_delete_category(params = {}) ⇒ Struct
Deletes Categories for the Amazon Q Business application environment instance.
-
#batch_update_category(params = {}) ⇒ Struct
Updates Categories for the Amazon Q Business application environment instance.
-
#create_library_item(params = {}) ⇒ Types::CreateLibraryItemOutput
Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
-
#create_presigned_url(params = {}) ⇒ Types::CreatePresignedUrlOutput
Creates a presigned URL for an S3 POST operation to upload a file.
-
#create_q_app(params = {}) ⇒ Types::CreateQAppOutput
Creates a new Amazon Q App based on the provided definition.
-
#delete_library_item(params = {}) ⇒ Struct
Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.
-
#delete_q_app(params = {}) ⇒ Struct
Deletes an Amazon Q App owned by the user.
-
#describe_q_app_permissions(params = {}) ⇒ Types::DescribeQAppPermissionsOutput
Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
-
#disassociate_library_item_review(params = {}) ⇒ Struct
Removes a rating or review previously submitted by the user for a library item.
-
#disassociate_q_app_from_user(params = {}) ⇒ Struct
Disassociates a Q App from a user removing the user's access to run the Q App.
-
#export_q_app_session_data(params = {}) ⇒ Types::ExportQAppSessionDataOutput
Exports the collected data of a Q App data collection session.
-
#get_library_item(params = {}) ⇒ Types::GetLibraryItemOutput
Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
-
#get_q_app(params = {}) ⇒ Types::GetQAppOutput
Retrieves the full details of an Q App, including its definition specifying the cards and flow.
-
#get_q_app_session(params = {}) ⇒ Types::GetQAppSessionOutput
Retrieves the current state and results for an active session of an Amazon Q App.
-
#get_q_app_session_metadata(params = {}) ⇒ Types::GetQAppSessionMetadataOutput
Retrieves the current configuration of a Q App session.
-
#import_document(params = {}) ⇒ Types::ImportDocumentOutput
Uploads a file that can then be used either as a default in a
FileUploadCard
from Q App definition or as a file that is used inside a single Q App run. -
#list_categories(params = {}) ⇒ Types::ListCategoriesOutput
Lists the categories of a Amazon Q Business application environment instance.
-
#list_library_items(params = {}) ⇒ Types::ListLibraryItemsOutput
Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
-
#list_q_app_session_data(params = {}) ⇒ Types::ListQAppSessionDataOutput
Lists the collected data of a Q App data collection session.
-
#list_q_apps(params = {}) ⇒ Types::ListQAppsOutput
Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags associated with an Amazon Q Apps resource.
-
#predict_q_app(params = {}) ⇒ Types::PredictQAppOutput
Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call
CreateQApp
. -
#start_q_app_session(params = {}) ⇒ Types::StartQAppSessionOutput
Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.
-
#stop_q_app_session(params = {}) ⇒ Struct
Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses.
-
#tag_resource(params = {}) ⇒ Struct
Associates tags with an Amazon Q Apps resource.
-
#untag_resource(params = {}) ⇒ Struct
Disassociates tags from an Amazon Q Apps resource.
-
#update_library_item(params = {}) ⇒ Types::UpdateLibraryItemOutput
Updates the library item for an Amazon Q App.
-
#update_library_item_metadata(params = {}) ⇒ Struct
Updates the verification status of a library item for an Amazon Q App.
-
#update_q_app(params = {}) ⇒ Types::UpdateQAppOutput
Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
-
#update_q_app_permissions(params = {}) ⇒ Types::UpdateQAppPermissionsOutput
Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
-
#update_q_app_session(params = {}) ⇒ Types::UpdateQAppSessionOutput
Updates the session for a given Q App
sessionId
. -
#update_q_app_session_metadata(params = {}) ⇒ Types::UpdateQAppSessionMetadataOutput
Updates the configuration metadata of a session for a given Q App
sessionId
.
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.
444 445 446 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#associate_library_item_review(params = {}) ⇒ Struct
Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.
483 484 485 486 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 483 def associate_library_item_review(params = {}, = {}) req = build_request(:associate_library_item_review, params) req.send_request() end |
#associate_q_app_with_user(params = {}) ⇒ Struct
This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a favorite for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.
521 522 523 524 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 521 def associate_q_app_with_user(params = {}, = {}) req = build_request(:associate_q_app_with_user, params) req.send_request() end |
#batch_create_category(params = {}) ⇒ Struct
Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
578 579 580 581 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 578 def batch_create_category(params = {}, = {}) req = build_request(:batch_create_category, params) req.send_request() end |
#batch_delete_category(params = {}) ⇒ Struct
Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
622 623 624 625 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 622 def batch_delete_category(params = {}, = {}) req = build_request(:batch_delete_category, params) req.send_request() end |
#batch_update_category(params = {}) ⇒ Struct
Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
679 680 681 682 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 679 def batch_update_category(params = {}, = {}) req = build_request(:batch_update_category, params) req.send_request() end |
#create_library_item(params = {}) ⇒ Types::CreateLibraryItemOutput
Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
760 761 762 763 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 760 def create_library_item(params = {}, = {}) req = build_request(:create_library_item, params) req.send_request() end |
#create_presigned_url(params = {}) ⇒ Types::CreatePresignedUrlOutput
Creates a presigned URL for an S3 POST operation to upload a file. You
can use this URL to set a default file for a FileUploadCard
in a Q
App definition or to provide a file for a single Q App run. The
scope
parameter determines how the file will be used, either at the
app definition level or the app session level.
877 878 879 880 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 877 def create_presigned_url(params = {}, = {}) req = build_request(:create_presigned_url, params) req.send_request() end |
#create_q_app(params = {}) ⇒ Types::CreateQAppOutput
Creates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1119 def create_q_app(params = {}, = {}) req = build_request(:create_q_app, params) req.send_request() end |
#delete_library_item(params = {}) ⇒ Struct
Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.
1155 1156 1157 1158 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1155 def delete_library_item(params = {}, = {}) req = build_request(:delete_library_item, params) req.send_request() end |
#delete_q_app(params = {}) ⇒ Struct
Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1191 def delete_q_app(params = {}, = {}) req = build_request(:delete_q_app, params) req.send_request() end |
#describe_q_app_permissions(params = {}) ⇒ Types::DescribeQAppPermissionsOutput
Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
1264 1265 1266 1267 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1264 def (params = {}, = {}) req = build_request(:describe_q_app_permissions, params) req.send_request() end |
#disassociate_library_item_review(params = {}) ⇒ Struct
Removes a rating or review previously submitted by the user for a library item.
1300 1301 1302 1303 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1300 def disassociate_library_item_review(params = {}, = {}) req = build_request(:disassociate_library_item_review, params) req.send_request() end |
#disassociate_q_app_from_user(params = {}) ⇒ Struct
Disassociates a Q App from a user removing the user's access to run the Q App.
1336 1337 1338 1339 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1336 def disassociate_q_app_from_user(params = {}, = {}) req = build_request(:disassociate_q_app_from_user, params) req.send_request() end |
#export_q_app_session_data(params = {}) ⇒ Types::ExportQAppSessionDataOutput
Exports the collected data of a Q App data collection session.
1373 1374 1375 1376 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1373 def export_q_app_session_data(params = {}, = {}) req = build_request(:export_q_app_session_data, params) req.send_request() end |
#get_library_item(params = {}) ⇒ Types::GetLibraryItemOutput
Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
1478 1479 1480 1481 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1478 def get_library_item(params = {}, = {}) req = build_request(:get_library_item, params) req.send_request() end |
#get_q_app(params = {}) ⇒ Types::GetQAppOutput
Retrieves the full details of an Q App, including its definition specifying the cards and flow.
1676 1677 1678 1679 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1676 def get_q_app(params = {}, = {}) req = build_request(:get_q_app, params) req.send_request() end |
#get_q_app_session(params = {}) ⇒ Types::GetQAppSessionOutput
Retrieves the current state and results for an active session of an Amazon Q App.
1729 1730 1731 1732 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1729 def get_q_app_session(params = {}, = {}) req = build_request(:get_q_app_session, params) req.send_request() end |
#get_q_app_session_metadata(params = {}) ⇒ Types::GetQAppSessionMetadataOutput
Retrieves the current configuration of a Q App session.
1793 1794 1795 1796 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1793 def (params = {}, = {}) req = build_request(:get_q_app_session_metadata, params) req.send_request() end |
#import_document(params = {}) ⇒ Types::ImportDocumentOutput
Uploads a file that can then be used either as a default in a
FileUploadCard
from Q App definition or as a file that is used
inside a single Q App run. The purpose of the document is determined
by a scope parameter that indicates whether it is at the app
definition level or at the app session level.
1886 1887 1888 1889 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1886 def import_document(params = {}, = {}) req = build_request(:import_document, params) req.send_request() end |
#list_categories(params = {}) ⇒ Types::ListCategoriesOutput
Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.
1950 1951 1952 1953 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1950 def list_categories(params = {}, = {}) req = build_request(:list_categories, params) req.send_request() end |
#list_library_items(params = {}) ⇒ Types::ListLibraryItemsOutput
Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2092 2093 2094 2095 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2092 def list_library_items(params = {}, = {}) req = build_request(:list_library_items, params) req.send_request() end |
#list_q_app_session_data(params = {}) ⇒ Types::ListQAppSessionDataOutput
Lists the collected data of a Q App data collection session.
2135 2136 2137 2138 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2135 def list_q_app_session_data(params = {}, = {}) req = build_request(:list_q_app_session_data, params) req.send_request() end |
#list_q_apps(params = {}) ⇒ Types::ListQAppsOutput
Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2271 2272 2273 2274 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2271 def list_q_apps(params = {}, = {}) req = build_request(:list_q_apps, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags associated with an Amazon Q Apps resource.
2315 2316 2317 2318 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2315 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#predict_q_app(params = {}) ⇒ Types::PredictQAppOutput
Generates an Amazon Q App definition based on either a conversation or
a problem statement provided as input.The resulting app definition can
be used to call CreateQApp
. This API doesn't create Amazon Q Apps
directly.
2438 2439 2440 2441 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2438 def predict_q_app(params = {}, = {}) req = build_request(:predict_q_app, params) req.send_request() end |
#start_q_app_session(params = {}) ⇒ Types::StartQAppSessionOutput
Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.
2527 2528 2529 2530 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2527 def start_q_app_session(params = {}, = {}) req = build_request(:start_q_app_session, params) req.send_request() end |
#stop_q_app_session(params = {}) ⇒ Struct
Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.
2556 2557 2558 2559 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2556 def stop_q_app_session(params = {}, = {}) req = build_request(:stop_q_app_session, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates tags with an Amazon Q Apps resource.
2594 2595 2596 2597 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2594 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Disassociates tags from an Amazon Q Apps resource.
2631 2632 2633 2634 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2631 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_library_item(params = {}) ⇒ Types::UpdateLibraryItemOutput
Updates the library item for an Amazon Q App.
2738 2739 2740 2741 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2738 def update_library_item(params = {}, = {}) req = build_request(:update_library_item, params) req.send_request() end |
#update_library_item_metadata(params = {}) ⇒ Struct
Updates the verification status of a library item for an Amazon Q App.
2778 2779 2780 2781 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2778 def (params = {}, = {}) req = build_request(:update_library_item_metadata, params) req.send_request() end |
#update_q_app(params = {}) ⇒ Types::UpdateQAppOutput
Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
3031 3032 3033 3034 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 3031 def update_q_app(params = {}, = {}) req = build_request(:update_q_app, params) req.send_request() end |
#update_q_app_permissions(params = {}) ⇒ Types::UpdateQAppPermissionsOutput
Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
3156 3157 3158 3159 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 3156 def (params = {}, = {}) req = build_request(:update_q_app_permissions, params) req.send_request() end |
#update_q_app_session(params = {}) ⇒ Types::UpdateQAppSessionOutput
Updates the session for a given Q App sessionId
. This is only valid
when at least one card of the session is in the WAITING
state. Data
for each WAITING
card can be provided as input. If inputs are not
provided, the call will be accepted but session will not move forward.
Inputs for cards that are not in the WAITING
status will be ignored.
3209 3210 3211 3212 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 3209 def update_q_app_session(params = {}, = {}) req = build_request(:update_q_app_session, params) req.send_request() end |
#update_q_app_session_metadata(params = {}) ⇒ Types::UpdateQAppSessionMetadataOutput
Updates the configuration metadata of a session for a given Q App
sessionId
.
3290 3291 3292 3293 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 3290 def (params = {}, = {}) req = build_request(:update_q_app_session_metadata, params) req.send_request() end |