Skip to content

Type definitions#

Index > LexModelBuildingService > Type definitions

Auto-generated documentation for LexModelBuildingService type annotations stubs module mypy-boto3-lex-models.

BlobTypeDef#

# BlobTypeDef definition

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

BotChannelAssociationTypeDef#

# BotChannelAssociationTypeDef definition

class BotChannelAssociationTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    botAlias: NotRequired[str],
    botName: NotRequired[str],
    createdDate: NotRequired[datetime],
    type: NotRequired[ChannelTypeType],  # (1)
    botConfiguration: NotRequired[Dict[str, str]],
    status: NotRequired[ChannelStatusType],  # (2)
    failureReason: NotRequired[str],
  1. See ChannelTypeType
  2. See ChannelStatusType

BotMetadataTypeDef#

# BotMetadataTypeDef definition

class BotMetadataTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    status: NotRequired[StatusType],  # (1)
    lastUpdatedDate: NotRequired[datetime],
    createdDate: NotRequired[datetime],
    version: NotRequired[str],
  1. See StatusType

BuiltinIntentMetadataTypeDef#

# BuiltinIntentMetadataTypeDef definition

class BuiltinIntentMetadataTypeDef(TypedDict):
    signature: NotRequired[str],
    supportedLocales: NotRequired[List[LocaleType]],  # (1)
  1. See LocaleType

BuiltinIntentSlotTypeDef#

# BuiltinIntentSlotTypeDef definition

class BuiltinIntentSlotTypeDef(TypedDict):
    name: NotRequired[str],

BuiltinSlotTypeMetadataTypeDef#

# BuiltinSlotTypeMetadataTypeDef definition

class BuiltinSlotTypeMetadataTypeDef(TypedDict):
    signature: NotRequired[str],
    supportedLocales: NotRequired[List[LocaleType]],  # (1)
  1. See LocaleType

CodeHookTypeDef#

# CodeHookTypeDef definition

class CodeHookTypeDef(TypedDict):
    uri: str,
    messageVersion: str,

LogSettingsRequestTypeDef#

# LogSettingsRequestTypeDef definition

class LogSettingsRequestTypeDef(TypedDict):
    logType: LogTypeType,  # (1)
    destination: DestinationType,  # (2)
    resourceArn: str,
    kmsKeyArn: NotRequired[str],
  1. See LogTypeType
  2. See DestinationType

LogSettingsResponseTypeDef#

# LogSettingsResponseTypeDef definition

class LogSettingsResponseTypeDef(TypedDict):
    logType: NotRequired[LogTypeType],  # (1)
    destination: NotRequired[DestinationType],  # (2)
    kmsKeyArn: NotRequired[str],
    resourceArn: NotRequired[str],
    resourcePrefix: NotRequired[str],
  1. See LogTypeType
  2. See DestinationType

CreateBotVersionRequestRequestTypeDef#

# CreateBotVersionRequestRequestTypeDef definition

class CreateBotVersionRequestRequestTypeDef(TypedDict):
    name: str,
    checksum: NotRequired[str],

IntentTypeDef#

# IntentTypeDef definition

class IntentTypeDef(TypedDict):
    intentName: str,
    intentVersion: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateIntentVersionRequestRequestTypeDef#

# CreateIntentVersionRequestRequestTypeDef definition

class CreateIntentVersionRequestRequestTypeDef(TypedDict):
    name: str,
    checksum: NotRequired[str],

InputContextTypeDef#

# InputContextTypeDef definition

class InputContextTypeDef(TypedDict):
    name: str,

KendraConfigurationTypeDef#

# KendraConfigurationTypeDef definition

class KendraConfigurationTypeDef(TypedDict):
    kendraIndex: str,
    role: str,
    queryFilterString: NotRequired[str],

OutputContextTypeDef#

# OutputContextTypeDef definition

class OutputContextTypeDef(TypedDict):
    name: str,
    timeToLiveInSeconds: int,
    turnsToLive: int,

CreateSlotTypeVersionRequestRequestTypeDef#

# CreateSlotTypeVersionRequestRequestTypeDef definition

class CreateSlotTypeVersionRequestRequestTypeDef(TypedDict):
    name: str,
    checksum: NotRequired[str],

EnumerationValueTypeDef#

# EnumerationValueTypeDef definition

class EnumerationValueTypeDef(TypedDict):
    value: str,
    synonyms: NotRequired[List[str]],

DeleteBotAliasRequestRequestTypeDef#

# DeleteBotAliasRequestRequestTypeDef definition

class DeleteBotAliasRequestRequestTypeDef(TypedDict):
    name: str,
    botName: str,

DeleteBotChannelAssociationRequestRequestTypeDef#

# DeleteBotChannelAssociationRequestRequestTypeDef definition

class DeleteBotChannelAssociationRequestRequestTypeDef(TypedDict):
    name: str,
    botName: str,
    botAlias: str,

DeleteBotRequestRequestTypeDef#

# DeleteBotRequestRequestTypeDef definition

class DeleteBotRequestRequestTypeDef(TypedDict):
    name: str,

DeleteBotVersionRequestRequestTypeDef#

# DeleteBotVersionRequestRequestTypeDef definition

class DeleteBotVersionRequestRequestTypeDef(TypedDict):
    name: str,
    version: str,

DeleteIntentRequestRequestTypeDef#

# DeleteIntentRequestRequestTypeDef definition

class DeleteIntentRequestRequestTypeDef(TypedDict):
    name: str,

DeleteIntentVersionRequestRequestTypeDef#

# DeleteIntentVersionRequestRequestTypeDef definition

class DeleteIntentVersionRequestRequestTypeDef(TypedDict):
    name: str,
    version: str,

DeleteSlotTypeRequestRequestTypeDef#

# DeleteSlotTypeRequestRequestTypeDef definition

class DeleteSlotTypeRequestRequestTypeDef(TypedDict):
    name: str,

DeleteSlotTypeVersionRequestRequestTypeDef#

# DeleteSlotTypeVersionRequestRequestTypeDef definition

class DeleteSlotTypeVersionRequestRequestTypeDef(TypedDict):
    name: str,
    version: str,

DeleteUtterancesRequestRequestTypeDef#

# DeleteUtterancesRequestRequestTypeDef definition

class DeleteUtterancesRequestRequestTypeDef(TypedDict):
    botName: str,
    userId: str,

GetBotAliasRequestRequestTypeDef#

# GetBotAliasRequestRequestTypeDef definition

class GetBotAliasRequestRequestTypeDef(TypedDict):
    name: str,
    botName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

GetBotAliasesRequestRequestTypeDef#

# GetBotAliasesRequestRequestTypeDef definition

class GetBotAliasesRequestRequestTypeDef(TypedDict):
    botName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    nameContains: NotRequired[str],

GetBotChannelAssociationRequestRequestTypeDef#

# GetBotChannelAssociationRequestRequestTypeDef definition

class GetBotChannelAssociationRequestRequestTypeDef(TypedDict):
    name: str,
    botName: str,
    botAlias: str,

GetBotChannelAssociationsRequestRequestTypeDef#

# GetBotChannelAssociationsRequestRequestTypeDef definition

class GetBotChannelAssociationsRequestRequestTypeDef(TypedDict):
    botName: str,
    botAlias: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    nameContains: NotRequired[str],

GetBotRequestRequestTypeDef#

# GetBotRequestRequestTypeDef definition

class GetBotRequestRequestTypeDef(TypedDict):
    name: str,
    versionOrAlias: str,

GetBotVersionsRequestRequestTypeDef#

# GetBotVersionsRequestRequestTypeDef definition

class GetBotVersionsRequestRequestTypeDef(TypedDict):
    name: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

GetBotsRequestRequestTypeDef#

# GetBotsRequestRequestTypeDef definition

class GetBotsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    nameContains: NotRequired[str],

GetBuiltinIntentRequestRequestTypeDef#

# GetBuiltinIntentRequestRequestTypeDef definition

class GetBuiltinIntentRequestRequestTypeDef(TypedDict):
    signature: str,

GetBuiltinIntentsRequestRequestTypeDef#

# GetBuiltinIntentsRequestRequestTypeDef definition

class GetBuiltinIntentsRequestRequestTypeDef(TypedDict):
    locale: NotRequired[LocaleType],  # (1)
    signatureContains: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See LocaleType

GetBuiltinSlotTypesRequestRequestTypeDef#

# GetBuiltinSlotTypesRequestRequestTypeDef definition

class GetBuiltinSlotTypesRequestRequestTypeDef(TypedDict):
    locale: NotRequired[LocaleType],  # (1)
    signatureContains: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See LocaleType

GetExportRequestRequestTypeDef#

# GetExportRequestRequestTypeDef definition

class GetExportRequestRequestTypeDef(TypedDict):
    name: str,
    version: str,
    resourceType: ResourceTypeType,  # (1)
    exportType: ExportTypeType,  # (2)
  1. See ResourceTypeType
  2. See ExportTypeType

GetImportRequestRequestTypeDef#

# GetImportRequestRequestTypeDef definition

class GetImportRequestRequestTypeDef(TypedDict):
    importId: str,

GetIntentRequestRequestTypeDef#

# GetIntentRequestRequestTypeDef definition

class GetIntentRequestRequestTypeDef(TypedDict):
    name: str,
    version: str,

GetIntentVersionsRequestRequestTypeDef#

# GetIntentVersionsRequestRequestTypeDef definition

class GetIntentVersionsRequestRequestTypeDef(TypedDict):
    name: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

IntentMetadataTypeDef#

# IntentMetadataTypeDef definition

class IntentMetadataTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    lastUpdatedDate: NotRequired[datetime],
    createdDate: NotRequired[datetime],
    version: NotRequired[str],

GetIntentsRequestRequestTypeDef#

# GetIntentsRequestRequestTypeDef definition

class GetIntentsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    nameContains: NotRequired[str],

GetMigrationRequestRequestTypeDef#

# GetMigrationRequestRequestTypeDef definition

class GetMigrationRequestRequestTypeDef(TypedDict):
    migrationId: str,

MigrationAlertTypeDef#

# MigrationAlertTypeDef definition

class MigrationAlertTypeDef(TypedDict):
    type: NotRequired[MigrationAlertTypeType],  # (1)
    message: NotRequired[str],
    details: NotRequired[List[str]],
    referenceURLs: NotRequired[List[str]],
  1. See MigrationAlertTypeType

GetMigrationsRequestRequestTypeDef#

# GetMigrationsRequestRequestTypeDef definition

class GetMigrationsRequestRequestTypeDef(TypedDict):
    sortByAttribute: NotRequired[MigrationSortAttributeType],  # (1)
    sortByOrder: NotRequired[SortOrderType],  # (2)
    v1BotNameContains: NotRequired[str],
    migrationStatusEquals: NotRequired[MigrationStatusType],  # (3)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See MigrationSortAttributeType
  2. See SortOrderType
  3. See MigrationStatusType

MigrationSummaryTypeDef#

# MigrationSummaryTypeDef definition

class MigrationSummaryTypeDef(TypedDict):
    migrationId: NotRequired[str],
    v1BotName: NotRequired[str],
    v1BotVersion: NotRequired[str],
    v1BotLocale: NotRequired[LocaleType],  # (1)
    v2BotId: NotRequired[str],
    v2BotRole: NotRequired[str],
    migrationStatus: NotRequired[MigrationStatusType],  # (2)
    migrationStrategy: NotRequired[MigrationStrategyType],  # (3)
    migrationTimestamp: NotRequired[datetime],
  1. See LocaleType
  2. See MigrationStatusType
  3. See MigrationStrategyType

GetSlotTypeRequestRequestTypeDef#

# GetSlotTypeRequestRequestTypeDef definition

class GetSlotTypeRequestRequestTypeDef(TypedDict):
    name: str,
    version: str,

GetSlotTypeVersionsRequestRequestTypeDef#

# GetSlotTypeVersionsRequestRequestTypeDef definition

class GetSlotTypeVersionsRequestRequestTypeDef(TypedDict):
    name: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

SlotTypeMetadataTypeDef#

# SlotTypeMetadataTypeDef definition

class SlotTypeMetadataTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    lastUpdatedDate: NotRequired[datetime],
    createdDate: NotRequired[datetime],
    version: NotRequired[str],

GetSlotTypesRequestRequestTypeDef#

# GetSlotTypesRequestRequestTypeDef definition

class GetSlotTypesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    nameContains: NotRequired[str],

GetUtterancesViewRequestRequestTypeDef#

# GetUtterancesViewRequestRequestTypeDef definition

class GetUtterancesViewRequestRequestTypeDef(TypedDict):
    botName: str,
    botVersions: Sequence[str],
    statusType: StatusTypeType,  # (1)
  1. See StatusTypeType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

TagTypeDef#

# TagTypeDef definition

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

MessageTypeDef#

# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    contentType: ContentTypeType,  # (1)
    content: str,
    groupNumber: NotRequired[int],
  1. See ContentTypeType

SlotDefaultValueTypeDef#

# SlotDefaultValueTypeDef definition

class SlotDefaultValueTypeDef(TypedDict):
    defaultValue: str,

SlotTypeRegexConfigurationTypeDef#

# SlotTypeRegexConfigurationTypeDef definition

class SlotTypeRegexConfigurationTypeDef(TypedDict):
    pattern: str,

StartMigrationRequestRequestTypeDef#

# StartMigrationRequestRequestTypeDef definition

class StartMigrationRequestRequestTypeDef(TypedDict):
    v1BotName: str,
    v1BotVersion: str,
    v2BotName: str,
    v2BotRole: str,
    migrationStrategy: MigrationStrategyType,  # (1)
  1. See MigrationStrategyType

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UtteranceDataTypeDef#

# UtteranceDataTypeDef definition

class UtteranceDataTypeDef(TypedDict):
    utteranceString: NotRequired[str],
    count: NotRequired[int],
    distinctUsers: NotRequired[int],
    firstUtteredDate: NotRequired[datetime],
    lastUtteredDate: NotRequired[datetime],

FulfillmentActivityTypeDef#

# FulfillmentActivityTypeDef definition

class FulfillmentActivityTypeDef(TypedDict):
    type: FulfillmentActivityTypeType,  # (1)
    codeHook: NotRequired[CodeHookTypeDef],  # (2)
  1. See FulfillmentActivityTypeType
  2. See CodeHookTypeDef

ConversationLogsRequestTypeDef#

# ConversationLogsRequestTypeDef definition

class ConversationLogsRequestTypeDef(TypedDict):
    logSettings: Sequence[LogSettingsRequestTypeDef],  # (1)
    iamRoleArn: str,
  1. See LogSettingsRequestTypeDef

ConversationLogsResponseTypeDef#

# ConversationLogsResponseTypeDef definition

class ConversationLogsResponseTypeDef(TypedDict):
    logSettings: NotRequired[List[LogSettingsResponseTypeDef]],  # (1)
    iamRoleArn: NotRequired[str],
  1. See LogSettingsResponseTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetBotChannelAssociationResponseTypeDef#

# GetBotChannelAssociationResponseTypeDef definition

class GetBotChannelAssociationResponseTypeDef(TypedDict):
    name: str,
    description: str,
    botAlias: str,
    botName: str,
    createdDate: datetime,
    type: ChannelTypeType,  # (1)
    botConfiguration: Dict[str, str],
    status: ChannelStatusType,  # (2)
    failureReason: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ChannelTypeType
  2. See ChannelStatusType
  3. See ResponseMetadataTypeDef

GetBotChannelAssociationsResponseTypeDef#

# GetBotChannelAssociationsResponseTypeDef definition

class GetBotChannelAssociationsResponseTypeDef(TypedDict):
    botChannelAssociations: List[BotChannelAssociationTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotChannelAssociationTypeDef
  2. See ResponseMetadataTypeDef

GetBotVersionsResponseTypeDef#

# GetBotVersionsResponseTypeDef definition

class GetBotVersionsResponseTypeDef(TypedDict):
    bots: List[BotMetadataTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotMetadataTypeDef
  2. See ResponseMetadataTypeDef

GetBotsResponseTypeDef#

# GetBotsResponseTypeDef definition

class GetBotsResponseTypeDef(TypedDict):
    bots: List[BotMetadataTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotMetadataTypeDef
  2. See ResponseMetadataTypeDef

GetBuiltinIntentResponseTypeDef#

# GetBuiltinIntentResponseTypeDef definition

class GetBuiltinIntentResponseTypeDef(TypedDict):
    signature: str,
    supportedLocales: List[LocaleType],  # (1)
    slots: List[BuiltinIntentSlotTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LocaleType
  2. See BuiltinIntentSlotTypeDef
  3. See ResponseMetadataTypeDef

GetBuiltinIntentsResponseTypeDef#

# GetBuiltinIntentsResponseTypeDef definition

class GetBuiltinIntentsResponseTypeDef(TypedDict):
    intents: List[BuiltinIntentMetadataTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BuiltinIntentMetadataTypeDef
  2. See ResponseMetadataTypeDef

GetBuiltinSlotTypesResponseTypeDef#

# GetBuiltinSlotTypesResponseTypeDef definition

class GetBuiltinSlotTypesResponseTypeDef(TypedDict):
    slotTypes: List[BuiltinSlotTypeMetadataTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BuiltinSlotTypeMetadataTypeDef
  2. See