qapps/aws.sdk.kotlin.services.qapps.model

Package-level declarations

Types

AccessDeniedException

class AccessDeniedException : QAppsException

The client is not authorized to perform the requested operation.

sealed class Action

class AppDefinition

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

AppDefinitionInput

class AppDefinitionInput

The input for defining an Q App.

AppRequiredCapability

sealed class AppRequiredCapability

sealed class AppStatus

AssociateLibraryItemReviewRequest

class AssociateLibraryItemReviewRequest

AssociateLibraryItemReviewResponse

class AssociateLibraryItemReviewResponse

AssociateQAppWithUserRequest

class AssociateQAppWithUserRequest

AssociateQAppWithUserResponse

class AssociateQAppWithUserResponse

AttributeFilter

class AttributeFilter

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

BatchCreateCategoryInputCategory

class BatchCreateCategoryInputCategory

The category object to be created.

BatchCreateCategoryRequest

class BatchCreateCategoryRequest

BatchCreateCategoryResponse

class BatchCreateCategoryResponse

BatchDeleteCategoryRequest

class BatchDeleteCategoryRequest

BatchDeleteCategoryResponse

class BatchDeleteCategoryResponse

BatchUpdateCategoryRequest

class BatchUpdateCategoryRequest

BatchUpdateCategoryResponse

class BatchUpdateCategoryResponse

sealed class Card

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

sealed class CardInput

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

CardOutputSource

sealed class CardOutputSource

class CardStatus

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

sealed class CardType

class CardValue

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.

class CategoryInput

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

ConflictException

class ConflictException : QAppsException

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

ContentTooLargeException

class ContentTooLargeException : QAppsException

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

ConversationMessage

class ConversationMessage

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

CreateLibraryItemRequest

class CreateLibraryItemRequest

CreateLibraryItemResponse

class CreateLibraryItemResponse

CreatePresignedUrlRequest

class CreatePresignedUrlRequest

CreatePresignedUrlResponse

class CreatePresignedUrlResponse

CreateQAppRequest

class CreateQAppRequest

CreateQAppResponse

class CreateQAppResponse

DeleteLibraryItemRequest

class DeleteLibraryItemRequest

DeleteLibraryItemResponse

class DeleteLibraryItemResponse

DeleteQAppRequest

class DeleteQAppRequest

DeleteQAppResponse

class DeleteQAppResponse

DescribeQAppPermissionsRequest

class DescribeQAppPermissionsRequest

DescribeQAppPermissionsResponse

class DescribeQAppPermissionsResponse

DisassociateLibraryItemReviewRequest

class DisassociateLibraryItemReviewRequest

DisassociateLibraryItemReviewResponse

class DisassociateLibraryItemReviewResponse

DisassociateQAppFromUserRequest

class DisassociateQAppFromUserRequest

DisassociateQAppFromUserResponse

class DisassociateQAppFromUserResponse

DocumentAttribute

class DocumentAttribute

A document attribute or metadata field.

DocumentAttributeValue

sealed class DocumentAttributeValue

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

sealed class DocumentScope

ExecutionStatus

sealed class ExecutionStatus

ExportQAppSessionDataRequest

class ExportQAppSessionDataRequest

ExportQAppSessionDataResponse

class ExportQAppSessionDataResponse

class FileUploadCard

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

FileUploadCardInput

class FileUploadCardInput

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.

class FormInputCard

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

FormInputCardInput

class FormInputCardInput

Represents a form input card for an Amazon Q App.

FormInputCardMetadata

class FormInputCardMetadata

The metadata of the form input card.

GetLibraryItemRequest

class GetLibraryItemRequest

GetLibraryItemResponse

class GetLibraryItemResponse

class GetQAppRequest

GetQAppResponse

class GetQAppResponse

GetQAppSessionMetadataRequest

class GetQAppSessionMetadataRequest

GetQAppSessionMetadataResponse

class GetQAppSessionMetadataResponse

GetQAppSessionRequest

class GetQAppSessionRequest

GetQAppSessionResponse

class GetQAppSessionResponse

ImportDocumentRequest

class ImportDocumentRequest

ImportDocumentResponse

class ImportDocumentResponse

InputCardComputeMode

sealed class InputCardComputeMode

InternalServerException

class InternalServerException : QAppsException

An internal service error occurred while processing the request.

LibraryItemMember

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

LibraryItemStatus

sealed class LibraryItemStatus

ListCategoriesRequest

class ListCategoriesRequest

ListCategoriesResponse

class ListCategoriesResponse

ListLibraryItemsRequest

class ListLibraryItemsRequest

ListLibraryItemsResponse

class ListLibraryItemsResponse

ListQAppSessionDataRequest

class ListQAppSessionDataRequest

ListQAppSessionDataResponse

class ListQAppSessionDataResponse

ListQAppsRequest

class ListQAppsRequest

ListQAppsResponse

class ListQAppsResponse

ListTagsForResourceRequest

class ListTagsForResourceRequest

ListTagsForResourceResponse

class ListTagsForResourceResponse

PermissionInput

class PermissionInput

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

PermissionOutput

class PermissionOutput

The permission granted to the Amazon Q App.

sealed class PluginType

PredictAppDefinition

class PredictAppDefinition

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

PredictQAppInputOptions

sealed class PredictQAppInputOptions

The input options for generating an Q App definition.

PredictQAppRequest

class PredictQAppRequest

PredictQAppResponse

class PredictQAppResponse

PrincipalOutput

class PrincipalOutput

The principal for which the permission applies.

QAppSessionData

class QAppSessionData

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

open class QAppsException : AwsServiceException

Base class for all service related exceptions thrown by the QApps client

class QPluginCard

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

QPluginCardInput

class QPluginCardInput

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

class QQueryCard

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

QQueryCardInput

class QQueryCardInput

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

ResourceNotFoundException

class ResourceNotFoundException : QAppsException

The requested resource could not be found.

sealed class Sender

ServiceQuotaExceededException

class ServiceQuotaExceededException : QAppsException

The requested operation could not be completed because it would exceed the service's quota or limit.

SessionSharingConfiguration

class SessionSharingConfiguration

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

StartQAppSessionRequest

class StartQAppSessionRequest

StartQAppSessionResponse

class StartQAppSessionResponse

StopQAppSessionRequest

class StopQAppSessionRequest

StopQAppSessionResponse

class StopQAppSessionResponse

class Submission

A record created when a user submits a form card.

SubmissionMutation

class SubmissionMutation

Represents an action performed on a submission.

SubmissionMutationKind

sealed class SubmissionMutationKind

TagResourceRequest

class TagResourceRequest

TagResourceResponse

class TagResourceResponse

class TextInputCard

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

TextInputCardInput

class TextInputCardInput

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

ThrottlingException

class ThrottlingException : QAppsException

The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.

UnauthorizedException

class UnauthorizedException : QAppsException

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

UntagResourceRequest

class UntagResourceRequest

UntagResourceResponse

class UntagResourceResponse

UpdateLibraryItemMetadataRequest

class UpdateLibraryItemMetadataRequest

UpdateLibraryItemMetadataResponse

class UpdateLibraryItemMetadataResponse

UpdateLibraryItemRequest

class UpdateLibraryItemRequest

UpdateLibraryItemResponse

class UpdateLibraryItemResponse

UpdateQAppPermissionsRequest

class UpdateQAppPermissionsRequest

UpdateQAppPermissionsResponse

class UpdateQAppPermissionsResponse

UpdateQAppRequest

class UpdateQAppRequest

UpdateQAppResponse

class UpdateQAppResponse

UpdateQAppSessionMetadataRequest

class UpdateQAppSessionMetadataRequest

UpdateQAppSessionMetadataResponse

class UpdateQAppSessionMetadataResponse

UpdateQAppSessionRequest

class UpdateQAppSessionRequest

UpdateQAppSessionResponse

class UpdateQAppSessionResponse

class User

A user of an Amazon Q App.

class UserAppItem

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

sealed class UserType

ValidationException

class ValidationException : QAppsException

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