Module Awso_qapps.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule String_ : sig ... end
Sourcemodule AccessDeniedException : sig ... end

The client is not authorized to perform the requested operation.

Sourcemodule ActionIdentifier : sig ... end
Sourcemodule AmazonResourceName : sig ... end
Sourcemodule AppArn : sig ... end
Sourcemodule UUID : sig ... end
Sourcemodule Title : sig ... end
Sourcemodule Placeholder : sig ... end
Sourcemodule DependencyList : sig ... end
Sourcemodule Default : sig ... end
Sourcemodule CardType : sig ... end
Sourcemodule TextInputCard : sig ... end

A card in an Amazon Q App that allows the user to input text.

Sourcemodule Prompt : sig ... end
Sourcemodule MemoryReferenceList : sig ... end
Sourcemodule CardOutputSource : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule Long : sig ... end
Sourcemodule PlatoString : sig ... end
Sourcemodule DocumentAttributeValue : sig ... end

The value of a document attribute. You can only provide one value for a document attribute.

Sourcemodule DocumentAttributeKey : sig ... end
Sourcemodule DocumentAttribute : sig ... end

A document attribute or metadata field.

module AttributeFilter : sig ... end

The filter criteria used on responses based on document attributes or metadata fields.

module AttributeFilters : sig ... end
Sourcemodule QQueryCard : sig ... end

A card in a Amazon Q App that generates a response based on the Amazon Q Business service.

Sourcemodule PluginType : sig ... end
Sourcemodule QPluginCard : sig ... end

A card in an Q App that integrates with a third-party plugin or service.

Sourcemodule InputCardComputeMode : sig ... end
Sourcemodule FormInputCardMetadata : sig ... end

The metadata of the form input card.

Sourcemodule FormInputCard : sig ... end

A card in an Amazon Q App that allows the user to submit a response.

Sourcemodule Boolean : sig ... end
Sourcemodule FileUploadCard : sig ... end

A card in an Amazon Q App that allows the user to upload a file.

Sourcemodule Card : sig ... end

A card representing a component or step in an Amazon Q App's flow.

Sourcemodule CardModelList : sig ... end
Sourcemodule AppDefinition : sig ... end

The definition of the Q App, specifying the cards and flow.

Sourcemodule InitialPrompt : sig ... end
Sourcemodule TextInputCardInput : sig ... end

The input shape for defining a text input card in an Amazon Q App.

Sourcemodule QQueryCardInput : sig ... end

The input shape for defining a query card in an Amazon Q App.

Sourcemodule PluginId : sig ... end
Sourcemodule QPluginCardInput : sig ... end

The input shape for defining a plugin card in an Amazon Q App.

Sourcemodule FormInputCardInput : sig ... end

Represents a form input card for an Amazon Q App.

Sourcemodule Filename : sig ... end
Sourcemodule FileUploadCardInput : sig ... end

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.

Sourcemodule CardInput : sig ... end

The properties defining an input card in an Amazon Q App.

Sourcemodule CardList : sig ... end
Sourcemodule AppDefinitionInput : sig ... end

The input for defining an Q App.

Sourcemodule AppRequiredCapability : sig ... end
Sourcemodule AppRequiredCapabilities : sig ... end
Sourcemodule AppStatus : sig ... end
Sourcemodule AppVersion : sig ... end
Sourcemodule InstanceId : sig ... end

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.

The category object to be created.

Sourcemodule BatchCreateCategoryInput : sig ... end

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.

Sourcemodule DeleteCategoryInputList : sig ... end
Sourcemodule BatchDeleteCategoryInput : sig ... end

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.

Sourcemodule CategoryInputTitleString : sig ... end
Sourcemodule CategoryInputColorString : sig ... end
Sourcemodule CategoryInput : sig ... end

A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.

Sourcemodule CategoryListInput : sig ... end
Sourcemodule BatchUpdateCategoryInput : sig ... end

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.

Sourcemodule QAppsTimestamp : sig ... end
Sourcemodule Document : sig ... end
Sourcemodule Submission : sig ... end

A record created when a user submits a form card.

Sourcemodule SubmissionList : sig ... end
Sourcemodule ExecutionStatus : sig ... end
Sourcemodule CardStatus : sig ... end

The current status and value of a card in an active Amazon Q App session.

Sourcemodule CardStatusMap : sig ... end
Sourcemodule SubmissionMutationKind : sig ... end
Sourcemodule SubmissionMutation : sig ... end

Represents an action performed on a submission.

Sourcemodule CardValueValueString : sig ... end
Sourcemodule CardValue : sig ... end

The value or result associated with a card in a Amazon Q App session.

Sourcemodule CardValueList : sig ... end
Sourcemodule Integer : sig ... end
Sourcemodule Category : sig ... end

A category used to classify and filter library items for Amazon Q Apps.

Sourcemodule CategoriesList : sig ... end
Sourcemodule CategoryIdList : sig ... end
Sourcemodule CategoryList : sig ... end
Sourcemodule ConflictException : sig ... end

The requested operation could not be completed due to a conflict with the current state of the resource.

Sourcemodule ContentTooLargeException : sig ... end

The requested operation could not be completed because the content exceeds the maximum allowed size.

Sourcemodule Sender : sig ... end
Sourcemodule ConversationMessage : sig ... end

A message in a conversation, used as input for generating an Amazon Q App definition.

Sourcemodule CreateLibraryItemInput : sig ... end

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.

Sourcemodule ValidationException : sig ... end

The input failed to satisfy the constraints specified by the service.

Sourcemodule UnauthorizedException : sig ... end

The client is not authenticated or authorized to perform the requested operation.

Sourcemodule ThrottlingException : sig ... end

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.

Sourcemodule ResourceNotFoundException : sig ... end

The requested resource could not be found.

Sourcemodule InternalServerException : sig ... end

An internal service error occurred while processing the request.

Sourcemodule CreateLibraryItemOutput : sig ... end

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.

Sourcemodule DocumentScope : sig ... end
Sourcemodule CreatePresignedUrlInput : sig ... end

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.

Sourcemodule PresignedUrlFields : sig ... end
Sourcemodule CreatePresignedUrlOutput : sig ... end

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.

Sourcemodule TagMap : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule CreateQAppInput : sig ... end

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.

Sourcemodule CreateQAppOutput : sig ... end

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.

Sourcemodule DeleteLibraryItemInput : sig ... end

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.

Sourcemodule DeleteQAppInput : sig ... end

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.

Sourcemodule PrincipalOutput : sig ... end

The principal for which the permission applies.

Sourcemodule PermissionOutput : sig ... end

The permission granted to the Amazon Q App.

Sourcemodule PermissionsOutputList : sig ... end

Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.

Removes 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.

Sourcemodule GetLibraryItemInput : sig ... end

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

Sourcemodule GetLibraryItemOutput : sig ... end

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

Sourcemodule GetQAppInput : sig ... end

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

Sourcemodule GetQAppOutput : sig ... end

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

Sourcemodule GetQAppSessionInput : sig ... end

Retrieves the current state and results for an active session of an Amazon Q App.

Retrieves the current configuration of a Q App session.

Sourcemodule SessionSharingRevealCards : sig ... end
Sourcemodule SessionSharingEnabled : sig ... end

The sharing configuration of an Amazon Q App data collection session.

Sourcemodule SessionName : sig ... end

Retrieves the current configuration of a Q App session.

Sourcemodule GetQAppSessionOutput : sig ... end

Retrieves the current state and results for an active session of an Amazon Q App.

Sourcemodule ImportDocumentInput : sig ... end

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.

Sourcemodule ImportDocumentOutput : sig ... end

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.

Sourcemodule LibraryItemMember : sig ... end

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.

Sourcemodule LibraryItemList : sig ... end
Sourcemodule LibraryItemStatus : sig ... end
Sourcemodule ListCategoriesInput : sig ... end

Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

Sourcemodule ListCategoriesOutput : sig ... end

Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

Sourcemodule PaginationToken : sig ... end
Sourcemodule PageLimit : sig ... end
Sourcemodule ListLibraryItemsInput : sig ... end

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

Sourcemodule ListLibraryItemsOutput : sig ... end

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

Sourcemodule ListQAppSessionDataInput : sig ... end

Lists the collected data of a Q App data collection session.

Sourcemodule UserId : sig ... end
Sourcemodule User : sig ... end

A user of an Amazon Q App.

Sourcemodule QAppSessionData : sig ... end

The response collected for a Amazon Q App session. This container represents a single response to a Q App session.

Sourcemodule QAppSessionDataList : sig ... end
Sourcemodule ListQAppSessionDataOutput : sig ... end

Lists the collected data of a Q App data collection session.

Sourcemodule ListQAppsInput : sig ... end

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..

Sourcemodule UserAppItem : sig ... end

An Amazon Q App associated with a user, either owned by the user or favorited.

Sourcemodule UserAppsList : sig ... end
Sourcemodule ListQAppsOutput : sig ... end

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.

Sourcemodule TagValue : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule Tags : sig ... end

Lists the tags associated with an Amazon Q Apps resource.

Sourcemodule PermissionInputActionEnum : sig ... end
Sourcemodule PermissionInput : sig ... end

The permission to grant or revoke for a Amazon Q App.

Sourcemodule PredictAppDefinition : sig ... end

The definition of an Amazon Q App generated based on input such as a conversation or problem statement.

Sourcemodule PredictQAppInputOptions : sig ... end

The input options for generating an Q App definition.

Sourcemodule PredictQAppInput : sig ... end

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.

Sourcemodule PredictQAppOutput : sig ... end

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.

Sourcemodule StartQAppSessionInput : sig ... end

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.

Sourcemodule StartQAppSessionOutput : sig ... end

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.

Sourcemodule StopQAppSessionInput : sig ... end

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.

Sourcemodule TagKeys : sig ... end
Sourcemodule TagResourceRequest : sig ... end

Associates tags with an Amazon Q Apps resource.

Sourcemodule TagResourceResponse : sig ... end

Associates tags with an Amazon Q Apps resource.

Sourcemodule UntagResourceRequest : sig ... end

Disassociates tags from an Amazon Q Apps resource.

Sourcemodule UntagResourceResponse : sig ... end

Disassociates tags from an Amazon Q Apps resource.

Sourcemodule UpdateLibraryItemInput : sig ... end

Updates the library item for an Amazon Q App.

Updates the verification status of a library item for an Amazon Q App.

Sourcemodule UpdateLibraryItemOutput : sig ... end

Updates the library item for an Amazon Q App.

Sourcemodule UpdateQAppInput : sig ... end

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

Sourcemodule UpdateQAppOutput : sig ... end

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

Updates 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.

Sourcemodule UpdateQAppSessionInput : sig ... end

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.

Sourcemodule UpdateQAppSessionOutput : sig ... end

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.