Skip to content

Type definitions#

Index > QApps > Type definitions

Auto-generated documentation for QApps type annotations stubs module mypy-boto3-qapps.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

FormInputCardMetadataUnionTypeDef#

# FormInputCardMetadataUnionTypeDef definition

FormInputCardMetadataUnionTypeDef = Union[
    FormInputCardMetadataTypeDef,  # (1)
    FormInputCardMetadataOutputTypeDef,  # (2)
]
  1. See FormInputCardMetadataTypeDef
  2. See FormInputCardMetadataOutputTypeDef

DocumentAttributeValueUnionTypeDef#

# DocumentAttributeValueUnionTypeDef definition

DocumentAttributeValueUnionTypeDef = Union[
    DocumentAttributeValueTypeDef,  # (1)
    DocumentAttributeValueOutputTypeDef,  # (2)
]
  1. See DocumentAttributeValueTypeDef
  2. See DocumentAttributeValueOutputTypeDef

FormInputCardInputUnionTypeDef#

# FormInputCardInputUnionTypeDef definition

FormInputCardInputUnionTypeDef = Union[
    FormInputCardInputTypeDef,  # (1)
    FormInputCardInputOutputTypeDef,  # (2)
]
  1. See FormInputCardInputTypeDef
  2. See FormInputCardInputOutputTypeDef

DocumentAttributeUnionTypeDef#

# DocumentAttributeUnionTypeDef definition

DocumentAttributeUnionTypeDef = Union[
    DocumentAttributeTypeDef,  # (1)
    DocumentAttributeOutputTypeDef,  # (2)
]
  1. See DocumentAttributeTypeDef
  2. See DocumentAttributeOutputTypeDef

AttributeFilterUnionTypeDef#

# AttributeFilterUnionTypeDef definition

AttributeFilterUnionTypeDef = Union[
    AttributeFilterTypeDef,  # (1)
    AttributeFilterOutputTypeDef,  # (2)
]
  1. See AttributeFilterTypeDef
  2. See AttributeFilterOutputTypeDef

QQueryCardInputUnionTypeDef#

# QQueryCardInputUnionTypeDef definition

QQueryCardInputUnionTypeDef = Union[
    QQueryCardInputTypeDef,  # (1)
    QQueryCardInputOutputTypeDef,  # (2)
]
  1. See QQueryCardInputTypeDef
  2. See QQueryCardInputOutputTypeDef

CardInputUnionTypeDef#

# CardInputUnionTypeDef definition

CardInputUnionTypeDef = Union[
    CardInputTypeDef,  # (1)
    CardInputOutputTypeDef,  # (2)
]
  1. See CardInputTypeDef
  2. See CardInputOutputTypeDef

AssociateLibraryItemReviewInputRequestTypeDef#

# AssociateLibraryItemReviewInputRequestTypeDef definition

class AssociateLibraryItemReviewInputRequestTypeDef(TypedDict):
    instanceId: str,
    libraryItemId: str,

AssociateQAppWithUserInputRequestTypeDef#

# AssociateQAppWithUserInputRequestTypeDef definition

class AssociateQAppWithUserInputRequestTypeDef(TypedDict):
    instanceId: str,
    appId: str,

BatchCreateCategoryInputCategoryTypeDef#

# BatchCreateCategoryInputCategoryTypeDef definition

class BatchCreateCategoryInputCategoryTypeDef(TypedDict):
    title: str,
    id: NotRequired[str],
    color: NotRequired[str],

BatchDeleteCategoryInputRequestTypeDef#

# BatchDeleteCategoryInputRequestTypeDef definition

class BatchDeleteCategoryInputRequestTypeDef(TypedDict):
    instanceId: str,
    categories: Sequence[str],

CategoryInputTypeDef#

# CategoryInputTypeDef definition

class CategoryInputTypeDef(TypedDict):
    id: str,
    title: str,
    color: NotRequired[str],

FileUploadCardInputTypeDef#

# FileUploadCardInputTypeDef definition

class FileUploadCardInputTypeDef(TypedDict):
    title: str,
    id: str,
    type: CardTypeType,  # (1)
    filename: NotRequired[str],
    fileId: NotRequired[str],
    allowOverride: NotRequired[bool],
  1. See CardTypeType

QPluginCardInputTypeDef#

# QPluginCardInputTypeDef definition

class QPluginCardInputTypeDef(TypedDict):
    title: str,
    id: str,
    type: CardTypeType,  # (1)
    prompt: str,
    pluginId: str,
    actionIdentifier: NotRequired[str],
  1. See CardTypeType

TextInputCardInputTypeDef#

# TextInputCardInputTypeDef definition

class TextInputCardInputTypeDef(TypedDict):
    title: str,
    id: str,
    type: CardTypeType,  # (1)
    placeholder: NotRequired[str],
    defaultValue: NotRequired[str],
  1. See CardTypeType

SubmissionTypeDef#

# SubmissionTypeDef definition

class SubmissionTypeDef(TypedDict):
    value: NotRequired[dict[str, Any]],
    submissionId: NotRequired[str],
    timestamp: NotRequired[datetime],

FileUploadCardTypeDef#

# FileUploadCardTypeDef definition

class FileUploadCardTypeDef(TypedDict):
    id: str,
    title: str,
    dependencies: list[str],
    type: CardTypeType,  # (1)
    filename: NotRequired[str],
    fileId: NotRequired[str],
    allowOverride: NotRequired[bool],
  1. See CardTypeType

QPluginCardTypeDef#

# QPluginCardTypeDef definition

class QPluginCardTypeDef(TypedDict):
    id: str,
    title: str,
    dependencies: list[str],
    type: CardTypeType,  # (1)
    prompt: str,
    pluginType: PluginTypeType,  # (2)
    pluginId: str,
    actionIdentifier: NotRequired[str],
  1. See CardTypeType
  2. See PluginTypeType

TextInputCardTypeDef#

# TextInputCardTypeDef definition

class TextInputCardTypeDef(TypedDict):
    id: str,
    title: str,
    dependencies: list[str],
    type: CardTypeType,  # (1)
    placeholder: NotRequired[str],
    defaultValue: NotRequired[str],
  1. See CardTypeType

SubmissionMutationTypeDef#

# SubmissionMutationTypeDef definition

class SubmissionMutationTypeDef(TypedDict):
    submissionId: str,
    mutationType: SubmissionMutationKindType,  # (1)
  1. See SubmissionMutationKindType

CategoryTypeDef#

# CategoryTypeDef definition

class CategoryTypeDef(TypedDict):
    id: str,
    title: str,
    color: NotRequired[str],
    appCount: NotRequired[int],

ConversationMessageTypeDef#

# ConversationMessageTypeDef definition

class ConversationMessageTypeDef(TypedDict):
    body: str,
    type: SenderType,  # (1)
  1. See SenderType

CreateLibraryItemInputRequestTypeDef#

# CreateLibraryItemInputRequestTypeDef definition

class CreateLibraryItemInputRequestTypeDef(TypedDict):
    instanceId: str,
    appId: str,
    appVersion: int,
    categories: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreatePresignedUrlInputRequestTypeDef#

# CreatePresignedUrlInputRequestTypeDef definition

class CreatePresignedUrlInputRequestTypeDef(TypedDict):
    instanceId: str,
    cardId: str,
    appId: str,
    fileContentsSha256: str,
    fileName: str,
    scope: DocumentScopeType,  # (1)
    sessionId: NotRequired[str],
  1. See DocumentScopeType

DeleteLibraryItemInputRequestTypeDef#

# DeleteLibraryItemInputRequestTypeDef definition

class DeleteLibraryItemInputRequestTypeDef(TypedDict):
    instanceId: str,
    libraryItemId: str,

DeleteQAppInputRequestTypeDef#

# DeleteQAppInputRequestTypeDef definition

class DeleteQAppInputRequestTypeDef(TypedDict):
    instanceId: str,
    appId: str,

DescribeQAppPermissionsInputRequestTypeDef#

# DescribeQAppPermissionsInputRequestTypeDef definition

class DescribeQAppPermissionsInputRequestTypeDef(TypedDict):
    instanceId: str,
    appId: str,

DisassociateLibraryItemReviewInputRequestTypeDef#

# DisassociateLibraryItemReviewInputRequestTypeDef definition

class DisassociateLibraryItemReviewInputRequestTypeDef(TypedDict):
    instanceId: str,
    libraryItemId: str,

DisassociateQAppFromUserInputRequestTypeDef#

# DisassociateQAppFromUserInputRequestTypeDef definition

class DisassociateQAppFromUserInputRequestTypeDef(TypedDict):
    instanceId: str,
    appId: str,

DocumentAttributeValueOutputTypeDef#

# DocumentAttributeValueOutputTypeDef definition

class DocumentAttributeValueOutputTypeDef(TypedDict):
    stringValue: NotRequired[str],
    stringListValue: NotRequired[list[str]],
    longValue: NotRequired[int],
    dateValue: NotRequired[datetime],

ExportQAppSessionDataInputRequestTypeDef#

# ExportQAppSessionDataInputRequestTypeDef definition

class ExportQAppSessionDataInputRequestTypeDef(TypedDict):
    instanceId: str,
    sessionId: str,

FormInputCardMetadataOutputTypeDef#

# FormInputCardMetadataOutputTypeDef definition

class FormInputCardMetadataOutputTypeDef(TypedDict):
    schema: dict[str, Any],

FormInputCardMetadataTypeDef#

# FormInputCardMetadataTypeDef definition

class FormInputCardMetadataTypeDef(TypedDict):
    schema: Mapping[str, Any],

GetLibraryItemInputRequestTypeDef#

# GetLibraryItemInputRequestTypeDef definition

class GetLibraryItemInputRequestTypeDef(TypedDict):
    instanceId: str,
    libraryItemId: str,
    appId: NotRequired[str],

GetQAppInputRequestTypeDef#

# GetQAppInputRequestTypeDef definition

class GetQAppInputRequestTypeDef(TypedDict):
    instanceId: str,
    appId: str,
    appVersion: NotRequired[int],

GetQAppSessionInputRequestTypeDef#

# GetQAppSessionInputRequestTypeDef definition

class GetQAppSessionInputRequestTypeDef(TypedDict):
    instanceId: str,
    sessionId: str,

GetQAppSessionMetadataInputRequestTypeDef#

# GetQAppSessionMetadataInputRequestTypeDef definition

class GetQAppSessionMetadataInputRequestTypeDef(TypedDict):
    instanceId: str,
    sessionId: str,

SessionSharingConfigurationTypeDef#

# SessionSharingConfigurationTypeDef definition

class SessionSharingConfigurationTypeDef(TypedDict):
    enabled: bool,
    acceptResponses: NotRequired[bool],
    revealCards: NotRequired[bool],

ImportDocumentInputRequestTypeDef#

# ImportDocumentInputRequestTypeDef definition

class ImportDocumentInputRequestTypeDef(TypedDict):
    instanceId: str,
    cardId: str,
    appId: str,
    fileContentsBase64: str,
    fileName: str,
    scope: DocumentScopeType,  # (1)
    sessionId: NotRequired[str],
  1. See DocumentScopeType

ListCategoriesInputRequestTypeDef#

# ListCategoriesInputRequestTypeDef definition

class ListCategoriesInputRequestTypeDef(TypedDict):
    instanceId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListLibraryItemsInputRequestTypeDef#

# ListLibraryItemsInputRequestTypeDef definition

class ListLibraryItemsInputRequestTypeDef(TypedDict):
    instanceId: str,
    limit: NotRequired[int],
    nextToken: NotRequired[str],
    categoryId: NotRequired[str],

ListQAppSessionDataInputRequestTypeDef#

# ListQAppSessionDataInputRequestTypeDef definition

class ListQAppSessionDataInputRequestTypeDef(TypedDict):
    instanceId: str,
    sessionId: str,

ListQAppsInputRequestTypeDef#

# ListQAppsInputRequestTypeDef definition

class ListQAppsInputRequestTypeDef(TypedDict):
    instanceId: str,
    limit: NotRequired[int],
    nextToken: NotRequired[str],

UserAppItemTypeDef#

# UserAppItemTypeDef definition

class UserAppItemTypeDef(TypedDict):
    appId: str,
    appArn: str,
    title: str,
    createdAt: datetime,
    description: NotRequired[str],
    canEdit: NotRequired[bool],
    status: NotRequired[str],
    isVerified: NotRequired[bool],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceARN: str,

PermissionInputTypeDef#

# PermissionInputTypeDef definition

class PermissionInputTypeDef(TypedDict):
    action: PermissionInputActionEnumType,  # (1)
    principal: str,
  1. See PermissionInputActionEnumType

PrincipalOutputTypeDef#

# PrincipalOutputTypeDef definition

class PrincipalOutputTypeDef(TypedDict):
    userId: NotRequired[str],
    userType: NotRequired[PrincipalOutputUserTypeEnumType],  # (1)
    email: NotRequired[str],
  1. See PrincipalOutputUserTypeEnumType

UserTypeDef#

# UserTypeDef definition

class UserTypeDef(TypedDict):
    userId: NotRequired[str],

StopQAppSessionInputRequestTypeDef#

# StopQAppSessionInputRequestTypeDef definition

class StopQAppSessionInputRequestTypeDef(TypedDict):
    instanceId: str,
    sessionId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceARN: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceARN: str,
    tagKeys: Sequence[str],

UpdateLibraryItemInputRequestTypeDef#

# UpdateLibraryItemInputRequestTypeDef definition

class UpdateLibraryItemInputRequestTypeDef(TypedDict):
    instanceId: str,
    libraryItemId: str,
    status: NotRequired[LibraryItemStatusType],  # (1)
    categories: NotRequired[Sequence[str]],
  1. See LibraryItemStatusType

UpdateLibraryItemMetadataInputRequestTypeDef#

# UpdateLibraryItemMetadataInputRequestTypeDef definition

class UpdateLibraryItemMetadataInputRequestTypeDef(TypedDict):
    instanceId: str,
    libraryItemId: str,
    isVerified: NotRequired[bool],

BatchCreateCategoryInputRequestTypeDef#

# BatchCreateCategoryInputRequestTypeDef definition

class BatchCreateCategoryInputRequestTypeDef(TypedDict):
    instanceId: str,
    categories: Sequence[BatchCreateCategoryInputCategoryTypeDef],  # (1)
  1. See BatchCreateCategoryInputCategoryTypeDef

BatchUpdateCategoryInputRequestTypeDef#

# BatchUpdateCategoryInputRequestTypeDef definition

class BatchUpdateCategoryInputRequestTypeDef(TypedDict):
    instanceId: str,
    categories: Sequence[CategoryInputTypeDef],  # (1)
  1. See CategoryInputTypeDef

CardStatusTypeDef#

# CardStatusTypeDef definition

class CardStatusTypeDef(TypedDict):
    currentState: ExecutionStatusType,  # (1)
    currentValue: str,
    submissions: NotRequired[list[SubmissionTypeDef]],  # (2)
  1. See ExecutionStatusType
  2. See SubmissionTypeDef

CardValueTypeDef#

# CardValueTypeDef definition

class CardValueTypeDef(TypedDict):
    cardId: str,
    value: str,
    submissionMutation: NotRequired[SubmissionMutationTypeDef],  # (1)
  1. See SubmissionMutationTypeDef

LibraryItemMemberTypeDef#

# LibraryItemMemberTypeDef definition

class LibraryItemMemberTypeDef(TypedDict):
    libraryItemId: str,
    appId: str,
    appVersion: int,
    categories: list[CategoryTypeDef],  # (1)
    status: str,
    createdAt: datetime,
    createdBy: str,
    ratingCount: int,
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
    isRatedByUser: NotRequired[bool],
    userCount: NotRequired[int],
    isVerified: NotRequired[bool],
  1. See CategoryTypeDef

PredictQAppInputOptionsTypeDef#

# PredictQAppInputOptionsTypeDef definition

class PredictQAppInputOptionsTypeDef(TypedDict):
    conversation: NotRequired[Sequence[ConversationMessageTypeDef]],  # (1)
    problemStatement: NotRequired[str],
  1. See ConversationMessageTypeDef

CreateLibraryItemOutputTypeDef#

# CreateLibraryItemOutputTypeDef definition

class CreateLibraryItemOutputTypeDef(TypedDict):
    libraryItemId: str,
    status: str,
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ratingCount: int,
    isVerified: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePresignedUrlOutputTypeDef#

# CreatePresignedUrlOutputTypeDef definition

class CreatePresignedUrlOutputTypeDef(TypedDict):
    fileId: str,
    presignedUrl: str,
    presignedUrlFields: dict[str, str],
    presignedUrlExpiration: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateQAppOutputTypeDef#

# CreateQAppOutputTypeDef definition

class CreateQAppOutputTypeDef(TypedDict):
    appId: str,
    appArn: str,
    title: str,
    description: str,
    initialPrompt: str,
    appVersion: int,
    status: AppStatusType,  # (1)
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    requiredCapabilities: list[AppRequiredCapabilityType],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AppStatusType
  2. See AppRequiredCapabilityType
  3. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExportQAppSessionDataOutputTypeDef#

# ExportQAppSessionDataOutputTypeDef definition

class ExportQAppSessionDataOutputTypeDef(TypedDict):
    csvFileLink: str,
    expiresAt: datetime,
    sessionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetLibraryItemOutputTypeDef#

# GetLibraryItemOutputTypeDef definition

class GetLibraryItemOutputTypeDef(TypedDict):
    libraryItemId: str,
    appId: str,
    appVersion: int,
    categories: list[CategoryTypeDef],  # (1)
    status: str,
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ratingCount: int,
    isRatedByUser: bool,
    userCount: int,
    isVerified: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CategoryTypeDef
  2. See ResponseMetadataTypeDef

ImportDocumentOutputTypeDef#

# ImportDocumentOutputTypeDef definition

class ImportDocumentOutputTypeDef(TypedDict):
    fileId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListCategoriesOutputTypeDef#

# ListCategoriesOutputTypeDef definition

class ListCategoriesOutputTypeDef(TypedDict):
    categories: list[CategoryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CategoryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartQAppSessionOutputTypeDef#

# StartQAppSessionOutputTypeDef definition

class StartQAppSessionOutputTypeDef(TypedDict):
    sessionId: str,
    sessionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateLibraryItemOutputTypeDef#

# UpdateLibraryItemOutputTypeDef definition

class UpdateLibraryItemOutputTypeDef(TypedDict):
    libraryItemId: str,
    appId: str,
    appVersion: int,
    categories: list[CategoryTypeDef],  # (1)
    status: str,
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ratingCount: int,
    isRatedByUser: bool,
    userCount: int,
    isVerified: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CategoryTypeDef
  2. See ResponseMetadataTypeDef

UpdateQAppOutputTypeDef#

# UpdateQAppOutputTypeDef definition

class UpdateQAppOutputTypeDef(TypedDict):
    appId: str,
    appArn: str,
    title: str,
    description: str,
    initialPrompt: str,
    appVersion: int,
    status: AppStatusType,  # (1)
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    requiredCapabilities: list[AppRequiredCapabilityType],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AppStatusType
  2. See AppRequiredCapabilityType
  3. See ResponseMetadataTypeDef

UpdateQAppSessionOutputTypeDef#

# UpdateQAppSessionOutputTypeDef definition

class UpdateQAppSessionOutputTypeDef(TypedDict):
    sessionId: str,
    sessionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DocumentAttributeOutputTypeDef#

# DocumentAttributeOutputTypeDef definition

class DocumentAttributeOutputTypeDef(TypedDict):
    name: str,
    value: DocumentAttributeValueOutputTypeDef,  # (1)
  1. See DocumentAttributeValueOutputTypeDef

DocumentAttributeValueTypeDef#

# DocumentAttributeValueTypeDef definition

class DocumentAttributeValueTypeDef(TypedDict):
    stringValue: NotRequired[str],
    stringListValue: NotRequired[Sequence[str]],
    longValue: NotRequired[int],
    dateValue: NotRequired[TimestampTypeDef],

FormInputCardInputOutputTypeDef#

# FormInputCardInputOutputTypeDef definition

class FormInputCardInputOutputTypeDef(TypedDict):
    title: str,
    id: str,
    type: CardTypeType,  # (1)
    metadata: FormInputCardMetadataOutputTypeDef,  # (2)
    computeMode: NotRequired[InputCardComputeModeType],  # (3)
  1. See CardTypeType
  2. See FormInputCardMetadataOutputTypeDef
  3. See InputCardComputeModeType

FormInputCardTypeDef#

# FormInputCardTypeDef definition

class FormInputCardTypeDef(TypedDict):
    id: str,
    title: str,
    dependencies: list[str],
    type: CardTypeType,  # (1)
    metadata: FormInputCardMetadataOutputTypeDef,  # (2)
    computeMode: NotRequired[InputCardComputeModeType],  # (3)
  1. See CardTypeType
  2. See FormInputCardMetadataOutputTypeDef
  3. See InputCardComputeModeType

GetQAppSessionMetadataOutputTypeDef#

# GetQAppSessionMetadataOutputTypeDef definition

class GetQAppSessionMetadataOutputTypeDef(TypedDict):
    sessionId: str,
    sessionArn: str,
    sessionName: str,
    sharingConfiguration: SessionSharingConfigurationTypeDef,  # (1)
    sessionOwner: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionSharingConfigurationTypeDef
  2. See ResponseMetadataTypeDef

UpdateQAppSessionMetadataInputRequestTypeDef#

# UpdateQAppSessionMetadataInputRequestTypeDef definition

class UpdateQAppSessionMetadataInputRequestTypeDef(TypedDict):
    instanceId: str,
    sessionId: str,
    sharingConfiguration: SessionSharingConfigurationTypeDef,  # (1)
    sessionName: NotRequired[str],
  1. See SessionSharingConfigurationTypeDef

UpdateQAppSessionMetadataOutputTypeDef#

# UpdateQAppSessionMetadataOutputTypeDef definition

class UpdateQAppSessionMetadataOutputTypeDef(TypedDict):
    sessionId: str,
    sessionArn: str,
    sessionName: str,
    sharingConfiguration: SessionSharingConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionSharingConfigurationTypeDef
  2. See ResponseMetadataTypeDef

ListLibraryItemsInputPaginateTypeDef#

# ListLibraryItemsInputPaginateTypeDef definition

class ListLibraryItemsInputPaginateTypeDef(TypedDict):
    instanceId: str,
    categoryId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQAppsInputPaginateTypeDef#

# ListQAppsInputPaginateTypeDef definition

class ListQAppsInputPaginateTypeDef(TypedDict):
    instanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQAppsOutputTypeDef#

# ListQAppsOutputTypeDef definition

class ListQAppsOutputTypeDef(TypedDict):
    apps: list[UserAppItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See UserAppItemTypeDef
  2. See ResponseMetadataTypeDef

UpdateQAppPermissionsInputRequestTypeDef#

# UpdateQAppPermissionsInputRequestTypeDef definition

class UpdateQAppPermissionsInputRequestTypeDef(TypedDict):
    instanceId: str,
    appId: str,
    grantPermissions: NotRequired[Sequence[PermissionInputTypeDef]],  # (1)
    revokePermissions: NotRequired[Sequence[PermissionInputTypeDef]],  # (1)
  1. See PermissionInputTypeDef
  2. See PermissionInputTypeDef

PermissionOutputTypeDef#

# PermissionOutputTypeDef definition

class PermissionOutputTypeDef(TypedDict):
    action: PermissionOutputActionEnumType,  # (1)
    principal: PrincipalOutputTypeDef,  # (2)
  1. See PermissionOutputActionEnumType
  2. See PrincipalOutputTypeDef

QAppSessionDataTypeDef#

# QAppSessionDataTypeDef definition

class QAppSessionDataTypeDef(TypedDict):
    cardId: str,
    user: UserTypeDef,  # (1)
    value: NotRequired[dict[str, Any]],
    submissionId: NotRequired[str],
    timestamp: NotRequired[datetime],
  1. See UserTypeDef

GetQAppSessionOutputTypeDef#

# GetQAppSessionOutputTypeDef definition

class GetQAppSessionOutputTypeDef(TypedDict):
    sessionId: str,
    sessionArn: str,
    sessionName: str,
    appVersion: int,
    latestPublishedAppVersion: int,
    status: ExecutionStatusType,  # (1)
    cardStatus: dict[str, CardStatusTypeDef],  # (2)
    userIsHost: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ExecutionStatusType
  2. See CardStatusTypeDef
  3. See ResponseMetadataTypeDef

StartQAppSessionInputRequestTypeDef#

# StartQAppSessionInputRequestTypeDef definition

class StartQAppSessionInputRequestTypeDef(TypedDict):
    instanceId: str,
    appId: str,
    appVersion: int,
    initialValues: NotRequired[Sequence[CardValueTypeDef]],  # (1)
    sessionId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See CardValueTypeDef

UpdateQAppSessionInputRequestTypeDef#

# UpdateQAppSessionInputRequestTypeDef definition

class UpdateQAppSessionInputRequestTypeDef(TypedDict):
    instanceId: str,
    sessionId: str,
    values: NotRequired[Sequence[CardValueTypeDef]],  # (1)
  1. See CardValueTypeDef

ListLibraryItemsOutputTypeDef#

# ListLibraryItemsOutputTypeDef definition

class ListLibraryItemsOutputTypeDef(TypedDict):
    libraryItems: list[LibraryItemMemberTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See LibraryItemMemberTypeDef
  2. See ResponseMetadataTypeDef

PredictQAppInputRequestTypeDef#

# PredictQAppInputRequestTypeDef definition

class PredictQAppInputRequestTypeDef(TypedDict):
    instanceId: str,
    options: NotRequired[PredictQAppInputOptionsTypeDef],  # (1)
  1. See PredictQAppInputOptionsTypeDef

AttributeFilterOutputTypeDef#

# AttributeFilterOutputTypeDef definition

class AttributeFilterOutputTypeDef(TypedDict):
    andAllFilters: NotRequired[list[dict[str, Any]]],
    orAllFilters: NotRequired[list[dict[str, Any]]],
    notFilter: NotRequired[dict[str, Any]],
    equalsTo: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    containsAll: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    containsAny: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    greaterThan: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    greaterThanOrEquals: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    lessThan: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
    lessThanOrEquals: NotRequired[DocumentAttributeOutputTypeDef],  # (1)
  1. See DocumentAttributeOutputTypeDef
  2. See DocumentAttributeOutputTypeDef
  3. See DocumentAttributeOutputTypeDef
  4. See DocumentAttributeOutputTypeDef
  5. See DocumentAttributeOutputTypeDef
  6. See DocumentAttributeOutputTypeDef
  7. See DocumentAttributeOutputTypeDef

FormInputCardInputTypeDef#

# FormInputCardInputTypeDef definition

class FormInputCardInputTypeDef(TypedDict):
    title: str,
    id: str,
    type: CardTypeType,  # (1)
    metadata: FormInputCardMetadataUnionTypeDef,  # (2)
    computeMode: NotRequired[InputCardComputeModeType],  # (3)
  1. See CardTypeType
  2. See FormInputCardMetadataTypeDef FormInputCardMetadataOutputTypeDef
  3. See InputCardComputeModeType

DescribeQAppPermissionsOutputTypeDef#

# DescribeQAppPermissionsOutputTypeDef definition

class DescribeQAppPermissionsOutputTypeDef(TypedDict):
    resourceArn: str,
    appId: str,
    permissions: list[PermissionOutputTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PermissionOutputTypeDef
  2. See ResponseMetadataTypeDef

UpdateQAppPermissionsOutputTypeDef#

# UpdateQAppPermissionsOutputTypeDef definition

class UpdateQAppPermissionsOutputTypeDef(TypedDict):
    resourceArn: str,
    appId: str,
    permissions: list[PermissionOutputTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PermissionOutputTypeDef
  2. See ResponseMetadataTypeDef

ListQAppSessionDataOutputTypeDef#

# ListQAppSessionDataOutputTypeDef definition

class ListQAppSessionDataOutputTypeDef(TypedDict):
    sessionId: str,
    sessionArn: str,
    sessionData: list[QAppSessionDataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See QAppSessionDataTypeDef
  2. See ResponseMetadataTypeDef

QQueryCardInputOutputTypeDef#

# QQueryCardInputOutputTypeDef definition

class QQueryCardInputOutputTypeDef(TypedDict):
    title: str,
    id: str,
    type: CardTypeType,  # (1)
    prompt: str,
    outputSource: NotRequired[CardOutputSourceType],  # (2)
    attributeFilter: NotRequired[AttributeFilterOutputTypeDef],  # (3)
  1. See CardTypeType
  2. See CardOutputSourceType
  3. See AttributeFilterOutputTypeDef

QQueryCardTypeDef#

# QQueryCardTypeDef definition

class QQueryCardTypeDef(TypedDict):
    id: str,
    title: str,
    dependencies: list[str],
    type: CardTypeType,  # (1)
    prompt: str,
    outputSource: CardOutputSourceType,  # (2)
    attributeFilter: NotRequired[AttributeFilterOutputTypeDef],  # (3)
    memoryReferences: NotRequired[list[str]],
  1. See CardTypeType
  2. See CardOutputSourceType
  3. See AttributeFilterOutputTypeDef

DocumentAttributeTypeDef#

# DocumentAttributeTypeDef definition

class DocumentAttributeTypeDef(TypedDict):
    name: str,
    value: DocumentAttributeValueUnionTypeDef,  # (1)
  1. See DocumentAttributeValueTypeDef DocumentAttributeValueOutputTypeDef

CardInputOutputTypeDef#

# CardInputOutputTypeDef definition

class CardInputOutputTypeDef(TypedDict):
    textInput: NotRequired[TextInputCardInputTypeDef],  # (1)
    qQuery: NotRequired[QQueryCardInputOutputTypeDef],  # (2)
    qPlugin: NotRequired[QPluginCardInputTypeDef],  # (3)
    fileUpload: NotRequired[FileUploadCardInputTypeDef],  # (4)
    formInput: NotRequired[FormInputCardInputOutputTypeDef],  # (5)
  1. See TextInputCardInputTypeDef
  2. See QQueryCardInputOutputTypeDef
  3. See QPluginCardInputTypeDef
  4. See FileUploadCardInputTypeDef
  5. See FormInputCardInputOutputTypeDef

CardTypeDef#

# CardTypeDef definition

class CardTypeDef(TypedDict):
    textInput: NotRequired[TextInputCardTypeDef],  # (1)
    qQuery: NotRequired[QQueryCardTypeDef],  # (2)
    qPlugin: NotRequired[QPluginCardTypeDef],  # (3)
    fileUpload: NotRequired[FileUploadCardTypeDef],  # (4)
    formInput: NotRequired[FormInputCardTypeDef],  # (5)
  1. See TextInputCardTypeDef
  2. See QQueryCardTypeDef
  3. See QPluginCardTypeDef
  4. See FileUploadCardTypeDef
  5. See FormInputCardTypeDef

AppDefinitionInputOutputTypeDef#

# AppDefinitionInputOutputTypeDef definition

class AppDefinitionInputOutputTypeDef(TypedDict):
    cards: list[CardInputOutputTypeDef],  # (1)
    initialPrompt: NotRequired[str],
  1. See CardInputOutputTypeDef

AppDefinitionTypeDef#

# AppDefinitionTypeDef definition

class AppDefinitionTypeDef(TypedDict):
    appDefinitionVersion: str,
    cards: list[CardTypeDef],  # (1)
    canEdit: NotRequired[bool],
  1. See CardTypeDef

AttributeFilterTypeDef#

# AttributeFilterTypeDef definition

class AttributeFilterTypeDef(TypedDict):
    andAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    orAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    notFilter: NotRequired[Mapping[str, Any]],
    equalsTo: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    containsAll: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    containsAny: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    greaterThan: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    greaterThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    lessThan: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    lessThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
  1. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  2. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  3. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  4. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  5. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  6. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  7. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef

PredictAppDefinitionTypeDef#

# PredictAppDefinitionTypeDef definition

class PredictAppDefinitionTypeDef(TypedDict):
    title: str,
    appDefinition: AppDefinitionInputOutputTypeDef,  # (1)
    description: NotRequired[str],
  1. See AppDefinitionInputOutputTypeDef

GetQAppOutputTypeDef#

# GetQAppOutputTypeDef definition

class GetQAppOutputTypeDef(TypedDict):
    appId: str,
    appArn: str,
    title: str,
    description: str,
    initialPrompt: str,
    appVersion: int,
    status: AppStatusType,  # (1)
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    requiredCapabilities: list[AppRequiredCapabilityType],  # (2)
    appDefinition: AppDefinitionTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AppStatusType
  2. See AppRequiredCapabilityType
  3. See AppDefinitionTypeDef
  4. See ResponseMetadataTypeDef

PredictQAppOutputTypeDef#

# PredictQAppOutputTypeDef definition

class PredictQAppOutputTypeDef(TypedDict):
    app: PredictAppDefinitionTypeDef,  # (1)
    problemStatement: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PredictAppDefinitionTypeDef
  2. See ResponseMetadataTypeDef

QQueryCardInputTypeDef#

# QQueryCardInputTypeDef definition

class QQueryCardInputTypeDef(TypedDict):
    title: str,
    id: str,
    type: CardTypeType,  # (1)
    prompt: str,
    outputSource: NotRequired[CardOutputSourceType],  # (2)
    attributeFilter: NotRequired[AttributeFilterUnionTypeDef],  # (3)
  1. See CardTypeType
  2. See CardOutputSourceType
  3. See AttributeFilterTypeDef AttributeFilterOutputTypeDef

CardInputTypeDef#

# CardInputTypeDef definition

class CardInputTypeDef(TypedDict):
    textInput: NotRequired[TextInputCardInputTypeDef],  # (1)
    qQuery: NotRequired[QQueryCardInputUnionTypeDef],  # (2)
    qPlugin: NotRequired[QPluginCardInputTypeDef],  # (3)
    fileUpload: NotRequired[FileUploadCardInputTypeDef],  # (4)
    formInput: NotRequired[FormInputCardInputUnionTypeDef],  # (5)
  1. See TextInputCardInputTypeDef
  2. See QQueryCardInputTypeDef QQueryCardInputOutputTypeDef
  3. See QPluginCardInputTypeDef
  4. See FileUploadCardInputTypeDef
  5. See FormInputCardInputTypeDef FormInputCardInputOutputTypeDef

AppDefinitionInputTypeDef#

# AppDefinitionInputTypeDef definition

class AppDefinitionInputTypeDef(TypedDict):
    cards: Sequence[CardInputUnionTypeDef],  # (1)
    initialPrompt: NotRequired[str],
  1. See CardInputTypeDef CardInputOutputTypeDef

CreateQAppInputRequestTypeDef#

# CreateQAppInputRequestTypeDef definition

class CreateQAppInputRequestTypeDef(TypedDict):
    instanceId: str,
    title: str,
    appDefinition: AppDefinitionInputTypeDef,  # (1)
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See AppDefinitionInputTypeDef

UpdateQAppInputRequestTypeDef#

# UpdateQAppInputRequestTypeDef definition

class UpdateQAppInputRequestTypeDef(TypedDict):
    instanceId: str,
    appId: str,
    title: NotRequired[str],
    description: NotRequired[str],
    appDefinition: NotRequired[AppDefinitionInputTypeDef],  # (1)
  1. See AppDefinitionInputTypeDef