Type definitions#
Index > LexModelsV2 > Type definitions
Auto-generated documentation for LexModelsV2 type annotations stubs module types-aiobotocore-lexv2-models.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
ActiveContextTypeDef#
# ActiveContextTypeDef definition
class ActiveContextTypeDef(TypedDict):
name: str,
AdvancedRecognitionSettingTypeDef#
# AdvancedRecognitionSettingTypeDef definition
class AdvancedRecognitionSettingTypeDef(TypedDict):
audioRecognitionStrategy: NotRequired[AudioRecognitionStrategyType], # (1)
ExecutionErrorDetailsTypeDef#
# ExecutionErrorDetailsTypeDef definition
class ExecutionErrorDetailsTypeDef(TypedDict):
errorCode: str,
errorMessage: str,
AgentTurnSpecificationTypeDef#
# AgentTurnSpecificationTypeDef definition
class AgentTurnSpecificationTypeDef(TypedDict):
agentPrompt: str,
AggregatedUtterancesFilterTypeDef#
# AggregatedUtterancesFilterTypeDef definition
class AggregatedUtterancesFilterTypeDef(TypedDict):
name: AggregatedUtterancesFilterNameType, # (1)
values: Sequence[str],
operator: AggregatedUtterancesFilterOperatorType, # (2)
AggregatedUtterancesSortByTypeDef#
# AggregatedUtterancesSortByTypeDef definition
class AggregatedUtterancesSortByTypeDef(TypedDict):
attribute: AggregatedUtterancesSortAttributeType, # (1)
order: SortOrderType, # (2)
AggregatedUtterancesSummaryTypeDef#
# AggregatedUtterancesSummaryTypeDef definition
class AggregatedUtterancesSummaryTypeDef(TypedDict):
utterance: NotRequired[str],
hitCount: NotRequired[int],
missedCount: NotRequired[int],
utteranceFirstRecordedInAggregationDuration: NotRequired[datetime],
utteranceLastRecordedInAggregationDuration: NotRequired[datetime],
containsDataFromDeletedResources: NotRequired[bool],
AllowedInputTypesTypeDef#
# AllowedInputTypesTypeDef definition
class AllowedInputTypesTypeDef(TypedDict):
allowAudioInput: bool,
allowDTMFInput: bool,
AnalyticsBinBySpecificationTypeDef#
# AnalyticsBinBySpecificationTypeDef definition
class AnalyticsBinBySpecificationTypeDef(TypedDict):
name: AnalyticsBinByNameType, # (1)
interval: AnalyticsIntervalType, # (2)
order: NotRequired[AnalyticsSortOrderType], # (3)
AnalyticsBinKeyTypeDef#
# AnalyticsBinKeyTypeDef definition
class AnalyticsBinKeyTypeDef(TypedDict):
name: NotRequired[AnalyticsBinByNameType], # (1)
value: NotRequired[int],
AnalyticsIntentFilterTypeDef#
# AnalyticsIntentFilterTypeDef definition
class AnalyticsIntentFilterTypeDef(TypedDict):
name: AnalyticsIntentFilterNameType, # (1)
operator: AnalyticsFilterOperatorType, # (2)
values: Sequence[str],
AnalyticsIntentGroupByKeyTypeDef#
# AnalyticsIntentGroupByKeyTypeDef definition
class AnalyticsIntentGroupByKeyTypeDef(TypedDict):
name: NotRequired[AnalyticsIntentFieldType], # (1)
value: NotRequired[str],
AnalyticsIntentGroupBySpecificationTypeDef#
# AnalyticsIntentGroupBySpecificationTypeDef definition
class AnalyticsIntentGroupBySpecificationTypeDef(TypedDict):
name: AnalyticsIntentFieldType, # (1)
AnalyticsIntentMetricResultTypeDef#
# AnalyticsIntentMetricResultTypeDef definition
class AnalyticsIntentMetricResultTypeDef(TypedDict):
name: NotRequired[AnalyticsIntentMetricNameType], # (1)
statistic: NotRequired[AnalyticsMetricStatisticType], # (2)
value: NotRequired[float],
AnalyticsIntentMetricTypeDef#
# AnalyticsIntentMetricTypeDef definition
class AnalyticsIntentMetricTypeDef(TypedDict):
name: AnalyticsIntentMetricNameType, # (1)
statistic: AnalyticsMetricStatisticType, # (2)
order: NotRequired[AnalyticsSortOrderType], # (3)
AnalyticsIntentNodeSummaryTypeDef#
# AnalyticsIntentNodeSummaryTypeDef definition
class AnalyticsIntentNodeSummaryTypeDef(TypedDict):
intentName: NotRequired[str],
intentPath: NotRequired[str],
intentCount: NotRequired[int],
intentLevel: NotRequired[int],
nodeType: NotRequired[AnalyticsNodeTypeType], # (1)
AnalyticsIntentStageFilterTypeDef#
# AnalyticsIntentStageFilterTypeDef definition
class AnalyticsIntentStageFilterTypeDef(TypedDict):
name: AnalyticsIntentStageFilterNameType, # (1)
operator: AnalyticsFilterOperatorType, # (2)
values: Sequence[str],
AnalyticsIntentStageGroupByKeyTypeDef#
# AnalyticsIntentStageGroupByKeyTypeDef definition
class AnalyticsIntentStageGroupByKeyTypeDef(TypedDict):
name: NotRequired[AnalyticsIntentStageFieldType], # (1)
value: NotRequired[str],
AnalyticsIntentStageGroupBySpecificationTypeDef#
# AnalyticsIntentStageGroupBySpecificationTypeDef definition
class AnalyticsIntentStageGroupBySpecificationTypeDef(TypedDict):
name: AnalyticsIntentStageFieldType, # (1)
AnalyticsIntentStageMetricResultTypeDef#
# AnalyticsIntentStageMetricResultTypeDef definition
class AnalyticsIntentStageMetricResultTypeDef(TypedDict):
name: NotRequired[AnalyticsIntentStageMetricNameType], # (1)
statistic: NotRequired[AnalyticsMetricStatisticType], # (2)
value: NotRequired[float],
AnalyticsIntentStageMetricTypeDef#
# AnalyticsIntentStageMetricTypeDef definition
class AnalyticsIntentStageMetricTypeDef(TypedDict):
name: AnalyticsIntentStageMetricNameType, # (1)
statistic: AnalyticsMetricStatisticType, # (2)
order: NotRequired[AnalyticsSortOrderType], # (3)
AnalyticsPathFilterTypeDef#
# AnalyticsPathFilterTypeDef definition
class AnalyticsPathFilterTypeDef(TypedDict):
name: AnalyticsCommonFilterNameType, # (1)
operator: AnalyticsFilterOperatorType, # (2)
values: Sequence[str],
AnalyticsSessionFilterTypeDef#
# AnalyticsSessionFilterTypeDef definition
class AnalyticsSessionFilterTypeDef(TypedDict):
name: AnalyticsSessionFilterNameType, # (1)
operator: AnalyticsFilterOperatorType, # (2)
values: Sequence[str],
AnalyticsSessionGroupByKeyTypeDef#
# AnalyticsSessionGroupByKeyTypeDef definition
class AnalyticsSessionGroupByKeyTypeDef(TypedDict):
name: NotRequired[AnalyticsSessionFieldType], # (1)
value: NotRequired[str],
AnalyticsSessionGroupBySpecificationTypeDef#
# AnalyticsSessionGroupBySpecificationTypeDef definition
class AnalyticsSessionGroupBySpecificationTypeDef(TypedDict):
name: AnalyticsSessionFieldType, # (1)
AnalyticsSessionMetricResultTypeDef#
# AnalyticsSessionMetricResultTypeDef definition
class AnalyticsSessionMetricResultTypeDef(TypedDict):
name: NotRequired[AnalyticsSessionMetricNameType], # (1)
statistic: NotRequired[AnalyticsMetricStatisticType], # (2)
value: NotRequired[float],
AnalyticsSessionMetricTypeDef#
# AnalyticsSessionMetricTypeDef definition
class AnalyticsSessionMetricTypeDef(TypedDict):
name: AnalyticsSessionMetricNameType, # (1)
statistic: AnalyticsMetricStatisticType, # (2)
order: NotRequired[AnalyticsSortOrderType], # (3)
AnalyticsUtteranceAttributeResultTypeDef#
# AnalyticsUtteranceAttributeResultTypeDef definition
class AnalyticsUtteranceAttributeResultTypeDef(TypedDict):
lastUsedIntent: NotRequired[str],
AnalyticsUtteranceAttributeTypeDef#
# AnalyticsUtteranceAttributeTypeDef definition
class AnalyticsUtteranceAttributeTypeDef(TypedDict):
name: AnalyticsUtteranceAttributeNameType, # (1)
AnalyticsUtteranceFilterTypeDef#
# AnalyticsUtteranceFilterTypeDef definition
class AnalyticsUtteranceFilterTypeDef(TypedDict):
name: AnalyticsUtteranceFilterNameType, # (1)
operator: AnalyticsFilterOperatorType, # (2)
values: Sequence[str],
AnalyticsUtteranceGroupByKeyTypeDef#
# AnalyticsUtteranceGroupByKeyTypeDef definition
class AnalyticsUtteranceGroupByKeyTypeDef(TypedDict):
name: NotRequired[AnalyticsUtteranceFieldType], # (1)
value: NotRequired[str],
AnalyticsUtteranceGroupBySpecificationTypeDef#
# AnalyticsUtteranceGroupBySpecificationTypeDef definition
class AnalyticsUtteranceGroupBySpecificationTypeDef(TypedDict):
name: AnalyticsUtteranceFieldType, # (1)
AnalyticsUtteranceMetricResultTypeDef#
# AnalyticsUtteranceMetricResultTypeDef definition
class AnalyticsUtteranceMetricResultTypeDef(TypedDict):
name: NotRequired[AnalyticsUtteranceMetricNameType], # (1)
statistic: NotRequired[AnalyticsMetricStatisticType], # (2)
value: NotRequired[float],
AnalyticsUtteranceMetricTypeDef#
# AnalyticsUtteranceMetricTypeDef definition
class AnalyticsUtteranceMetricTypeDef(TypedDict):
name: AnalyticsUtteranceMetricNameType, # (1)
statistic: AnalyticsMetricStatisticType, # (2)
order: NotRequired[AnalyticsSortOrderType], # (3)
AssociatedTranscriptFilterTypeDef#
# AssociatedTranscriptFilterTypeDef definition
class AssociatedTranscriptFilterTypeDef(TypedDict):
name: AssociatedTranscriptFilterNameType, # (1)
values: Sequence[str],
AssociatedTranscriptTypeDef#
# AssociatedTranscriptTypeDef definition
class AssociatedTranscriptTypeDef(TypedDict):
transcript: NotRequired[str],
AudioSpecificationTypeDef#
# AudioSpecificationTypeDef definition
class AudioSpecificationTypeDef(TypedDict):
maxLengthMs: int,
endTimeoutMs: int,
DTMFSpecificationTypeDef#
# DTMFSpecificationTypeDef definition
class DTMFSpecificationTypeDef(TypedDict):
maxLength: int,
endTimeoutMs: int,
deletionCharacter: str,
endCharacter: str,
S3BucketLogDestinationTypeDef#
# S3BucketLogDestinationTypeDef definition
class S3BucketLogDestinationTypeDef(TypedDict):
s3BucketArn: str,
logPrefix: str,
kmsKeyArn: NotRequired[str],
NewCustomVocabularyItemTypeDef#
# NewCustomVocabularyItemTypeDef definition
class NewCustomVocabularyItemTypeDef(TypedDict):
phrase: str,
weight: NotRequired[int],
displayAs: NotRequired[str],
CustomVocabularyItemTypeDef#
# CustomVocabularyItemTypeDef definition
class CustomVocabularyItemTypeDef(TypedDict):
itemId: str,
phrase: str,
weight: NotRequired[int],
displayAs: NotRequired[str],
FailedCustomVocabularyItemTypeDef#
# FailedCustomVocabularyItemTypeDef definition
class FailedCustomVocabularyItemTypeDef(TypedDict):
itemId: NotRequired[str],
errorMessage: NotRequired[str],
errorCode: NotRequired[ErrorCodeType], # (1)
- See ErrorCodeType
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CustomVocabularyEntryIdTypeDef#
# CustomVocabularyEntryIdTypeDef definition
class CustomVocabularyEntryIdTypeDef(TypedDict):
itemId: str,
BedrockModelSpecificationTypeDef#
# BedrockModelSpecificationTypeDef definition
class BedrockModelSpecificationTypeDef(TypedDict):
modelArn: str,
BotAliasHistoryEventTypeDef#
# BotAliasHistoryEventTypeDef definition
class BotAliasHistoryEventTypeDef(TypedDict):
botVersion: NotRequired[str],
startDate: NotRequired[datetime],
endDate: NotRequired[datetime],
BotAliasSummaryTypeDef#
# BotAliasSummaryTypeDef definition
class BotAliasSummaryTypeDef(TypedDict):
botAliasId: NotRequired[str],
botAliasName: NotRequired[str],
description: NotRequired[str],
botVersion: NotRequired[str],
botAliasStatus: NotRequired[BotAliasStatusType], # (1)
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
BotAliasTestExecutionTargetTypeDef#
# BotAliasTestExecutionTargetTypeDef definition
class BotAliasTestExecutionTargetTypeDef(TypedDict):
botId: str,
botAliasId: str,
localeId: str,
BotExportSpecificationTypeDef#
# BotExportSpecificationTypeDef definition
class BotExportSpecificationTypeDef(TypedDict):
botId: str,
botVersion: str,
BotFilterTypeDef#
# BotFilterTypeDef definition
class BotFilterTypeDef(TypedDict):
name: BotFilterNameType, # (1)
values: Sequence[str],
operator: BotFilterOperatorType, # (2)
DataPrivacyTypeDef#
# DataPrivacyTypeDef definition
class DataPrivacyTypeDef(TypedDict):
childDirected: bool,
BotLocaleExportSpecificationTypeDef#
# BotLocaleExportSpecificationTypeDef definition
class BotLocaleExportSpecificationTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
BotLocaleFilterTypeDef#
# BotLocaleFilterTypeDef definition
class BotLocaleFilterTypeDef(TypedDict):
name: BotLocaleFilterNameType, # (1)
values: Sequence[str],
operator: BotLocaleFilterOperatorType, # (2)
BotLocaleHistoryEventTypeDef#
# BotLocaleHistoryEventTypeDef definition
class BotLocaleHistoryEventTypeDef(TypedDict):
event: str,
eventDate: datetime,
VoiceSettingsTypeDef#
# VoiceSettingsTypeDef definition
class VoiceSettingsTypeDef(TypedDict):
voiceId: str,
engine: NotRequired[VoiceEngineType], # (1)
- See VoiceEngineType
BotLocaleSortByTypeDef#
# BotLocaleSortByTypeDef definition
class BotLocaleSortByTypeDef(TypedDict):
attribute: BotLocaleSortAttributeType, # (1)
order: SortOrderType, # (2)
BotLocaleSummaryTypeDef#
# BotLocaleSummaryTypeDef definition
class BotLocaleSummaryTypeDef(TypedDict):
localeId: NotRequired[str],
localeName: NotRequired[str],
description: NotRequired[str],
botLocaleStatus: NotRequired[BotLocaleStatusType], # (1)
lastUpdatedDateTime: NotRequired[datetime],
lastBuildSubmittedDateTime: NotRequired[datetime],
BotMemberTypeDef#
# BotMemberTypeDef definition
class BotMemberTypeDef(TypedDict):
botMemberId: str,
botMemberName: str,
botMemberAliasId: str,
botMemberAliasName: str,
botMemberVersion: str,
IntentStatisticsTypeDef#
# IntentStatisticsTypeDef definition
class IntentStatisticsTypeDef(TypedDict):
discoveredIntentCount: NotRequired[int],
SlotTypeStatisticsTypeDef#
# SlotTypeStatisticsTypeDef definition
class SlotTypeStatisticsTypeDef(TypedDict):
discoveredSlotTypeCount: NotRequired[int],
BotRecommendationSummaryTypeDef#
# BotRecommendationSummaryTypeDef definition
class BotRecommendationSummaryTypeDef(TypedDict):
botRecommendationStatus: BotRecommendationStatusType, # (1)
botRecommendationId: str,
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
BotSortByTypeDef#
# BotSortByTypeDef definition
class BotSortByTypeDef(TypedDict):
attribute: BotSortAttributeType, # (1)
order: SortOrderType, # (2)
- See BotSortAttributeType
- See SortOrderType
BotSummaryTypeDef#
# BotSummaryTypeDef definition
class BotSummaryTypeDef(TypedDict):
botId: NotRequired[str],
botName: NotRequired[str],
description: NotRequired[str],
botStatus: NotRequired[BotStatusType], # (1)
latestBotVersion: NotRequired[str],
lastUpdatedDateTime: NotRequired[datetime],
botType: NotRequired[BotTypeType], # (2)
- See BotStatusType
- See BotTypeType
BotVersionLocaleDetailsTypeDef#
# BotVersionLocaleDetailsTypeDef definition
class BotVersionLocaleDetailsTypeDef(TypedDict):
sourceBotVersion: str,
BotVersionSortByTypeDef#
# BotVersionSortByTypeDef definition
class BotVersionSortByTypeDef(TypedDict):
attribute: BotVersionSortAttributeType, # (1)
order: SortOrderType, # (2)
BotVersionSummaryTypeDef#
# BotVersionSummaryTypeDef definition
class BotVersionSummaryTypeDef(TypedDict):
botName: NotRequired[str],
botVersion: NotRequired[str],
description: NotRequired[str],
botStatus: NotRequired[BotStatusType], # (1)
creationDateTime: NotRequired[datetime],
- See BotStatusType
BuildBotLocaleRequestRequestTypeDef#
# BuildBotLocaleRequestRequestTypeDef definition
class BuildBotLocaleRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
BuiltInIntentSortByTypeDef#
# BuiltInIntentSortByTypeDef definition
class BuiltInIntentSortByTypeDef(TypedDict):
attribute: BuiltInIntentSortAttributeType, # (1)
order: SortOrderType, # (2)
BuiltInIntentSummaryTypeDef#
# BuiltInIntentSummaryTypeDef definition
class BuiltInIntentSummaryTypeDef(TypedDict):
intentSignature: NotRequired[str],
description: NotRequired[str],
BuiltInSlotTypeSortByTypeDef#
# BuiltInSlotTypeSortByTypeDef definition
class BuiltInSlotTypeSortByTypeDef(TypedDict):
attribute: BuiltInSlotTypeSortAttributeType, # (1)
order: SortOrderType, # (2)
BuiltInSlotTypeSummaryTypeDef#
# BuiltInSlotTypeSummaryTypeDef definition
class BuiltInSlotTypeSummaryTypeDef(TypedDict):
slotTypeSignature: NotRequired[str],
description: NotRequired[str],
ButtonTypeDef#
# ButtonTypeDef definition
class ButtonTypeDef(TypedDict):
text: str,
value: str,
CloudWatchLogGroupLogDestinationTypeDef#
# CloudWatchLogGroupLogDestinationTypeDef definition
class CloudWatchLogGroupLogDestinationTypeDef(TypedDict):
cloudWatchLogGroupArn: str,
logPrefix: str,
LambdaCodeHookTypeDef#
# LambdaCodeHookTypeDef definition
class LambdaCodeHookTypeDef(TypedDict):
lambdaARN: str,
codeHookInterfaceVersion: str,
SubSlotTypeCompositionTypeDef#
# SubSlotTypeCompositionTypeDef definition
class SubSlotTypeCompositionTypeDef(TypedDict):
name: str,
slotTypeId: str,
ConditionTypeDef#
# ConditionTypeDef definition
class ConditionTypeDef(TypedDict):
expressionString: str,
ConversationLevelIntentClassificationResultItemTypeDef#
# ConversationLevelIntentClassificationResultItemTypeDef definition
class ConversationLevelIntentClassificationResultItemTypeDef(TypedDict):
intentName: str,
matchResult: TestResultMatchStatusType, # (1)
ConversationLevelResultDetailTypeDef#
# ConversationLevelResultDetailTypeDef definition
class ConversationLevelResultDetailTypeDef(TypedDict):
endToEndResult: TestResultMatchStatusType, # (1)
speechTranscriptionResult: NotRequired[TestResultMatchStatusType], # (1)
ConversationLevelSlotResolutionResultItemTypeDef#
# ConversationLevelSlotResolutionResultItemTypeDef definition
class ConversationLevelSlotResolutionResultItemTypeDef(TypedDict):
intentName: str,
slotName: str,
matchResult: TestResultMatchStatusType, # (1)
ConversationLevelTestResultsFilterByTypeDef#
# ConversationLevelTestResultsFilterByTypeDef definition
class ConversationLevelTestResultsFilterByTypeDef(TypedDict):
endToEndResult: NotRequired[TestResultMatchStatusType], # (1)
ConversationLogsDataSourceFilterByTypeDef#
# ConversationLogsDataSourceFilterByTypeDef definition
class ConversationLogsDataSourceFilterByTypeDef(TypedDict):
startTime: datetime,
endTime: datetime,
inputMode: ConversationLogsInputModeFilterType, # (1)
SentimentAnalysisSettingsTypeDef#
# SentimentAnalysisSettingsTypeDef definition
class SentimentAnalysisSettingsTypeDef(TypedDict):
detectSentiment: bool,
DialogCodeHookSettingsTypeDef#
# DialogCodeHookSettingsTypeDef definition
class DialogCodeHookSettingsTypeDef(TypedDict):
enabled: bool,
InputContextTypeDef#
# InputContextTypeDef definition
class InputContextTypeDef(TypedDict):
name: str,
KendraConfigurationTypeDef#
# KendraConfigurationTypeDef definition
class KendraConfigurationTypeDef(TypedDict):
kendraIndex: str,
queryFilterStringEnabled: NotRequired[bool],
queryFilterString: NotRequired[str],
OutputContextTypeDef#
# OutputContextTypeDef definition
class OutputContextTypeDef(TypedDict):
name: str,
timeToLiveInSeconds: int,
turnsToLive: int,
SampleUtteranceTypeDef#
# SampleUtteranceTypeDef definition
class SampleUtteranceTypeDef(TypedDict):
utterance: str,
CreateResourcePolicyRequestRequestTypeDef#
# CreateResourcePolicyRequestRequestTypeDef definition
class CreateResourcePolicyRequestRequestTypeDef(TypedDict):
resourceArn: str,
policy: str,
PrincipalTypeDef#
# PrincipalTypeDef definition
class PrincipalTypeDef(TypedDict):
service: NotRequired[str],
arn: NotRequired[str],
MultipleValuesSettingTypeDef#
# MultipleValuesSettingTypeDef definition
class MultipleValuesSettingTypeDef(TypedDict):
allowMultipleValues: NotRequired[bool],
ObfuscationSettingTypeDef#
# ObfuscationSettingTypeDef definition
class ObfuscationSettingTypeDef(TypedDict):
obfuscationSettingType: ObfuscationSettingTypeType, # (1)
CustomPayloadTypeDef#
# CustomPayloadTypeDef definition
class CustomPayloadTypeDef(TypedDict):
value: str,
CustomVocabularyExportSpecificationTypeDef#
# CustomVocabularyExportSpecificationTypeDef definition
class CustomVocabularyExportSpecificationTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
CustomVocabularyImportSpecificationTypeDef#
# CustomVocabularyImportSpecificationTypeDef definition
class CustomVocabularyImportSpecificationTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
DateRangeFilterTypeDef#
# DateRangeFilterTypeDef definition
class DateRangeFilterTypeDef(TypedDict):
startDateTime: datetime,
endDateTime: datetime,
DeleteBotAliasRequestRequestTypeDef#
# DeleteBotAliasRequestRequestTypeDef definition
class DeleteBotAliasRequestRequestTypeDef(TypedDict):
botAliasId: str,
botId: str,
skipResourceInUseCheck: NotRequired[bool],
DeleteBotLocaleRequestRequestTypeDef#
# DeleteBotLocaleRequestRequestTypeDef definition
class DeleteBotLocaleRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
DeleteBotRequestRequestTypeDef#
# DeleteBotRequestRequestTypeDef definition
class DeleteBotRequestRequestTypeDef(TypedDict):
botId: str,
skipResourceInUseCheck: NotRequired[bool],
DeleteBotVersionRequestRequestTypeDef#
# DeleteBotVersionRequestRequestTypeDef definition
class DeleteBotVersionRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
skipResourceInUseCheck: NotRequired[bool],
DeleteCustomVocabularyRequestRequestTypeDef#
# DeleteCustomVocabularyRequestRequestTypeDef definition
class DeleteCustomVocabularyRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
DeleteExportRequestRequestTypeDef#
# DeleteExportRequestRequestTypeDef definition
class DeleteExportRequestRequestTypeDef(TypedDict):
exportId: str,
DeleteImportRequestRequestTypeDef#
# DeleteImportRequestRequestTypeDef definition
class DeleteImportRequestRequestTypeDef(TypedDict):
importId: str,
DeleteIntentRequestRequestTypeDef#
# DeleteIntentRequestRequestTypeDef definition
class DeleteIntentRequestRequestTypeDef(TypedDict):
intentId: str,
botId: str,
botVersion: str,
localeId: str,
DeleteResourcePolicyRequestRequestTypeDef#
# DeleteResourcePolicyRequestRequestTypeDef definition
class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
resourceArn: str,
expectedRevisionId: NotRequired[str],
DeleteResourcePolicyStatementRequestRequestTypeDef#
# DeleteResourcePolicyStatementRequestRequestTypeDef definition
class DeleteResourcePolicyStatementRequestRequestTypeDef(TypedDict):
resourceArn: str,
statementId: str,
expectedRevisionId: NotRequired[str],
DeleteSlotRequestRequestTypeDef#
# DeleteSlotRequestRequestTypeDef definition
class DeleteSlotRequestRequestTypeDef(TypedDict):
slotId: str,
botId: str,
botVersion: str,
localeId: str,
intentId: str,
DeleteSlotTypeRequestRequestTypeDef#
# DeleteSlotTypeRequestRequestTypeDef definition
class DeleteSlotTypeRequestRequestTypeDef(TypedDict):
slotTypeId: str,
botId: str,
botVersion: str,
localeId: str,
skipResourceInUseCheck: NotRequired[bool],
DeleteTestSetRequestRequestTypeDef#
# DeleteTestSetRequestRequestTypeDef definition
class DeleteTestSetRequestRequestTypeDef(TypedDict):
testSetId: str,
DeleteUtterancesRequestRequestTypeDef#
# DeleteUtterancesRequestRequestTypeDef definition
class DeleteUtterancesRequestRequestTypeDef(TypedDict):
botId: str,
localeId: NotRequired[str],
sessionId: NotRequired[str],
WaiterConfigTypeDef#
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeBotAliasRequestRequestTypeDef#
# DescribeBotAliasRequestRequestTypeDef definition
class DescribeBotAliasRequestRequestTypeDef(TypedDict):
botAliasId: str,
botId: str,
ParentBotNetworkTypeDef#
# ParentBotNetworkTypeDef definition
class ParentBotNetworkTypeDef(TypedDict):
botId: str,
botVersion: str,
DescribeBotLocaleRequestRequestTypeDef#
# DescribeBotLocaleRequestRequestTypeDef definition
class DescribeBotLocaleRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
DescribeBotRecommendationRequestRequestTypeDef#
# DescribeBotRecommendationRequestRequestTypeDef definition
class DescribeBotRecommendationRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
EncryptionSettingTypeDef#
# EncryptionSettingTypeDef definition
class EncryptionSettingTypeDef(TypedDict):
kmsKeyArn: NotRequired[str],
botLocaleExportPassword: NotRequired[str],
associatedTranscriptsPassword: NotRequired[str],
DescribeBotRequestRequestTypeDef#
# DescribeBotRequestRequestTypeDef definition
class DescribeBotRequestRequestTypeDef(TypedDict):
botId: str,
DescribeBotResourceGenerationRequestRequestTypeDef#
# DescribeBotResourceGenerationRequestRequestTypeDef definition
class DescribeBotResourceGenerationRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
generationId: str,
DescribeBotVersionRequestRequestTypeDef#
# DescribeBotVersionRequestRequestTypeDef definition
class DescribeBotVersionRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
DescribeCustomVocabularyMetadataRequestRequestTypeDef#
# DescribeCustomVocabularyMetadataRequestRequestTypeDef definition
class DescribeCustomVocabularyMetadataRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
DescribeExportRequestRequestTypeDef#
# DescribeExportRequestRequestTypeDef definition
class DescribeExportRequestRequestTypeDef(TypedDict):
exportId: str,
DescribeImportRequestRequestTypeDef#
# DescribeImportRequestRequestTypeDef definition
class DescribeImportRequestRequestTypeDef(TypedDict):
importId: str,
DescribeIntentRequestRequestTypeDef#
# DescribeIntentRequestRequestTypeDef definition
class DescribeIntentRequestRequestTypeDef(TypedDict):
intentId: str,
botId: str,
botVersion: str,
localeId: str,
SlotPriorityTypeDef#
# SlotPriorityTypeDef definition
class SlotPriorityTypeDef(TypedDict):
priority: int,
slotId: str,
DescribeResourcePolicyRequestRequestTypeDef#
# DescribeResourcePolicyRequestRequestTypeDef definition
class DescribeResourcePolicyRequestRequestTypeDef(TypedDict):
resourceArn: str,
DescribeSlotRequestRequestTypeDef#
# DescribeSlotRequestRequestTypeDef definition
class DescribeSlotRequestRequestTypeDef(TypedDict):
slotId: str,
botId: str,
botVersion: str,
localeId: str,
intentId: str,
DescribeSlotTypeRequestRequestTypeDef#
# DescribeSlotTypeRequestRequestTypeDef definition
class DescribeSlotTypeRequestRequestTypeDef(TypedDict):
slotTypeId: str,
botId: str,
botVersion: str,
localeId: str,
DescribeTestExecutionRequestRequestTypeDef#
# DescribeTestExecutionRequestRequestTypeDef definition
class DescribeTestExecutionRequestRequestTypeDef(TypedDict):
testExecutionId: str,
DescribeTestSetDiscrepancyReportRequestRequestTypeDef#
# DescribeTestSetDiscrepancyReportRequestRequestTypeDef definition
class DescribeTestSetDiscrepancyReportRequestRequestTypeDef(TypedDict):
testSetDiscrepancyReportId: str,
DescribeTestSetGenerationRequestRequestTypeDef#
# DescribeTestSetGenerationRequestRequestTypeDef definition
class DescribeTestSetGenerationRequestRequestTypeDef(TypedDict):
testSetGenerationId: str,
TestSetStorageLocationTypeDef#
# TestSetStorageLocationTypeDef definition
class TestSetStorageLocationTypeDef(TypedDict):
s3BucketName: str,
s3Path: str,
kmsKeyArn: NotRequired[str],
DescribeTestSetRequestRequestTypeDef#
# DescribeTestSetRequestRequestTypeDef definition
class DescribeTestSetRequestRequestTypeDef(TypedDict):
testSetId: str,
DialogActionTypeDef#
# DialogActionTypeDef definition
class DialogActionTypeDef(TypedDict):
type: DialogActionTypeType, # (1)
slotToElicit: NotRequired[str],
suppressNextMessage: NotRequired[bool],
IntentOverrideTypeDef#
# IntentOverrideTypeDef definition
class IntentOverrideTypeDef(TypedDict):
name: NotRequired[str],
slots: NotRequired[Mapping[str, SlotValueOverrideTypeDef]], # (1)
ElicitationCodeHookInvocationSettingTypeDef#
# ElicitationCodeHookInvocationSettingTypeDef definition
class ElicitationCodeHookInvocationSettingTypeDef(TypedDict):
enableCodeHookInvocation: bool,
invocationLabel: NotRequired[str],
ExportFilterTypeDef#
# ExportFilterTypeDef definition
class ExportFilterTypeDef(TypedDict):
name: ExportFilterNameType, # (1)
values: Sequence[str],
operator: ExportFilterOperatorType, # (2)
TestSetExportSpecificationTypeDef#
# TestSetExportSpecificationTypeDef definition
class TestSetExportSpecificationTypeDef(TypedDict):
testSetId: str,
ExportSortByTypeDef#
# ExportSortByTypeDef definition
class ExportSortByTypeDef(TypedDict):
attribute: ExportSortAttributeType, # (1)
order: SortOrderType, # (2)
- See ExportSortAttributeType
- See SortOrderType
GenerateBotElementRequestRequestTypeDef#
# GenerateBotElementRequestRequestTypeDef definition
class GenerateBotElementRequestRequestTypeDef(TypedDict):
intentId: str,
botId: str,
botVersion: str,
localeId: str,
GenerationSortByTypeDef#
# GenerationSortByTypeDef definition
class GenerationSortByTypeDef(TypedDict):
attribute: GenerationSortByAttributeType, # (1)
order: SortOrderType, # (2)
GenerationSummaryTypeDef#
# GenerationSummaryTypeDef definition
class GenerationSummaryTypeDef(TypedDict):
generationId: NotRequired[str],
generationStatus: NotRequired[GenerationStatusType], # (1)
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
GetTestExecutionArtifactsUrlRequestRequestTypeDef#
# GetTestExecutionArtifactsUrlRequestRequestTypeDef definition
class GetTestExecutionArtifactsUrlRequestRequestTypeDef(TypedDict):
testExecutionId: str,
GrammarSlotTypeSourceTypeDef#
# GrammarSlotTypeSourceTypeDef definition
class GrammarSlotTypeSourceTypeDef(TypedDict):
s3BucketName: str,
s3ObjectKey: str,
kmsKeyArn: NotRequired[str],
ImportFilterTypeDef#
# ImportFilterTypeDef definition
class ImportFilterTypeDef(TypedDict):
name: ImportFilterNameType, # (1)
values: Sequence[str],
operator: ImportFilterOperatorType, # (2)
ImportSortByTypeDef#
# ImportSortByTypeDef definition
class ImportSortByTypeDef(TypedDict):
attribute: ImportSortAttributeType, # (1)
order: SortOrderType, # (2)
- See ImportSortAttributeType
- See SortOrderType
ImportSummaryTypeDef#
# ImportSummaryTypeDef definition
class ImportSummaryTypeDef(TypedDict):
importId: NotRequired[str],
importedResourceId: NotRequired[str],
importedResourceName: NotRequired[str],
importStatus: NotRequired[ImportStatusType], # (1)
mergeStrategy: NotRequired[MergeStrategyType], # (2)
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
importedResourceType: NotRequired[ImportResourceTypeType], # (3)
- See ImportStatusType
- See MergeStrategyType
- See ImportResourceTypeType
RuntimeHintsTypeDef#
# RuntimeHintsTypeDef definition
class RuntimeHintsTypeDef(TypedDict):
slotHints: NotRequired[Dict[str, Dict[str, RuntimeHintDetailsTypeDef]]], # (1)
IntentClassificationTestResultItemCountsTypeDef#
# IntentClassificationTestResultItemCountsTypeDef definition
class IntentClassificationTestResultItemCountsTypeDef(TypedDict):
totalResultCount: int,
intentMatchResultCounts: Dict[TestResultMatchStatusType, int], # (1)
speechTranscriptionResultCounts: NotRequired[Dict[TestResultMatchStatusType, int]], # (1)
IntentFilterTypeDef#
# IntentFilterTypeDef definition
class IntentFilterTypeDef(TypedDict):
name: IntentFilterNameType, # (1)
values: Sequence[str],
operator: IntentFilterOperatorType, # (2)
IntentSortByTypeDef#
# IntentSortByTypeDef definition
class IntentSortByTypeDef(TypedDict):
attribute: IntentSortAttributeType, # (1)
order: SortOrderType, # (2)
- See IntentSortAttributeType
- See SortOrderType
InvokedIntentSampleTypeDef#
# InvokedIntentSampleTypeDef definition
class InvokedIntentSampleTypeDef(TypedDict):
intentName: NotRequired[str],
ListBotAliasesRequestRequestTypeDef#
# ListBotAliasesRequestRequestTypeDef definition
class ListBotAliasesRequestRequestTypeDef(TypedDict):
botId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListBotRecommendationsRequestRequestTypeDef#
# ListBotRecommendationsRequestRequestTypeDef definition
class ListBotRecommendationsRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListCustomVocabularyItemsRequestRequestTypeDef#
# ListCustomVocabularyItemsRequestRequestTypeDef definition
class ListCustomVocabularyItemsRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListRecommendedIntentsRequestRequestTypeDef#
# ListRecommendedIntentsRequestRequestTypeDef definition
class ListRecommendedIntentsRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
RecommendedIntentSummaryTypeDef#
# RecommendedIntentSummaryTypeDef definition
class RecommendedIntentSummaryTypeDef(TypedDict):
intentId: NotRequired[str],
intentName: NotRequired[str],
sampleUtterancesCount: NotRequired[int],
SessionDataSortByTypeDef#
# SessionDataSortByTypeDef definition
class SessionDataSortByTypeDef(TypedDict):
name: AnalyticsSessionSortByNameType, # (1)
order: AnalyticsSortOrderType, # (2)
SlotTypeFilterTypeDef#
# SlotTypeFilterTypeDef definition
class SlotTypeFilterTypeDef(TypedDict):
name: SlotTypeFilterNameType, # (1)
values: Sequence[str],
operator: SlotTypeFilterOperatorType, # (2)
SlotTypeSortByTypeDef#
# SlotTypeSortByTypeDef definition
class SlotTypeSortByTypeDef(TypedDict):
attribute: SlotTypeSortAttributeType, # (1)
order: SortOrderType, # (2)
SlotTypeSummaryTypeDef#
# SlotTypeSummaryTypeDef definition
class SlotTypeSummaryTypeDef(TypedDict):
slotTypeId: NotRequired[str],
slotTypeName: NotRequired[str],
description: NotRequired[str],
parentSlotTypeSignature: NotRequired[str],
lastUpdatedDateTime: NotRequired[datetime],
slotTypeCategory: NotRequired[SlotTypeCategoryType], # (1)
SlotFilterTypeDef#
# SlotFilterTypeDef definition
class SlotFilterTypeDef(TypedDict):
name: SlotFilterNameType, # (1)
values: Sequence[str],
operator: SlotFilterOperatorType, # (2)
SlotSortByTypeDef#
# SlotSortByTypeDef definition
class SlotSortByTypeDef(TypedDict):
attribute: SlotSortAttributeType, # (1)
order: SortOrderType, # (2)
- See SlotSortAttributeType
- See SortOrderType
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
TestExecutionSortByTypeDef#
# TestExecutionSortByTypeDef definition
class TestExecutionSortByTypeDef(TypedDict):
attribute: TestExecutionSortAttributeType, # (1)
order: SortOrderType, # (2)
ListTestSetRecordsRequestRequestTypeDef#
# ListTestSetRecordsRequestRequestTypeDef definition
class ListTestSetRecordsRequestRequestTypeDef(TypedDict):
testSetId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
TestSetSortByTypeDef#
# TestSetSortByTypeDef definition
class TestSetSortByTypeDef(TypedDict):
attribute: TestSetSortAttributeType, # (1)
order: SortOrderType, # (2)
UtteranceDataSortByTypeDef#
# UtteranceDataSortByTypeDef definition
class UtteranceDataSortByTypeDef(TypedDict):
name: AnalyticsUtteranceSortByNameType, # (1)
order: AnalyticsSortOrderType, # (2)
PlainTextMessageTypeDef#
# PlainTextMessageTypeDef definition
class PlainTextMessageTypeDef(TypedDict):
value: str,
SSMLMessageTypeDef#
# SSMLMessageTypeDef definition
class SSMLMessageTypeDef(TypedDict):
value: str,
OverallTestResultItemTypeDef#
# OverallTestResultItemTypeDef definition
class OverallTestResultItemTypeDef(TypedDict):
multiTurnConversation: bool,
totalResultCount: int,
endToEndResultCounts: Dict[TestResultMatchStatusType, int], # (1)
speechTranscriptionResultCounts: NotRequired[Dict[TestResultMatchStatusType, int]], # (1)
PathFormatTypeDef#
# PathFormatTypeDef definition
class PathFormatTypeDef(TypedDict):
objectPrefixes: NotRequired[List[str]],
TextInputSpecificationTypeDef#
# TextInputSpecificationTypeDef definition
class TextInputSpecificationTypeDef(TypedDict):
startTimeoutMs: int,
RelativeAggregationDurationTypeDef#
# RelativeAggregationDurationTypeDef definition
class RelativeAggregationDurationTypeDef(TypedDict):
timeDimension: TimeDimensionType, # (1)
timeValue: int,
RuntimeHintValueTypeDef#
# RuntimeHintValueTypeDef definition
class RuntimeHintValueTypeDef(TypedDict):
phrase: str,
SampleValueTypeDef#
# SampleValueTypeDef definition
class SampleValueTypeDef(TypedDict):
value: str,
SlotDefaultValueTypeDef#
# SlotDefaultValueTypeDef definition
class SlotDefaultValueTypeDef(TypedDict):
defaultValue: str,
SlotResolutionSettingTypeDef#
# SlotResolutionSettingTypeDef definition
class SlotResolutionSettingTypeDef(TypedDict):
slotResolutionStrategy: SlotResolutionStrategyType, # (1)
SlotResolutionTestResultItemCountsTypeDef#
# SlotResolutionTestResultItemCountsTypeDef definition
class SlotResolutionTestResultItemCountsTypeDef(TypedDict):
totalResultCount: int,
slotMatchResultCounts: Dict[TestResultMatchStatusType, int], # (1)
speechTranscriptionResultCounts: NotRequired[Dict[TestResultMatchStatusType, int]], # (1)
SlotValueTypeDef#
# SlotValueTypeDef definition
class SlotValueTypeDef(TypedDict):
interpretedValue: NotRequired[str],
SlotValueRegexFilterTypeDef#
# SlotValueRegexFilterTypeDef definition
class SlotValueRegexFilterTypeDef(TypedDict):
pattern: str,
StartBotResourceGenerationRequestRequestTypeDef#
# StartBotResourceGenerationRequestRequestTypeDef definition
class StartBotResourceGenerationRequestRequestTypeDef(TypedDict):
generationInputPrompt: str,
botId: str,
botVersion: str,
localeId: str,
StopBotRecommendationRequestRequestTypeDef#
# StopBotRecommendationRequestRequestTypeDef definition
class StopBotRecommendationRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tags: Mapping[str, str],
TestSetIntentDiscrepancyItemTypeDef#
# TestSetIntentDiscrepancyItemTypeDef definition
class TestSetIntentDiscrepancyItemTypeDef(TypedDict):
intentName: str,
errorMessage: str,
TestSetSlotDiscrepancyItemTypeDef#
# TestSetSlotDiscrepancyItemTypeDef definition
class TestSetSlotDiscrepancyItemTypeDef(TypedDict):
intentName: str,
slotName: str,
errorMessage: str,
TestSetDiscrepancyReportBotAliasTargetTypeDef#
# TestSetDiscrepancyReportBotAliasTargetTypeDef definition
class TestSetDiscrepancyReportBotAliasTargetTypeDef(TypedDict):
botId: str,
botAliasId: str,
localeId: str,
TestSetImportInputLocationTypeDef#
# TestSetImportInputLocationTypeDef definition
class TestSetImportInputLocationTypeDef(TypedDict):
s3BucketName: str,
s3Path: str,
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tagKeys: Sequence[str],
UpdateExportRequestRequestTypeDef#
# UpdateExportRequestRequestTypeDef definition
class UpdateExportRequestRequestTypeDef(TypedDict):
exportId: str,
filePassword: NotRequired[str],
UpdateResourcePolicyRequestRequestTypeDef#
# UpdateResourcePolicyRequestRequestTypeDef definition
class UpdateResourcePolicyRequestRequestTypeDef(TypedDict):
resourceArn: str,
policy: str,
expectedRevisionId: NotRequired[str],
UpdateTestSetRequestRequestTypeDef#
# UpdateTestSetRequestRequestTypeDef definition
class UpdateTestSetRequestRequestTypeDef(TypedDict):
testSetId: str,
testSetName: str,
description: NotRequired[str],
UserTurnIntentOutputTypeDef#
# UserTurnIntentOutputTypeDef definition
class UserTurnIntentOutputTypeDef(TypedDict):
name: str,
slots: NotRequired[Dict[str, UserTurnSlotOutputTypeDef]], # (1)
UserTurnSlotOutputTypeDef#
# UserTurnSlotOutputTypeDef definition
class UserTurnSlotOutputTypeDef(TypedDict):
value: NotRequired[str],
values: NotRequired[List[Dict[str, Any]]],
subSlots: NotRequired[Dict[str, Dict[str, Any]]],
UtteranceAudioInputSpecificationTypeDef#
# UtteranceAudioInputSpecificationTypeDef definition
class UtteranceAudioInputSpecificationTypeDef(TypedDict):
audioFileS3Location: str,
AgentTurnResultTypeDef#
# AgentTurnResultTypeDef definition
class AgentTurnResultTypeDef(TypedDict):
expectedAgentPrompt: str,
actualAgentPrompt: NotRequired[str],
errorDetails: NotRequired[ExecutionErrorDetailsTypeDef], # (1)
actualElicitedSlot: NotRequired[str],
actualIntent: NotRequired[str],
AnalyticsIntentResultTypeDef#
# AnalyticsIntentResultTypeDef definition
class AnalyticsIntentResultTypeDef(TypedDict):
binKeys: NotRequired[List[AnalyticsBinKeyTypeDef]], # (1)
groupByKeys: NotRequired[List[AnalyticsIntentGroupByKeyTypeDef]], # (2)
metricsResults: NotRequired[List[AnalyticsIntentMetricResultTypeDef]], # (3)
- See AnalyticsBinKeyTypeDef
- See AnalyticsIntentGroupByKeyTypeDef
- See AnalyticsIntentMetricResultTypeDef
AnalyticsIntentStageResultTypeDef#
# AnalyticsIntentStageResultTypeDef definition
class AnalyticsIntentStageResultTypeDef(TypedDict):
binKeys: NotRequired[List[AnalyticsBinKeyTypeDef]], # (1)
groupByKeys: NotRequired[List[AnalyticsIntentStageGroupByKeyTypeDef]], # (2)
metricsResults: NotRequired[List[AnalyticsIntentStageMetricResultTypeDef]], # (3)
- See AnalyticsBinKeyTypeDef
- See AnalyticsIntentStageGroupByKeyTypeDef
- See AnalyticsIntentStageMetricResultTypeDef
AnalyticsSessionResultTypeDef#
# AnalyticsSessionResultTypeDef definition
class AnalyticsSessionResultTypeDef(TypedDict):
binKeys: NotRequired[List[AnalyticsBinKeyTypeDef]], # (1)
groupByKeys: NotRequired[List[AnalyticsSessionGroupByKeyTypeDef]], # (2)
metricsResults: NotRequired[List[AnalyticsSessionMetricResultTypeDef]], # (3)
- See AnalyticsBinKeyTypeDef
- See AnalyticsSessionGroupByKeyTypeDef
- See AnalyticsSessionMetricResultTypeDef
AnalyticsUtteranceResultTypeDef#
# AnalyticsUtteranceResultTypeDef definition
class AnalyticsUtteranceResultTypeDef(TypedDict):
binKeys: NotRequired[List[AnalyticsBinKeyTypeDef]], # (1)
groupByKeys: NotRequired[List[AnalyticsUtteranceGroupByKeyTypeDef]], # (2)
metricsResults: NotRequired[List[AnalyticsUtteranceMetricResultTypeDef]], # (3)
attributeResults: NotRequired[List[AnalyticsUtteranceAttributeResultTypeDef]], # (4)
- See AnalyticsBinKeyTypeDef
- See AnalyticsUtteranceGroupByKeyTypeDef
- See AnalyticsUtteranceMetricResultTypeDef
- See AnalyticsUtteranceAttributeResultTypeDef
SearchAssociatedTranscriptsRequestRequestTypeDef#
# SearchAssociatedTranscriptsRequestRequestTypeDef definition
class SearchAssociatedTranscriptsRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
filters: Sequence[AssociatedTranscriptFilterTypeDef], # (1)
searchOrder: NotRequired[SearchOrderType], # (2)
maxResults: NotRequired[int],
nextIndex: NotRequired[int],
AudioAndDTMFInputSpecificationTypeDef#
# AudioAndDTMFInputSpecificationTypeDef definition
class AudioAndDTMFInputSpecificationTypeDef(TypedDict):
startTimeoutMs: int,
audioSpecification: NotRequired[AudioSpecificationTypeDef], # (1)
dtmfSpecification: NotRequired[DTMFSpecificationTypeDef], # (2)
AudioLogDestinationTypeDef#
# AudioLogDestinationTypeDef definition
class AudioLogDestinationTypeDef(TypedDict):
s3Bucket: S3BucketLogDestinationTypeDef, # (1)
BatchCreateCustomVocabularyItemRequestRequestTypeDef#
# BatchCreateCustomVocabularyItemRequestRequestTypeDef definition
class BatchCreateCustomVocabularyItemRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
customVocabularyItemList: Sequence[NewCustomVocabularyItemTypeDef], # (1)
BatchUpdateCustomVocabularyItemRequestRequestTypeDef#
# BatchUpdateCustomVocabularyItemRequestRequestTypeDef definition
class BatchUpdateCustomVocabularyItemRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
customVocabularyItemList: Sequence[CustomVocabularyItemTypeDef], # (1)
BatchCreateCustomVocabularyItemResponseTypeDef#
# BatchCreateCustomVocabularyItemResponseTypeDef definition
class BatchCreateCustomVocabularyItemResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
errors: List[FailedCustomVocabularyItemTypeDef], # (1)
resources: List[CustomVocabularyItemTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
BatchDeleteCustomVocabularyItemResponseTypeDef#
# BatchDeleteCustomVocabularyItemResponseTypeDef definition
class BatchDeleteCustomVocabularyItemResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
errors: List[FailedCustomVocabularyItemTypeDef], # (1)
resources: List[CustomVocabularyItemTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
BatchUpdateCustomVocabularyItemResponseTypeDef#
# BatchUpdateCustomVocabularyItemResponseTypeDef definition
class BatchUpdateCustomVocabularyItemResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
errors: List[FailedCustomVocabularyItemTypeDef], # (1)
resources: List[CustomVocabularyItemTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
BuildBotLocaleResponseTypeDef#
# BuildBotLocaleResponseTypeDef definition
class BuildBotLocaleResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botLocaleStatus: BotLocaleStatusType, # (1)
lastBuildSubmittedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateResourcePolicyResponseTypeDef#
# CreateResourcePolicyResponseTypeDef definition
class CreateResourcePolicyResponseTypeDef(TypedDict):
resourceArn: str,
revisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateResourcePolicyStatementResponseTypeDef#
# CreateResourcePolicyStatementResponseTypeDef definition
class CreateResourcePolicyStatementResponseTypeDef(TypedDict):
resourceArn: str,
revisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUploadUrlResponseTypeDef#
# CreateUploadUrlResponseTypeDef definition
class CreateUploadUrlResponseTypeDef(TypedDict):
importId: str,
uploadUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBotAliasResponseTypeDef#
# DeleteBotAliasResponseTypeDef definition
class DeleteBotAliasResponseTypeDef(TypedDict):
botAliasId: str,
botId: str,
botAliasStatus: BotAliasStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteBotLocaleResponseTypeDef#
# DeleteBotLocaleResponseTypeDef definition
class DeleteBotLocaleResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botLocaleStatus: BotLocaleStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteBotResponseTypeDef#
# DeleteBotResponseTypeDef definition
class DeleteBotResponseTypeDef(TypedDict):
botId: str,
botStatus: BotStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BotStatusType
- See ResponseMetadataTypeDef
DeleteBotVersionResponseTypeDef#
# DeleteBotVersionResponseTypeDef definition
class DeleteBotVersionResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
botStatus: BotStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BotStatusType
- See ResponseMetadataTypeDef
DeleteCustomVocabularyResponseTypeDef#
# DeleteCustomVocabularyResponseTypeDef definition
class DeleteCustomVocabularyResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
customVocabularyStatus: CustomVocabularyStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteExportResponseTypeDef#
# DeleteExportResponseTypeDef definition
class DeleteExportResponseTypeDef(TypedDict):
exportId: str,
exportStatus: ExportStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteImportResponseTypeDef#
# DeleteImportResponseTypeDef definition
class DeleteImportResponseTypeDef(TypedDict):
importId: str,
importStatus: ImportStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteResourcePolicyResponseTypeDef#
# DeleteResourcePolicyResponseTypeDef definition
class DeleteResourcePolicyResponseTypeDef(TypedDict):
resourceArn: str,
revisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteResourcePolicyStatementResponseTypeDef#
# DeleteResourcePolicyStatementResponseTypeDef definition
class DeleteResourcePolicyStatementResponseTypeDef(TypedDict):
resourceArn: str,
revisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeBotResourceGenerationResponseTypeDef#
# DescribeBotResourceGenerationResponseTypeDef definition
class DescribeBotResourceGenerationResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
generationId: str,
failureReasons: List[str],
generationStatus: GenerationStatusType, # (1)
generationInputPrompt: str,
generatedBotLocaleUrl: str,
creationDateTime: datetime,
modelArn: str,
lastUpdatedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeCustomVocabularyMetadataResponseTypeDef#
# DescribeCustomVocabularyMetadataResponseTypeDef definition
class DescribeCustomVocabularyMetadataResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
customVocabularyStatus: CustomVocabularyStatusType, # (1)
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeResourcePolicyResponseTypeDef#
# DescribeResourcePolicyResponseTypeDef definition
class DescribeResourcePolicyResponseTypeDef(TypedDict):
resourceArn: str,
policy: str,
revisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetTestExecutionArtifactsUrlResponseTypeDef#
# GetTestExecutionArtifactsUrlResponseTypeDef definition
class GetTestExecutionArtifactsUrlResponseTypeDef(TypedDict):
testExecutionId: str,
downloadArtifactsUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListCustomVocabularyItemsResponseTypeDef#
# ListCustomVocabularyItemsResponseTypeDef definition
class ListCustomVocabularyItemsResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
customVocabularyItems: List[CustomVocabularyItemTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListIntentPathsResponseTypeDef#
# ListIntentPathsResponseTypeDef definition
class ListIntentPathsResponseTypeDef(TypedDict):
nodeSummaries: List[AnalyticsIntentNodeSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SearchAssociatedTranscriptsResponseTypeDef#
# SearchAssociatedTranscriptsResponseTypeDef definition
class SearchAssociatedTranscriptsResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
nextIndex: int,
associatedTranscripts: List[AssociatedTranscriptTypeDef], # (1)
totalResults: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartBotResourceGenerationResponseTypeDef#
# StartBotResourceGenerationResponseTypeDef definition
class StartBotResourceGenerationResponseTypeDef(TypedDict):
generationInputPrompt: str,
generationId: str,
botId: str,
botVersion: str,
localeId: str,
generationStatus: GenerationStatusType, # (1)
creationDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopBotRecommendationResponseTypeDef#
# StopBotRecommendationResponseTypeDef definition
class StopBotRecommendationResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationStatus: BotRecommendationStatusType, # (1)
botRecommendationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateResourcePolicyResponseTypeDef#
# UpdateResourcePolicyResponseTypeDef definition
class UpdateResourcePolicyResponseTypeDef(TypedDict):
resourceArn: str,
revisionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
BatchDeleteCustomVocabularyItemRequestRequestTypeDef#
# BatchDeleteCustomVocabularyItemRequestRequestTypeDef definition
class BatchDeleteCustomVocabularyItemRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
customVocabularyItemList: Sequence[CustomVocabularyEntryIdTypeDef], # (1)
DescriptiveBotBuilderSpecificationTypeDef#
# DescriptiveBotBuilderSpecificationTypeDef definition
class DescriptiveBotBuilderSpecificationTypeDef(TypedDict):
enabled: bool,
bedrockModelSpecification: NotRequired[BedrockModelSpecificationTypeDef], # (1)
SampleUtteranceGenerationSpecificationTypeDef#
# SampleUtteranceGenerationSpecificationTypeDef definition
class SampleUtteranceGenerationSpecificationTypeDef(TypedDict):
enabled: bool,
bedrockModelSpecification: NotRequired[BedrockModelSpecificationTypeDef], # (1)
SlotResolutionImprovementSpecificationTypeDef#
# SlotResolutionImprovementSpecificationTypeDef definition
class SlotResolutionImprovementSpecificationTypeDef(TypedDict):
enabled: bool,
bedrockModelSpecification: NotRequired[BedrockModelSpecificationTypeDef], # (1)
ListBotAliasesResponseTypeDef#
# ListBotAliasesResponseTypeDef definition
class ListBotAliasesResponseTypeDef(TypedDict):
botAliasSummaries: List[BotAliasSummaryTypeDef], # (1)
nextToken: str,
botId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TestExecutionTargetTypeDef#
# TestExecutionTargetTypeDef definition
class TestExecutionTargetTypeDef(TypedDict):
botAliasTarget: NotRequired[BotAliasTestExecutionTargetTypeDef], # (1)
BotImportSpecificationTypeDef#
# BotImportSpecificationTypeDef definition
class BotImportSpecificationTypeDef(TypedDict):
botName: str,
roleArn: str,
dataPrivacy: DataPrivacyTypeDef, # (1)
idleSessionTTLInSeconds: NotRequired[int],
botTags: NotRequired[Dict[str, str]],
testBotAliasTags: NotRequired[Dict[str, str]],
BotLocaleImportSpecificationTypeDef#
# BotLocaleImportSpecificationTypeDef definition
class BotLocaleImportSpecificationTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
nluIntentConfidenceThreshold: NotRequired[float],
voiceSettings: NotRequired[VoiceSettingsTypeDef], # (1)
ListBotLocalesRequestRequestTypeDef#
# ListBotLocalesRequestRequestTypeDef definition
class ListBotLocalesRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
sortBy: NotRequired[BotLocaleSortByTypeDef], # (1)
filters: NotRequired[Sequence[BotLocaleFilterTypeDef]], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListBotLocalesResponseTypeDef#
# ListBotLocalesResponseTypeDef definition
class ListBotLocalesResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
nextToken: str,
botLocaleSummaries: List[BotLocaleSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateBotRequestRequestTypeDef#
# CreateBotRequestRequestTypeDef definition
class CreateBotRequestRequestTypeDef(TypedDict):
botName: str,
roleArn: str,
dataPrivacy: DataPrivacyTypeDef, # (1)
idleSessionTTLInSeconds: int,
description: NotRequired[str],
botTags: NotRequired[Mapping[str, str]],
testBotAliasTags: NotRequired[Mapping[str, str]],
botType: NotRequired[BotTypeType], # (2)
botMembers: NotRequired[Sequence[BotMemberTypeDef]], # (3)
- See DataPrivacyTypeDef
- See BotTypeType
- See BotMemberTypeDef
CreateBotResponseTypeDef#
# CreateBotResponseTypeDef definition
class CreateBotResponseTypeDef(TypedDict):
botId: str,
botName: str,
description: str,
roleArn: str,
dataPrivacy: DataPrivacyTypeDef, # (1)
idleSessionTTLInSeconds: int,
botStatus: BotStatusType, # (2)
creationDateTime: datetime,
botTags: Dict[str, str],
testBotAliasTags: Dict[str, str],
botType: BotTypeType, # (3)
botMembers: List[BotMemberTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See DataPrivacyTypeDef
- See BotStatusType
- See BotTypeType
- See BotMemberTypeDef
- See ResponseMetadataTypeDef
DescribeBotResponseTypeDef#
# DescribeBotResponseTypeDef definition
class DescribeBotResponseTypeDef(TypedDict):
botId: str,
botName: str,
description: str,
roleArn: str,
dataPrivacy: DataPrivacyTypeDef, # (1)
idleSessionTTLInSeconds: int,
botStatus: BotStatusType, # (2)
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
botType: BotTypeType, # (3)
botMembers: List[BotMemberTypeDef], # (4)
failureReasons: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See DataPrivacyTypeDef
- See BotStatusType
- See BotTypeType
- See BotMemberTypeDef
- See ResponseMetadataTypeDef
UpdateBotRequestRequestTypeDef#
# UpdateBotRequestRequestTypeDef definition
class UpdateBotRequestRequestTypeDef(TypedDict):
botId: str,
botName: str,
roleArn: str,
dataPrivacy: DataPrivacyTypeDef, # (1)
idleSessionTTLInSeconds: int,
description: NotRequired[str],
botType: NotRequired[BotTypeType], # (2)
botMembers: NotRequired[Sequence[BotMemberTypeDef]], # (3)
- See DataPrivacyTypeDef
- See BotTypeType
- See BotMemberTypeDef
UpdateBotResponseTypeDef#
# UpdateBotResponseTypeDef definition
class UpdateBotResponseTypeDef(TypedDict):
botId: str,
botName: str,
description: str,
roleArn: str,
dataPrivacy: DataPrivacyTypeDef, # (1)
idleSessionTTLInSeconds: int,
botStatus: BotStatusType, # (2)
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
botType: BotTypeType, # (3)
botMembers: List[BotMemberTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See DataPrivacyTypeDef
- See BotStatusType
- See BotTypeType
- See BotMemberTypeDef
- See ResponseMetadataTypeDef
BotRecommendationResultStatisticsTypeDef#
# BotRecommendationResultStatisticsTypeDef definition
class BotRecommendationResultStatisticsTypeDef(TypedDict):
intents: NotRequired[IntentStatisticsTypeDef], # (1)
slotTypes: NotRequired[SlotTypeStatisticsTypeDef], # (2)
ListBotRecommendationsResponseTypeDef#
# ListBotRecommendationsResponseTypeDef definition
class ListBotRecommendationsResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationSummaries: List[BotRecommendationSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBotsRequestRequestTypeDef#
# ListBotsRequestRequestTypeDef definition
class ListBotsRequestRequestTypeDef(TypedDict):
sortBy: NotRequired[BotSortByTypeDef], # (1)
filters: NotRequired[Sequence[BotFilterTypeDef]], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
- See BotSortByTypeDef
- See BotFilterTypeDef
ListBotsResponseTypeDef#
# ListBotsResponseTypeDef definition
class ListBotsResponseTypeDef(TypedDict):
botSummaries: List[BotSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateBotVersionRequestRequestTypeDef#
# CreateBotVersionRequestRequestTypeDef definition
class CreateBotVersionRequestRequestTypeDef(TypedDict):
botId: str,
botVersionLocaleSpecification: Mapping[str, BotVersionLocaleDetailsTypeDef], # (1)
description: NotRequired[str],
CreateBotVersionResponseTypeDef#
# CreateBotVersionResponseTypeDef definition
class CreateBotVersionResponseTypeDef(TypedDict):
botId: str,
description: str,
botVersion: str,
botVersionLocaleSpecification: Dict[str, BotVersionLocaleDetailsTypeDef], # (1)
botStatus: BotStatusType, # (2)
creationDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListBotVersionsRequestRequestTypeDef#
# ListBotVersionsRequestRequestTypeDef definition
class ListBotVersionsRequestRequestTypeDef(TypedDict):
botId: str,
sortBy: NotRequired[BotVersionSortByTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListBotVersionsResponseTypeDef#
# ListBotVersionsResponseTypeDef definition
class ListBotVersionsResponseTypeDef(TypedDict):
botId: str,
botVersionSummaries: List[BotVersionSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBuiltInIntentsRequestRequestTypeDef#
# ListBuiltInIntentsRequestRequestTypeDef definition
class ListBuiltInIntentsRequestRequestTypeDef(TypedDict):
localeId: str,
sortBy: NotRequired[BuiltInIntentSortByTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListBuiltInIntentsResponseTypeDef#
# ListBuiltInIntentsResponseTypeDef definition
class ListBuiltInIntentsResponseTypeDef(TypedDict):
builtInIntentSummaries: List[BuiltInIntentSummaryTypeDef], # (1)
nextToken: str,
localeId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBuiltInSlotTypesRequestRequestTypeDef#
# ListBuiltInSlotTypesRequestRequestTypeDef definition
class ListBuiltInSlotTypesRequestRequestTypeDef(TypedDict):
localeId: str,
sortBy: NotRequired[BuiltInSlotTypeSortByTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListBuiltInSlotTypesResponseTypeDef#
# ListBuiltInSlotTypesResponseTypeDef definition
class ListBuiltInSlotTypesResponseTypeDef(TypedDict):
builtInSlotTypeSummaries: List[BuiltInSlotTypeSummaryTypeDef], # (1)
nextToken: str,
localeId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImageResponseCardTypeDef#
# ImageResponseCardTypeDef definition
class ImageResponseCardTypeDef(TypedDict):
title: str,
subtitle: NotRequired[str],
imageUrl: NotRequired[str],
buttons: NotRequired[Sequence[ButtonTypeDef]], # (1)
- See ButtonTypeDef
TextLogDestinationTypeDef#
# TextLogDestinationTypeDef definition
class TextLogDestinationTypeDef(TypedDict):
cloudWatch: CloudWatchLogGroupLogDestinationTypeDef, # (1)
CodeHookSpecificationTypeDef#
# CodeHookSpecificationTypeDef definition
class CodeHookSpecificationTypeDef(TypedDict):
lambdaCodeHook: LambdaCodeHookTypeDef, # (1)
CompositeSlotTypeSettingTypeDef#
# CompositeSlotTypeSettingTypeDef definition
class CompositeSlotTypeSettingTypeDef(TypedDict):
subSlots: NotRequired[Sequence[SubSlotTypeCompositionTypeDef]], # (1)
ConversationLevelTestResultItemTypeDef#
# ConversationLevelTestResultItemTypeDef definition
class ConversationLevelTestResultItemTypeDef(TypedDict):
conversationId: str,
endToEndResult: TestResultMatchStatusType, # (1)
intentClassificationResults: List[ConversationLevelIntentClassificationResultItemTypeDef], # (3)
slotResolutionResults: List[ConversationLevelSlotResolutionResultItemTypeDef], # (4)
speechTranscriptionResult: NotRequired[TestResultMatchStatusType], # (1)
- See TestResultMatchStatusType
- See TestResultMatchStatusType
- See ConversationLevelIntentClassificationResultItemTypeDef
- See ConversationLevelSlotResolutionResultItemTypeDef
TestExecutionResultFilterByTypeDef#
# TestExecutionResultFilterByTypeDef definition
class TestExecutionResultFilterByTypeDef(TypedDict):
resultTypeFilter: TestResultTypeFilterType, # (1)
conversationLevelTestResultsFilterBy: NotRequired[ConversationLevelTestResultsFilterByTypeDef], # (2)
ConversationLogsDataSourceTypeDef#
# ConversationLogsDataSourceTypeDef definition
class ConversationLogsDataSourceTypeDef(TypedDict):
botId: str,
botAliasId: str,
localeId: str,
filter: ConversationLogsDataSourceFilterByTypeDef, # (1)
IntentSummaryTypeDef#
# IntentSummaryTypeDef definition
class IntentSummaryTypeDef(TypedDict):
intentId: NotRequired[str],
intentName: NotRequired[str],
description: NotRequired[str],
parentIntentSignature: NotRequired[str],
inputContexts: NotRequired[List[InputContextTypeDef]], # (1)
outputContexts: NotRequired[List[OutputContextTypeDef]], # (2)
lastUpdatedDateTime: NotRequired[datetime],
GenerateBotElementResponseTypeDef#
# GenerateBotElementResponseTypeDef definition
class GenerateBotElementResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
intentId: str,
sampleUtterances: List[SampleUtteranceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateResourcePolicyStatementRequestRequestTypeDef#
# CreateResourcePolicyStatementRequestRequestTypeDef definition
class CreateResourcePolicyStatementRequestRequestTypeDef(TypedDict):
resourceArn: str,
statementId: str,
effect: EffectType, # (1)
principal: Sequence[PrincipalTypeDef], # (2)
action: Sequence[str],
condition: NotRequired[Mapping[str, Mapping[str, str]]],
expectedRevisionId: NotRequired[str],
- See EffectType
- See PrincipalTypeDef
LexTranscriptFilterTypeDef#
# LexTranscriptFilterTypeDef definition
class LexTranscriptFilterTypeDef(TypedDict):
dateRangeFilter: NotRequired[DateRangeFilterTypeDef], # (1)
DescribeBotAliasRequestBotAliasAvailableWaitTypeDef#
# DescribeBotAliasRequestBotAliasAvailableWaitTypeDef definition
class DescribeBotAliasRequestBotAliasAvailableWaitTypeDef(TypedDict):
botAliasId: str,
botId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeBotLocaleRequestBotLocaleBuiltWaitTypeDef#
# DescribeBotLocaleRequestBotLocaleBuiltWaitTypeDef definition
class DescribeBotLocaleRequestBotLocaleBuiltWaitTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeBotLocaleRequestBotLocaleCreatedWaitTypeDef#
# DescribeBotLocaleRequestBotLocaleCreatedWaitTypeDef definition
class DescribeBotLocaleRequestBotLocaleCreatedWaitTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeBotLocaleRequestBotLocaleExpressTestingAvailableWaitTypeDef#
# DescribeBotLocaleRequestBotLocaleExpressTestingAvailableWaitTypeDef definition
class DescribeBotLocaleRequestBotLocaleExpressTestingAvailableWaitTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeBotRequestBotAvailableWaitTypeDef#
# DescribeBotRequestBotAvailableWaitTypeDef definition
class DescribeBotRequestBotAvailableWaitTypeDef(TypedDict):
botId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeBotVersionRequestBotVersionAvailableWaitTypeDef#
# DescribeBotVersionRequestBotVersionAvailableWaitTypeDef definition
class DescribeBotVersionRequestBotVersionAvailableWaitTypeDef(TypedDict):
botId: str,
botVersion: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeExportRequestBotExportCompletedWaitTypeDef#
# DescribeExportRequestBotExportCompletedWaitTypeDef definition
class DescribeExportRequestBotExportCompletedWaitTypeDef(TypedDict):
exportId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeImportRequestBotImportCompletedWaitTypeDef#
# DescribeImportRequestBotImportCompletedWaitTypeDef definition
class DescribeImportRequestBotImportCompletedWaitTypeDef(TypedDict):
importId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeBotVersionResponseTypeDef#
# DescribeBotVersionResponseTypeDef definition
class DescribeBotVersionResponseTypeDef(TypedDict):
botId: str,
botName: str,
botVersion: str,
description: str,
roleArn: str,
dataPrivacy: DataPrivacyTypeDef, # (1)
idleSessionTTLInSeconds: int,
botStatus: BotStatusType, # (2)
failureReasons: List[str],
creationDateTime: datetime,
parentBotNetworks: List[ParentBotNetworkTypeDef], # (3)
botType: BotTypeType, # (4)
botMembers: List[BotMemberTypeDef], # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See DataPrivacyTypeDef
- See BotStatusType
- See ParentBotNetworkTypeDef
- See BotTypeType
- See BotMemberTypeDef
- See ResponseMetadataTypeDef
UpdateBotRecommendationRequestRequestTypeDef#
# UpdateBotRecommendationRequestRequestTypeDef definition
class UpdateBotRecommendationRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
encryptionSetting: EncryptionSettingTypeDef, # (1)
DescribeTestSetResponseTypeDef#
# DescribeTestSetResponseTypeDef definition
class DescribeTestSetResponseTypeDef(TypedDict):
testSetId: str,
testSetName: str,
description: str,
modality: TestSetModalityType, # (1)
status: TestSetStatusType, # (2)
roleArn: str,
numTurns: int,
storageLocation: TestSetStorageLocationTypeDef, # (3)
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See TestSetModalityType
- See TestSetStatusType
- See TestSetStorageLocationTypeDef
- See ResponseMetadataTypeDef
TestSetSummaryTypeDef#
# TestSetSummaryTypeDef definition
class TestSetSummaryTypeDef(TypedDict):
testSetId: NotRequired[str],
testSetName: NotRequired[str],
description: NotRequired[str],
modality: NotRequired[TestSetModalityType], # (1)
status: NotRequired[TestSetStatusType], # (2)
roleArn: NotRequired[str],
numTurns: NotRequired[int],
storageLocation: NotRequired[TestSetStorageLocationTypeDef], # (3)
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
UpdateTestSetResponseTypeDef#
# UpdateTestSetResponseTypeDef definition
class UpdateTestSetResponseTypeDef(TypedDict):
testSetId: str,
testSetName: str,
description: str,
modality: TestSetModalityType, # (1)
status: TestSetStatusType, # (2)
roleArn: str,
numTurns: int,
storageLocation: TestSetStorageLocationTypeDef, # (3)
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See TestSetModalityType
- See TestSetStatusType
- See TestSetStorageLocationTypeDef
- See ResponseMetadataTypeDef
DialogStateTypeDef#
# DialogStateTypeDef definition
class DialogStateTypeDef(TypedDict):
dialogAction: NotRequired[DialogActionTypeDef], # (1)
intent: NotRequired[IntentOverrideTypeDef], # (2)
sessionAttributes: NotRequired[Mapping[str, str]],
ExportResourceSpecificationTypeDef#
# ExportResourceSpecificationTypeDef definition
class ExportResourceSpecificationTypeDef(TypedDict):
botExportSpecification: NotRequired[BotExportSpecificationTypeDef], # (1)
botLocaleExportSpecification: NotRequired[BotLocaleExportSpecificationTypeDef], # (2)
customVocabularyExportSpecification: NotRequired[CustomVocabularyExportSpecificationTypeDef], # (3)
testSetExportSpecification: NotRequired[TestSetExportSpecificationTypeDef], # (4)
- See BotExportSpecificationTypeDef
- See BotLocaleExportSpecificationTypeDef
- See CustomVocabularyExportSpecificationTypeDef
- See TestSetExportSpecificationTypeDef
ListExportsRequestRequestTypeDef#
# ListExportsRequestRequestTypeDef definition
class ListExportsRequestRequestTypeDef(TypedDict):
botId: NotRequired[str],
botVersion: NotRequired[str],
sortBy: NotRequired[ExportSortByTypeDef], # (1)
filters: NotRequired[Sequence[ExportFilterTypeDef]], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
localeId: NotRequired[str],
ListBotResourceGenerationsRequestRequestTypeDef#
# ListBotResourceGenerationsRequestRequestTypeDef definition
class ListBotResourceGenerationsRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
sortBy: NotRequired[GenerationSortByTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListBotResourceGenerationsResponseTypeDef#
# ListBotResourceGenerationsResponseTypeDef definition
class ListBotResourceGenerationsResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
generationSummaries: List[GenerationSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GrammarSlotTypeSettingTypeDef#
# GrammarSlotTypeSettingTypeDef definition
class GrammarSlotTypeSettingTypeDef(TypedDict):
source: NotRequired[GrammarSlotTypeSourceTypeDef], # (1)
ListImportsRequestRequestTypeDef#
# ListImportsRequestRequestTypeDef definition
class ListImportsRequestRequestTypeDef(TypedDict):
botId: NotRequired[str],
botVersion: NotRequired[str],
sortBy: NotRequired[ImportSortByTypeDef], # (1)
filters: NotRequired[Sequence[ImportFilterTypeDef]], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
localeId: NotRequired[str],
ListImportsResponseTypeDef#
# ListImportsResponseTypeDef definition
class ListImportsResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
importSummaries: List[ImportSummaryTypeDef], # (1)
nextToken: str,
localeId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
InputSessionStateSpecificationTypeDef#
# InputSessionStateSpecificationTypeDef definition
class InputSessionStateSpecificationTypeDef(TypedDict):
sessionAttributes: NotRequired[Dict[str, str]],
activeContexts: NotRequired[List[ActiveContextTypeDef]], # (1)
runtimeHints: NotRequired[RuntimeHintsTypeDef], # (2)
IntentClassificationTestResultItemTypeDef#
# IntentClassificationTestResultItemTypeDef definition
class IntentClassificationTestResultItemTypeDef(TypedDict):
intentName: str,
multiTurnConversation: bool,
resultCounts: IntentClassificationTestResultItemCountsTypeDef, # (1)
ListIntentsRequestRequestTypeDef#
# ListIntentsRequestRequestTypeDef definition
class ListIntentsRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
sortBy: NotRequired[IntentSortByTypeDef], # (1)
filters: NotRequired[Sequence[IntentFilterTypeDef]], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SessionSpecificationTypeDef#
# SessionSpecificationTypeDef definition
class SessionSpecificationTypeDef(TypedDict):
botAliasId: NotRequired[str],
botVersion: NotRequired[str],
localeId: NotRequired[str],
channel: NotRequired[str],
sessionId: NotRequired[str],
conversationStartTime: NotRequired[datetime],
conversationEndTime: NotRequired[datetime],
conversationDurationSeconds: NotRequired[int],
conversationEndState: NotRequired[ConversationEndStateType], # (1)
mode: NotRequired[AnalyticsModalityType], # (2)
numberOfTurns: NotRequired[int],
invokedIntentSamples: NotRequired[List[InvokedIntentSampleTypeDef]], # (3)
originatingRequestId: NotRequired[str],
ListIntentMetricsRequestRequestTypeDef#
# ListIntentMetricsRequestRequestTypeDef definition
class ListIntentMetricsRequestRequestTypeDef(TypedDict):
botId: str,
startDateTime: Union[datetime, str],
endDateTime: Union[datetime, str],
metrics: Sequence[AnalyticsIntentMetricTypeDef], # (1)
binBy: NotRequired[Sequence[AnalyticsBinBySpecificationTypeDef]], # (2)
groupBy: NotRequired[Sequence[AnalyticsIntentGroupBySpecificationTypeDef]], # (3)
filters: NotRequired[Sequence[AnalyticsIntentFilterTypeDef]], # (4)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
- See AnalyticsIntentMetricTypeDef
- See AnalyticsBinBySpecificationTypeDef
- See AnalyticsIntentGroupBySpecificationTypeDef
- See AnalyticsIntentFilterTypeDef
ListIntentPathsRequestRequestTypeDef#
# ListIntentPathsRequestRequestTypeDef definition
class ListIntentPathsRequestRequestTypeDef(TypedDict):
botId: str,
startDateTime: Union[datetime, str],
endDateTime: Union[datetime, str],
intentPath: str,
filters: NotRequired[Sequence[AnalyticsPathFilterTypeDef]], # (1)
ListIntentStageMetricsRequestRequestTypeDef#
# ListIntentStageMetricsRequestRequestTypeDef definition
class ListIntentStageMetricsRequestRequestTypeDef(TypedDict):
botId: str,
startDateTime: Union[datetime, str],
endDateTime: Union[datetime, str],
metrics: Sequence[AnalyticsIntentStageMetricTypeDef], # (1)
binBy: NotRequired[Sequence[AnalyticsBinBySpecificationTypeDef]], # (2)
groupBy: NotRequired[Sequence[AnalyticsIntentStageGroupBySpecificationTypeDef]], # (3)
filters: NotRequired[Sequence[AnalyticsIntentStageFilterTypeDef]], # (4)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
- See AnalyticsIntentStageMetricTypeDef
- See AnalyticsBinBySpecificationTypeDef
- See AnalyticsIntentStageGroupBySpecificationTypeDef
- See AnalyticsIntentStageFilterTypeDef
ListSessionMetricsRequestRequestTypeDef#
# ListSessionMetricsRequestRequestTypeDef definition
class ListSessionMetricsRequestRequestTypeDef(TypedDict):
botId: str,
startDateTime: Union[datetime, str],
endDateTime: Union[datetime, str],
metrics: Sequence[AnalyticsSessionMetricTypeDef], # (1)
binBy: NotRequired[Sequence[AnalyticsBinBySpecificationTypeDef]], # (2)
groupBy: NotRequired[Sequence[AnalyticsSessionGroupBySpecificationTypeDef]], # (3)
filters: NotRequired[Sequence[AnalyticsSessionFilterTypeDef]], # (4)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
- See AnalyticsSessionMetricTypeDef
- See AnalyticsBinBySpecificationTypeDef
- See AnalyticsSessionGroupBySpecificationTypeDef
- See AnalyticsSessionFilterTypeDef
ListUtteranceMetricsRequestRequestTypeDef#
# ListUtteranceMetricsRequestRequestTypeDef definition
class ListUtteranceMetricsRequestRequestTypeDef(TypedDict):
botId: str,
startDateTime: Union[datetime, str],
endDateTime: Union[datetime, str],
metrics: Sequence[AnalyticsUtteranceMetricTypeDef], # (1)
binBy: NotRequired[Sequence[AnalyticsBinBySpecificationTypeDef]], # (2)
groupBy: NotRequired[Sequence[AnalyticsUtteranceGroupBySpecificationTypeDef]], # (3)
attributes: NotRequired[Sequence[AnalyticsUtteranceAttributeTypeDef]], # (4)
filters: NotRequired[Sequence[AnalyticsUtteranceFilterTypeDef]], # (5)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
- See AnalyticsUtteranceMetricTypeDef
- See AnalyticsBinBySpecificationTypeDef
- See AnalyticsUtteranceGroupBySpecificationTypeDef
- See AnalyticsUtteranceAttributeTypeDef
- See AnalyticsUtteranceFilterTypeDef
ListRecommendedIntentsResponseTypeDef#
# ListRecommendedIntentsResponseTypeDef definition
class ListRecommendedIntentsResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationId: str,
summaryList: List[RecommendedIntentSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSessionAnalyticsDataRequestRequestTypeDef#
# ListSessionAnalyticsDataRequestRequestTypeDef definition
class ListSessionAnalyticsDataRequestRequestTypeDef(TypedDict):
botId: str,
startDateTime: Union[datetime, str],
endDateTime: Union[datetime, str],
sortBy: NotRequired[SessionDataSortByTypeDef], # (1)
filters: NotRequired[Sequence[AnalyticsSessionFilterTypeDef]], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListSlotTypesRequestRequestTypeDef#
# ListSlotTypesRequestRequestTypeDef definition
class ListSlotTypesRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
sortBy: NotRequired[SlotTypeSortByTypeDef], # (1)
filters: NotRequired[Sequence[SlotTypeFilterTypeDef]], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListSlotTypesResponseTypeDef#
# ListSlotTypesResponseTypeDef definition
class ListSlotTypesResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
slotTypeSummaries: List[SlotTypeSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSlotsRequestRequestTypeDef#
# ListSlotsRequestRequestTypeDef definition
class ListSlotsRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
intentId: str,
sortBy: NotRequired[SlotSortByTypeDef], # (1)
filters: NotRequired[Sequence[SlotFilterTypeDef]], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
- See SlotSortByTypeDef
- See SlotFilterTypeDef
ListTestExecutionsRequestRequestTypeDef#
# ListTestExecutionsRequestRequestTypeDef definition
class ListTestExecutionsRequestRequestTypeDef(TypedDict):
sortBy: NotRequired[TestExecutionSortByTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTestSetsRequestRequestTypeDef#
# ListTestSetsRequestRequestTypeDef definition
class ListTestSetsRequestRequestTypeDef(TypedDict):
sortBy: NotRequired[TestSetSortByTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListUtteranceAnalyticsDataRequestRequestTypeDef#
# ListUtteranceAnalyticsDataRequestRequestTypeDef definition
class ListUtteranceAnalyticsDataRequestRequestTypeDef(TypedDict):
botId: str,
startDateTime: Union[datetime, str],
endDateTime: Union[datetime, str],
sortBy: NotRequired[UtteranceDataSortByTypeDef], # (1)
filters: NotRequired[Sequence[AnalyticsUtteranceFilterTypeDef]], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
OverallTestResultsTypeDef#
# OverallTestResultsTypeDef definition
class OverallTestResultsTypeDef(TypedDict):
items: List[OverallTestResultItemTypeDef], # (1)
UtteranceAggregationDurationTypeDef#
# UtteranceAggregationDurationTypeDef definition
class UtteranceAggregationDurationTypeDef(TypedDict):
relativeAggregationDuration: RelativeAggregationDurationTypeDef, # (1)
RuntimeHintDetailsTypeDef#
# RuntimeHintDetailsTypeDef definition
class RuntimeHintDetailsTypeDef(TypedDict):
runtimeHintValues: NotRequired[List[RuntimeHintValueTypeDef]], # (1)
subSlotHints: NotRequired[Dict[str, Dict[str, Any]]],
SlotTypeValueTypeDef#
# SlotTypeValueTypeDef definition
class SlotTypeValueTypeDef(TypedDict):
sampleValue: NotRequired[SampleValueTypeDef], # (1)
synonyms: NotRequired[Sequence[SampleValueTypeDef]], # (2)
- See SampleValueTypeDef
- See SampleValueTypeDef
SlotDefaultValueSpecificationTypeDef#
# SlotDefaultValueSpecificationTypeDef definition
class SlotDefaultValueSpecificationTypeDef(TypedDict):
defaultValueList: Sequence[SlotDefaultValueTypeDef], # (1)
SlotResolutionTestResultItemTypeDef#
# SlotResolutionTestResultItemTypeDef definition
class SlotResolutionTestResultItemTypeDef(TypedDict):
slotName: str,
resultCounts: SlotResolutionTestResultItemCountsTypeDef, # (1)
SlotValueOverrideTypeDef#
# SlotValueOverrideTypeDef definition
class SlotValueOverrideTypeDef(TypedDict):
shape: NotRequired[SlotShapeType], # (1)
value: NotRequired[SlotValueTypeDef], # (2)
values: NotRequired[Sequence[Dict[str, Any]]],
- See SlotShapeType
- See SlotValueTypeDef
SlotValueSelectionSettingTypeDef#
# SlotValueSelectionSettingTypeDef definition
class SlotValueSelectionSettingTypeDef(TypedDict):
resolutionStrategy: SlotValueResolutionStrategyType, # (1)
regexFilter: NotRequired[SlotValueRegexFilterTypeDef], # (2)
advancedRecognitionSetting: NotRequired[AdvancedRecognitionSettingTypeDef], # (3)
- See SlotValueResolutionStrategyType
- See SlotValueRegexFilterTypeDef
- See AdvancedRecognitionSettingTypeDef
TestSetDiscrepancyErrorsTypeDef#
# TestSetDiscrepancyErrorsTypeDef definition
class TestSetDiscrepancyErrorsTypeDef(TypedDict):
intentDiscrepancies: List[TestSetIntentDiscrepancyItemTypeDef], # (1)
slotDiscrepancies: List[TestSetSlotDiscrepancyItemTypeDef], # (2)
TestSetDiscrepancyReportResourceTargetTypeDef#
# TestSetDiscrepancyReportResourceTargetTypeDef definition
class TestSetDiscrepancyReportResourceTargetTypeDef(TypedDict):
botAliasTarget: NotRequired[TestSetDiscrepancyReportBotAliasTargetTypeDef], # (1)
TestSetImportResourceSpecificationTypeDef#
# TestSetImportResourceSpecificationTypeDef definition
class TestSetImportResourceSpecificationTypeDef(TypedDict):
testSetName: str,
roleArn: str,
storageLocation: TestSetStorageLocationTypeDef, # (1)
importInputLocation: TestSetImportInputLocationTypeDef, # (2)
modality: TestSetModalityType, # (3)
description: NotRequired[str],
testSetTags: NotRequired[Dict[str, str]],
UserTurnOutputSpecificationTypeDef#
# UserTurnOutputSpecificationTypeDef definition
class UserTurnOutputSpecificationTypeDef(TypedDict):
intent: UserTurnIntentOutputTypeDef, # (1)
activeContexts: NotRequired[List[ActiveContextTypeDef]], # (2)
transcript: NotRequired[str],
UtteranceInputSpecificationTypeDef#
# UtteranceInputSpecificationTypeDef definition
class UtteranceInputSpecificationTypeDef(TypedDict):
textInput: NotRequired[str],
audioInput: NotRequired[UtteranceAudioInputSpecificationTypeDef], # (1)
ListIntentMetricsResponseTypeDef#
# ListIntentMetricsResponseTypeDef definition
class ListIntentMetricsResponseTypeDef(TypedDict):
botId: str,
results: List[AnalyticsIntentResultTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListIntentStageMetricsResponseTypeDef#
# ListIntentStageMetricsResponseTypeDef definition
class ListIntentStageMetricsResponseTypeDef(TypedDict):
botId: str,
results: List[AnalyticsIntentStageResultTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSessionMetricsResponseTypeDef#
# ListSessionMetricsResponseTypeDef definition
class ListSessionMetricsResponseTypeDef(TypedDict):
botId: str,
results: List[AnalyticsSessionResultTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUtteranceMetricsResponseTypeDef#
# ListUtteranceMetricsResponseTypeDef definition
class ListUtteranceMetricsResponseTypeDef(TypedDict):
botId: str,
results: List[AnalyticsUtteranceResultTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PromptAttemptSpecificationTypeDef#
# PromptAttemptSpecificationTypeDef definition
class PromptAttemptSpecificationTypeDef(TypedDict):
allowedInputTypes: AllowedInputTypesTypeDef, # (1)
allowInterrupt: NotRequired[bool],
audioAndDTMFInputSpecification: NotRequired[AudioAndDTMFInputSpecificationTypeDef], # (2)
textInputSpecification: NotRequired[TextInputSpecificationTypeDef], # (3)
- See AllowedInputTypesTypeDef
- See AudioAndDTMFInputSpecificationTypeDef
- See TextInputSpecificationTypeDef
AudioLogSettingTypeDef#
# AudioLogSettingTypeDef definition
class AudioLogSettingTypeDef(TypedDict):
enabled: bool,
destination: AudioLogDestinationTypeDef, # (1)
selectiveLoggingEnabled: NotRequired[bool],
BuildtimeSettingsTypeDef#
# BuildtimeSettingsTypeDef definition
class BuildtimeSettingsTypeDef(TypedDict):
descriptiveBotBuilder: NotRequired[DescriptiveBotBuilderSpecificationTypeDef], # (1)
sampleUtteranceGeneration: NotRequired[SampleUtteranceGenerationSpecificationTypeDef], # (2)
RuntimeSettingsTypeDef#
# RuntimeSettingsTypeDef definition
class RuntimeSettingsTypeDef(TypedDict):
slotResolutionImprovement: NotRequired[SlotResolutionImprovementSpecificationTypeDef], # (1)
DescribeTestExecutionResponseTypeDef#
# DescribeTestExecutionResponseTypeDef definition
class DescribeTestExecutionResponseTypeDef(TypedDict):
testExecutionId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
testExecutionStatus: TestExecutionStatusType, # (1)
testSetId: str,
testSetName: str,
target: TestExecutionTargetTypeDef, # (2)
apiMode: TestExecutionApiModeType, # (3)
testExecutionModality: TestExecutionModalityType, # (4)
failureReasons: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See TestExecutionStatusType
- See TestExecutionTargetTypeDef
- See TestExecutionApiModeType
- See TestExecutionModalityType
- See ResponseMetadataTypeDef
StartTestExecutionRequestRequestTypeDef#
# StartTestExecutionRequestRequestTypeDef definition
class StartTestExecutionRequestRequestTypeDef(TypedDict):
testSetId: str,
target: TestExecutionTargetTypeDef, # (1)
apiMode: TestExecutionApiModeType, # (2)
testExecutionModality: NotRequired[TestExecutionModalityType], # (3)
StartTestExecutionResponseTypeDef#
# StartTestExecutionResponseTypeDef definition
class StartTestExecutionResponseTypeDef(TypedDict):
testExecutionId: str,
creationDateTime: datetime,
testSetId: str,
target: TestExecutionTargetTypeDef, # (1)
apiMode: TestExecutionApiModeType, # (2)
testExecutionModality: TestExecutionModalityType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See TestExecutionTargetTypeDef
- See TestExecutionApiModeType
- See TestExecutionModalityType
- See ResponseMetadataTypeDef
TestExecutionSummaryTypeDef#
# TestExecutionSummaryTypeDef definition
class TestExecutionSummaryTypeDef(TypedDict):
testExecutionId: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
testExecutionStatus: NotRequired[TestExecutionStatusType], # (1)
testSetId: NotRequired[str],
testSetName: NotRequired[str],
target: NotRequired[TestExecutionTargetTypeDef], # (2)
apiMode: NotRequired[TestExecutionApiModeType], # (3)
testExecutionModality: NotRequired[TestExecutionModalityType], # (4)
- See TestExecutionStatusType
- See TestExecutionTargetTypeDef
- See TestExecutionApiModeType
- See TestExecutionModalityType
BotRecommendationResultsTypeDef#
# BotRecommendationResultsTypeDef definition
class BotRecommendationResultsTypeDef(TypedDict):
botLocaleExportUrl: NotRequired[str],
associatedTranscriptsUrl: NotRequired[str],
statistics: NotRequired[BotRecommendationResultStatisticsTypeDef], # (1)
MessageTypeDef#
# MessageTypeDef definition
class MessageTypeDef(TypedDict):
plainTextMessage: NotRequired[PlainTextMessageTypeDef], # (1)
customPayload: NotRequired[CustomPayloadTypeDef], # (2)
ssmlMessage: NotRequired[SSMLMessageTypeDef], # (3)
imageResponseCard: NotRequired[ImageResponseCardTypeDef], # (4)
- See PlainTextMessageTypeDef
- See CustomPayloadTypeDef
- See SSMLMessageTypeDef
- See ImageResponseCardTypeDef
UtteranceBotResponseTypeDef#
# UtteranceBotResponseTypeDef definition
class UtteranceBotResponseTypeDef(TypedDict):
content: NotRequired[str],
contentType: NotRequired[UtteranceContentTypeType], # (1)
imageResponseCard: NotRequired[ImageResponseCardTypeDef], # (2)
TextLogSettingTypeDef#
# TextLogSettingTypeDef definition
class TextLogSettingTypeDef(TypedDict):
enabled: bool,
destination: TextLogDestinationTypeDef, # (1)
selectiveLoggingEnabled: NotRequired[bool],
BotAliasLocaleSettingsTypeDef#
# BotAliasLocaleSettingsTypeDef definition
class BotAliasLocaleSettingsTypeDef(TypedDict):
enabled: bool,
codeHookSpecification: NotRequired[CodeHookSpecificationTypeDef], # (1)
ConversationLevelTestResultsTypeDef#
# ConversationLevelTestResultsTypeDef definition
class ConversationLevelTestResultsTypeDef(TypedDict):
items: List[ConversationLevelTestResultItemTypeDef], # (1)
ListTestExecutionResultItemsRequestRequestTypeDef#
# ListTestExecutionResultItemsRequestRequestTypeDef definition
class ListTestExecutionResultItemsRequestRequestTypeDef(TypedDict):
testExecutionId: str,
resultFilterBy: TestExecutionResultFilterByTypeDef, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
TestSetGenerationDataSourceTypeDef#
# TestSetGenerationDataSourceTypeDef definition
class TestSetGenerationDataSourceTypeDef(TypedDict):
conversationLogsDataSource: NotRequired[ConversationLogsDataSourceTypeDef], # (1)
ListIntentsResponseTypeDef#
# ListIntentsResponseTypeDef definition
class ListIntentsResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
intentSummaries: List[IntentSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TranscriptFilterTypeDef#
# TranscriptFilterTypeDef definition
class TranscriptFilterTypeDef(TypedDict):
lexTranscriptFilter: NotRequired[LexTranscriptFilterTypeDef], # (1)
ListTestSetsResponseTypeDef#
# ListTestSetsResponseTypeDef definition
class ListTestSetsResponseTypeDef(TypedDict):
testSets: List[TestSetSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateExportRequestRequestTypeDef#
# CreateExportRequestRequestTypeDef definition
class CreateExportRequestRequestTypeDef(TypedDict):
resourceSpecification: ExportResourceSpecificationTypeDef, # (1)
fileFormat: ImportExportFileFormatType, # (2)
filePassword: NotRequired[str],
CreateExportResponseTypeDef#
# CreateExportResponseTypeDef definition
class CreateExportResponseTypeDef(TypedDict):
exportId: str,
resourceSpecification: ExportResourceSpecificationTypeDef, # (1)
fileFormat: ImportExportFileFormatType, # (2)
exportStatus: ExportStatusType, # (3)
creationDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ExportResourceSpecificationTypeDef
- See ImportExportFileFormatType
- See ExportStatusType
- See ResponseMetadataTypeDef
DescribeExportResponseTypeDef#
# DescribeExportResponseTypeDef definition
class DescribeExportResponseTypeDef(TypedDict):
exportId: str,
resourceSpecification: ExportResourceSpecificationTypeDef, # (1)
fileFormat: ImportExportFileFormatType, # (2)
exportStatus: ExportStatusType, # (3)
failureReasons: List[str],
downloadUrl: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ExportResourceSpecificationTypeDef
- See ImportExportFileFormatType
- See ExportStatusType
- See ResponseMetadataTypeDef
ExportSummaryTypeDef#
# ExportSummaryTypeDef definition
class ExportSummaryTypeDef(TypedDict):
exportId: NotRequired[str],
resourceSpecification: NotRequired[ExportResourceSpecificationTypeDef], # (1)
fileFormat: NotRequired[ImportExportFileFormatType], # (2)
exportStatus: NotRequired[ExportStatusType], # (3)
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
UpdateExportResponseTypeDef#
# UpdateExportResponseTypeDef definition
class UpdateExportResponseTypeDef(TypedDict):
exportId: str,
resourceSpecification: ExportResourceSpecificationTypeDef, # (1)
fileFormat: ImportExportFileFormatType, # (2)
exportStatus: ExportStatusType, # (3)
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ExportResourceSpecificationTypeDef
- See ImportExportFileFormatType
- See ExportStatusType
- See ResponseMetadataTypeDef
ExternalSourceSettingTypeDef#
# ExternalSourceSettingTypeDef definition
class ExternalSourceSettingTypeDef(TypedDict):
grammarSlotTypeSetting: NotRequired[GrammarSlotTypeSettingTypeDef], # (1)
IntentClassificationTestResultsTypeDef#
# IntentClassificationTestResultsTypeDef definition
class IntentClassificationTestResultsTypeDef(TypedDict):
items: List[IntentClassificationTestResultItemTypeDef], # (1)
ListSessionAnalyticsDataResponseTypeDef#
# ListSessionAnalyticsDataResponseTypeDef definition
class ListSessionAnalyticsDataResponseTypeDef(TypedDict):
botId: str,
nextToken: str,
sessions: List[SessionSpecificationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAggregatedUtterancesRequestRequestTypeDef#
# ListAggregatedUtterancesRequestRequestTypeDef definition
class ListAggregatedUtterancesRequestRequestTypeDef(TypedDict):
botId: str,
localeId: str,
aggregationDuration: UtteranceAggregationDurationTypeDef, # (1)
botAliasId: NotRequired[str],
botVersion: NotRequired[str],
sortBy: NotRequired[AggregatedUtterancesSortByTypeDef], # (2)
filters: NotRequired[Sequence[AggregatedUtterancesFilterTypeDef]], # (3)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
- See UtteranceAggregationDurationTypeDef
- See AggregatedUtterancesSortByTypeDef
- See AggregatedUtterancesFilterTypeDef
ListAggregatedUtterancesResponseTypeDef#
# ListAggregatedUtterancesResponseTypeDef definition
class ListAggregatedUtterancesResponseTypeDef(TypedDict):
botId: str,
botAliasId: str,
botVersion: str,
localeId: str,
aggregationDuration: UtteranceAggregationDurationTypeDef, # (1)
aggregationWindowStartTime: datetime,
aggregationWindowEndTime: datetime,
aggregationLastRefreshedDateTime: datetime,
aggregatedUtterancesSummaries: List[AggregatedUtterancesSummaryTypeDef], # (2)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See UtteranceAggregationDurationTypeDef
- See AggregatedUtterancesSummaryTypeDef
- See ResponseMetadataTypeDef
IntentLevelSlotResolutionTestResultItemTypeDef#
# IntentLevelSlotResolutionTestResultItemTypeDef definition
class IntentLevelSlotResolutionTestResultItemTypeDef(TypedDict):
intentName: str,
multiTurnConversation: bool,
slotResolutionResults: List[SlotResolutionTestResultItemTypeDef], # (1)
CreateTestSetDiscrepancyReportRequestRequestTypeDef#
# CreateTestSetDiscrepancyReportRequestRequestTypeDef definition
class CreateTestSetDiscrepancyReportRequestRequestTypeDef(TypedDict):
testSetId: str,
target: TestSetDiscrepancyReportResourceTargetTypeDef, # (1)
CreateTestSetDiscrepancyReportResponseTypeDef#
# CreateTestSetDiscrepancyReportResponseTypeDef definition
class CreateTestSetDiscrepancyReportResponseTypeDef(TypedDict):
testSetDiscrepancyReportId: str,
creationDateTime: datetime,
testSetId: str,
target: TestSetDiscrepancyReportResourceTargetTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTestSetDiscrepancyReportResponseTypeDef#
# DescribeTestSetDiscrepancyReportResponseTypeDef definition
class DescribeTestSetDiscrepancyReportResponseTypeDef(TypedDict):
testSetDiscrepancyReportId: str,
testSetId: str,
creationDateTime: datetime,
target: TestSetDiscrepancyReportResourceTargetTypeDef, # (1)
testSetDiscrepancyReportStatus: TestSetDiscrepancyReportStatusType, # (2)
lastUpdatedDataTime: datetime,
testSetDiscrepancyTopErrors: TestSetDiscrepancyErrorsTypeDef, # (3)
testSetDiscrepancyRawOutputUrl: str,
failureReasons: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See TestSetDiscrepancyReportResourceTargetTypeDef
- See TestSetDiscrepancyReportStatusType
- See TestSetDiscrepancyErrorsTypeDef
- See ResponseMetadataTypeDef
ImportResourceSpecificationTypeDef#
# ImportResourceSpecificationTypeDef definition
class ImportResourceSpecificationTypeDef(TypedDict):
botImportSpecification: NotRequired[BotImportSpecificationTypeDef], # (1)
botLocaleImportSpecification: NotRequired[BotLocaleImportSpecificationTypeDef], # (2)
customVocabularyImportSpecification: NotRequired[CustomVocabularyImportSpecificationTypeDef], # (3)
testSetImportResourceSpecification: NotRequired[TestSetImportResourceSpecificationTypeDef], # (4)
- See BotImportSpecificationTypeDef
- See BotLocaleImportSpecificationTypeDef
- See CustomVocabularyImportSpecificationTypeDef
- See TestSetImportResourceSpecificationTypeDef
UserTurnInputSpecificationTypeDef#
# UserTurnInputSpecificationTypeDef definition
class UserTurnInputSpecificationTypeDef(TypedDict):
utteranceInput: UtteranceInputSpecificationTypeDef, # (1)
requestAttributes: NotRequired[Dict[str, str]],
sessionState: NotRequired[InputSessionStateSpecificationTypeDef], # (2)
GenerativeAISettingsTypeDef#
# GenerativeAISettingsTypeDef definition
class GenerativeAISettingsTypeDef(TypedDict):
runtimeSettings: NotRequired[RuntimeSettingsTypeDef], # (1)
buildtimeSettings: NotRequired[BuildtimeSettingsTypeDef], # (2)
ListTestExecutionsResponseTypeDef#
# ListTestExecutionsResponseTypeDef definition
class ListTestExecutionsResponseTypeDef(TypedDict):
testExecutions: List[TestExecutionSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MessageGroupTypeDef#
# MessageGroupTypeDef definition
class MessageGroupTypeDef(TypedDict):
message: MessageTypeDef, # (1)
variations: NotRequired[Sequence[MessageTypeDef]], # (2)
- See MessageTypeDef
- See MessageTypeDef
UtteranceSpecificationTypeDef#
# UtteranceSpecificationTypeDef definition
class UtteranceSpecificationTypeDef(TypedDict):
botAliasId: NotRequired[str],
botVersion: NotRequired[str],
localeId: NotRequired[str],
sessionId: NotRequired[str],
channel: NotRequired[str],
mode: NotRequired[AnalyticsModalityType], # (1)
conversationStartTime: NotRequired[datetime],
conversationEndTime: NotRequired[datetime],
utterance: NotRequired[str],
utteranceTimestamp: NotRequired[datetime],
audioVoiceDurationMillis: NotRequired[int],
utteranceUnderstood: NotRequired[bool],
inputType: NotRequired[str],
outputType: NotRequired[str],
associatedIntentName: NotRequired[str],
associatedSlotName: NotRequired[str],
intentState: NotRequired[IntentStateType], # (2)
dialogActionType: NotRequired[str],
botResponseAudioVoiceId: NotRequired[str],
slotsFilledInSession: NotRequired[str],
utteranceRequestId: NotRequired[str],
botResponses: NotRequired[List[UtteranceBotResponseTypeDef]], # (3)
ConversationLogSettingsTypeDef#
# ConversationLogSettingsTypeDef definition
class ConversationLogSettingsTypeDef(TypedDict):
textLogSettings: NotRequired[Sequence[TextLogSettingTypeDef]], # (1)
audioLogSettings: NotRequired[Sequence[AudioLogSettingTypeDef]], # (2)
DescribeTestSetGenerationResponseTypeDef#
# DescribeTestSetGenerationResponseTypeDef definition
class DescribeTestSetGenerationResponseTypeDef(TypedDict):
testSetGenerationId: str,
testSetGenerationStatus: TestSetGenerationStatusType, # (1)
failureReasons: List[str],
testSetId: str,
testSetName: str,
description: str,
storageLocation: TestSetStorageLocationTypeDef, # (2)
generationDataSource: TestSetGenerationDataSourceTypeDef, # (3)
roleArn: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See TestSetGenerationStatusType
- See TestSetStorageLocationTypeDef
- See TestSetGenerationDataSourceTypeDef
- See ResponseMetadataTypeDef
StartTestSetGenerationRequestRequestTypeDef#
# StartTestSetGenerationRequestRequestTypeDef definition
class StartTestSetGenerationRequestRequestTypeDef(TypedDict):
testSetName: str,
storageLocation: TestSetStorageLocationTypeDef, # (1)
generationDataSource: TestSetGenerationDataSourceTypeDef, # (2)
roleArn: str,
description: NotRequired[str],
testSetTags: NotRequired[Mapping[str, str]],
StartTestSetGenerationResponseTypeDef#
# StartTestSetGenerationResponseTypeDef definition
class StartTestSetGenerationResponseTypeDef(TypedDict):
testSetGenerationId: str,
creationDateTime: datetime,
testSetGenerationStatus: TestSetGenerationStatusType, # (1)
testSetName: str,
description: str,
storageLocation: TestSetStorageLocationTypeDef, # (2)
generationDataSource: TestSetGenerationDataSourceTypeDef, # (3)
roleArn: str,
testSetTags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See TestSetGenerationStatusType
- See TestSetStorageLocationTypeDef
- See TestSetGenerationDataSourceTypeDef
- See ResponseMetadataTypeDef
S3BucketTranscriptSourceTypeDef#
# S3BucketTranscriptSourceTypeDef definition
class S3BucketTranscriptSourceTypeDef(TypedDict):
s3BucketName: str,
transcriptFormat: TranscriptFormatType, # (2)
pathFormat: NotRequired[PathFormatTypeDef], # (1)
transcriptFilter: NotRequired[TranscriptFilterTypeDef], # (3)
kmsKeyArn: NotRequired[str],
ListExportsResponseTypeDef#
# ListExportsResponseTypeDef definition
class ListExportsResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
exportSummaries: List[ExportSummaryTypeDef], # (1)
nextToken: str,
localeId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateSlotTypeRequestRequestTypeDef#
# CreateSlotTypeRequestRequestTypeDef definition
class CreateSlotTypeRequestRequestTypeDef(TypedDict):
slotTypeName: str,
botId: str,
botVersion: str,
localeId: str,
description: NotRequired[str],
slotTypeValues: NotRequired[Sequence[SlotTypeValueTypeDef]], # (1)
valueSelectionSetting: NotRequired[SlotValueSelectionSettingTypeDef], # (2)
parentSlotTypeSignature: NotRequired[str],
externalSourceSetting: NotRequired[ExternalSourceSettingTypeDef], # (3)
compositeSlotTypeSetting: NotRequired[CompositeSlotTypeSettingTypeDef], # (4)
- See SlotTypeValueTypeDef
- See SlotValueSelectionSettingTypeDef
- See ExternalSourceSettingTypeDef
- See CompositeSlotTypeSettingTypeDef
CreateSlotTypeResponseTypeDef#
# CreateSlotTypeResponseTypeDef definition
class CreateSlotTypeResponseTypeDef(TypedDict):
slotTypeId: str,
slotTypeName: str,
description: str,
slotTypeValues: List[SlotTypeValueTypeDef], # (1)
valueSelectionSetting: SlotValueSelectionSettingTypeDef, # (2)
parentSlotTypeSignature: str,
botId: str,
botVersion: str,
localeId: str,
creationDateTime: datetime,
externalSourceSetting: ExternalSourceSettingTypeDef, # (3)
compositeSlotTypeSetting: CompositeSlotTypeSettingTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See SlotTypeValueTypeDef
- See SlotValueSelectionSettingTypeDef
- See ExternalSourceSettingTypeDef
- See CompositeSlotTypeSettingTypeDef
- See ResponseMetadataTypeDef
DescribeSlotTypeResponseTypeDef#
# DescribeSlotTypeResponseTypeDef definition
class DescribeSlotTypeResponseTypeDef(TypedDict):
slotTypeId: str,
slotTypeName: str,
description: str,
slotTypeValues: List[SlotTypeValueTypeDef], # (1)
valueSelectionSetting: SlotValueSelectionSettingTypeDef, # (2)
parentSlotTypeSignature: str,
botId: str,
botVersion: str,
localeId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
externalSourceSetting: ExternalSourceSettingTypeDef, # (3)
compositeSlotTypeSetting: CompositeSlotTypeSettingTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See SlotTypeValueTypeDef
- See SlotValueSelectionSettingTypeDef
- See ExternalSourceSettingTypeDef
- See CompositeSlotTypeSettingTypeDef
- See ResponseMetadataTypeDef
UpdateSlotTypeRequestRequestTypeDef#
# UpdateSlotTypeRequestRequestTypeDef definition
class UpdateSlotTypeRequestRequestTypeDef(TypedDict):
slotTypeId: str,
slotTypeName: str,
botId: str,
botVersion: str,
localeId: str,
description: NotRequired[str],
slotTypeValues: NotRequired[Sequence[SlotTypeValueTypeDef]], # (1)
valueSelectionSetting: NotRequired[SlotValueSelectionSettingTypeDef], # (2)
parentSlotTypeSignature: NotRequired[str],
externalSourceSetting: NotRequired[ExternalSourceSettingTypeDef], # (3)
compositeSlotTypeSetting: NotRequired[CompositeSlotTypeSettingTypeDef], # (4)
- See SlotTypeValueTypeDef
- See SlotValueSelectionSettingTypeDef
- See ExternalSourceSettingTypeDef
- See CompositeSlotTypeSettingTypeDef
UpdateSlotTypeResponseTypeDef#
# UpdateSlotTypeResponseTypeDef definition
class UpdateSlotTypeResponseTypeDef(TypedDict):
slotTypeId: str,
slotTypeName: str,
description: str,
slotTypeValues: List[SlotTypeValueTypeDef], # (1)
valueSelectionSetting: SlotValueSelectionSettingTypeDef, # (2)
parentSlotTypeSignature: str,
botId: str,
botVersion: str,
localeId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
externalSourceSetting: ExternalSourceSettingTypeDef, # (3)
compositeSlotTypeSetting: CompositeSlotTypeSettingTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See SlotTypeValueTypeDef
- See SlotValueSelectionSettingTypeDef
- See ExternalSourceSettingTypeDef
- See CompositeSlotTypeSettingTypeDef
- See ResponseMetadataTypeDef
IntentLevelSlotResolutionTestResultsTypeDef#
# IntentLevelSlotResolutionTestResultsTypeDef definition
class IntentLevelSlotResolutionTestResultsTypeDef(TypedDict):
items: List[IntentLevelSlotResolutionTestResultItemTypeDef], # (1)
DescribeImportResponseTypeDef#
# DescribeImportResponseTypeDef definition
class DescribeImportResponseTypeDef(TypedDict):
importId: str,
resourceSpecification: ImportResourceSpecificationTypeDef, # (1)
importedResourceId: str,
importedResourceName: str,
mergeStrategy: MergeStrategyType, # (2)
importStatus: ImportStatusType, # (3)
failureReasons: List[str],
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ImportResourceSpecificationTypeDef
- See MergeStrategyType
- See ImportStatusType
- See ResponseMetadataTypeDef
StartImportRequestRequestTypeDef#
# StartImportRequestRequestTypeDef definition
class StartImportRequestRequestTypeDef(TypedDict):
importId: str,
resourceSpecification: ImportResourceSpecificationTypeDef, # (1)
mergeStrategy: MergeStrategyType, # (2)
filePassword: NotRequired[str],
StartImportResponseTypeDef#
# StartImportResponseTypeDef definition
class StartImportResponseTypeDef(TypedDict):
importId: str,
resourceSpecification: ImportResourceSpecificationTypeDef, # (1)
mergeStrategy: MergeStrategyType, # (2)
importStatus: ImportStatusType, # (3)
creationDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ImportResourceSpecificationTypeDef
- See MergeStrategyType
- See ImportStatusType
- See ResponseMetadataTypeDef
UserTurnResultTypeDef#
# UserTurnResultTypeDef definition
class UserTurnResultTypeDef(TypedDict):
input: UserTurnInputSpecificationTypeDef, # (1)
expectedOutput: UserTurnOutputSpecificationTypeDef, # (2)
actualOutput: NotRequired[UserTurnOutputSpecificationTypeDef], # (2)
errorDetails: NotRequired[ExecutionErrorDetailsTypeDef], # (4)
endToEndResult: NotRequired[TestResultMatchStatusType], # (5)
intentMatchResult: NotRequired[TestResultMatchStatusType], # (5)
slotMatchResult: NotRequired[TestResultMatchStatusType], # (5)
speechTranscriptionResult: NotRequired[TestResultMatchStatusType], # (5)
conversationLevelResult: NotRequired[ConversationLevelResultDetailTypeDef], # (9)
- See UserTurnInputSpecificationTypeDef
- See UserTurnOutputSpecificationTypeDef
- See UserTurnOutputSpecificationTypeDef
- See ExecutionErrorDetailsTypeDef
- See TestResultMatchStatusType
- See TestResultMatchStatusType
- See TestResultMatchStatusType
- See TestResultMatchStatusType
- See ConversationLevelResultDetailTypeDef
UserTurnSpecificationTypeDef#
# UserTurnSpecificationTypeDef definition
class UserTurnSpecificationTypeDef(TypedDict):
input: UserTurnInputSpecificationTypeDef, # (1)
expected: UserTurnOutputSpecificationTypeDef, # (2)
CreateBotLocaleRequestRequestTypeDef#
# CreateBotLocaleRequestRequestTypeDef definition
class CreateBotLocaleRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
nluIntentConfidenceThreshold: float,
description: NotRequired[str],
voiceSettings: NotRequired[VoiceSettingsTypeDef], # (1)
generativeAISettings: NotRequired[GenerativeAISettingsTypeDef], # (2)
CreateBotLocaleResponseTypeDef#
# CreateBotLocaleResponseTypeDef definition
class CreateBotLocaleResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeName: str,
localeId: str,
description: str,
nluIntentConfidenceThreshold: float,
voiceSettings: VoiceSettingsTypeDef, # (1)
botLocaleStatus: BotLocaleStatusType, # (2)
creationDateTime: datetime,
generativeAISettings: GenerativeAISettingsTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See VoiceSettingsTypeDef
- See BotLocaleStatusType
- See GenerativeAISettingsTypeDef
- See ResponseMetadataTypeDef
DescribeBotLocaleResponseTypeDef#
# DescribeBotLocaleResponseTypeDef definition
class DescribeBotLocaleResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
localeName: str,
description: str,
nluIntentConfidenceThreshold: float,
voiceSettings: VoiceSettingsTypeDef, # (1)
intentsCount: int,
slotTypesCount: int,
botLocaleStatus: BotLocaleStatusType, # (2)
failureReasons: List[str],
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
lastBuildSubmittedDateTime: datetime,
botLocaleHistoryEvents: List[BotLocaleHistoryEventTypeDef], # (3)
recommendedActions: List[str],
generativeAISettings: GenerativeAISettingsTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See VoiceSettingsTypeDef
- See BotLocaleStatusType
- See BotLocaleHistoryEventTypeDef
- See GenerativeAISettingsTypeDef
- See ResponseMetadataTypeDef
UpdateBotLocaleRequestRequestTypeDef#
# UpdateBotLocaleRequestRequestTypeDef definition
class UpdateBotLocaleRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
nluIntentConfidenceThreshold: float,
description: NotRequired[str],
voiceSettings: NotRequired[VoiceSettingsTypeDef], # (1)
generativeAISettings: NotRequired[GenerativeAISettingsTypeDef], # (2)
UpdateBotLocaleResponseTypeDef#
# UpdateBotLocaleResponseTypeDef definition
class UpdateBotLocaleResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
localeName: str,
description: str,
nluIntentConfidenceThreshold: float,
voiceSettings: VoiceSettingsTypeDef, # (1)
botLocaleStatus: BotLocaleStatusType, # (2)
failureReasons: List[str],
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
recommendedActions: List[str],
generativeAISettings: GenerativeAISettingsTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See VoiceSettingsTypeDef
- See BotLocaleStatusType
- See GenerativeAISettingsTypeDef
- See ResponseMetadataTypeDef
FulfillmentStartResponseSpecificationTypeDef#
# FulfillmentStartResponseSpecificationTypeDef definition
class FulfillmentStartResponseSpecificationTypeDef(TypedDict):
delayInSeconds: int,
messageGroups: Sequence[MessageGroupTypeDef], # (1)
allowInterrupt: NotRequired[bool],
FulfillmentUpdateResponseSpecificationTypeDef#
# FulfillmentUpdateResponseSpecificationTypeDef definition
class FulfillmentUpdateResponseSpecificationTypeDef(TypedDict):
frequencyInSeconds: int,
messageGroups: Sequence[MessageGroupTypeDef], # (1)
allowInterrupt: NotRequired[bool],
PromptSpecificationTypeDef#
# PromptSpecificationTypeDef definition
class PromptSpecificationTypeDef(TypedDict):
messageGroups: Sequence[MessageGroupTypeDef], # (1)
maxRetries: int,
allowInterrupt: NotRequired[bool],
messageSelectionStrategy: NotRequired[MessageSelectionStrategyType], # (2)
promptAttemptsSpecification: NotRequired[Mapping[PromptAttemptType, PromptAttemptSpecificationTypeDef]], # (3)
- See MessageGroupTypeDef
- See MessageSelectionStrategyType
- See PromptAttemptType PromptAttemptSpecificationTypeDef
ResponseSpecificationTypeDef#
# ResponseSpecificationTypeDef definition
class ResponseSpecificationTypeDef(TypedDict):
messageGroups: Sequence[MessageGroupTypeDef], # (1)
allowInterrupt: NotRequired[bool],
StillWaitingResponseSpecificationTypeDef#
# StillWaitingResponseSpecificationTypeDef definition
class StillWaitingResponseSpecificationTypeDef(TypedDict):
messageGroups: Sequence[MessageGroupTypeDef], # (1)
frequencyInSeconds: int,
timeoutInSeconds: int,
allowInterrupt: NotRequired[bool],
ListUtteranceAnalyticsDataResponseTypeDef#
# ListUtteranceAnalyticsDataResponseTypeDef definition
class ListUtteranceAnalyticsDataResponseTypeDef(TypedDict):
botId: str,
nextToken: str,
utterances: List[UtteranceSpecificationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateBotAliasRequestRequestTypeDef#
# CreateBotAliasRequestRequestTypeDef definition
class CreateBotAliasRequestRequestTypeDef(TypedDict):
botAliasName: str,
botId: str,
description: NotRequired[str],
botVersion: NotRequired[str],
botAliasLocaleSettings: NotRequired[Mapping[str, BotAliasLocaleSettingsTypeDef]], # (1)
conversationLogSettings: NotRequired[ConversationLogSettingsTypeDef], # (2)
sentimentAnalysisSettings: NotRequired[SentimentAnalysisSettingsTypeDef], # (3)
tags: NotRequired[Mapping[str, str]],
- See BotAliasLocaleSettingsTypeDef
- See ConversationLogSettingsTypeDef
- See SentimentAnalysisSettingsTypeDef
CreateBotAliasResponseTypeDef#
# CreateBotAliasResponseTypeDef definition
class CreateBotAliasResponseTypeDef(TypedDict):
botAliasId: str,
botAliasName: str,
description: str,
botVersion: str,
botAliasLocaleSettings: Dict[str, BotAliasLocaleSettingsTypeDef], # (1)
conversationLogSettings: ConversationLogSettingsTypeDef, # (2)
sentimentAnalysisSettings: SentimentAnalysisSettingsTypeDef, # (3)
botAliasStatus: BotAliasStatusType, # (4)
botId: str,
creationDateTime: datetime,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See BotAliasLocaleSettingsTypeDef
- See ConversationLogSettingsTypeDef
- See SentimentAnalysisSettingsTypeDef
- See BotAliasStatusType
- See ResponseMetadataTypeDef
DescribeBotAliasResponseTypeDef#
# DescribeBotAliasResponseTypeDef definition
class DescribeBotAliasResponseTypeDef(TypedDict):
botAliasId: str,
botAliasName: str,
description: str,
botVersion: str,
botAliasLocaleSettings: Dict[str, BotAliasLocaleSettingsTypeDef], # (1)
conversationLogSettings: ConversationLogSettingsTypeDef, # (2)
sentimentAnalysisSettings: SentimentAnalysisSettingsTypeDef, # (3)
botAliasHistoryEvents: List[BotAliasHistoryEventTypeDef], # (4)
botAliasStatus: BotAliasStatusType, # (5)
botId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
parentBotNetworks: List[ParentBotNetworkTypeDef], # (6)
ResponseMetadata: ResponseMetadataTypeDef, # (7)
- See BotAliasLocaleSettingsTypeDef
- See ConversationLogSettingsTypeDef
- See SentimentAnalysisSettingsTypeDef
- See BotAliasHistoryEventTypeDef
- See BotAliasStatusType
- See ParentBotNetworkTypeDef
- See ResponseMetadataTypeDef
UpdateBotAliasRequestRequestTypeDef#
# UpdateBotAliasRequestRequestTypeDef definition
class UpdateBotAliasRequestRequestTypeDef(TypedDict):
botAliasId: str,
botAliasName: str,
botId: str,
description: NotRequired[str],
botVersion: NotRequired[str],
botAliasLocaleSettings: NotRequired[Mapping[str, BotAliasLocaleSettingsTypeDef]], # (1)
conversationLogSettings: NotRequired[ConversationLogSettingsTypeDef], # (2)
sentimentAnalysisSettings: NotRequired[SentimentAnalysisSettingsTypeDef], # (3)
- See BotAliasLocaleSettingsTypeDef
- See ConversationLogSettingsTypeDef
- See SentimentAnalysisSettingsTypeDef
UpdateBotAliasResponseTypeDef#
# UpdateBotAliasResponseTypeDef definition
class UpdateBotAliasResponseTypeDef(TypedDict):
botAliasId: str,
botAliasName: str,
description: str,
botVersion: str,
botAliasLocaleSettings: Dict[str, BotAliasLocaleSettingsTypeDef], # (1)
conversationLogSettings: ConversationLogSettingsTypeDef, # (2)
sentimentAnalysisSettings: SentimentAnalysisSettingsTypeDef, # (3)
botAliasStatus: BotAliasStatusType, # (4)
botId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See BotAliasLocaleSettingsTypeDef
- See ConversationLogSettingsTypeDef
- See SentimentAnalysisSettingsTypeDef
- See BotAliasStatusType
- See ResponseMetadataTypeDef
TranscriptSourceSettingTypeDef#
# TranscriptSourceSettingTypeDef definition
class TranscriptSourceSettingTypeDef(TypedDict):
s3BucketTranscriptSource: NotRequired[S3BucketTranscriptSourceTypeDef], # (1)
TestSetTurnResultTypeDef#
# TestSetTurnResultTypeDef definition
class TestSetTurnResultTypeDef(TypedDict):
agent: NotRequired[AgentTurnResultTypeDef], # (1)
user: NotRequired[UserTurnResultTypeDef], # (2)
TurnSpecificationTypeDef#
# TurnSpecificationTypeDef definition
class TurnSpecificationTypeDef(TypedDict):
agentTurn: NotRequired[AgentTurnSpecificationTypeDef], # (1)
userTurn: NotRequired[UserTurnSpecificationTypeDef], # (2)
FulfillmentUpdatesSpecificationTypeDef#
# FulfillmentUpdatesSpecificationTypeDef definition
class FulfillmentUpdatesSpecificationTypeDef(TypedDict):
active: bool,
startResponse: NotRequired[FulfillmentStartResponseSpecificationTypeDef], # (1)
updateResponse: NotRequired[FulfillmentUpdateResponseSpecificationTypeDef], # (2)
timeoutInSeconds: NotRequired[int],
SlotSummaryTypeDef#
# SlotSummaryTypeDef definition
class SlotSummaryTypeDef(TypedDict):
slotId: NotRequired[str],
slotName: NotRequired[str],
description: NotRequired[str],
slotConstraint: NotRequired[SlotConstraintType], # (1)
slotTypeId: NotRequired[str],
valueElicitationPromptSpecification: NotRequired[PromptSpecificationTypeDef], # (2)
lastUpdatedDateTime: NotRequired[datetime],
ConditionalBranchTypeDef#
# ConditionalBranchTypeDef definition
class ConditionalBranchTypeDef(TypedDict):
name: str,
condition: ConditionTypeDef, # (1)
nextStep: DialogStateTypeDef, # (2)
response: NotRequired[ResponseSpecificationTypeDef], # (3)
DefaultConditionalBranchTypeDef#
# DefaultConditionalBranchTypeDef definition
class DefaultConditionalBranchTypeDef(TypedDict):
nextStep: NotRequired[DialogStateTypeDef], # (1)
response: NotRequired[ResponseSpecificationTypeDef], # (2)
WaitAndContinueSpecificationTypeDef#
# WaitAndContinueSpecificationTypeDef definition
class WaitAndContinueSpecificationTypeDef(TypedDict):
waitingResponse: ResponseSpecificationTypeDef, # (1)
continueResponse: ResponseSpecificationTypeDef, # (1)
stillWaitingResponse: NotRequired[StillWaitingResponseSpecificationTypeDef], # (3)
active: NotRequired[bool],
- See ResponseSpecificationTypeDef
- See ResponseSpecificationTypeDef
- See StillWaitingResponseSpecificationTypeDef
DescribeBotRecommendationResponseTypeDef#
# DescribeBotRecommendationResponseTypeDef definition
class DescribeBotRecommendationResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationStatus: BotRecommendationStatusType, # (1)
botRecommendationId: str,
failureReasons: List[str],
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
transcriptSourceSetting: TranscriptSourceSettingTypeDef, # (2)
encryptionSetting: EncryptionSettingTypeDef, # (3)
botRecommendationResults: BotRecommendationResultsTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See BotRecommendationStatusType
- See TranscriptSourceSettingTypeDef
- See EncryptionSettingTypeDef
- See BotRecommendationResultsTypeDef
- See ResponseMetadataTypeDef
StartBotRecommendationRequestRequestTypeDef#
# StartBotRecommendationRequestRequestTypeDef definition
class StartBotRecommendationRequestRequestTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
transcriptSourceSetting: TranscriptSourceSettingTypeDef, # (1)
encryptionSetting: NotRequired[EncryptionSettingTypeDef], # (2)
StartBotRecommendationResponseTypeDef#
# StartBotRecommendationResponseTypeDef definition
class StartBotRecommendationResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationStatus: BotRecommendationStatusType, # (1)
botRecommendationId: str,
creationDateTime: datetime,
transcriptSourceSetting: TranscriptSourceSettingTypeDef, # (2)
encryptionSetting: EncryptionSettingTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See BotRecommendationStatusType
- See TranscriptSourceSettingTypeDef
- See EncryptionSettingTypeDef
- See ResponseMetadataTypeDef
UpdateBotRecommendationResponseTypeDef#
# UpdateBotRecommendationResponseTypeDef definition
class UpdateBotRecommendationResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
botRecommendationStatus: BotRecommendationStatusType, # (1)
botRecommendationId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
transcriptSourceSetting: TranscriptSourceSettingTypeDef, # (2)
encryptionSetting: EncryptionSettingTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See BotRecommendationStatusType
- See TranscriptSourceSettingTypeDef
- See EncryptionSettingTypeDef
- See ResponseMetadataTypeDef
UtteranceLevelTestResultItemTypeDef#
# UtteranceLevelTestResultItemTypeDef definition
class UtteranceLevelTestResultItemTypeDef(TypedDict):
recordNumber: int,
turnResult: TestSetTurnResultTypeDef, # (1)
conversationId: NotRequired[str],
TestSetTurnRecordTypeDef#
# TestSetTurnRecordTypeDef definition
class TestSetTurnRecordTypeDef(TypedDict):
recordNumber: int,
turnSpecification: TurnSpecificationTypeDef, # (1)
conversationId: NotRequired[str],
turnNumber: NotRequired[int],
ListSlotsResponseTypeDef#
# ListSlotsResponseTypeDef definition
class ListSlotsResponseTypeDef(TypedDict):
botId: str,
botVersion: str,
localeId: str,
intentId: str,
slotSummaries: List[SlotSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConditionalSpecificationTypeDef#
# ConditionalSpecificationTypeDef definition
class ConditionalSpecificationTypeDef(TypedDict):
active: bool,
conditionalBranches: Sequence[ConditionalBranchTypeDef], # (1)
defaultBranch: DefaultConditionalBranchTypeDef, # (2)
SubSlotValueElicitationSettingTypeDef#
# SubSlotValueElicitationSettingTypeDef definition
class SubSlotValueElicitationSettingTypeDef(TypedDict):
promptSpecification: PromptSpecificationTypeDef, # (2)
defaultValueSpecification: NotRequired[SlotDefaultValueSpecificationTypeDef], # (1)
sampleUtterances: NotRequired[Sequence[SampleUtteranceTypeDef]], # (3)
waitAndContinueSpecification: NotRequired[WaitAndContinueSpecificationTypeDef], # (4)
- See SlotDefaultValueSpecificationTypeDef
- See PromptSpecificationTypeDef
- See SampleUtteranceTypeDef
- See WaitAndContinueSpecificationTypeDef
UtteranceLevelTestResultsTypeDef#
# UtteranceLevelTestResultsTypeDef definition
class UtteranceLevelTestResultsTypeDef(TypedDict):
items: List[UtteranceLevelTestResultItemTypeDef], # (1)
ListTestSetRecordsResponseTypeDef#
# ListTestSetRecordsResponseTypeDef definition
class ListTestSetRecordsResponseTypeDef(TypedDict):
testSetRecords: List[TestSetTurnRecordTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
IntentClosingSettingTypeDef#
# IntentClosingSettingTypeDef definition
class IntentClosingSettingTypeDef(TypedDict):
closingResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
active: NotRequired[bool],
nextStep: NotRequired[DialogStateTypeDef], # (2)
conditional: NotRequired[ConditionalSpecificationTypeDef], # (3)
PostDialogCodeHookInvocationSpecificationTypeDef#
# PostDialogCodeHookInvocationSpecificationTypeDef definition
class PostDialogCodeHookInvocationSpecificationTypeDef(TypedDict):
successResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
successNextStep: NotRequired[DialogStateTypeDef], # (2)
successConditional: NotRequired[ConditionalSpecificationTypeDef], # (3)
failureResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
failureNextStep: NotRequired[DialogStateTypeDef], # (2)
failureConditional: NotRequired[ConditionalSpecificationTypeDef], # (3)
timeoutResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
timeoutNextStep: NotRequired[DialogStateTypeDef], # (2)
timeoutConditional: NotRequired[ConditionalSpecificationTypeDef], # (3)
- See ResponseSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See ResponseSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See ResponseSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
PostFulfillmentStatusSpecificationTypeDef#
# PostFulfillmentStatusSpecificationTypeDef definition
class PostFulfillmentStatusSpecificationTypeDef(TypedDict):
successResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
failureResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
timeoutResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
successNextStep: NotRequired[DialogStateTypeDef], # (4)
successConditional: NotRequired[ConditionalSpecificationTypeDef], # (5)
failureNextStep: NotRequired[DialogStateTypeDef], # (4)
failureConditional: NotRequired[ConditionalSpecificationTypeDef], # (5)
timeoutNextStep: NotRequired[DialogStateTypeDef], # (4)
timeoutConditional: NotRequired[ConditionalSpecificationTypeDef], # (5)
- See ResponseSpecificationTypeDef
- See ResponseSpecificationTypeDef
- See ResponseSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
SpecificationsTypeDef#
# SpecificationsTypeDef definition
class SpecificationsTypeDef(TypedDict):
slotTypeId: str,
valueElicitationSetting: SubSlotValueElicitationSettingTypeDef, # (1)
TestExecutionResultItemsTypeDef#
# TestExecutionResultItemsTypeDef definition
class TestExecutionResultItemsTypeDef(TypedDict):
overallTestResults: NotRequired[OverallTestResultsTypeDef], # (1)
conversationLevelTestResults: NotRequired[ConversationLevelTestResultsTypeDef], # (2)
intentClassificationTestResults: NotRequired[IntentClassificationTestResultsTypeDef], # (3)
intentLevelSlotResolutionTestResults: NotRequired[IntentLevelSlotResolutionTestResultsTypeDef], # (4)
utteranceLevelTestResults: NotRequired[UtteranceLevelTestResultsTypeDef], # (5)
- See OverallTestResultsTypeDef
- See ConversationLevelTestResultsTypeDef
- See IntentClassificationTestResultsTypeDef
- See IntentLevelSlotResolutionTestResultsTypeDef
- See UtteranceLevelTestResultsTypeDef
DialogCodeHookInvocationSettingTypeDef#
# DialogCodeHookInvocationSettingTypeDef definition
class DialogCodeHookInvocationSettingTypeDef(TypedDict):
enableCodeHookInvocation: bool,
active: bool,
postCodeHookSpecification: PostDialogCodeHookInvocationSpecificationTypeDef, # (1)
invocationLabel: NotRequired[str],
FulfillmentCodeHookSettingsTypeDef#
# FulfillmentCodeHookSettingsTypeDef definition
class FulfillmentCodeHookSettingsTypeDef(TypedDict):
enabled: bool,
postFulfillmentStatusSpecification: NotRequired[PostFulfillmentStatusSpecificationTypeDef], # (1)
fulfillmentUpdatesSpecification: NotRequired[FulfillmentUpdatesSpecificationTypeDef], # (2)
active: NotRequired[bool],
SubSlotSettingTypeDef#
# SubSlotSettingTypeDef definition
class SubSlotSettingTypeDef(TypedDict):
expression: NotRequired[str],
slotSpecifications: NotRequired[Mapping[str, SpecificationsTypeDef]], # (1)
ListTestExecutionResultItemsResponseTypeDef#
# ListTestExecutionResultItemsResponseTypeDef definition
class ListTestExecutionResultItemsResponseTypeDef(TypedDict):
testExecutionResults: TestExecutionResultItemsTypeDef, # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
InitialResponseSettingTypeDef#
# InitialResponseSettingTypeDef definition
class InitialResponseSettingTypeDef(TypedDict):
initialResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
nextStep: NotRequired[DialogStateTypeDef], # (2)
conditional: NotRequired[ConditionalSpecificationTypeDef], # (3)
codeHook: NotRequired[DialogCodeHookInvocationSettingTypeDef], # (4)
- See ResponseSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See DialogCodeHookInvocationSettingTypeDef
IntentConfirmationSettingTypeDef#
# IntentConfirmationSettingTypeDef definition
class IntentConfirmationSettingTypeDef(TypedDict):
promptSpecification: PromptSpecificationTypeDef, # (1)
declinationResponse: NotRequired[ResponseSpecificationTypeDef], # (2)
active: NotRequired[bool],
confirmationResponse: NotRequired[ResponseSpecificationTypeDef], # (2)
confirmationNextStep: NotRequired[DialogStateTypeDef], # (4)
confirmationConditional: NotRequired[ConditionalSpecificationTypeDef], # (5)
declinationNextStep: NotRequired[DialogStateTypeDef], # (4)
declinationConditional: NotRequired[ConditionalSpecificationTypeDef], # (5)
failureResponse: NotRequired[ResponseSpecificationTypeDef], # (2)
failureNextStep: NotRequired[DialogStateTypeDef], # (4)
failureConditional: NotRequired[ConditionalSpecificationTypeDef], # (5)
codeHook: NotRequired[DialogCodeHookInvocationSettingTypeDef], # (11)
elicitationCodeHook: NotRequired[ElicitationCodeHookInvocationSettingTypeDef], # (12)
- See PromptSpecificationTypeDef
- See ResponseSpecificationTypeDef
- See ResponseSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See ResponseSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See DialogCodeHookInvocationSettingTypeDef
- See ElicitationCodeHookInvocationSettingTypeDef
SlotCaptureSettingTypeDef#
# SlotCaptureSettingTypeDef definition
class SlotCaptureSettingTypeDef(TypedDict):
captureResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
captureNextStep: NotRequired[DialogStateTypeDef], # (2)
captureConditional: NotRequired[ConditionalSpecificationTypeDef], # (3)
failureResponse: NotRequired[ResponseSpecificationTypeDef], # (1)
failureNextStep: NotRequired[DialogStateTypeDef], # (2)
failureConditional: NotRequired[ConditionalSpecificationTypeDef], # (3)
codeHook: NotRequired[DialogCodeHookInvocationSettingTypeDef], # (7)
elicitationCodeHook: NotRequired[ElicitationCodeHookInvocationSettingTypeDef], # (8)
- See ResponseSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See ResponseSpecificationTypeDef
- See DialogStateTypeDef
- See ConditionalSpecificationTypeDef
- See DialogCodeHookInvocationSettingTypeDef
- See ElicitationCodeHookInvocationSettingTypeDef
CreateIntentRequestRequestTypeDef#
# CreateIntentRequestRequestTypeDef definition
class CreateIntentRequestRequestTypeDef(TypedDict):
intentName: str,
botId: str,
botVersion: str,
localeId: str,
description: NotRequired[str],
parentIntentSignature: NotRequired[str],
sampleUtterances: NotRequired[Sequence[SampleUtteranceTypeDef]], # (1)
dialogCodeHook: NotRequired[DialogCodeHookSettingsTypeDef], # (2)
fulfillmentCodeHook: NotRequired[FulfillmentCodeHookSettingsTypeDef], # (3)
intentConfirmationSetting: NotRequired[IntentConfirmationSettingTypeDef], # (4)
intentClosingSetting: NotRequired[IntentClosingSettingTypeDef], # (5)
inputContexts: NotRequired[Sequence[InputContextTypeDef]], # (6)
outputContexts: NotRequired[Sequence[OutputContextTypeDef]], # (7)
kendraConfiguration: NotRequired[KendraConfigurationTypeDef], # (8)
initialResponseSetting: NotRequired[InitialResponseSettingTypeDef], # (9)
- See SampleUtteranceTypeDef
- See DialogCodeHookSettingsTypeDef
- See FulfillmentCodeHookSettingsTypeDef
- See IntentConfirmationSettingTypeDef
- See IntentClosingSettingTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See KendraConfigurationTypeDef
- See InitialResponseSettingTypeDef
CreateIntentResponseTypeDef#
# CreateIntentResponseTypeDef definition
class CreateIntentResponseTypeDef(TypedDict):
intentId: str,
intentName: str,
description: str,
parentIntentSignature: str,
sampleUtterances: List[SampleUtteranceTypeDef], # (1)
dialogCodeHook: DialogCodeHookSettingsTypeDef, # (2)
fulfillmentCodeHook: FulfillmentCodeHookSettingsTypeDef, # (3)
intentConfirmationSetting: IntentConfirmationSettingTypeDef, # (4)
intentClosingSetting: IntentClosingSettingTypeDef, # (5)
inputContexts: List[InputContextTypeDef], # (6)
outputContexts: List[OutputContextTypeDef], # (7)
kendraConfiguration: KendraConfigurationTypeDef, # (8)
botId: str,
botVersion: str,
localeId: str,
creationDateTime: datetime,
initialResponseSetting: InitialResponseSettingTypeDef, # (9)
ResponseMetadata: ResponseMetadataTypeDef, # (10)
- See SampleUtteranceTypeDef
- See DialogCodeHookSettingsTypeDef
- See FulfillmentCodeHookSettingsTypeDef
- See IntentConfirmationSettingTypeDef
- See IntentClosingSettingTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See KendraConfigurationTypeDef
- See InitialResponseSettingTypeDef
- See ResponseMetadataTypeDef
DescribeIntentResponseTypeDef#
# DescribeIntentResponseTypeDef definition
class DescribeIntentResponseTypeDef(TypedDict):
intentId: str,
intentName: str,
description: str,
parentIntentSignature: str,
sampleUtterances: List[SampleUtteranceTypeDef], # (1)
dialogCodeHook: DialogCodeHookSettingsTypeDef, # (2)
fulfillmentCodeHook: FulfillmentCodeHookSettingsTypeDef, # (3)
slotPriorities: List[SlotPriorityTypeDef], # (4)
intentConfirmationSetting: IntentConfirmationSettingTypeDef, # (5)
intentClosingSetting: IntentClosingSettingTypeDef, # (6)
inputContexts: List[InputContextTypeDef], # (7)
outputContexts: List[OutputContextTypeDef], # (8)
kendraConfiguration: KendraConfigurationTypeDef, # (9)
botId: str,
botVersion: str,
localeId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
initialResponseSetting: InitialResponseSettingTypeDef, # (10)
ResponseMetadata: ResponseMetadataTypeDef, # (11)
- See SampleUtteranceTypeDef
- See DialogCodeHookSettingsTypeDef
- See FulfillmentCodeHookSettingsTypeDef
- See SlotPriorityTypeDef
- See IntentConfirmationSettingTypeDef
- See IntentClosingSettingTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See KendraConfigurationTypeDef
- See InitialResponseSettingTypeDef
- See ResponseMetadataTypeDef
UpdateIntentRequestRequestTypeDef#
# UpdateIntentRequestRequestTypeDef definition
class UpdateIntentRequestRequestTypeDef(TypedDict):
intentId: str,
intentName: str,
botId: str,
botVersion: str,
localeId: str,
description: NotRequired[str],
parentIntentSignature: NotRequired[str],
sampleUtterances: NotRequired[Sequence[SampleUtteranceTypeDef]], # (1)
dialogCodeHook: NotRequired[DialogCodeHookSettingsTypeDef], # (2)
fulfillmentCodeHook: NotRequired[FulfillmentCodeHookSettingsTypeDef], # (3)
slotPriorities: NotRequired[Sequence[SlotPriorityTypeDef]], # (4)
intentConfirmationSetting: NotRequired[IntentConfirmationSettingTypeDef], # (5)
intentClosingSetting: NotRequired[IntentClosingSettingTypeDef], # (6)
inputContexts: NotRequired[Sequence[InputContextTypeDef]], # (7)
outputContexts: NotRequired[Sequence[OutputContextTypeDef]], # (8)
kendraConfiguration: NotRequired[KendraConfigurationTypeDef], # (9)
initialResponseSetting: NotRequired[InitialResponseSettingTypeDef], # (10)
- See SampleUtteranceTypeDef
- See DialogCodeHookSettingsTypeDef
- See FulfillmentCodeHookSettingsTypeDef
- See SlotPriorityTypeDef
- See IntentConfirmationSettingTypeDef
- See IntentClosingSettingTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See KendraConfigurationTypeDef
- See InitialResponseSettingTypeDef
UpdateIntentResponseTypeDef#
# UpdateIntentResponseTypeDef definition
class UpdateIntentResponseTypeDef(TypedDict):
intentId: str,
intentName: str,
description: str,
parentIntentSignature: str,
sampleUtterances: List[SampleUtteranceTypeDef], # (1)
dialogCodeHook: DialogCodeHookSettingsTypeDef, # (2)
fulfillmentCodeHook: FulfillmentCodeHookSettingsTypeDef, # (3)
slotPriorities: List[SlotPriorityTypeDef], # (4)
intentConfirmationSetting: IntentConfirmationSettingTypeDef, # (5)
intentClosingSetting: IntentClosingSettingTypeDef, # (6)
inputContexts: List[InputContextTypeDef], # (7)
outputContexts: List[OutputContextTypeDef], # (8)
kendraConfiguration: KendraConfigurationTypeDef, # (9)
botId: str,
botVersion: str,
localeId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
initialResponseSetting: InitialResponseSettingTypeDef, # (10)
ResponseMetadata: ResponseMetadataTypeDef, # (11)
- See SampleUtteranceTypeDef
- See DialogCodeHookSettingsTypeDef
- See FulfillmentCodeHookSettingsTypeDef
- See SlotPriorityTypeDef
- See IntentConfirmationSettingTypeDef
- See IntentClosingSettingTypeDef
- See InputContextTypeDef
- See OutputContextTypeDef
- See KendraConfigurationTypeDef
- See InitialResponseSettingTypeDef
- See ResponseMetadataTypeDef
SlotValueElicitationSettingTypeDef#
# SlotValueElicitationSettingTypeDef definition
class SlotValueElicitationSettingTypeDef(TypedDict):
slotConstraint: SlotConstraintType, # (2)
defaultValueSpecification: NotRequired[SlotDefaultValueSpecificationTypeDef], # (1)
promptSpecification: NotRequired[PromptSpecificationTypeDef], # (3)
sampleUtterances: NotRequired[Sequence[SampleUtteranceTypeDef]], # (4)
waitAndContinueSpecification: NotRequired[WaitAndContinueSpecificationTypeDef], # (5)
slotCaptureSetting: NotRequired[SlotCaptureSettingTypeDef], # (6)
slotResolutionSetting: NotRequired[SlotResolutionSettingTypeDef], # (7)
- See SlotDefaultValueSpecificationTypeDef
- See SlotConstraintType
- See PromptSpecificationTypeDef
- See SampleUtteranceTypeDef
- See WaitAndContinueSpecificationTypeDef
- See SlotCaptureSettingTypeDef
- See SlotResolutionSettingTypeDef
CreateSlotRequestRequestTypeDef#
# CreateSlotRequestRequestTypeDef definition
class CreateSlotRequestRequestTypeDef(TypedDict):
slotName: str,
valueElicitationSetting: SlotValueElicitationSettingTypeDef, # (1)
botId: str,
botVersion: str,
localeId: str,
intentId: str,
description: NotRequired[str],
slotTypeId: NotRequired[str],
obfuscationSetting: NotRequired[ObfuscationSettingTypeDef], # (2)
multipleValuesSetting: NotRequired[MultipleValuesSettingTypeDef], # (3)
subSlotSetting: NotRequired[SubSlotSettingTypeDef], # (4)
- See SlotValueElicitationSettingTypeDef
- See ObfuscationSettingTypeDef
- See MultipleValuesSettingTypeDef
- See SubSlotSettingTypeDef
CreateSlotResponseTypeDef#
# CreateSlotResponseTypeDef definition
class CreateSlotResponseTypeDef(TypedDict):
slotId: str,
slotName: str,
description: str,
slotTypeId: str,
valueElicitationSetting: SlotValueElicitationSettingTypeDef, # (1)
obfuscationSetting: ObfuscationSettingTypeDef, # (2)
botId: str,
botVersion: str,
localeId: str,
intentId: str,
creationDateTime: datetime,
multipleValuesSetting: MultipleValuesSettingTypeDef, # (3)
subSlotSetting: SubSlotSettingTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See SlotValueElicitationSettingTypeDef
- See ObfuscationSettingTypeDef
- See MultipleValuesSettingTypeDef
- See SubSlotSettingTypeDef
- See ResponseMetadataTypeDef
DescribeSlotResponseTypeDef#
# DescribeSlotResponseTypeDef definition
class DescribeSlotResponseTypeDef(TypedDict):
slotId: str,
slotName: str,
description: str,
slotTypeId: str,
valueElicitationSetting: SlotValueElicitationSettingTypeDef, # (1)
obfuscationSetting: ObfuscationSettingTypeDef, # (2)
botId: str,
botVersion: str,
localeId: str,
intentId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
multipleValuesSetting: MultipleValuesSettingTypeDef, # (3)
subSlotSetting: SubSlotSettingTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See SlotValueElicitationSettingTypeDef
- See ObfuscationSettingTypeDef
- See MultipleValuesSettingTypeDef
- See SubSlotSettingTypeDef
- See ResponseMetadataTypeDef
UpdateSlotRequestRequestTypeDef#
# UpdateSlotRequestRequestTypeDef definition
class UpdateSlotRequestRequestTypeDef(TypedDict):
slotId: str,
slotName: str,
valueElicitationSetting: SlotValueElicitationSettingTypeDef, # (1)
botId: str,
botVersion: str,
localeId: str,
intentId: str,
description: NotRequired[str],
slotTypeId: NotRequired[str],
obfuscationSetting: NotRequired[ObfuscationSettingTypeDef], # (2)
multipleValuesSetting: NotRequired[MultipleValuesSettingTypeDef], # (3)
subSlotSetting: NotRequired[SubSlotSettingTypeDef], # (4)
- See SlotValueElicitationSettingTypeDef
- See ObfuscationSettingTypeDef
- See MultipleValuesSettingTypeDef
- See SubSlotSettingTypeDef
UpdateSlotResponseTypeDef#
# UpdateSlotResponseTypeDef definition
class UpdateSlotResponseTypeDef(TypedDict):
slotId: str,
slotName: str,
description: str,
slotTypeId: str,
valueElicitationSetting: SlotValueElicitationSettingTypeDef, # (1)
obfuscationSetting: ObfuscationSettingTypeDef, # (2)
botId: str,
botVersion: str,
localeId: str,
intentId: str,
creationDateTime: datetime,
lastUpdatedDateTime: datetime,
multipleValuesSetting: MultipleValuesSettingTypeDef, # (3)
subSlotSetting: SubSlotSettingTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)