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.
-
#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_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.
-
#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.
-
#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.
-
#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_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_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_session(params = {}) ⇒ Types::UpdateQAppSessionOutput
Updates the 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 |
#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.
602 603 604 605 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 602 def create_library_item(params = {}, = {}) req = build_request(:create_library_item, 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.
833 834 835 836 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 833 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.
869 870 871 872 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 869 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.
905 906 907 908 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 905 def delete_q_app(params = {}, = {}) req = build_request(:delete_q_app, 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.
941 942 943 944 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 941 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.
977 978 979 980 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 977 def disassociate_q_app_from_user(params = {}, = {}) req = build_request(:disassociate_q_app_from_user, 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.
1080 1081 1082 1083 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1080 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.
1265 1266 1267 1268 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1265 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.
1332 1333 1334 1335 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1332 def get_q_app_session(params = {}, = {}) req = build_request(:get_q_app_session, 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.
1426 1427 1428 1429 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1426 def import_document(params = {}, = {}) req = build_request(:import_document, 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.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1566 def list_library_items(params = {}, = {}) req = build_request(:list_library_items, 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.
1702 1703 1704 1705 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1702 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.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1746 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.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1864 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.
1945 1946 1947 1948 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1945 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.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 1974 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.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2012 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.
2049 2050 2051 2052 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2049 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.
2154 2155 2156 2157 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2154 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.
2194 2195 2196 2197 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2194 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.
2436 2437 2438 2439 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2436 def update_q_app(params = {}, = {}) req = build_request(:update_q_app, 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.
2485 2486 2487 2488 |
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/client.rb', line 2485 def update_q_app_session(params = {}, = {}) req = build_request(:update_q_app_session, params) req.send_request() end |