Type definitions

Index > QApps > Type definitions

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

TimestampTypeDef

# TimestampTypeDef Union usage example

from types_boto3_qapps.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

AppDefinitionInputUnionTypeDef

# AppDefinitionInputUnionTypeDef Union usage example

from types_boto3_qapps.type_defs import AppDefinitionInputUnionTypeDef


def get_value() -> AppDefinitionInputUnionTypeDef:
    return ...


# AppDefinitionInputUnionTypeDef definition

AppDefinitionInputUnionTypeDef = Union[
    AppDefinitionInputTypeDef,  # (1)
    AppDefinitionInputOutputTypeDef,  # (2)
]

1. See AppDefinitionInputTypeDef
2. See AppDefinitionInputOutputTypeDef

AssociateLibraryItemReviewInputTypeDef

# AssociateLibraryItemReviewInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import AssociateLibraryItemReviewInputTypeDef


def get_value() -> AssociateLibraryItemReviewInputTypeDef:
    return {
        "instanceId": ...,
    }


# AssociateLibraryItemReviewInputTypeDef definition

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

AssociateQAppWithUserInputTypeDef

# AssociateQAppWithUserInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import AssociateQAppWithUserInputTypeDef


def get_value() -> AssociateQAppWithUserInputTypeDef:
    return {
        "instanceId": ...,
    }


# AssociateQAppWithUserInputTypeDef definition

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

BatchCreateCategoryInputCategoryTypeDef

# BatchCreateCategoryInputCategoryTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import BatchCreateCategoryInputCategoryTypeDef


def get_value() -> BatchCreateCategoryInputCategoryTypeDef:
    return {
        "id": ...,
    }


# BatchCreateCategoryInputCategoryTypeDef definition

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

BatchDeleteCategoryInputTypeDef

# BatchDeleteCategoryInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import BatchDeleteCategoryInputTypeDef


def get_value() -> BatchDeleteCategoryInputTypeDef:
    return {
        "instanceId": ...,
    }


# BatchDeleteCategoryInputTypeDef definition

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

CategoryInputTypeDef

# CategoryInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CategoryInputTypeDef


def get_value() -> CategoryInputTypeDef:
    return {
        "id": ...,
    }


# CategoryInputTypeDef definition

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

FileUploadCardInputTypeDef

# FileUploadCardInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import FileUploadCardInputTypeDef


def get_value() -> FileUploadCardInputTypeDef:
    return {
        "title": ...,
    }


# 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 TypedDict usage example

from types_boto3_qapps.type_defs import QPluginCardInputTypeDef


def get_value() -> QPluginCardInputTypeDef:
    return {
        "title": ...,
    }


# QPluginCardInputTypeDef definition

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

1. See CardTypeType

TextInputCardInputTypeDef

# TextInputCardInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import TextInputCardInputTypeDef


def get_value() -> TextInputCardInputTypeDef:
    return {
        "title": ...,
    }


# TextInputCardInputTypeDef definition

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

1. See CardTypeType

SubmissionTypeDef

# SubmissionTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import SubmissionTypeDef


def get_value() -> SubmissionTypeDef:
    return {
        "value": ...,
    }


# SubmissionTypeDef definition

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

FileUploadCardTypeDef

# FileUploadCardTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import FileUploadCardTypeDef


def get_value() -> FileUploadCardTypeDef:
    return {
        "id": ...,
    }


# 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 TypedDict usage example

from types_boto3_qapps.type_defs import QPluginCardTypeDef


def get_value() -> QPluginCardTypeDef:
    return {
        "id": ...,
    }


# 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 TypedDict usage example

from types_boto3_qapps.type_defs import TextInputCardTypeDef


def get_value() -> TextInputCardTypeDef:
    return {
        "id": ...,
    }


# 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 TypedDict usage example

from types_boto3_qapps.type_defs import SubmissionMutationTypeDef


def get_value() -> SubmissionMutationTypeDef:
    return {
        "submissionId": ...,
    }


# SubmissionMutationTypeDef definition

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

1. See SubmissionMutationKindType

CategoryTypeDef

# CategoryTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CategoryTypeDef


def get_value() -> CategoryTypeDef:
    return {
        "id": ...,
    }


# CategoryTypeDef definition

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

ConversationMessageTypeDef

# ConversationMessageTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ConversationMessageTypeDef


def get_value() -> ConversationMessageTypeDef:
    return {
        "body": ...,
    }


# ConversationMessageTypeDef definition

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

1. See SenderType

CreateLibraryItemInputTypeDef

# CreateLibraryItemInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CreateLibraryItemInputTypeDef


def get_value() -> CreateLibraryItemInputTypeDef:
    return {
        "instanceId": ...,
    }


# CreateLibraryItemInputTypeDef definition

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

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

CreatePresignedUrlInputTypeDef

# CreatePresignedUrlInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CreatePresignedUrlInputTypeDef


def get_value() -> CreatePresignedUrlInputTypeDef:
    return {
        "instanceId": ...,
    }


# CreatePresignedUrlInputTypeDef definition

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

1. See DocumentScopeType

DeleteLibraryItemInputTypeDef

# DeleteLibraryItemInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DeleteLibraryItemInputTypeDef


def get_value() -> DeleteLibraryItemInputTypeDef:
    return {
        "instanceId": ...,
    }


# DeleteLibraryItemInputTypeDef definition

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

DeleteQAppInputTypeDef

# DeleteQAppInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DeleteQAppInputTypeDef


def get_value() -> DeleteQAppInputTypeDef:
    return {
        "instanceId": ...,
    }


# DeleteQAppInputTypeDef definition

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

DescribeQAppPermissionsInputTypeDef

# DescribeQAppPermissionsInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DescribeQAppPermissionsInputTypeDef


def get_value() -> DescribeQAppPermissionsInputTypeDef:
    return {
        "instanceId": ...,
    }


# DescribeQAppPermissionsInputTypeDef definition

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

DisassociateLibraryItemReviewInputTypeDef

# DisassociateLibraryItemReviewInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DisassociateLibraryItemReviewInputTypeDef


def get_value() -> DisassociateLibraryItemReviewInputTypeDef:
    return {
        "instanceId": ...,
    }


# DisassociateLibraryItemReviewInputTypeDef definition

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

DisassociateQAppFromUserInputTypeDef

# DisassociateQAppFromUserInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DisassociateQAppFromUserInputTypeDef


def get_value() -> DisassociateQAppFromUserInputTypeDef:
    return {
        "instanceId": ...,
    }


# DisassociateQAppFromUserInputTypeDef definition

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

DocumentAttributeValueOutputTypeDef

# DocumentAttributeValueOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DocumentAttributeValueOutputTypeDef


def get_value() -> DocumentAttributeValueOutputTypeDef:
    return {
        "stringValue": ...,
    }


# DocumentAttributeValueOutputTypeDef definition

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

ExportQAppSessionDataInputTypeDef

# ExportQAppSessionDataInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ExportQAppSessionDataInputTypeDef


def get_value() -> ExportQAppSessionDataInputTypeDef:
    return {
        "instanceId": ...,
    }


# ExportQAppSessionDataInputTypeDef definition

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

FormInputCardMetadataOutputTypeDef

# FormInputCardMetadataOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import FormInputCardMetadataOutputTypeDef


def get_value() -> FormInputCardMetadataOutputTypeDef:
    return {
        "schema": ...,
    }


# FormInputCardMetadataOutputTypeDef definition

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

FormInputCardMetadataTypeDef

# FormInputCardMetadataTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import FormInputCardMetadataTypeDef


def get_value() -> FormInputCardMetadataTypeDef:
    return {
        "schema": ...,
    }


# FormInputCardMetadataTypeDef definition

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

GetLibraryItemInputTypeDef

# GetLibraryItemInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import GetLibraryItemInputTypeDef


def get_value() -> GetLibraryItemInputTypeDef:
    return {
        "instanceId": ...,
    }


# GetLibraryItemInputTypeDef definition

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

GetQAppInputTypeDef

# GetQAppInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import GetQAppInputTypeDef


def get_value() -> GetQAppInputTypeDef:
    return {
        "instanceId": ...,
    }


# GetQAppInputTypeDef definition

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

GetQAppSessionInputTypeDef

# GetQAppSessionInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import GetQAppSessionInputTypeDef


def get_value() -> GetQAppSessionInputTypeDef:
    return {
        "instanceId": ...,
    }


# GetQAppSessionInputTypeDef definition

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

GetQAppSessionMetadataInputTypeDef

# GetQAppSessionMetadataInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import GetQAppSessionMetadataInputTypeDef


def get_value() -> GetQAppSessionMetadataInputTypeDef:
    return {
        "instanceId": ...,
    }


# GetQAppSessionMetadataInputTypeDef definition

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

SessionSharingConfigurationTypeDef

# SessionSharingConfigurationTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import SessionSharingConfigurationTypeDef


def get_value() -> SessionSharingConfigurationTypeDef:
    return {
        "enabled": ...,
    }


# SessionSharingConfigurationTypeDef definition

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

ImportDocumentInputTypeDef

# ImportDocumentInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ImportDocumentInputTypeDef


def get_value() -> ImportDocumentInputTypeDef:
    return {
        "instanceId": ...,
    }


# ImportDocumentInputTypeDef definition

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

1. See DocumentScopeType

ListCategoriesInputTypeDef

# ListCategoriesInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListCategoriesInputTypeDef


def get_value() -> ListCategoriesInputTypeDef:
    return {
        "instanceId": ...,
    }


# ListCategoriesInputTypeDef definition

class ListCategoriesInputTypeDef(TypedDict):
    instanceId: str,

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListLibraryItemsInputTypeDef

# ListLibraryItemsInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListLibraryItemsInputTypeDef


def get_value() -> ListLibraryItemsInputTypeDef:
    return {
        "instanceId": ...,
    }


# ListLibraryItemsInputTypeDef definition

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

ListQAppSessionDataInputTypeDef

# ListQAppSessionDataInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListQAppSessionDataInputTypeDef


def get_value() -> ListQAppSessionDataInputTypeDef:
    return {
        "instanceId": ...,
    }


# ListQAppSessionDataInputTypeDef definition

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

ListQAppsInputTypeDef

# ListQAppsInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListQAppsInputTypeDef


def get_value() -> ListQAppsInputTypeDef:
    return {
        "instanceId": ...,
    }


# ListQAppsInputTypeDef definition

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

UserAppItemTypeDef

# UserAppItemTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UserAppItemTypeDef


def get_value() -> UserAppItemTypeDef:
    return {
        "appId": ...,
    }


# UserAppItemTypeDef definition

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

ListTagsForResourceRequestTypeDef

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceARN": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceARN: str,

PermissionInputTypeDef

# PermissionInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import PermissionInputTypeDef


def get_value() -> PermissionInputTypeDef:
    return {
        "action": ...,
    }


# PermissionInputTypeDef definition

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

1. See PermissionInputActionEnumType

PrincipalOutputTypeDef

# PrincipalOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import PrincipalOutputTypeDef


def get_value() -> PrincipalOutputTypeDef:
    return {
        "userId": ...,
    }


# PrincipalOutputTypeDef definition

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

1. See PrincipalOutputUserTypeEnumType

UserTypeDef

# UserTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UserTypeDef


def get_value() -> UserTypeDef:
    return {
        "userId": ...,
    }


# UserTypeDef definition

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

StopQAppSessionInputTypeDef

# StopQAppSessionInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import StopQAppSessionInputTypeDef


def get_value() -> StopQAppSessionInputTypeDef:
    return {
        "instanceId": ...,
    }


# StopQAppSessionInputTypeDef definition

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

TagResourceRequestTypeDef

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceARN": ...,
    }


# TagResourceRequestTypeDef definition

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

UntagResourceRequestTypeDef

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceARN": ...,
    }


# UntagResourceRequestTypeDef definition

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

UpdateLibraryItemInputTypeDef

# UpdateLibraryItemInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateLibraryItemInputTypeDef


def get_value() -> UpdateLibraryItemInputTypeDef:
    return {
        "instanceId": ...,
    }


# UpdateLibraryItemInputTypeDef definition

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

1. See LibraryItemStatusType

UpdateLibraryItemMetadataInputTypeDef

# UpdateLibraryItemMetadataInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateLibraryItemMetadataInputTypeDef


def get_value() -> UpdateLibraryItemMetadataInputTypeDef:
    return {
        "instanceId": ...,
    }


# UpdateLibraryItemMetadataInputTypeDef definition

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

BatchCreateCategoryInputTypeDef

# BatchCreateCategoryInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import BatchCreateCategoryInputTypeDef


def get_value() -> BatchCreateCategoryInputTypeDef:
    return {
        "instanceId": ...,
    }


# BatchCreateCategoryInputTypeDef definition

class BatchCreateCategoryInputTypeDef(TypedDict):
    instanceId: str,
    categories: Sequence[BatchCreateCategoryInputCategoryTypeDef],  # (1)

1. See Sequence[BatchCreateCategoryInputCategoryTypeDef]

BatchUpdateCategoryInputTypeDef

# BatchUpdateCategoryInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import BatchUpdateCategoryInputTypeDef


def get_value() -> BatchUpdateCategoryInputTypeDef:
    return {
        "instanceId": ...,
    }


# BatchUpdateCategoryInputTypeDef definition

class BatchUpdateCategoryInputTypeDef(TypedDict):
    instanceId: str,
    categories: Sequence[CategoryInputTypeDef],  # (1)

1. See Sequence[CategoryInputTypeDef]

CardStatusTypeDef

# CardStatusTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CardStatusTypeDef


def get_value() -> CardStatusTypeDef:
    return {
        "currentState": ...,
    }


# CardStatusTypeDef definition

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

1. See ExecutionStatusType
2. See List[SubmissionTypeDef]

CardValueTypeDef

# CardValueTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CardValueTypeDef


def get_value() -> CardValueTypeDef:
    return {
        "cardId": ...,
    }


# CardValueTypeDef definition

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

1. See SubmissionMutationTypeDef

LibraryItemMemberTypeDef

# LibraryItemMemberTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import LibraryItemMemberTypeDef


def get_value() -> LibraryItemMemberTypeDef:
    return {
        "libraryItemId": ...,
    }


# LibraryItemMemberTypeDef definition

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

1. See List[CategoryTypeDef]

PredictQAppInputOptionsTypeDef

# PredictQAppInputOptionsTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import PredictQAppInputOptionsTypeDef


def get_value() -> PredictQAppInputOptionsTypeDef:
    return {
        "conversation": ...,
    }


# PredictQAppInputOptionsTypeDef definition

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

1. See Sequence[ConversationMessageTypeDef]

CreateLibraryItemOutputTypeDef

# CreateLibraryItemOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CreateLibraryItemOutputTypeDef


def get_value() -> CreateLibraryItemOutputTypeDef:
    return {
        "libraryItemId": ...,
    }


# CreateLibraryItemOutputTypeDef definition

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

1. See ResponseMetadataTypeDef

CreatePresignedUrlOutputTypeDef

# CreatePresignedUrlOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CreatePresignedUrlOutputTypeDef


def get_value() -> CreatePresignedUrlOutputTypeDef:
    return {
        "fileId": ...,
    }


# CreatePresignedUrlOutputTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateQAppOutputTypeDef

# CreateQAppOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CreateQAppOutputTypeDef


def get_value() -> CreateQAppOutputTypeDef:
    return {
        "appId": ...,
    }


# CreateQAppOutputTypeDef definition

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

1. See AppStatusType
2. See List[AppRequiredCapabilityType]
3. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

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

1. See ResponseMetadataTypeDef

ExportQAppSessionDataOutputTypeDef

# ExportQAppSessionDataOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ExportQAppSessionDataOutputTypeDef


def get_value() -> ExportQAppSessionDataOutputTypeDef:
    return {
        "csvFileLink": ...,
    }


# ExportQAppSessionDataOutputTypeDef definition

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

1. See ResponseMetadataTypeDef

GetLibraryItemOutputTypeDef

# GetLibraryItemOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import GetLibraryItemOutputTypeDef


def get_value() -> GetLibraryItemOutputTypeDef:
    return {
        "libraryItemId": ...,
    }


# GetLibraryItemOutputTypeDef definition

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

1. See List[CategoryTypeDef]
2. See ResponseMetadataTypeDef

ImportDocumentOutputTypeDef

# ImportDocumentOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ImportDocumentOutputTypeDef


def get_value() -> ImportDocumentOutputTypeDef:
    return {
        "fileId": ...,
    }


# ImportDocumentOutputTypeDef definition

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

1. See ResponseMetadataTypeDef

ListCategoriesOutputTypeDef

# ListCategoriesOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListCategoriesOutputTypeDef


def get_value() -> ListCategoriesOutputTypeDef:
    return {
        "categories": ...,
    }


# ListCategoriesOutputTypeDef definition

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

1. See List[CategoryTypeDef]
2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

StartQAppSessionOutputTypeDef

# StartQAppSessionOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import StartQAppSessionOutputTypeDef


def get_value() -> StartQAppSessionOutputTypeDef:
    return {
        "sessionId": ...,
    }


# StartQAppSessionOutputTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateLibraryItemOutputTypeDef

# UpdateLibraryItemOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateLibraryItemOutputTypeDef


def get_value() -> UpdateLibraryItemOutputTypeDef:
    return {
        "libraryItemId": ...,
    }


# UpdateLibraryItemOutputTypeDef definition

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

1. See List[CategoryTypeDef]
2. See ResponseMetadataTypeDef

UpdateQAppOutputTypeDef

# UpdateQAppOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateQAppOutputTypeDef


def get_value() -> UpdateQAppOutputTypeDef:
    return {
        "appId": ...,
    }


# UpdateQAppOutputTypeDef definition

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

1. See AppStatusType
2. See List[AppRequiredCapabilityType]
3. See ResponseMetadataTypeDef

UpdateQAppSessionOutputTypeDef

# UpdateQAppSessionOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateQAppSessionOutputTypeDef


def get_value() -> UpdateQAppSessionOutputTypeDef:
    return {
        "sessionId": ...,
    }


# UpdateQAppSessionOutputTypeDef definition

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

1. See ResponseMetadataTypeDef

DocumentAttributeOutputTypeDef

# DocumentAttributeOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DocumentAttributeOutputTypeDef


def get_value() -> DocumentAttributeOutputTypeDef:
    return {
        "name": ...,
    }


# DocumentAttributeOutputTypeDef definition

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

1. See DocumentAttributeValueOutputTypeDef

DocumentAttributeValueTypeDef

# DocumentAttributeValueTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DocumentAttributeValueTypeDef


def get_value() -> DocumentAttributeValueTypeDef:
    return {
        "stringValue": ...,
    }


# DocumentAttributeValueTypeDef definition

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

FormInputCardInputOutputTypeDef

# FormInputCardInputOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import FormInputCardInputOutputTypeDef


def get_value() -> FormInputCardInputOutputTypeDef:
    return {
        "title": ...,
    }


# 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 TypedDict usage example

from types_boto3_qapps.type_defs import FormInputCardTypeDef


def get_value() -> FormInputCardTypeDef:
    return {
        "id": ...,
    }


# 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

FormInputCardInputTypeDef

# FormInputCardInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import FormInputCardInputTypeDef


def get_value() -> FormInputCardInputTypeDef:
    return {
        "title": ...,
    }


# FormInputCardInputTypeDef definition

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

1. See CardTypeType
2. See FormInputCardMetadataTypeDef
3. See InputCardComputeModeType

GetQAppSessionMetadataOutputTypeDef

# GetQAppSessionMetadataOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import GetQAppSessionMetadataOutputTypeDef


def get_value() -> GetQAppSessionMetadataOutputTypeDef:
    return {
        "sessionId": ...,
    }


# 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

UpdateQAppSessionMetadataInputTypeDef

# UpdateQAppSessionMetadataInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateQAppSessionMetadataInputTypeDef


def get_value() -> UpdateQAppSessionMetadataInputTypeDef:
    return {
        "instanceId": ...,
    }


# UpdateQAppSessionMetadataInputTypeDef definition

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

1. See SessionSharingConfigurationTypeDef

UpdateQAppSessionMetadataOutputTypeDef

# UpdateQAppSessionMetadataOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateQAppSessionMetadataOutputTypeDef


def get_value() -> UpdateQAppSessionMetadataOutputTypeDef:
    return {
        "sessionId": ...,
    }


# 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 TypedDict usage example

from types_boto3_qapps.type_defs import ListLibraryItemsInputPaginateTypeDef


def get_value() -> ListLibraryItemsInputPaginateTypeDef:
    return {
        "instanceId": ...,
    }


# ListLibraryItemsInputPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListQAppsInputPaginateTypeDef

# ListQAppsInputPaginateTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListQAppsInputPaginateTypeDef


def get_value() -> ListQAppsInputPaginateTypeDef:
    return {
        "instanceId": ...,
    }


# ListQAppsInputPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListQAppsOutputTypeDef

# ListQAppsOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListQAppsOutputTypeDef


def get_value() -> ListQAppsOutputTypeDef:
    return {
        "apps": ...,
    }


# ListQAppsOutputTypeDef definition

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

1. See List[UserAppItemTypeDef]
2. See ResponseMetadataTypeDef

UpdateQAppPermissionsInputTypeDef

# UpdateQAppPermissionsInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateQAppPermissionsInputTypeDef


def get_value() -> UpdateQAppPermissionsInputTypeDef:
    return {
        "instanceId": ...,
    }


# UpdateQAppPermissionsInputTypeDef definition

class UpdateQAppPermissionsInputTypeDef(TypedDict):
    instanceId: str,
    appId: str,
    grantPermissions: NotRequired[Sequence[PermissionInputTypeDef]],  # (1)
    revokePermissions: NotRequired[Sequence[PermissionInputTypeDef]],  # (1)

1. See Sequence[PermissionInputTypeDef]
2. See Sequence[PermissionInputTypeDef]

PermissionOutputTypeDef

# PermissionOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import PermissionOutputTypeDef


def get_value() -> PermissionOutputTypeDef:
    return {
        "action": ...,
    }


# PermissionOutputTypeDef definition

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

1. See PermissionOutputActionEnumType
2. See PrincipalOutputTypeDef

QAppSessionDataTypeDef

# QAppSessionDataTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import QAppSessionDataTypeDef


def get_value() -> QAppSessionDataTypeDef:
    return {
        "cardId": ...,
    }


# QAppSessionDataTypeDef definition

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

1. See UserTypeDef

GetQAppSessionOutputTypeDef

# GetQAppSessionOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import GetQAppSessionOutputTypeDef


def get_value() -> GetQAppSessionOutputTypeDef:
    return {
        "sessionId": ...,
    }


# 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 Dict[str, CardStatusTypeDef]
3. See ResponseMetadataTypeDef

StartQAppSessionInputTypeDef

# StartQAppSessionInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import StartQAppSessionInputTypeDef


def get_value() -> StartQAppSessionInputTypeDef:
    return {
        "instanceId": ...,
    }


# StartQAppSessionInputTypeDef definition

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

1. See Sequence[CardValueTypeDef]

UpdateQAppSessionInputTypeDef

# UpdateQAppSessionInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateQAppSessionInputTypeDef


def get_value() -> UpdateQAppSessionInputTypeDef:
    return {
        "instanceId": ...,
    }


# UpdateQAppSessionInputTypeDef definition

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

1. See Sequence[CardValueTypeDef]

ListLibraryItemsOutputTypeDef

# ListLibraryItemsOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListLibraryItemsOutputTypeDef


def get_value() -> ListLibraryItemsOutputTypeDef:
    return {
        "libraryItems": ...,
    }


# ListLibraryItemsOutputTypeDef definition

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

1. See List[LibraryItemMemberTypeDef]
2. See ResponseMetadataTypeDef

PredictQAppInputTypeDef

# PredictQAppInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import PredictQAppInputTypeDef


def get_value() -> PredictQAppInputTypeDef:
    return {
        "instanceId": ...,
    }


# PredictQAppInputTypeDef definition

class PredictQAppInputTypeDef(TypedDict):
    instanceId: str,
    options: NotRequired[PredictQAppInputOptionsTypeDef],  # (1)

1. See PredictQAppInputOptionsTypeDef

AttributeFilterOutputTypeDef

# AttributeFilterOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import AttributeFilterOutputTypeDef


def get_value() -> AttributeFilterOutputTypeDef:
    return {
        "andAllFilters": ...,
    }


# 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

DocumentAttributeTypeDef

# DocumentAttributeTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DocumentAttributeTypeDef


def get_value() -> DocumentAttributeTypeDef:
    return {
        "name": ...,
    }


# DocumentAttributeTypeDef definition

class DocumentAttributeTypeDef(TypedDict):
    name: str,
    value: DocumentAttributeValueTypeDef,  # (1)

1. See DocumentAttributeValueTypeDef

DescribeQAppPermissionsOutputTypeDef

# DescribeQAppPermissionsOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import DescribeQAppPermissionsOutputTypeDef


def get_value() -> DescribeQAppPermissionsOutputTypeDef:
    return {
        "resourceArn": ...,
    }


# DescribeQAppPermissionsOutputTypeDef definition

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

1. See List[PermissionOutputTypeDef]
2. See ResponseMetadataTypeDef

UpdateQAppPermissionsOutputTypeDef

# UpdateQAppPermissionsOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateQAppPermissionsOutputTypeDef


def get_value() -> UpdateQAppPermissionsOutputTypeDef:
    return {
        "resourceArn": ...,
    }


# UpdateQAppPermissionsOutputTypeDef definition

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

1. See List[PermissionOutputTypeDef]
2. See ResponseMetadataTypeDef

ListQAppSessionDataOutputTypeDef

# ListQAppSessionDataOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import ListQAppSessionDataOutputTypeDef


def get_value() -> ListQAppSessionDataOutputTypeDef:
    return {
        "sessionId": ...,
    }


# ListQAppSessionDataOutputTypeDef definition

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

1. See List[QAppSessionDataTypeDef]
2. See ResponseMetadataTypeDef

QQueryCardInputOutputTypeDef

# QQueryCardInputOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import QQueryCardInputOutputTypeDef


def get_value() -> QQueryCardInputOutputTypeDef:
    return {
        "title": ...,
    }


# 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 TypedDict usage example

from types_boto3_qapps.type_defs import QQueryCardTypeDef


def get_value() -> QQueryCardTypeDef:
    return {
        "id": ...,
    }


# 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

AttributeFilterTypeDef

# AttributeFilterTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import AttributeFilterTypeDef


def get_value() -> AttributeFilterTypeDef:
    return {
        "andAllFilters": ...,
    }


# AttributeFilterTypeDef definition

class AttributeFilterTypeDef(TypedDict):
    andAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    orAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    notFilter: NotRequired[Mapping[str, Any]],
    equalsTo: NotRequired[DocumentAttributeTypeDef],  # (1)
    containsAll: NotRequired[DocumentAttributeTypeDef],  # (1)
    containsAny: NotRequired[DocumentAttributeTypeDef],  # (1)
    greaterThan: NotRequired[DocumentAttributeTypeDef],  # (1)
    greaterThanOrEquals: NotRequired[DocumentAttributeTypeDef],  # (1)
    lessThan: NotRequired[DocumentAttributeTypeDef],  # (1)
    lessThanOrEquals: NotRequired[DocumentAttributeTypeDef],  # (1)

1. See DocumentAttributeTypeDef
2. See DocumentAttributeTypeDef
3. See DocumentAttributeTypeDef
4. See DocumentAttributeTypeDef
5. See DocumentAttributeTypeDef
6. See DocumentAttributeTypeDef
7. See DocumentAttributeTypeDef

CardInputOutputTypeDef

# CardInputOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CardInputOutputTypeDef


def get_value() -> CardInputOutputTypeDef:
    return {
        "textInput": ...,
    }


# 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 TypedDict usage example

from types_boto3_qapps.type_defs import CardTypeDef


def get_value() -> CardTypeDef:
    return {
        "textInput": ...,
    }


# 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

QQueryCardInputTypeDef

# QQueryCardInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import QQueryCardInputTypeDef


def get_value() -> QQueryCardInputTypeDef:
    return {
        "title": ...,
    }


# QQueryCardInputTypeDef definition

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

1. See CardTypeType
2. See CardOutputSourceType
3. See AttributeFilterTypeDef

AppDefinitionInputOutputTypeDef

# AppDefinitionInputOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import AppDefinitionInputOutputTypeDef


def get_value() -> AppDefinitionInputOutputTypeDef:
    return {
        "cards": ...,
    }


# AppDefinitionInputOutputTypeDef definition

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

1. See List[CardInputOutputTypeDef]

AppDefinitionTypeDef

# AppDefinitionTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import AppDefinitionTypeDef


def get_value() -> AppDefinitionTypeDef:
    return {
        "appDefinitionVersion": ...,
    }


# AppDefinitionTypeDef definition

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

1. See List[CardTypeDef]

CardInputTypeDef

# CardInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CardInputTypeDef


def get_value() -> CardInputTypeDef:
    return {
        "textInput": ...,
    }


# CardInputTypeDef definition

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

1. See TextInputCardInputTypeDef
2. See QQueryCardInputTypeDef
3. See QPluginCardInputTypeDef
4. See FileUploadCardInputTypeDef
5. See FormInputCardInputTypeDef

PredictAppDefinitionTypeDef

# PredictAppDefinitionTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import PredictAppDefinitionTypeDef


def get_value() -> PredictAppDefinitionTypeDef:
    return {
        "title": ...,
    }


# PredictAppDefinitionTypeDef definition

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

1. See AppDefinitionInputOutputTypeDef

GetQAppOutputTypeDef

# GetQAppOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import GetQAppOutputTypeDef


def get_value() -> GetQAppOutputTypeDef:
    return {
        "appId": ...,
    }


# GetQAppOutputTypeDef definition

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

1. See AppStatusType
2. See List[AppRequiredCapabilityType]
3. See AppDefinitionTypeDef
4. See ResponseMetadataTypeDef

AppDefinitionInputTypeDef

# AppDefinitionInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import AppDefinitionInputTypeDef


def get_value() -> AppDefinitionInputTypeDef:
    return {
        "cards": ...,
    }


# AppDefinitionInputTypeDef definition

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

1. See Sequence[CardInputTypeDef]

PredictQAppOutputTypeDef

# PredictQAppOutputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import PredictQAppOutputTypeDef


def get_value() -> PredictQAppOutputTypeDef:
    return {
        "app": ...,
    }


# PredictQAppOutputTypeDef definition

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

1. See PredictAppDefinitionTypeDef
2. See ResponseMetadataTypeDef

CreateQAppInputTypeDef

# CreateQAppInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import CreateQAppInputTypeDef


def get_value() -> CreateQAppInputTypeDef:
    return {
        "instanceId": ...,
    }


# CreateQAppInputTypeDef definition

class CreateQAppInputTypeDef(TypedDict):
    instanceId: str,
    title: str,
    appDefinition: AppDefinitionInputUnionTypeDef,  # (1)
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

1. See AppDefinitionInputUnionTypeDef

UpdateQAppInputTypeDef

# UpdateQAppInputTypeDef TypedDict usage example

from types_boto3_qapps.type_defs import UpdateQAppInputTypeDef


def get_value() -> UpdateQAppInputTypeDef:
    return {
        "instanceId": ...,
    }


# UpdateQAppInputTypeDef definition

class UpdateQAppInputTypeDef(TypedDict):
    instanceId: str,
    appId: str,
    title: NotRequired[str],
    description: NotRequired[str],
    appDefinition: NotRequired[AppDefinitionInputUnionTypeDef],  # (1)

1. See AppDefinitionInputUnionTypeDef