Type definitions#
Index > LexModelBuildingService > Type definitions
Auto-generated documentation for LexModelBuildingService type annotations stubs module types-aiobotocore-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],
- See ChannelTypeType
- 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],
- See StatusType
BuiltinIntentMetadataTypeDef#
# BuiltinIntentMetadataTypeDef definition
class BuiltinIntentMetadataTypeDef(TypedDict):
signature: NotRequired[str],
supportedLocales: NotRequired[List[LocaleType]], # (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)
- 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],
- See LogTypeType
- 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],
- See LogTypeType
- 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],
- See LocaleType
GetBuiltinSlotTypesRequestRequestTypeDef#
# GetBuiltinSlotTypesRequestRequestTypeDef definition
class GetBuiltinSlotTypesRequestRequestTypeDef(TypedDict):
locale: NotRequired[LocaleType], # (1)
signatureContains: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
- See LocaleType
GetExportRequestRequestTypeDef#
# GetExportRequestRequestTypeDef definition
class GetExportRequestRequestTypeDef(TypedDict):
name: str,
version: str,
resourceType: ResourceTypeType, # (1)
exportType: ExportTypeType, # (2)
- See ResourceTypeType
- 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]],
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],
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],
- See LocaleType
- See MigrationStatusType
- 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)
- 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],
- 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)
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)
ConversationLogsRequestTypeDef#
# ConversationLogsRequestTypeDef definition
class ConversationLogsRequestTypeDef(TypedDict):
logSettings: Sequence[LogSettingsRequestTypeDef], # (1)
iamRoleArn: str,
ConversationLogsResponseTypeDef#
# ConversationLogsResponseTypeDef definition
class ConversationLogsResponseTypeDef(TypedDict):
logSettings: NotRequired[List[LogSettingsResponseTypeDef]], # (1)
iamRoleArn: NotRequired[str],
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
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)
- See ChannelTypeType
- See ChannelStatusType
- See ResponseMetadataTypeDef
GetBotChannelAssociationsResponseTypeDef#
# GetBotChannelAssociationsResponseTypeDef definition
class GetBotChannelAssociationsResponseTypeDef(TypedDict):
botChannelAssociations: List[BotChannelAssociationTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBotVersionsResponseTypeDef#
# GetBotVersionsResponseTypeDef definition
class GetBotVersionsResponseTypeDef(TypedDict):
bots: List[BotMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBotsResponseTypeDef#
# GetBotsResponseTypeDef definition
class GetBotsResponseTypeDef(TypedDict):
bots: List[BotMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBuiltinIntentResponseTypeDef#
# GetBuiltinIntentResponseTypeDef definition
class GetBuiltinIntentResponseTypeDef(TypedDict):
signature: str,
supportedLocales: List[LocaleType], # (1)
slots: List[BuiltinIntentSlotTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetBuiltinIntentsResponseTypeDef#
# GetBuiltinIntentsResponseTypeDef definition
class GetBuiltinIntentsResponseTypeDef(TypedDict):
intents: List[BuiltinIntentMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBuiltinSlotTypesResponseTypeDef#
# GetBuiltinSlotTypesResponseTypeDef definition
class GetBuiltinSlotTypesResponseTypeDef(TypedDict):
slotTypes: List[BuiltinSlotTypeMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetExportResponseTypeDef#
# GetExportResponseTypeDef definition
class GetExportResponseTypeDef(TypedDict):
name: str,
version: str,
resourceType: ResourceTypeType, # (1)
exportType: ExportTypeType, # (2)
exportStatus: ExportStatusType, # (3)
failureReason: str,
url: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ResourceTypeType
- See ExportTypeType
- See ExportStatusType
- See ResponseMetadataTypeDef
GetImportResponseTypeDef#
# GetImportResponseTypeDef definition
class GetImportResponseTypeDef(TypedDict):
name: str,
resourceType: ResourceTypeType, # (1)
mergeStrategy: MergeStrategyType, # (2)
importId: str,
importStatus: ImportStatusType, # (3)
failureReason: List[str],
createdDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ResourceTypeType
- See MergeStrategyType
- See ImportStatusType
- See ResponseMetadataTypeDef
StartMigrationResponseTypeDef#
# StartMigrationResponseTypeDef definition
class StartMigrationResponseTypeDef(TypedDict):
v1BotName: str,
v1BotVersion: str,
v1BotLocale: LocaleType, # (1)
v2BotId: str,
v2BotRole: str,
migrationId: str,
migrationStrategy: MigrationStrategyType, # (2)
migrationTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See LocaleType
- See MigrationStrategyType
- See ResponseMetadataTypeDef
GetBotAliasesRequestGetBotAliasesPaginateTypeDef#
# GetBotAliasesRequestGetBotAliasesPaginateTypeDef definition
class GetBotAliasesRequestGetBotAliasesPaginateTypeDef(TypedDict):
botName: str,
nameContains: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetBotChannelAssociationsRequestGetBotChannelAssociationsPaginateTypeDef#
# GetBotChannelAssociationsRequestGetBotChannelAssociationsPaginateTypeDef definition
class GetBotChannelAssociationsRequestGetBotChannelAssociationsPaginateTypeDef(TypedDict):
botName: str,
botAlias: str,
nameContains: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetBotVersionsRequestGetBotVersionsPaginateTypeDef#
# GetBotVersionsRequestGetBotVersionsPaginateTypeDef definition
class GetBotVersionsRequestGetBotVersionsPaginateTypeDef(TypedDict):
name: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetBotsRequestGetBotsPaginateTypeDef#
# GetBotsRequestGetBotsPaginateTypeDef definition
class GetBotsRequestGetBotsPaginateTypeDef(TypedDict):
nameContains: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetBuiltinIntentsRequestGetBuiltinIntentsPaginateTypeDef#
# GetBuiltinIntentsRequestGetBuiltinIntentsPaginateTypeDef definition
class GetBuiltinIntentsRequestGetBuiltinIntentsPaginateTypeDef(TypedDict):
locale: NotRequired[LocaleType], # (1)
signatureContains: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See LocaleType
- See PaginatorConfigTypeDef
GetBuiltinSlotTypesRequestGetBuiltinSlotTypesPaginateTypeDef#
# GetBuiltinSlotTypesRequestGetBuiltinSlotTypesPaginateTypeDef definition
class GetBuiltinSlotTypesRequestGetBuiltinSlotTypesPaginateTypeDef(TypedDict):
locale: NotRequired[LocaleType], # (1)
signatureContains: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See LocaleType
- See PaginatorConfigTypeDef
GetIntentVersionsRequestGetIntentVersionsPaginateTypeDef#
# GetIntentVersionsRequestGetIntentVersionsPaginateTypeDef definition
class GetIntentVersionsRequestGetIntentVersionsPaginateTypeDef(TypedDict):
name: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetIntentsRequestGetIntentsPaginateTypeDef#
# GetIntentsRequestGetIntentsPaginateTypeDef definition
class GetIntentsRequestGetIntentsPaginateTypeDef(TypedDict):
nameContains: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSlotTypeVersionsRequestGetSlotTypeVersionsPaginateTypeDef#
# GetSlotTypeVersionsRequestGetSlotTypeVersionsPaginateTypeDef definition
class GetSlotTypeVersionsRequestGetSlotTypeVersionsPaginateTypeDef(TypedDict):
name: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSlotTypesRequestGetSlotTypesPaginateTypeDef#
# GetSlotTypesRequestGetSlotTypesPaginateTypeDef definition
class GetSlotTypesRequestGetSlotTypesPaginateTypeDef(TypedDict):
nameContains: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetIntentVersionsResponseTypeDef#
# GetIntentVersionsResponseTypeDef definition
class GetIntentVersionsResponseTypeDef(TypedDict):
intents: List[IntentMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetIntentsResponseTypeDef#
# GetIntentsResponseTypeDef definition
class GetIntentsResponseTypeDef(TypedDict):
intents: List[IntentMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetMigrationResponseTypeDef#
# GetMigrationResponseTypeDef definition
class GetMigrationResponseTypeDef(TypedDict):
migrationId: str,
v1BotName: str,
v1BotVersion: str,
v1BotLocale: LocaleType, # (1)
v2BotId: str,
v2BotRole: str,
migrationStatus: MigrationStatusType, # (2)
migrationStrategy: MigrationStrategyType, # (3)
migrationTimestamp: datetime,
alerts: List[MigrationAlertTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See LocaleType
- See MigrationStatusType
- See MigrationStrategyType
- See MigrationAlertTypeDef
- See ResponseMetadataTypeDef
GetMigrationsResponseTypeDef#
# GetMigrationsResponseTypeDef definition
class GetMigrationsResponseTypeDef(TypedDict):
migrationSummaries: List[MigrationSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSlotTypeVersionsResponseTypeDef#
# GetSlotTypeVersionsResponseTypeDef definition
class GetSlotTypeVersionsResponseTypeDef(TypedDict):
slotTypes: List[SlotTypeMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSlotTypesResponseTypeDef#
# GetSlotTypesResponseTypeDef definition
class GetSlotTypesResponseTypeDef(TypedDict):
slotTypes: List[SlotTypeMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
StartImportRequestRequestTypeDef#
# StartImportRequestRequestTypeDef definition
class StartImportRequestRequestTypeDef(TypedDict):
payload: Union[str, bytes, IO[Any], StreamingBody],
resourceType: ResourceTypeType, # (1)
mergeStrategy: MergeStrategyType, # (2)
tags: NotRequired[Sequence[TagTypeDef]], # (3)
- See ResourceTypeType
- See MergeStrategyType
- See TagTypeDef
StartImportResponseTypeDef#
# StartImportResponseTypeDef definition
class StartImportResponseTypeDef(TypedDict):
name: str,
resourceType: ResourceTypeType, # (1)
mergeStrategy: MergeStrategyType, # (2)
importId: str,
importStatus: ImportStatusType, # (3)
tags: List[TagTypeDef], # (4)
createdDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See ResourceTypeType
- See MergeStrategyType
- See ImportStatusType
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
PromptTypeDef#
# PromptTypeDef definition
class PromptTypeDef(TypedDict):
messages: List[MessageTypeDef], # (1)
maxAttempts: int,
responseCard: NotRequired[str],
- See MessageTypeDef
StatementTypeDef#
# StatementTypeDef definition
class StatementTypeDef(TypedDict):
messages: List[MessageTypeDef], # (1)
responseCard: NotRequired[str],
- See MessageTypeDef
SlotDefaultValueSpecTypeDef#
# SlotDefaultValueSpecTypeDef definition
class SlotDefaultValueSpecTypeDef(TypedDict):
defaultValueList: List[SlotDefaultValueTypeDef], # (1)
SlotTypeConfigurationTypeDef#
# SlotTypeConfigurationTypeDef definition
class SlotTypeConfigurationTypeDef(TypedDict):
regexConfiguration: NotRequired[SlotTypeRegexConfigurationTypeDef], # (1)
UtteranceListTypeDef#
# UtteranceListTypeDef definition
class UtteranceListTypeDef(TypedDict):
botVersion: NotRequired[str],
utterances: NotRequired[List[UtteranceDataTypeDef]], # (1)
PutBotAliasRequestRequestTypeDef#
# PutBotAliasRequestRequestTypeDef definition
class PutBotAliasRequestRequestTypeDef(TypedDict):
name: str,
botVersion: str,
botName: str,
description: NotRequired[str],
checksum: NotRequired[str],
conversationLogs: NotRequired[ConversationLogsRequestTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
BotAliasMetadataTypeDef#
# BotAliasMetadataTypeDef definition
class BotAliasMetadataTypeDef(TypedDict):
name: NotRequired[str],
description: NotRequired[str],
botVersion: NotRequired[str],
botName: NotRequired[str],
lastUpdatedDate: NotRequired[datetime],
createdDate: NotRequired[datetime],
checksum: NotRequired[str],
conversationLogs: NotRequired[ConversationLogsResponseTypeDef], # (1)
GetBotAliasResponseTypeDef#
# GetBotAliasResponseTypeDef definition
class GetBotAliasResponseTypeDef(TypedDict):
name: str,
description: str,
botVersion: str,
botName: str,
lastUpdatedDate: datetime,
createdDate: datetime,
checksum: str,
conversationLogs: ConversationLogsResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutBotAliasResponseTypeDef#
# PutBotAliasResponseTypeDef definition
class PutBotAliasResponseTypeDef(TypedDict):
name: str,
description: str,
botVersion: str,
botName: str,
lastUpdatedDate: datetime,
createdDate: datetime,
checksum: str,
conversationLogs: ConversationLogsResponseTypeDef, # (1)
tags: List[TagTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
CreateBotVersionResponseTypeDef#
# CreateBotVersionResponseTypeDef definition
class CreateBotVersionResponseTypeDef(TypedDict):
name: str,
description: str,
intents: List[IntentTypeDef], # (1)
clarificationPrompt: PromptTypeDef, # (2)
abortStatement: StatementTypeDef, # (3)
status: StatusType, # (4)
failureReason: str,
lastUpdatedDate: datetime,
createdDate: datetime,
idleSessionTTLInSeconds: int,
voiceId: str,
checksum: str,
version: str,
locale: LocaleType, # (5)
childDirected: bool,
enableModelImprovements: bool,
detectSentiment: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See IntentTypeDef
- See PromptTypeDef
- See StatementTypeDef
- See StatusType
- See LocaleType
- See ResponseMetadataTypeDef
FollowUpPromptTypeDef#
# FollowUpPromptTypeDef definition
class FollowUpPromptTypeDef(TypedDict):
prompt: PromptTypeDef, # (1)
rejectionStatement: StatementTypeDef, # (2)
- See PromptTypeDef
- See StatementTypeDef
GetBotResponseTypeDef#
# GetBotResponseTypeDef definition
class GetBotResponseTypeDef(TypedDict):
name: str,
description: str,
intents: List[IntentTypeDef], # (1)
enableModelImprovements: bool,
nluIntentConfidenceThreshold: float,
clarificationPrompt: PromptTypeDef, # (2)
abortStatement: StatementTypeDef, # (3)
status: StatusType, # (4)
failureReason: str,
lastUpdatedDate: datetime,
createdDate: datetime,
idleSessionTTLInSeconds: int,
voiceId: str,
checksum: str,
version: str,
locale: LocaleType, # (5)
childDirected: bool,
detectSentiment: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See IntentTypeDef
- See PromptTypeDef
- See StatementTypeDef
- See StatusType
- See LocaleType
- See ResponseMetadataTypeDef
PutBotRequestRequestTypeDef#
# PutBotRequestRequestTypeDef definition
class PutBotRequestRequestTypeDef(TypedDict):
name: str,
locale: LocaleType, # (1)
childDirected: bool,
description: NotRequired[str],
intents: NotRequired[Sequence[IntentTypeDef]], # (2)
enableModelImprovements: NotRequired[bool],
nluIntentConfidenceThreshold: NotRequired[float],
clarificationPrompt: NotRequired[PromptTypeDef], # (3)
abortStatement: NotRequired[StatementTypeDef], # (4)
idleSessionTTLInSeconds: NotRequired[int],
voiceId: NotRequired[str],
checksum: NotRequired[str],
processBehavior: NotRequired[ProcessBehaviorType], # (5)
detectSentiment: NotRequired[bool],
createVersion: NotRequired[bool],
tags: NotRequired[Sequence[TagTypeDef]], # (6)
- See LocaleType
- See IntentTypeDef
- See PromptTypeDef
- See StatementTypeDef
- See ProcessBehaviorType
- See TagTypeDef
PutBotResponseTypeDef#
# PutBotResponseTypeDef definition
class PutBotResponseTypeDef(TypedDict):
name: str,
description: str,
intents: List[IntentTypeDef], # (1)
enableModelImprovements: bool,
nluIntentConfidenceThreshold: float,
clarificationPrompt: PromptTypeDef, # (2)
abortStatement: StatementTypeDef, # (3)
status: StatusType, # (4)
failureReason: str,
lastUpdatedDate: datetime,
createdDate: datetime,
idleSessionTTLInSeconds: int,
voiceId: str,
checksum: str,
version: str,
locale: LocaleType, # (5)
childDirected: bool,
createVersion: bool,
detectSentiment: bool,
tags: List[TagTypeDef], # (6)
ResponseMetadata: ResponseMetadataTypeDef, # (7)
- See IntentTypeDef
- See PromptTypeDef
- See StatementTypeDef
- See StatusType
- See LocaleType
- See TagTypeDef
- See ResponseMetadataTypeDef
SlotTypeDef#
# SlotTypeDef definition
class SlotTypeDef(TypedDict):
name: str,
slotConstraint: SlotConstraintType, # (1)
description: NotRequired[str],
slotType: NotRequired[str],
slotTypeVersion: NotRequired[str],
valueElicitationPrompt: NotRequired[PromptTypeDef], # (2)
priority: NotRequired[int],
sampleUtterances: NotRequired[List[str]],
responseCard: NotRequired[str],
obfuscationSetting: NotRequired[ObfuscationSettingType], # (3)
defaultValueSpec: NotRequired[SlotDefaultValueSpecTypeDef], # (4)
CreateSlotTypeVersionResponseTypeDef#
# CreateSlotTypeVersionResponseTypeDef definition
class CreateSlotTypeVersionResponseTypeDef(TypedDict):
name: str,
description: str,
enumerationValues: List[EnumerationValueTypeDef], # (1)
lastUpdatedDate: datetime,
createdDate: datetime,
version: str,
checksum: str,
valueSelectionStrategy: SlotValueSelectionStrategyType, # (2)
parentSlotTypeSignature: str,
slotTypeConfigurations: List[SlotTypeConfigurationTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See EnumerationValueTypeDef
- See SlotValueSelectionStrategyType
- See SlotTypeConfigurationTypeDef
- See ResponseMetadataTypeDef
GetSlotTypeResponseTypeDef#
# GetSlotTypeResponseTypeDef definition
class GetSlotTypeResponseTypeDef(TypedDict):
name: str,
description: str,
enumerationValues: List[EnumerationValueTypeDef], # (1)
lastUpdatedDate: datetime,
createdDate: datetime,
version: str,
checksum: str,
valueSelectionStrategy: SlotValueSelectionStrategyType, # (2)
parentSlotTypeSignature: str,
slotTypeConfigurations: List[SlotTypeConfigurationTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See EnumerationValueTypeDef
- See SlotValueSelectionStrategyType
- See SlotTypeConfigurationTypeDef
- See ResponseMetadataTypeDef
PutSlotTypeRequestRequestTypeDef#
# PutSlotTypeRequestRequestTypeDef definition
class PutSlotTypeRequestRequestTypeDef(TypedDict):
name: str,
description: NotRequired[str],
enumerationValues: NotRequired[Sequence[EnumerationValueTypeDef]], # (1)
checksum: NotRequired[str],
valueSelectionStrategy: NotRequired[SlotValueSelectionStrategyType], # (2)
createVersion: NotRequired[bool],
parentSlotTypeSignature: NotRequired[str],
slotTypeConfigurations: NotRequired[Sequence[SlotTypeConfigurationTypeDef]], # (3)
PutSlotTypeResponseTypeDef#
# PutSlotTypeResponseTypeDef definition
class PutSlotTypeResponseTypeDef(TypedDict):
name: str,
description: str,
enumerationValues: List[EnumerationValueTypeDef], # (1)
lastUpdatedDate: datetime,
createdDate: datetime,
version: str,
checksum: str,
valueSelectionStrategy: SlotValueSelectionStrategyType, # (2)
createVersion: bool,
parentSlotTypeSignature: str,
slotTypeConfigurations: List[SlotTypeConfigurationTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See EnumerationValueTypeDef
- See SlotValueSelectionStrategyType
- See SlotTypeConfigurationTypeDef
- See ResponseMetadataTypeDef
GetUtterancesViewResponseTypeDef#
# GetUtterancesViewResponseTypeDef definition
class GetUtterancesViewResponseTypeDef(TypedDict):
botName: str,
utterances: List[UtteranceListTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBotAliasesResponseTypeDef#
# GetBotAliasesResponseTypeDef definition
class GetBotAliasesResponseTypeDef(TypedDict):
BotAliases: List[BotAliasMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateIntentVersionResponseTypeDef#
# CreateIntentVersionResponseTypeDef definition
class CreateIntentVersionResponseTypeDef(TypedDict):
name: str,
description: str,
slots: List[SlotTypeDef], # (1)
sampleUtterances: List[str],
confirmationPrompt: PromptTypeDef, # (2)
rejectionStatement: StatementTypeDef, # (3)
followUpPrompt: FollowUpPromptTypeDef, # (4)
conclusionStatement: StatementTypeDef, # (3)
dialogCodeHook: CodeHookTypeDef, # (6)
fulfillmentActivity: FulfillmentActivityTypeDef, # (7)
parentIntentSignature: str,
lastUpdatedDate: datetime,
createdDate: datetime,
version: str,
checksum: str,
kendraConfiguration: KendraConfigurationTypeDef, # (8)
inputContexts: List[InputContextTypeDef], # (9)
outputContexts: List[OutputContextTypeDef], # (10)
ResponseMetadata: ResponseMetadataTypeDef, # (11)
- See SlotTypeDef
- See PromptTypeDef
- See StatementTypeDef
- See FollowUpPromptTypeDef
- See StatementTypeDef
- See CodeHookTypeDef
- See FulfillmentActivityTypeDef
- See KendraConfigurationTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See ResponseMetadataTypeDef
GetIntentResponseTypeDef#
# GetIntentResponseTypeDef definition
class GetIntentResponseTypeDef(TypedDict):
name: str,
description: str,
slots: List[SlotTypeDef], # (1)
sampleUtterances: List[str],
confirmationPrompt: PromptTypeDef, # (2)
rejectionStatement: StatementTypeDef, # (3)
followUpPrompt: FollowUpPromptTypeDef, # (4)
conclusionStatement: StatementTypeDef, # (3)
dialogCodeHook: CodeHookTypeDef, # (6)
fulfillmentActivity: FulfillmentActivityTypeDef, # (7)
parentIntentSignature: str,
lastUpdatedDate: datetime,
createdDate: datetime,
version: str,
checksum: str,
kendraConfiguration: KendraConfigurationTypeDef, # (8)
inputContexts: List[InputContextTypeDef], # (9)
outputContexts: List[OutputContextTypeDef], # (10)
ResponseMetadata: ResponseMetadataTypeDef, # (11)
- See SlotTypeDef
- See PromptTypeDef
- See StatementTypeDef
- See FollowUpPromptTypeDef
- See StatementTypeDef
- See CodeHookTypeDef
- See FulfillmentActivityTypeDef
- See KendraConfigurationTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See ResponseMetadataTypeDef
PutIntentRequestRequestTypeDef#
# PutIntentRequestRequestTypeDef definition
class PutIntentRequestRequestTypeDef(TypedDict):
name: str,
description: NotRequired[str],
slots: NotRequired[Sequence[SlotTypeDef]], # (1)
sampleUtterances: NotRequired[Sequence[str]],
confirmationPrompt: NotRequired[PromptTypeDef], # (2)
rejectionStatement: NotRequired[StatementTypeDef], # (3)
followUpPrompt: NotRequired[FollowUpPromptTypeDef], # (4)
conclusionStatement: NotRequired[StatementTypeDef], # (3)
dialogCodeHook: NotRequired[CodeHookTypeDef], # (6)
fulfillmentActivity: NotRequired[FulfillmentActivityTypeDef], # (7)
parentIntentSignature: NotRequired[str],
checksum: NotRequired[str],
createVersion: NotRequired[bool],
kendraConfiguration: NotRequired[KendraConfigurationTypeDef], # (8)
inputContexts: NotRequired[Sequence[InputContextTypeDef]], # (9)
outputContexts: NotRequired[Sequence[OutputContextTypeDef]], # (10)
- See SlotTypeDef
- See PromptTypeDef
- See StatementTypeDef
- See FollowUpPromptTypeDef
- See StatementTypeDef
- See CodeHookTypeDef
- See FulfillmentActivityTypeDef
- See KendraConfigurationTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
PutIntentResponseTypeDef#
# PutIntentResponseTypeDef definition
class PutIntentResponseTypeDef(TypedDict):
name: str,
description: str,
slots: List[SlotTypeDef], # (1)
sampleUtterances: List[str],
confirmationPrompt: PromptTypeDef, # (2)
rejectionStatement: StatementTypeDef, # (3)
followUpPrompt: FollowUpPromptTypeDef, # (4)
conclusionStatement: StatementTypeDef, # (3)
dialogCodeHook: CodeHookTypeDef, # (6)
fulfillmentActivity: FulfillmentActivityTypeDef, # (7)
parentIntentSignature: str,
lastUpdatedDate: datetime,
createdDate: datetime,
version: str,
checksum: str,
createVersion: bool,
kendraConfiguration: KendraConfigurationTypeDef, # (8)
inputContexts: List[InputContextTypeDef], # (9)
outputContexts: List[OutputContextTypeDef], # (10)
ResponseMetadata: ResponseMetadataTypeDef, # (11)
- See SlotTypeDef
- See PromptTypeDef
- See StatementTypeDef
- See FollowUpPromptTypeDef
- See StatementTypeDef
- See CodeHookTypeDef
- See FulfillmentActivityTypeDef
- See KendraConfigurationTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See ResponseMetadataTypeDef