| Class | Description |
|---|---|
| AppDefinition |
The definition of the Q App, specifying the cards and flow.
|
| AppDefinitionInput |
The input for defining an Q App.
|
| AssociateLibraryItemReviewRequest | |
| AssociateLibraryItemReviewResult | |
| AssociateQAppWithUserRequest | |
| AssociateQAppWithUserResult | |
| AttributeFilter |
The filter criteria used on responses based on document attributes or metadata fields.
|
| Card |
A card representing a component or step in an Amazon Q App's flow.
|
| CardInput |
The properties defining an input card in an Amazon Q App.
|
| CardStatus |
The current status and value of a card in an active Amazon Q App session.
|
| CardValue |
The value or result associated with a card in a Amazon Q App session.
|
| Category |
A category used to classify and filter library items for Amazon Q Apps.
|
| ConversationMessage |
A message in a conversation, used as input for generating an Amazon Q App definition.
|
| CreateLibraryItemRequest | |
| CreateLibraryItemResult | |
| CreateQAppRequest | |
| CreateQAppResult | |
| DeleteLibraryItemRequest | |
| DeleteLibraryItemResult | |
| DeleteQAppRequest | |
| DeleteQAppResult | |
| DisassociateLibraryItemReviewRequest | |
| DisassociateLibraryItemReviewResult | |
| DisassociateQAppFromUserRequest | |
| DisassociateQAppFromUserResult | |
| DocumentAttribute |
A document attribute or metadata field.
|
| DocumentAttributeValue |
The value of a document attribute.
|
| FileUploadCard |
A card in an Amazon Q App that allows the user to upload a file.
|
| FileUploadCardInput |
Represents a file upload card.
|
| GetLibraryItemRequest | |
| GetLibraryItemResult | |
| GetQAppRequest | |
| GetQAppResult | |
| GetQAppSessionRequest | |
| GetQAppSessionResult | |
| ImportDocumentRequest | |
| ImportDocumentResult | |
| LibraryItemMember |
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.
|
| ListLibraryItemsRequest | |
| ListLibraryItemsResult | |
| ListQAppsRequest | |
| ListQAppsResult | |
| ListTagsForResourceRequest | |
| ListTagsForResourceResult | |
| PredictAppDefinition |
The definition of an Amazon Q App generated based on input such as a conversation or problem statement.
|
| PredictQAppInputOptions |
The input options for generating an Q App definition.
|
| PredictQAppRequest | |
| PredictQAppResult | |
| QPluginCard |
A card in an Q App that integrates with a third-party plugin or service.
|
| QPluginCardInput |
The input shape for defining a plugin card in an Amazon Q App.
|
| QQueryCard |
A card in a Amazon Q App that generates a response based on the Amazon Q Business service.
|
| QQueryCardInput |
The input shape for defining a query card in an Amazon Q App.
|
| StartQAppSessionRequest | |
| StartQAppSessionResult | |
| StopQAppSessionRequest | |
| StopQAppSessionResult | |
| TagResourceRequest | |
| TagResourceResult | |
| TextInputCard |
A card in an Amazon Q App that allows the user to input text.
|
| TextInputCardInput |
The input shape for defining a text input card in an Amazon Q App.
|
| UntagResourceRequest | |
| UntagResourceResult | |
| UpdateLibraryItemRequest | |
| UpdateLibraryItemResult | |
| UpdateQAppRequest | |
| UpdateQAppResult | |
| UpdateQAppSessionRequest | |
| UpdateQAppSessionResult | |
| UserAppItem |
An Amazon Q App associated with a user, either owned by the user or favorited.
|
| Enum | Description |
|---|---|
| AppRequiredCapability | |
| AppStatus | |
| CardOutputSource | |
| CardType | |
| DocumentScope | |
| ExecutionStatus | |
| LibraryItemStatus | |
| PluginType | |
| Sender |
| Exception | Description |
|---|---|
| AccessDeniedException |
The client is not authorized to perform the requested operation.
|
| AWSQAppsException |
Base exception for all service exceptions thrown by QApps
|
| ConflictException |
The requested operation could not be completed due to a conflict with the current state of the resource.
|
| ContentTooLargeException |
The requested operation could not be completed because the content exceeds the maximum allowed size.
|
| InternalServerException |
An internal service error occurred while processing the request.
|
| ResourceNotFoundException |
The requested resource could not be found.
|
| ServiceQuotaExceededException |
The requested operation could not be completed because it would exceed the service's quota or limit.
|
| ThrottlingException |
The requested operation could not be completed because too many requests were sent at once.
|
| UnauthorizedException |
The client is not authenticated or authorized to perform the requested operation.
|
| ValidationException |
The input failed to satisfy the constraints specified by the service.
|