Awso_qapps_syncSourceval associate_library_item_review :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.AssociateLibraryItemReviewInput.t ->
(unit, unit) Result.tval associate_q_app_with_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.AssociateQAppWithUserInput.t ->
(unit, unit) Result.tval batch_create_category :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.BatchCreateCategoryInput.t ->
(unit, unit) Result.tval batch_delete_category :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.BatchDeleteCategoryInput.t ->
(unit, unit) Result.tval batch_update_category :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.BatchUpdateCategoryInput.t ->
(unit, unit) Result.tval create_library_item :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.CreateLibraryItemInput.t ->
(Awso_qapps.Values.CreateLibraryItemOutput.t,
Awso_qapps.Values.CreateLibraryItemOutput.error)
Result.tval create_presigned_url :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.CreatePresignedUrlInput.t ->
(Awso_qapps.Values.CreatePresignedUrlOutput.t,
Awso_qapps.Values.CreatePresignedUrlOutput.error)
Result.tval create_q_app :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.CreateQAppInput.t ->
(Awso_qapps.Values.CreateQAppOutput.t,
Awso_qapps.Values.CreateQAppOutput.error)
Result.tval delete_library_item :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.DeleteLibraryItemInput.t ->
(unit, unit) Result.tval delete_q_app :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.DeleteQAppInput.t ->
(unit, unit) Result.tval describe_q_app_permissions :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.DescribeQAppPermissionsInput.t ->
(Awso_qapps.Values.DescribeQAppPermissionsOutput.t,
Awso_qapps.Values.DescribeQAppPermissionsOutput.error)
Result.tval disassociate_library_item_review :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.DisassociateLibraryItemReviewInput.t ->
(unit, unit) Result.tval disassociate_q_app_from_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.DisassociateQAppFromUserInput.t ->
(unit, unit) Result.tval export_q_app_session_data :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.ExportQAppSessionDataInput.t ->
(Awso_qapps.Values.ExportQAppSessionDataOutput.t,
Awso_qapps.Values.ExportQAppSessionDataOutput.error)
Result.tval get_library_item :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.GetLibraryItemInput.t ->
(Awso_qapps.Values.GetLibraryItemOutput.t,
Awso_qapps.Values.GetLibraryItemOutput.error)
Result.tval get_q_app :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.GetQAppInput.t ->
(Awso_qapps.Values.GetQAppOutput.t, Awso_qapps.Values.GetQAppOutput.error)
Result.tval get_q_app_session :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.GetQAppSessionInput.t ->
(Awso_qapps.Values.GetQAppSessionOutput.t,
Awso_qapps.Values.GetQAppSessionOutput.error)
Result.tval get_q_app_session_metadata :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.GetQAppSessionMetadataInput.t ->
(Awso_qapps.Values.GetQAppSessionMetadataOutput.t,
Awso_qapps.Values.GetQAppSessionMetadataOutput.error)
Result.tval import_document :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.ImportDocumentInput.t ->
(Awso_qapps.Values.ImportDocumentOutput.t,
Awso_qapps.Values.ImportDocumentOutput.error)
Result.tval list_categories :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.ListCategoriesInput.t ->
(Awso_qapps.Values.ListCategoriesOutput.t,
Awso_qapps.Values.ListCategoriesOutput.error)
Result.tval list_library_items :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.ListLibraryItemsInput.t ->
(Awso_qapps.Values.ListLibraryItemsOutput.t,
Awso_qapps.Values.ListLibraryItemsOutput.error)
Result.tval list_q_app_session_data :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.ListQAppSessionDataInput.t ->
(Awso_qapps.Values.ListQAppSessionDataOutput.t,
Awso_qapps.Values.ListQAppSessionDataOutput.error)
Result.tval list_q_apps :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.ListQAppsInput.t ->
(Awso_qapps.Values.ListQAppsOutput.t,
Awso_qapps.Values.ListQAppsOutput.error)
Result.tval list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.ListTagsForResourceRequest.t ->
(Awso_qapps.Values.ListTagsForResourceResponse.t,
Awso_qapps.Values.ListTagsForResourceResponse.error)
Result.tval predict_q_app :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.PredictQAppInput.t ->
(Awso_qapps.Values.PredictQAppOutput.t,
Awso_qapps.Values.PredictQAppOutput.error)
Result.tval start_q_app_session :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.StartQAppSessionInput.t ->
(Awso_qapps.Values.StartQAppSessionOutput.t,
Awso_qapps.Values.StartQAppSessionOutput.error)
Result.tval stop_q_app_session :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.StopQAppSessionInput.t ->
(unit, unit) Result.tval tag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.TagResourceRequest.t ->
(Awso_qapps.Values.TagResourceResponse.t,
Awso_qapps.Values.TagResourceResponse.error)
Result.tval untag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.UntagResourceRequest.t ->
(Awso_qapps.Values.UntagResourceResponse.t,
Awso_qapps.Values.UntagResourceResponse.error)
Result.tval update_library_item :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.UpdateLibraryItemInput.t ->
(Awso_qapps.Values.UpdateLibraryItemOutput.t,
Awso_qapps.Values.UpdateLibraryItemOutput.error)
Result.tval update_library_item_metadata :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.UpdateLibraryItemMetadataInput.t ->
(unit, unit) Result.tval update_q_app :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.UpdateQAppInput.t ->
(Awso_qapps.Values.UpdateQAppOutput.t,
Awso_qapps.Values.UpdateQAppOutput.error)
Result.tval update_q_app_permissions :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.UpdateQAppPermissionsInput.t ->
(Awso_qapps.Values.UpdateQAppPermissionsOutput.t,
Awso_qapps.Values.UpdateQAppPermissionsOutput.error)
Result.tval update_q_app_session :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.UpdateQAppSessionInput.t ->
(Awso_qapps.Values.UpdateQAppSessionOutput.t,
Awso_qapps.Values.UpdateQAppSessionOutput.error)
Result.tval update_q_app_session_metadata :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_qapps.Values.UpdateQAppSessionMetadataInput.t ->
(Awso_qapps.Values.UpdateQAppSessionMetadataOutput.t,
Awso_qapps.Values.UpdateQAppSessionMetadataOutput.error)
Result.tinclude module type of struct include Awso_qapps.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]The client is not authorized to perform the requested operation.
A card in an Amazon Q App that allows the user to input text.
module DocumentAttributeValueStringValueString =
Awso_qapps.Values.DocumentAttributeValueStringValueStringThe value of a document attribute. You can only provide one value for a document attribute.
A document attribute or metadata field.
module AttributeFilter = Awso_qapps.Values.AttributeFilterThe filter criteria used on responses based on document attributes or metadata fields.
module AttributeFilters = Awso_qapps.Values.AttributeFiltersA card in a Amazon Q App that generates a response based on the Amazon Q Business service.
A card in an Q App that integrates with a third-party plugin or service.
The metadata of the form input card.
A card in an Amazon Q App that allows the user to submit a response.
A card in an Amazon Q App that allows the user to upload a file.
A card representing a component or step in an Amazon Q App's flow.
The definition of the Q App, specifying the cards and flow.
The input shape for defining a text input card in an Amazon Q App.
The input shape for defining a query card in an Amazon Q App.
The input shape for defining a plugin card in an Amazon Q App.
Represents a form input card for an Amazon Q App.
Represents a file upload card. It can optionally receive a filename and fileId to set a default file. If not received, the user must provide the file when the Q App runs.
The properties defining an input card in an Amazon Q App.
The input for defining an Q App.
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.
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.
module BatchCreateCategoryInputCategoryTitleString =
Awso_qapps.Values.BatchCreateCategoryInputCategoryTitleStringmodule BatchCreateCategoryInputCategoryColorString =
Awso_qapps.Values.BatchCreateCategoryInputCategoryColorStringThe category object to be created.
module BatchCreateCategoryInputCategoryList =
Awso_qapps.Values.BatchCreateCategoryInputCategoryListCreates 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.
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.
A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.
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.
A record created when a user submits a form card.
The current status and value of a card in an active Amazon Q App session.
Represents an action performed on a submission.
The value or result associated with a card in a Amazon Q App session.
A category used to classify and filter library items for Amazon Q Apps.
The requested operation could not be completed due to a conflict with the current state of the resource.
The requested operation could not be completed because the content exceeds the maximum allowed size.
A message in a conversation, used as input for generating an Amazon Q App definition.
Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
The input failed to satisfy the constraints specified by the service.
The client is not authenticated or authorized to perform the requested operation.
The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
The requested operation could not be completed because it would exceed the service's quota or limit.
The requested resource could not be found.
An internal service error occurred while processing the request.
Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
module CreatePresignedUrlInputFileContentsSha256String =
Awso_qapps.Values.CreatePresignedUrlInputFileContentsSha256StringCreates 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. The IAM permissions are derived from the qapps:ImportDocument action. For more information on the IAM policy for Amazon Q Apps, see IAM permissions for using Amazon Q Apps.
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. The IAM permissions are derived from the qapps:ImportDocument action. For more information on the IAM policy for Amazon Q Apps, see IAM permissions for using Amazon Q Apps.
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.
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.
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.
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.
Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
The principal for which the permission applies.
The permission granted to the Amazon Q App.
Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
module DisassociateLibraryItemReviewInput =
Awso_qapps.Values.DisassociateLibraryItemReviewInputRemoves a rating or review previously submitted by the user for a library item.
Disassociates a Q App from a user removing the user's access to run the Q App.
Exports the collected data of a Q App data collection session.
Exports the collected data of a Q App data collection session.
Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
Retrieves the full details of an Q App, including its definition specifying the cards and flow.
Retrieves the full details of an Q App, including its definition specifying the cards and flow.
Retrieves the current state and results for an active session of an Amazon Q App.
Retrieves the current configuration of a Q App session.
The sharing configuration of an Amazon Q App data collection session.
Retrieves the current configuration of a Q App session.
Retrieves the current state and results for an active session of an Amazon Q App.
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.
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.
A library item is a snapshot of an Amazon Q App that can be published so the users in their Amazon Q Apps library can discover it, clone it, and run it.
Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.
Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.
Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
Lists the collected data of a Q App data collection session.
A user of an Amazon Q App.
The response collected for a Amazon Q App session. This container represents a single response to a Q App session.
Lists the collected data of a Q App data collection session.
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..
An Amazon Q App associated with a user, either owned by the user or favorited.
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..
Lists the tags associated with an Amazon Q Apps resource.
Lists the tags associated with an Amazon Q Apps resource.
The permission to grant or revoke for a Amazon Q App.
The definition of an Amazon Q App generated based on input such as a conversation or problem statement.
module PredictQAppInputOptionsProblemStatementString =
Awso_qapps.Values.PredictQAppInputOptionsProblemStatementStringmodule PredictQAppInputOptionsConversationList =
Awso_qapps.Values.PredictQAppInputOptionsConversationListThe input options for generating an Q App definition.
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.
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.
Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run. Each Q App session will be condensed into a single conversation in the web experience.
Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run. Each Q App session will be condensed into a single conversation in the web experience.
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.
Associates tags with an Amazon Q Apps resource.
Associates tags with an Amazon Q Apps resource.
Disassociates tags from an Amazon Q Apps resource.
Disassociates tags from an Amazon Q Apps resource.
Updates the library item for an Amazon Q App.
Updates the verification status of a library item for an Amazon Q App.
Updates the library item for an Amazon Q App.
Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
module UpdateQAppPermissionsInputRevokePermissionsList =
Awso_qapps.Values.UpdateQAppPermissionsInputRevokePermissionsListmodule UpdateQAppPermissionsInputGrantPermissionsList =
Awso_qapps.Values.UpdateQAppPermissionsInputGrantPermissionsListUpdates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
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.
Updates the configuration metadata of a session for a given Q App sessionId.
Updates the configuration metadata of a session for a given Q App sessionId.
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.