Skip to content

Type definitions#

Index > QBusiness > Type definitions

Auto-generated documentation for QBusiness type annotations stubs module mypy-boto3-qbusiness.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ActionExecutionPayloadFieldPaginatorTypeDef#

# ActionExecutionPayloadFieldPaginatorTypeDef definition

class ActionExecutionPayloadFieldPaginatorTypeDef(TypedDict):
    value: Dict[str, Any],

ActionExecutionPayloadFieldTypeDef#

# ActionExecutionPayloadFieldTypeDef definition

class ActionExecutionPayloadFieldTypeDef(TypedDict):
    value: Mapping[str, Any],

ActionReviewPayloadFieldAllowedValueTypeDef#

# ActionReviewPayloadFieldAllowedValueTypeDef definition

class ActionReviewPayloadFieldAllowedValueTypeDef(TypedDict):
    displayValue: NotRequired[Dict[str, Any]],
    value: NotRequired[Dict[str, Any]],

ApplicationTypeDef#

# ApplicationTypeDef definition

class ApplicationTypeDef(TypedDict):
    applicationId: NotRequired[str],
    createdAt: NotRequired[datetime],
    displayName: NotRequired[str],
    status: NotRequired[ApplicationStatusType],  # (1)
    updatedAt: NotRequired[datetime],
  1. See ApplicationStatusType

AppliedAttachmentsConfigurationTypeDef#

# AppliedAttachmentsConfigurationTypeDef definition

class AppliedAttachmentsConfigurationTypeDef(TypedDict):
    attachmentsControlMode: NotRequired[AttachmentsControlModeType],  # (1)
  1. See AttachmentsControlModeType

ErrorDetailTypeDef#

# ErrorDetailTypeDef definition

class ErrorDetailTypeDef(TypedDict):
    errorCode: NotRequired[ErrorCodeType],  # (1)
    errorMessage: NotRequired[str],
  1. See ErrorCodeType

AttachmentsConfigurationTypeDef#

# AttachmentsConfigurationTypeDef definition

class AttachmentsConfigurationTypeDef(TypedDict):
    attachmentsControlMode: AttachmentsControlModeType,  # (1)
  1. See AttachmentsControlModeType

BasicAuthConfigurationTypeDef#

# BasicAuthConfigurationTypeDef definition

class BasicAuthConfigurationTypeDef(TypedDict):
    roleArn: str,
    secretArn: str,

DeleteDocumentTypeDef#

# DeleteDocumentTypeDef definition

class DeleteDocumentTypeDef(TypedDict):
    documentId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BlockedPhrasesConfigurationTypeDef#

# BlockedPhrasesConfigurationTypeDef definition

class BlockedPhrasesConfigurationTypeDef(TypedDict):
    blockedPhrases: NotRequired[List[str]],
    systemMessageOverride: NotRequired[str],

BlockedPhrasesConfigurationUpdateTypeDef#

# BlockedPhrasesConfigurationUpdateTypeDef definition

class BlockedPhrasesConfigurationUpdateTypeDef(TypedDict):
    blockedPhrasesToCreateOrUpdate: NotRequired[Sequence[str]],
    blockedPhrasesToDelete: NotRequired[Sequence[str]],
    systemMessageOverride: NotRequired[str],

ContentBlockerRuleTypeDef#

# ContentBlockerRuleTypeDef definition

class ContentBlockerRuleTypeDef(TypedDict):
    systemMessageOverride: NotRequired[str],

EligibleDataSourceTypeDef#

# EligibleDataSourceTypeDef definition

class EligibleDataSourceTypeDef(TypedDict):
    dataSourceId: NotRequired[str],
    indexId: NotRequired[str],

ConversationTypeDef#

# ConversationTypeDef definition

class ConversationTypeDef(TypedDict):
    conversationId: NotRequired[str],
    startTime: NotRequired[datetime],
    title: NotRequired[str],

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef definition

class EncryptionConfigurationTypeDef(TypedDict):
    kmsKeyId: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

DataSourceVpcConfigurationTypeDef#

# DataSourceVpcConfigurationTypeDef definition

class DataSourceVpcConfigurationTypeDef(TypedDict):
    securityGroupIds: Sequence[str],
    subnetIds: Sequence[str],

IndexCapacityConfigurationTypeDef#

# IndexCapacityConfigurationTypeDef definition

class IndexCapacityConfigurationTypeDef(TypedDict):
    units: NotRequired[int],

UserAliasTypeDef#

# UserAliasTypeDef definition

class UserAliasTypeDef(TypedDict):
    userId: str,
    dataSourceId: NotRequired[str],
    indexId: NotRequired[str],

DataSourceSyncJobMetricsTypeDef