Skip to content

Type definitions#

Index > LexModelsV2 > Type definitions

Auto-generated documentation for LexModelsV2 type annotations stubs module mypy-boto3-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)
  1. See AudioRecognitionStrategyType

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)
  1. See AggregatedUtterancesFilterNameType
  2. See AggregatedUtterancesFilterOperatorType

AggregatedUtterancesSortByTypeDef#

# AggregatedUtterancesSortByTypeDef definition

class AggregatedUtterancesSortByTypeDef(TypedDict):
    attribute: AggregatedUtterancesSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See AggregatedUtterancesSortAttributeType
  2. See SortOrderType

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)
  1. See AnalyticsBinByNameType
  2. See AnalyticsIntervalType
  3. See AnalyticsSortOrderType

AnalyticsBinKeyTypeDef#

# AnalyticsBinKeyTypeDef definition

class AnalyticsBinKeyTypeDef(TypedDict):
    name: NotRequired[AnalyticsBinByNameType],  # (1)
    value: NotRequired[int],
  1. See AnalyticsBinByNameType

AnalyticsIntentFilterTypeDef#

# AnalyticsIntentFilterTypeDef definition

class AnalyticsIntentFilterTypeDef(TypedDict):
    name: AnalyticsIntentFilterNameType,  # (1)
    operator: AnalyticsFilterOperatorType,  # (2)
    values: Sequence[str],
  1. See AnalyticsIntentFilterNameType
  2. See AnalyticsFilterOperatorType

AnalyticsIntentGroupByKeyTypeDef#

# AnalyticsIntentGroupByKeyTypeDef definition

class AnalyticsIntentGroupByKeyTypeDef(TypedDict):
    name: NotRequired[AnalyticsIntentFieldType],  # (1)
    value: NotRequired[str],
  1. See AnalyticsIntentFieldType

AnalyticsIntentGroupBySpecificationTypeDef#

# AnalyticsIntentGroupBySpecificationTypeDef definition

class AnalyticsIntentGroupBySpecificationTypeDef(TypedDict):
    name: AnalyticsIntentFieldType,  # (1)
  1. See AnalyticsIntentFieldType

AnalyticsIntentMetricResultTypeDef#

# AnalyticsIntentMetricResultTypeDef definition

class AnalyticsIntentMetricResultTypeDef(TypedDict):
    name: NotRequired[AnalyticsIntentMetricNameType],  # (1)
    statistic: NotRequired[AnalyticsMetricStatisticType],  # (2)
    value: NotRequired[float],
  1. See AnalyticsIntentMetricNameType
  2. See AnalyticsMetricStatisticType

AnalyticsIntentMetricTypeDef#

# AnalyticsIntentMetricTypeDef definition

class AnalyticsIntentMetricTypeDef(TypedDict):
    name: AnalyticsIntentMetricNameType,  # (1)
    statistic: AnalyticsMetricStatisticType,  # (2)
    order: NotRequired[AnalyticsSortOrderType],  # (3)
  1. See AnalyticsIntentMetricNameType
  2. See AnalyticsMetricStatisticType
  3. See AnalyticsSortOrderType

AnalyticsIntentNodeSummaryTypeDef#

# AnalyticsIntentNodeSummaryTypeDef definition

class AnalyticsIntentNodeSummaryTypeDef(TypedDict):
    intentName: NotRequired[str],
    intentPath: NotRequired[str],
    intentCount: NotRequired[int],
    intentLevel: NotRequired[int],
    nodeType: NotRequired[AnalyticsNodeTypeType],  # (1)
  1. See AnalyticsNodeTypeType

AnalyticsIntentStageFilterTypeDef#

# AnalyticsIntentStageFilterTypeDef definition

class AnalyticsIntentStageFilterTypeDef(TypedDict):
    name: AnalyticsIntentStageFilterNameType,  # (1)
    operator: AnalyticsFilterOperatorType,  # (2)
    values: Sequence[str],
  1. See AnalyticsIntentStageFilterNameType
  2. See AnalyticsFilterOperatorType

AnalyticsIntentStageGroupByKeyTypeDef#

# AnalyticsIntentStageGroupByKeyTypeDef definition

class AnalyticsIntentStageGroupByKeyTypeDef(TypedDict):
    name: NotRequired[AnalyticsIntentStageFieldType],  # (1)
    value: NotRequired[str],
  1. See AnalyticsIntentStageFieldType

AnalyticsIntentStageGroupBySpecificationTypeDef#

# AnalyticsIntentStageGroupBySpecificationTypeDef definition

class AnalyticsIntentStageGroupBySpecificationTypeDef(TypedDict):
    name: AnalyticsIntentStageFieldType,  # (1)
  1. See AnalyticsIntentStageFieldType

AnalyticsIntentStageMetricResultTypeDef#

# AnalyticsIntentStageMetricResultTypeDef definition

class AnalyticsIntentStageMetricResultTypeDef(TypedDict):
    name: NotRequired[AnalyticsIntentStageMetricNameType],  # (1)
    statistic: NotRequired[AnalyticsMetricStatisticType],  # (2)
    value: NotRequired[float],
  1. See AnalyticsIntentStageMetricNameType
  2. See AnalyticsMetricStatisticType

AnalyticsIntentStageMetricTypeDef#

# AnalyticsIntentStageMetricTypeDef definition

class AnalyticsIntentStageMetricTypeDef(TypedDict):
    name: AnalyticsIntentStageMetricNameType,  # (1)
    statistic: AnalyticsMetricStatisticType,  # (2)
    order: NotRequired[AnalyticsSortOrderType],  # (3)
  1. See AnalyticsIntentStageMetricNameType
  2. See AnalyticsMetricStatisticType
  3. See AnalyticsSortOrderType

AnalyticsPathFilterTypeDef#

# AnalyticsPathFilterTypeDef definition

class AnalyticsPathFilterTypeDef(TypedDict):
    name: AnalyticsCommonFilterNameType,  # (1)
    operator: AnalyticsFilterOperatorType,  # (2)
    values: Sequence[str],
  1. See AnalyticsCommonFilterNameType
  2. See AnalyticsFilterOperatorType

AnalyticsSessionFilterTypeDef#

# AnalyticsSessionFilterTypeDef definition

class AnalyticsSessionFilterTypeDef(TypedDict):
    name: AnalyticsSessionFilterNameType,  # (1)
    operator: AnalyticsFilterOperatorType,  # (2)
    values: Sequence[str],
  1. See AnalyticsSessionFilterNameType
  2. See AnalyticsFilterOperatorType

AnalyticsSessionGroupByKeyTypeDef#

# AnalyticsSessionGroupByKeyTypeDef definition

class AnalyticsSessionGroupByKeyTypeDef(TypedDict):
    name: NotRequired[AnalyticsSessionFieldType],  # (1)
    value: NotRequired[str],
  1. See AnalyticsSessionFieldType

AnalyticsSessionGroupBySpecificationTypeDef#

# AnalyticsSessionGroupBySpecificationTypeDef definition

class AnalyticsSessionGroupBySpecificationTypeDef(TypedDict):
    name: AnalyticsSessionFieldType,  # (1)
  1. See AnalyticsSessionFieldType

AnalyticsSessionMetricResultTypeDef#

# AnalyticsSessionMetricResultTypeDef definition

class AnalyticsSessionMetricResultTypeDef(TypedDict):
    name: NotRequired[AnalyticsSessionMetricNameType],  # (1)
    statistic: NotRequired[AnalyticsMetricStatisticType],  # (2)
    value: NotRequired[float],
  1. See AnalyticsSessionMetricNameType
  2. See AnalyticsMetricStatisticType

AnalyticsSessionMetricTypeDef#

# AnalyticsSessionMetricTypeDef definition

class AnalyticsSessionMetricTypeDef(TypedDict):
    name: AnalyticsSessionMetricNameType,  # (1)
    statistic: AnalyticsMetricStatisticType,  # (2)
    order: NotRequired[AnalyticsSortOrderType],  # (3)
  1. See AnalyticsSessionMetricNameType
  2. See AnalyticsMetricStatisticType
  3. See AnalyticsSortOrderType

AnalyticsUtteranceAttributeResultTypeDef#

# AnalyticsUtteranceAttributeResultTypeDef definition

class AnalyticsUtteranceAttributeResultTypeDef(TypedDict):
    lastUsedIntent: NotRequired[str],

AnalyticsUtteranceAttributeTypeDef#

# AnalyticsUtteranceAttributeTypeDef definition

class AnalyticsUtteranceAttributeTypeDef(TypedDict):
    name: AnalyticsUtteranceAttributeNameType,  # (1)
  1. See AnalyticsUtteranceAttributeNameType

AnalyticsUtteranceFilterTypeDef#

# AnalyticsUtteranceFilterTypeDef definition

class AnalyticsUtteranceFilterTypeDef(TypedDict):
    name: AnalyticsUtteranceFilterNameType,  # (1)
    operator: AnalyticsFilterOperatorType,  # (2)
    values: Sequence[str],
  1. See AnalyticsUtteranceFilterNameType
  2. See AnalyticsFilterOperatorType

AnalyticsUtteranceGroupByKeyTypeDef#

# AnalyticsUtteranceGroupByKeyTypeDef definition

class AnalyticsUtteranceGroupByKeyTypeDef(TypedDict):
    name: NotRequired[AnalyticsUtteranceFieldType],  # (1)
    value: NotRequired[str],
  1. See AnalyticsUtteranceFieldType

AnalyticsUtteranceGroupBySpecificationTypeDef#

# AnalyticsUtteranceGroupBySpecificationTypeDef definition

class AnalyticsUtteranceGroupBySpecificationTypeDef(TypedDict):
    name: AnalyticsUtteranceFieldType,  # (1)
  1. See AnalyticsUtteranceFieldType

AnalyticsUtteranceMetricResultTypeDef#

# AnalyticsUtteranceMetricResultTypeDef definition

class AnalyticsUtteranceMetricResultTypeDef(TypedDict):
    name: NotRequired[AnalyticsUtteranceMetricNameType],  # (1)
    statistic: NotRequired[AnalyticsMetricStatisticType],  # (2)
    value: NotRequired[float],
  1. See AnalyticsUtteranceMetricNameType
  2. See AnalyticsMetricStatisticType

AnalyticsUtteranceMetricTypeDef#

# AnalyticsUtteranceMetricTypeDef definition

class AnalyticsUtteranceMetricTypeDef(TypedDict):
    name: AnalyticsUtteranceMetricNameType,  # (1)
    statistic: AnalyticsMetricStatisticType,  # (2)
    order: NotRequired[AnalyticsSortOrderType],  # (3)
  1. See AnalyticsUtteranceMetricNameType
  2. See AnalyticsMetricStatisticType
  3. See AnalyticsSortOrderType

AssociatedTranscriptFilterTypeDef#

# AssociatedTranscriptFilterTypeDef definition

class AssociatedTranscriptFilterTypeDef(TypedDict):
    name: AssociatedTranscriptFilterNameType,  # (1)
    values: Sequence[str],
  1. See AssociatedTranscriptFilterNameType

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)
  1. See ErrorCodeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CustomVocabularyEntryIdTypeDef#

# CustomVocabularyEntryIdTypeDef definition

class CustomVocabularyEntryIdTypeDef(TypedDict):
    itemId: str,

BedrockKnowledgeStoreConfigurationTypeDef#

# BedrockKnowledgeStoreConfigurationTypeDef definition

class BedrockKnowledgeStoreConfigurationTypeDef(TypedDict):
    bedrockKnowledgeBaseArn: str,

BedrockModelSpecificationTypeDef#

# BedrockModelSpecificationTypeDef definition

class BedrockModelSpecificationTypeDef(TypedDict):
    modelArn: str,

BotAliasHistoryEventTypeDef#

# BotAliasHistoryEventTypeDef definition

class BotAliasHistoryEventTypeDef(TypedDict):
    botVersion: NotRequired[str],
    startDate: NotRequired[datetime],
    endDate: NotRequired[datetime],

BotAliasReplicaSummaryTypeDef#

# BotAliasReplicaSummaryTypeDef definition

class BotAliasReplicaSummaryTypeDef(TypedDict):
    botAliasId: NotRequired[str],
    botAliasReplicationStatus: NotRequired[BotAliasReplicationStatusType],  # (1)
    botVersion: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReasons: NotRequired[List[str]],
  1. See BotAliasReplicationStatusType

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],
  1. See BotAliasStatusType

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)
  1. See BotFilterNameType
  2. See BotFilterOperatorType

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)
  1. See BotLocaleFilterNameType
  2. See BotLocaleFilterOperatorType

BotLocaleHistoryEventTypeDef#

# BotLocaleHistoryEventTypeDef definition

class BotLocaleHistoryEventTypeDef(TypedDict):
    event: str,
    eventDate: datetime,

VoiceSettingsTypeDef#

# VoiceSettingsTypeDef definition

class VoiceSettingsTypeDef(TypedDict):
    voiceId: str,
    engine: NotRequired[VoiceEngineType],  # (1)
  1. See VoiceEngineType

BotLocaleSortByTypeDef#

# BotLocaleSortByTypeDef definition

class BotLocaleSortByTypeDef(TypedDict):
    attribute: BotLocaleSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See BotLocaleSortAttributeType
  2. See SortOrderType

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],
  1. See BotLocaleStatusType

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],
  1. See BotRecommendationStatusType

BotReplicaSummaryTypeDef#

# BotReplicaSummaryTypeDef definition

class BotReplicaSummaryTypeDef(TypedDict):
    replicaRegion: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    botReplicaStatus: NotRequired[BotReplicaStatusType],  # (1)
    failureReasons: NotRequired[List[str]],
  1. See BotReplicaStatusType

BotSortByTypeDef#

# BotSortByTypeDef definition

class BotSortByTypeDef(TypedDict):
    attribute: BotSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See BotSortAttributeType
  2. 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)
  1. See BotStatusType
  2. See BotTypeType

BotVersionLocaleDetailsTypeDef#

# BotVersionLocaleDetailsTypeDef definition

class BotVersionLocaleDetailsTypeDef(TypedDict):
    sourceBotVersion: str,

BotVersionReplicaSortByTypeDef#

# BotVersionReplicaSortByTypeDef definition

class BotVersionReplicaSortByTypeDef(TypedDict):
    attribute: BotVersionReplicaSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See BotVersionReplicaSortAttributeType
  2. See SortOrderType

BotVersionReplicaSummaryTypeDef#

# BotVersionReplicaSummaryTypeDef definition

class BotVersionReplicaSummaryTypeDef(TypedDict):
    botVersion: NotRequired[str],
    botVersionReplicationStatus: NotRequired[BotVersionReplicationStatusType],  # (1)
    creationDateTime: NotRequired[datetime],
    failureReasons: NotRequired[List[str]],
  1. See BotVersionReplicationStatusType

BotVersionSortByTypeDef#

# BotVersionSortByTypeDef definition

class BotVersionSortByTypeDef(TypedDict):
    attribute: BotVersionSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See BotVersionSortAttributeType
  2. See SortOrderType

BotVersionSummaryTypeDef#

# BotVersionSummaryTypeDef definition

class BotVersionSummaryTypeDef(TypedDict):
    botName: NotRequired[str],
    botVersion: NotRequired[str],
    description: NotRequired[str],
    botStatus: NotRequired[BotStatusType],  # (1)
    creationDateTime: NotRequired[datetime],
  1. 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)
  1. See BuiltInIntentSortAttributeType
  2. See SortOrderType

BuiltInIntentSummaryTypeDef#

# BuiltInIntentSummaryTypeDef definition

class BuiltInIntentSummaryTypeDef(TypedDict):
    intentSignature: NotRequired[str],
    description: NotRequired[str],

BuiltInSlotTypeSortByTypeDef#

# BuiltInSlotTypeSortByTypeDef definition

class BuiltInSlotTypeSortByTypeDef(TypedDict):
    attribute: BuiltInSlotTypeSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See BuiltInSlotTypeSortAttributeType
  2. See SortOrderType

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)
  1. See TestResultMatchStatusType

ConversationLevelResultDetailTypeDef#

# ConversationLevelResultDetailTypeDef definition

class ConversationLevelResultDetailTypeDef(TypedDict):
    endToEndResult: TestResultMatchStatusType,  # (1)
    speechTranscriptionResult: NotRequired[TestResultMatchStatusType],  # (1)
  1. See TestResultMatchStatusType
  2. See TestResultMatchStatusType

ConversationLevelSlotResolutionResultItemTypeDef#

# ConversationLevelSlotResolutionResultItemTypeDef definition

class ConversationLevelSlotResolutionResultItemTypeDef(TypedDict):
    intentName: str,
    slotName: str,
    matchResult: TestResultMatchStatusType,  # (1)
  1. See TestResultMatchStatusType

ConversationLevelTestResultsFilterByTypeDef#

# ConversationLevelTestResultsFilterByTypeDef definition

class ConversationLevelTestResultsFilterByTypeDef(TypedDict):
    endToEndResult: NotRequired[TestResultMatchStatusType],  # (1)
  1. See TestResultMatchStatusType

ConversationLogsDataSourceFilterByTypeDef#

# ConversationLogsDataSourceFilterByTypeDef definition

class ConversationLogsDataSourceFilterByTypeDef(TypedDict):
    startTime: datetime,
    endTime: datetime,
    inputMode: ConversationLogsInputModeFilterType,  # (1)
  1. See ConversationLogsInputModeFilterType

SentimentAnalysisSettingsTypeDef#

# SentimentAnalysisSettingsTypeDef definition

class SentimentAnalysisSettingsTypeDef(TypedDict):
    detectSentiment: bool,

CreateBotReplicaRequestRequestTypeDef#

# CreateBotReplicaRequestRequestTypeDef definition

class CreateBotReplicaRequestRequestTypeDef(TypedDict):
    botId: str,
    replicaRegion: str,

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)
  1. See ObfuscationSettingTypeType

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,

QnAKendraConfigurationTypeDef#

# QnAKendraConfigurationTypeDef definition

class QnAKendraConfigurationTypeDef(TypedDict):
    kendraIndex: str,
    queryFilterStringEnabled: NotRequired[bool],
    queryFilterString: NotRequired[str],
    exactResponse: NotRequired[bool],

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,

DeleteBotReplicaRequestRequestTypeDef#

# DeleteBotReplicaRequestRequestTypeDef definition

class DeleteBotReplicaRequestRequestTypeDef(TypedDict):
    botId: str,
    replicaRegion: 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],

DescribeBotReplicaRequestRequestTypeDef#

# DescribeBotReplicaRequestRequestTypeDef definition

class DescribeBotReplicaRequestRequestTypeDef(TypedDict):
    botId: str,
    replicaRegion: 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],
  1. See DialogActionTypeType

IntentOverrideTypeDef#

# IntentOverrideTypeDef definition

class IntentOverrideTypeDef(TypedDict):
    name: NotRequired[str],
    slots: NotRequired[Mapping[str, SlotValueOverrideTypeDef]],  # (1)
  1. See SlotValueOverrideTypeDef

ElicitationCodeHookInvocationSettingTypeDef#

# ElicitationCodeHookInvocationSettingTypeDef definition

class ElicitationCodeHookInvocationSettingTypeDef(TypedDict):
    enableCodeHookInvocation: bool,
    invocationLabel: NotRequired[str],

ExactResponseFieldsTypeDef#

# ExactResponseFieldsTypeDef definition

class ExactResponseFieldsTypeDef(TypedDict):
    questionField: str,
    answerField: str,

ExportFilterTypeDef#

# ExportFilterTypeDef definition

class ExportFilterTypeDef(TypedDict):
    name: ExportFilterNameType,  # (1)
    values: Sequence[str],
    operator: ExportFilterOperatorType,  # (2)
  1. See ExportFilterNameType
  2. See ExportFilterOperatorType

TestSetExportSpecificationTypeDef#

# TestSetExportSpecificationTypeDef definition

class TestSetExportSpecificationTypeDef(TypedDict):
    testSetId: str,

ExportSortByTypeDef#

# ExportSortByTypeDef definition

class ExportSortByTypeDef(TypedDict):
    attribute: ExportSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See ExportSortAttributeType
  2. 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)
  1. See GenerationSortByAttributeType
  2. See SortOrderType

GenerationSummaryTypeDef#

# GenerationSummaryTypeDef definition

class GenerationSummaryTypeDef(TypedDict):
    generationId: NotRequired[str],
    generationStatus: NotRequired[GenerationStatusType],  # (1)
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
  1. See GenerationStatusType

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)
  1. See ImportFilterNameType
  2. See ImportFilterOperatorType

ImportSortByTypeDef#

# ImportSortByTypeDef definition

class ImportSortByTypeDef(TypedDict):
    attribute: ImportSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See ImportSortAttributeType
  2. 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)
  1. See ImportStatusType
  2. See MergeStrategyType
  3. See ImportResourceTypeType

RuntimeHintsTypeDef#

# RuntimeHintsTypeDef definition

class RuntimeHintsTypeDef(TypedDict):
    slotHints: NotRequired[Dict[str, Dict[str, RuntimeHintDetailsTypeDef]]],  # (1)
  1. See RuntimeHintDetailsTypeDef

IntentClassificationTestResultItemCountsTypeDef#

# IntentClassificationTestResultItemCountsTypeDef definition

class IntentClassificationTestResultItemCountsTypeDef(TypedDict):
    totalResultCount: int,
    intentMatchResultCounts: Dict[TestResultMatchStatusType, int],  # (1)
    speechTranscriptionResultCounts: NotRequired[Dict[TestResultMatchStatusType, int]],  # (1)
  1. See TestResultMatchStatusType
  2. See TestResultMatchStatusType

IntentFilterTypeDef#

# IntentFilterTypeDef definition

class IntentFilterTypeDef(TypedDict):
    name: IntentFilterNameType,  # (1)
    values: Sequence[str],
    operator: IntentFilterOperatorType,  # (2)
  1. See IntentFilterNameType
  2. See IntentFilterOperatorType

IntentSortByTypeDef#

# IntentSortByTypeDef definition

class IntentSortByTypeDef(TypedDict):
    attribute: IntentSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See IntentSortAttributeType
  2. See SortOrderType

InvokedIntentSampleTypeDef#

# InvokedIntentSampleTypeDef definition

class InvokedIntentSampleTypeDef(TypedDict):
    intentName: NotRequired[str],

ListBotAliasReplicasRequestRequestTypeDef#

# ListBotAliasReplicasRequestRequestTypeDef definition

class ListBotAliasReplicasRequestRequestTypeDef(TypedDict):
    botId: str,
    replicaRegion: str,
    maxResults: NotRequired[int],
    nextToken: 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],

ListBotReplicasRequestRequestTypeDef#

# ListBotReplicasRequestRequestTypeDef definition

class ListBotReplicasRequestRequestTypeDef(TypedDict):
    botId: 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)
  1. See AnalyticsSessionSortByNameType
  2. See AnalyticsSortOrderType

SlotTypeFilterTypeDef#

# SlotTypeFilterTypeDef definition

class SlotTypeFilterTypeDef(TypedDict):
    name: SlotTypeFilterNameType,  # (1)
    values: Sequence[str],
    operator: SlotTypeFilterOperatorType,  # (2)
  1. See SlotTypeFilterNameType
  2. See SlotTypeFilterOperatorType

SlotTypeSortByTypeDef#

# SlotTypeSortByTypeDef definition

class SlotTypeSortByTypeDef(TypedDict):
    attribute: SlotTypeSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See SlotTypeSortAttributeType
  2. See SortOrderType

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)
  1. See SlotTypeCategoryType

SlotFilterTypeDef#

# SlotFilterTypeDef definition

class SlotFilterTypeDef(TypedDict):
    name: SlotFilterNameType,  # (1)
    values: Sequence[str],
    operator: SlotFilterOperatorType,  # (2)
  1. See SlotFilterNameType
  2. See SlotFilterOperatorType

SlotSortByTypeDef#

# SlotSortByTypeDef definition

class SlotSortByTypeDef(TypedDict):
    attribute: SlotSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See SlotSortAttributeType
  2. See SortOrderType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceARN: str,

TestExecutionSortByTypeDef#

# TestExecutionSortByTypeDef definition

class TestExecutionSortByTypeDef(TypedDict):
    attribute: TestExecutionSortAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See TestExecutionSortAttributeType
  2. See SortOrderType

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)
  1. See TestSetSortAttributeType
  2. See SortOrderType

UtteranceDataSortByTypeDef#

# UtteranceDataSortByTypeDef definition

class UtteranceDataSortByTypeDef(TypedDict):
    name: AnalyticsUtteranceSortByNameType,  # (1)
    order: AnalyticsSortOrderType,  # (2)
  1. See AnalyticsUtteranceSortByNameType
  2. See AnalyticsSortOrderType

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)
  1. See TestResultMatchStatusType
  2. See TestResultMatchStatusType

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,
  1. See TimeDimensionType

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)
  1. See SlotResolutionStrategyType

SlotResolutionTestResultItemCountsTypeDef#

# SlotResolutionTestResultItemCountsTypeDef definition

class SlotResolutionTestResultItemCountsTypeDef(TypedDict):
    totalResultCount: int,
    slotMatchResultCounts: Dict[TestResultMatchStatusType, int],  # (1)
    speechTranscriptionResultCounts: NotRequired[Dict[TestResultMatchStatusType, int]],  # (1)
  1. See TestResultMatchStatusType
  2. See TestResultMatchStatusType

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)
  1. See UserTurnSlotOutputTypeDef

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],
  1. See ExecutionErrorDetailsTypeDef

AnalyticsIntentResultTypeDef#

# AnalyticsIntentResultTypeDef definition

class AnalyticsIntentResultTypeDef(TypedDict):
    binKeys: NotRequired[List[AnalyticsBinKeyTypeDef]],  # (1)
    groupByKeys: NotRequired[List[AnalyticsIntentGroupByKeyTypeDef]],  # (2)
    metricsResults: NotRequired[List[AnalyticsIntentMetricResultTypeDef]],  # (3)
  1. See AnalyticsBinKeyTypeDef
  2. See AnalyticsIntentGroupByKeyTypeDef
  3. See AnalyticsIntentMetricResultTypeDef

AnalyticsIntentStageResultTypeDef#

# AnalyticsIntentStageResultTypeDef definition

class AnalyticsIntentStageResultTypeDef(TypedDict):
    binKeys: NotRequired[List[AnalyticsBinKeyTypeDef]],  # (1)
    groupByKeys: NotRequired[List[AnalyticsIntentStageGroupByKeyTypeDef]],  # (2)
    metricsResults: NotRequired[List[AnalyticsIntentStageMetricResultTypeDef]],  # (3)
  1. See AnalyticsBinKeyTypeDef
  2. See AnalyticsIntentStageGroupByKeyTypeDef
  3. See AnalyticsIntentStageMetricResultTypeDef

AnalyticsSessionResultTypeDef#

# AnalyticsSessionResultTypeDef definition

class AnalyticsSessionResultTypeDef(TypedDict):
    binKeys: NotRequired[List[AnalyticsBinKeyTypeDef]],  # (1)
    groupByKeys: NotRequired[List[AnalyticsSessionGroupByKeyTypeDef]],  # (2)
    metricsResults: NotRequired[List[AnalyticsSessionMetricResultTypeDef]],  # (3)
  1. See AnalyticsBinKeyTypeDef
  2. See AnalyticsSessionGroupByKeyTypeDef
  3. 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)
  1. See AnalyticsBinKeyTypeDef
  2. See AnalyticsUtteranceGroupByKeyTypeDef
  3. See AnalyticsUtteranceMetricResultTypeDef
  4. 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],
  1. See AssociatedTranscriptFilterTypeDef
  2. See SearchOrderType

AudioAndDTMFInputSpecificationTypeDef#

# AudioAndDTMFInputSpecificationTypeDef definition

class AudioAndDTMFInputSpecificationTypeDef(TypedDict):
    startTimeoutMs: int,
    audioSpecification: NotRequired[AudioSpecificationTypeDef],  # (1)
    dtmfSpecification: NotRequired[DTMFSpecificationTypeDef],  # (2)
  1. See AudioSpecificationTypeDef
  2. See DTMFSpecificationTypeDef

AudioLogDestinationTypeDef#

# AudioLogDestinationTypeDef definition

class AudioLogDestinationTypeDef(TypedDict):
    s3Bucket: S3BucketLogDestinationTypeDef,  # (1)
  1. See S3BucketLogDestinationTypeDef

BatchCreateCustomVocabularyItemRequestRequestTypeDef#

# BatchCreateCustomVocabularyItemRequestRequestTypeDef definition

class BatchCreateCustomVocabularyItemRequestRequestTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    customVocabularyItemList: Sequence[NewCustomVocabularyItemTypeDef],  # (1)
  1. See NewCustomVocabularyItemTypeDef

BatchUpdateCustomVocabularyItemRequestRequestTypeDef#

# BatchUpdateCustomVocabularyItemRequestRequestTypeDef definition

class BatchUpdateCustomVocabularyItemRequestRequestTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    customVocabularyItemList: Sequence[CustomVocabularyItemTypeDef],  # (1)
  1. See CustomVocabularyItemTypeDef

BatchCreateCustomVocabularyItemResponseTypeDef#

# BatchCreateCustomVocabularyItemResponseTypeDef definition

class BatchCreateCustomVocabularyItemResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    errors: List[FailedCustomVocabularyItemTypeDef],  # (1)
    resources: List[CustomVocabularyItemTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FailedCustomVocabularyItemTypeDef
  2. See CustomVocabularyItemTypeDef
  3. See ResponseMetadataTypeDef

BatchDeleteCustomVocabularyItemResponseTypeDef#

# BatchDeleteCustomVocabularyItemResponseTypeDef definition

class BatchDeleteCustomVocabularyItemResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    errors: List[FailedCustomVocabularyItemTypeDef],  # (1)
    resources: List[CustomVocabularyItemTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FailedCustomVocabularyItemTypeDef
  2. See CustomVocabularyItemTypeDef
  3. See ResponseMetadataTypeDef

BatchUpdateCustomVocabularyItemResponseTypeDef#

# BatchUpdateCustomVocabularyItemResponseTypeDef definition

class BatchUpdateCustomVocabularyItemResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    errors: List[FailedCustomVocabularyItemTypeDef],  # (1)
    resources: List[CustomVocabularyItemTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FailedCustomVocabularyItemTypeDef
  2. See CustomVocabularyItemTypeDef
  3. See ResponseMetadataTypeDef

BuildBotLocaleResponseTypeDef#

# BuildBotLocaleResponseTypeDef definition

class BuildBotLocaleResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    botLocaleStatus: BotLocaleStatusType,  # (1)
    lastBuildSubmittedDateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotLocaleStatusType
  2. See ResponseMetadataTypeDef

CreateBotReplicaResponseTypeDef#

# CreateBotReplicaResponseTypeDef definition

class CreateBotReplicaResponseTypeDef(TypedDict):
    botId: str,
    replicaRegion: str,
    sourceRegion: str,
    creationDateTime: datetime,
    botReplicaStatus: BotReplicaStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotReplicaStatusType
  2. See ResponseMetadataTypeDef

CreateResourcePolicyResponseTypeDef#

# CreateResourcePolicyResponseTypeDef definition

class CreateResourcePolicyResponseTypeDef(TypedDict):
    resourceArn: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateResourcePolicyStatementResponseTypeDef#

# CreateResourcePolicyStatementResponseTypeDef definition

class CreateResourcePolicyStatementResponseTypeDef(TypedDict):
    resourceArn: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUploadUrlResponseTypeDef#

# CreateUploadUrlResponseTypeDef definition

class CreateUploadUrlResponseTypeDef(TypedDict):
    importId: str,
    uploadUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBotAliasResponseTypeDef#

# DeleteBotAliasResponseTypeDef definition

class DeleteBotAliasResponseTypeDef(TypedDict):
    botAliasId: str,
    botId: str,
    botAliasStatus: BotAliasStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotAliasStatusType
  2. See ResponseMetadataTypeDef

DeleteBotLocaleResponseTypeDef#

# DeleteBotLocaleResponseTypeDef definition

class DeleteBotLocaleResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    botLocaleStatus: BotLocaleStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotLocaleStatusType
  2. See ResponseMetadataTypeDef

DeleteBotReplicaResponseTypeDef#

# DeleteBotReplicaResponseTypeDef definition

class DeleteBotReplicaResponseTypeDef(TypedDict):
    botId: str,
    replicaRegion: str,
    botReplicaStatus: BotReplicaStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotReplicaStatusType
  2. See ResponseMetadataTypeDef

DeleteBotResponseTypeDef#

# DeleteBotResponseTypeDef definition

class DeleteBotResponseTypeDef(TypedDict):
    botId: str,
    botStatus: BotStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotStatusType
  2. See ResponseMetadataTypeDef

DeleteBotVersionResponseTypeDef#

# DeleteBotVersionResponseTypeDef definition

class DeleteBotVersionResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    botStatus: BotStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotStatusType
  2. See ResponseMetadataTypeDef

DeleteCustomVocabularyResponseTypeDef#

# DeleteCustomVocabularyResponseTypeDef definition

class DeleteCustomVocabularyResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    customVocabularyStatus: CustomVocabularyStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CustomVocabularyStatusType
  2. See ResponseMetadataTypeDef

DeleteExportResponseTypeDef#

# DeleteExportResponseTypeDef definition

class DeleteExportResponseTypeDef(TypedDict):
    exportId: str,
    exportStatus: ExportStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExportStatusType
  2. See ResponseMetadataTypeDef

DeleteImportResponseTypeDef#

# DeleteImportResponseTypeDef definition

class DeleteImportResponseTypeDef(TypedDict):
    importId: str,
    importStatus: ImportStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportStatusType
  2. See ResponseMetadataTypeDef

DeleteResourcePolicyResponseTypeDef#

# DeleteResourcePolicyResponseTypeDef definition

class DeleteResourcePolicyResponseTypeDef(TypedDict):
    resourceArn: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteResourcePolicyStatementResponseTypeDef#

# DeleteResourcePolicyStatementResponseTypeDef definition

class DeleteResourcePolicyStatementResponseTypeDef(TypedDict):
    resourceArn: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeBotReplicaResponseTypeDef#

# DescribeBotReplicaResponseTypeDef definition

class DescribeBotReplicaResponseTypeDef(TypedDict):
    botId: str,
    replicaRegion: str,
    sourceRegion: str,
    creationDateTime: datetime,
    botReplicaStatus: BotReplicaStatusType,  # (1)
    failureReasons: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotReplicaStatusType
  2. See ResponseMetadataTypeDef

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)
  1. See GenerationStatusType
  2. See ResponseMetadataTypeDef

DescribeCustomVocabularyMetadataResponseTypeDef#

# DescribeCustomVocabularyMetadataResponseTypeDef definition

class DescribeCustomVocabularyMetadataResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    customVocabularyStatus: CustomVocabularyStatusType,  # (1)
    creationDateTime: datetime,
    lastUpdatedDateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CustomVocabularyStatusType
  2. See ResponseMetadataTypeDef

DescribeResourcePolicyResponseTypeDef#

# DescribeResourcePolicyResponseTypeDef definition

class DescribeResourcePolicyResponseTypeDef(TypedDict):
    resourceArn: str,
    policy: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetTestExecutionArtifactsUrlResponseTypeDef#

# GetTestExecutionArtifactsUrlResponseTypeDef definition

class GetTestExecutionArtifactsUrlResponseTypeDef(TypedDict):
    testExecutionId: str,
    downloadArtifactsUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListCustomVocabularyItemsResponseTypeDef#

# ListCustomVocabularyItemsResponseTypeDef definition

class ListCustomVocabularyItemsResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    customVocabularyItems: List[CustomVocabularyItemTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CustomVocabularyItemTypeDef
  2. See ResponseMetadataTypeDef

ListIntentPathsResponseTypeDef#

# ListIntentPathsResponseTypeDef definition

class ListIntentPathsResponseTypeDef(TypedDict):
    nodeSummaries: List[AnalyticsIntentNodeSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalyticsIntentNodeSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

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)
  1. See AssociatedTranscriptTypeDef
  2. See ResponseMetadataTypeDef

StartBotResourceGenerationResponseTypeDef#

# StartBotResourceGenerationResponseTypeDef definition

class StartBotResourceGenerationResponseTypeDef(TypedDict):
    generationInputPrompt: str,
    generationId: str,
    botId: str,
    botVersion: str,
    localeId: str,
    generationStatus: GenerationStatusType,  # (1)
    creationDateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GenerationStatusType
  2. See ResponseMetadataTypeDef

StopBotRecommendationResponseTypeDef#

# StopBotRecommendationResponseTypeDef definition

class StopBotRecommendationResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    botRecommendationStatus: BotRecommendationStatusType,  # (1)
    botRecommendationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotRecommendationStatusType
  2. See ResponseMetadataTypeDef

UpdateResourcePolicyResponseTypeDef#

# UpdateResourcePolicyResponseTypeDef definition

class UpdateResourcePolicyResponseTypeDef(TypedDict):
    resourceArn: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

BatchDeleteCustomVocabularyItemRequestRequestTypeDef#

# BatchDeleteCustomVocabularyItemRequestRequestTypeDef definition

class BatchDeleteCustomVocabularyItemRequestRequestTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    customVocabularyItemList: Sequence[CustomVocabularyEntryIdTypeDef],  # (1)
  1. See CustomVocabularyEntryIdTypeDef

DescriptiveBotBuilderSpecificationTypeDef#

# DescriptiveBotBuilderSpecificationTypeDef definition

class DescriptiveBotBuilderSpecificationTypeDef(TypedDict):
    enabled: bool,
    bedrockModelSpecification: NotRequired[BedrockModelSpecificationTypeDef],  # (1)
  1. See BedrockModelSpecificationTypeDef

SampleUtteranceGenerationSpecificationTypeDef#

# SampleUtteranceGenerationSpecificationTypeDef definition

class SampleUtteranceGenerationSpecificationTypeDef(TypedDict):
    enabled: bool,
    bedrockModelSpecification: NotRequired[BedrockModelSpecificationTypeDef],  # (1)
  1. See BedrockModelSpecificationTypeDef

SlotResolutionImprovementSpecificationTypeDef#

# SlotResolutionImprovementSpecificationTypeDef definition

class SlotResolutionImprovementSpecificationTypeDef(TypedDict):
    enabled: bool,
    bedrockModelSpecification: NotRequired[BedrockModelSpecificationTypeDef],  # (1)
  1. See BedrockModelSpecificationTypeDef

ListBotAliasReplicasResponseTypeDef#

# ListBotAliasReplicasResponseTypeDef definition

class ListBotAliasReplicasResponseTypeDef(TypedDict):
    botId: str,
    sourceRegion: str,
    replicaRegion: str,
    botAliasReplicaSummaries: List[BotAliasReplicaSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotAliasReplicaSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListBotAliasesResponseTypeDef#

# ListBotAliasesResponseTypeDef definition

class ListBotAliasesResponseTypeDef(TypedDict):
    botAliasSummaries: List[BotAliasSummaryTypeDef],  # (1)
    nextToken: str,
    botId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotAliasSummaryTypeDef
  2. See ResponseMetadataTypeDef

TestExecutionTargetTypeDef#

# TestExecutionTargetTypeDef definition

class TestExecutionTargetTypeDef(TypedDict):
    botAliasTarget: NotRequired[BotAliasTestExecutionTargetTypeDef],  # (1)
  1. See BotAliasTestExecutionTargetTypeDef

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]],
  1. See DataPrivacyTypeDef

BotLocaleImportSpecificationTypeDef#

# BotLocaleImportSpecificationTypeDef definition

class BotLocaleImportSpecificationTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    nluIntentConfidenceThreshold: NotRequired[float],
    voiceSettings: NotRequired[VoiceSettingsTypeDef],  # (1)
  1. See VoiceSettingsTypeDef

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],
  1. See BotLocaleSortByTypeDef
  2. See BotLocaleFilterTypeDef

ListBotLocalesResponseTypeDef#

# ListBotLocalesResponseTypeDef definition

class ListBotLocalesResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    nextToken: str,
    botLocaleSummaries: List[BotLocaleSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotLocaleSummaryTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See DataPrivacyTypeDef
  2. See BotTypeType
  3. 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)
  1. See DataPrivacyTypeDef
  2. See BotStatusType
  3. See BotTypeType
  4. See BotMemberTypeDef
  5. 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)
  1. See DataPrivacyTypeDef
  2. See BotStatusType
  3. See BotTypeType
  4. See BotMemberTypeDef
  5. 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)
  1. See DataPrivacyTypeDef
  2. See BotTypeType
  3. 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)
  1. See DataPrivacyTypeDef
  2. See BotStatusType
  3. See BotTypeType
  4. See BotMemberTypeDef
  5. See ResponseMetadataTypeDef

BotRecommendationResultStatisticsTypeDef#

# BotRecommendationResultStatisticsTypeDef definition

class BotRecommendationResultStatisticsTypeDef(TypedDict):
    intents: NotRequired[IntentStatisticsTypeDef],  # (1)
    slotTypes: NotRequired[SlotTypeStatisticsTypeDef],  # (2)
  1. See IntentStatisticsTypeDef
  2. See SlotTypeStatisticsTypeDef

ListBotRecommendationsResponseTypeDef#

# ListBotRecommendationsResponseTypeDef definition

class ListBotRecommendationsResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    botRecommendationSummaries: List[BotRecommendationSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotRecommendationSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListBotReplicasResponseTypeDef#

# ListBotReplicasResponseTypeDef definition

class ListBotReplicasResponseTypeDef(TypedDict):
    botId: str,
    sourceRegion: str,
    botReplicaSummaries: List[BotReplicaSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotReplicaSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListBotsRequestRequestTypeDef#

# ListBotsRequestRequestTypeDef definition

class ListBotsRequestRequestTypeDef(TypedDict):
    sortBy: NotRequired[BotSortByTypeDef],  # (1)
    filters: NotRequired[Sequence[BotFilterTypeDef]],  # (2)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See BotSortByTypeDef
  2. See BotFilterTypeDef

ListBotsResponseTypeDef#

# ListBotsResponseTypeDef definition

class ListBotsResponseTypeDef(TypedDict):
    botSummaries: List[BotSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateBotVersionRequestRequestTypeDef#

# CreateBotVersionRequestRequestTypeDef definition

class CreateBotVersionRequestRequestTypeDef(TypedDict):
    botId: str,
    botVersionLocaleSpecification: Mapping[str, BotVersionLocaleDetailsTypeDef],  # (1)
    description: NotRequired[str],
  1. See BotVersionLocaleDetailsTypeDef

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)
  1. See BotVersionLocaleDetailsTypeDef
  2. See BotStatusType
  3. See ResponseMetadataTypeDef

ListBotVersionReplicasRequestRequestTypeDef#

# ListBotVersionReplicasRequestRequestTypeDef definition

class ListBotVersionReplicasRequestRequestTypeDef(TypedDict):
    botId: str,
    replicaRegion: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[BotVersionReplicaSortByTypeDef],  # (1)
  1. See BotVersionReplicaSortByTypeDef

ListBotVersionReplicasResponseTypeDef#

# ListBotVersionReplicasResponseTypeDef definition

class ListBotVersionReplicasResponseTypeDef(TypedDict):
    botId: str,
    sourceRegion: str,
    replicaRegion: str,
    botVersionReplicaSummaries: List[BotVersionReplicaSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotVersionReplicaSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListBotVersionsRequestRequestTypeDef#

# ListBotVersionsRequestRequestTypeDef definition

class ListBotVersionsRequestRequestTypeDef(TypedDict):
    botId: str,
    sortBy: NotRequired[BotVersionSortByTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See BotVersionSortByTypeDef

ListBotVersionsResponseTypeDef#

# ListBotVersionsResponseTypeDef definition

class ListBotVersionsResponseTypeDef(TypedDict):
    botId: str,
    botVersionSummaries: List[BotVersionSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BotVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListBuiltInIntentsRequestRequestTypeDef#

# ListBuiltInIntentsRequestRequestTypeDef definition

class ListBuiltInIntentsRequestRequestTypeDef(TypedDict):
    localeId: str,
    sortBy: NotRequired[BuiltInIntentSortByTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See BuiltInIntentSortByTypeDef

ListBuiltInIntentsResponseTypeDef#

# ListBuiltInIntentsResponseTypeDef definition

class ListBuiltInIntentsResponseTypeDef(TypedDict):
    builtInIntentSummaries: List[BuiltInIntentSummaryTypeDef],  # (1)
    nextToken: str,
    localeId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BuiltInIntentSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListBuiltInSlotTypesRequestRequestTypeDef#

# ListBuiltInSlotTypesRequestRequestTypeDef definition

class ListBuiltInSlotTypesRequestRequestTypeDef(TypedDict):
    localeId: str,
    sortBy: NotRequired[BuiltInSlotTypeSortByTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See BuiltInSlotTypeSortByTypeDef

ListBuiltInSlotTypesResponseTypeDef#

# ListBuiltInSlotTypesResponseTypeDef definition

class ListBuiltInSlotTypesResponseTypeDef(TypedDict):
    builtInSlotTypeSummaries: List[BuiltInSlotTypeSummaryTypeDef],  # (1)
    nextToken: str,
    localeId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BuiltInSlotTypeSummaryTypeDef
  2. See ResponseMetadataTypeDef

ImageResponseCardTypeDef#

# ImageResponseCardTypeDef definition

class ImageResponseCardTypeDef(TypedDict):
    title: str,
    subtitle: NotRequired[str],
    imageUrl: NotRequired[str],
    buttons: NotRequired[Sequence[ButtonTypeDef]],  # (1)
  1. See ButtonTypeDef

TextLogDestinationTypeDef#

# TextLogDestinationTypeDef definition

class TextLogDestinationTypeDef(TypedDict):
    cloudWatch: CloudWatchLogGroupLogDestinationTypeDef,  # (1)
  1. See CloudWatchLogGroupLogDestinationTypeDef

CodeHookSpecificationTypeDef#

# CodeHookSpecificationTypeDef definition

class CodeHookSpecificationTypeDef(TypedDict):
    lambdaCodeHook: LambdaCodeHookTypeDef,  # (1)
  1. See LambdaCodeHookTypeDef

CompositeSlotTypeSettingTypeDef#

# CompositeSlotTypeSettingTypeDef definition

class CompositeSlotTypeSettingTypeDef(TypedDict):
    subSlots: NotRequired[Sequence[SubSlotTypeCompositionTypeDef]],  # (1)
  1. See SubSlotTypeCompositionTypeDef

ConversationLevelTestResultItemTypeDef#

# ConversationLevelTestResultItemTypeDef definition

class ConversationLevelTestResultItemTypeDef(TypedDict):
    conversationId: str,
    endToEndResult: TestResultMatchStatusType,  # (1)
    intentClassificationResults: List[ConversationLevelIntentClassificationResultItemTypeDef],  # (3)
    slotResolutionResults: List[ConversationLevelSlotResolutionResultItemTypeDef],  # (4)
    speechTranscriptionResult: NotRequired[TestResultMatchStatusType],  # (1)
  1. See TestResultMatchStatusType
  2. See TestResultMatchStatusType
  3. See ConversationLevelIntentClassificationResultItemTypeDef
  4. See ConversationLevelSlotResolutionResultItemTypeDef

TestExecutionResultFilterByTypeDef#

# TestExecutionResultFilterByTypeDef definition

class TestExecutionResultFilterByTypeDef(TypedDict):
    resultTypeFilter: TestResultTypeFilterType,  # (1)
    conversationLevelTestResultsFilterBy: NotRequired[ConversationLevelTestResultsFilterByTypeDef],  # (2)
  1. See TestResultTypeFilterType
  2. See ConversationLevelTestResultsFilterByTypeDef

ConversationLogsDataSourceTypeDef#

# ConversationLogsDataSourceTypeDef definition

class ConversationLogsDataSourceTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    filter: ConversationLogsDataSourceFilterByTypeDef,  # (1)
  1. See ConversationLogsDataSourceFilterByTypeDef

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],
  1. See InputContextTypeDef
  2. See OutputContextTypeDef

GenerateBotElementResponseTypeDef#

# GenerateBotElementResponseTypeDef definition

class GenerateBotElementResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    intentId: str,
    sampleUtterances: List[SampleUtteranceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SampleUtteranceTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See EffectType
  2. See PrincipalTypeDef

LexTranscriptFilterTypeDef#

# LexTranscriptFilterTypeDef definition

class LexTranscriptFilterTypeDef(TypedDict):
    dateRangeFilter: NotRequired[DateRangeFilterTypeDef],  # (1)
  1. See DateRangeFilterTypeDef

DescribeBotAliasRequestBotAliasAvailableWaitTypeDef#

# DescribeBotAliasRequestBotAliasAvailableWaitTypeDef definition

class DescribeBotAliasRequestBotAliasAvailableWaitTypeDef(TypedDict):
    botAliasId: str,
    botId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeBotLocaleRequestBotLocaleBuiltWaitTypeDef#

# DescribeBotLocaleRequestBotLocaleBuiltWaitTypeDef definition

class DescribeBotLocaleRequestBotLocaleBuiltWaitTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeBotLocaleRequestBotLocaleCreatedWaitTypeDef#

# DescribeBotLocaleRequestBotLocaleCreatedWaitTypeDef definition

class DescribeBotLocaleRequestBotLocaleCreatedWaitTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeBotLocaleRequestBotLocaleExpressTestingAvailableWaitTypeDef#

# DescribeBotLocaleRequestBotLocaleExpressTestingAvailableWaitTypeDef definition

class DescribeBotLocaleRequestBotLocaleExpressTestingAvailableWaitTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeBotRequestBotAvailableWaitTypeDef#

# DescribeBotRequestBotAvailableWaitTypeDef definition

class DescribeBotRequestBotAvailableWaitTypeDef(TypedDict):
    botId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeBotVersionRequestBotVersionAvailableWaitTypeDef#

# DescribeBotVersionRequestBotVersionAvailableWaitTypeDef definition

class DescribeBotVersionRequestBotVersionAvailableWaitTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeExportRequestBotExportCompletedWaitTypeDef#

# DescribeExportRequestBotExportCompletedWaitTypeDef definition

class DescribeExportRequestBotExportCompletedWaitTypeDef(TypedDict):
    exportId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeImportRequestBotImportCompletedWaitTypeDef#

# DescribeImportRequestBotImportCompletedWaitTypeDef definition

class DescribeImportRequestBotImportCompletedWaitTypeDef(TypedDict):
    importId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

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)
  1. See DataPrivacyTypeDef
  2. See BotStatusType
  3. See ParentBotNetworkTypeDef
  4. See BotTypeType
  5. See BotMemberTypeDef
  6. See ResponseMetadataTypeDef

UpdateBotRecommendationRequestRequestTypeDef#

# UpdateBotRecommendationRequestRequestTypeDef definition

class UpdateBotRecommendationRequestRequestTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    botRecommendationId: str,
    encryptionSetting: EncryptionSettingTypeDef,  # (1)
  1. See EncryptionSettingTypeDef

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)
  1. See TestSetModalityType
  2. See TestSetStatusType
  3. See TestSetStorageLocationTypeDef
  4. 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],
  1. See TestSetModalityType
  2. See TestSetStatusType
  3. See TestSetStorageLocationTypeDef

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)
  1. See TestSetModalityType
  2. See TestSetStatusType
  3. See TestSetStorageLocationTypeDef
  4. See ResponseMetadataTypeDef

DialogStateTypeDef#

# DialogStateTypeDef definition

class DialogStateTypeDef(TypedDict):
    dialogAction: NotRequired[DialogActionTypeDef],  # (1)
    intent: NotRequired[IntentOverrideTypeDef],  # (2)
    sessionAttributes: NotRequired[Mapping[str, str]],
  1. See DialogActionTypeDef
  2. See IntentOverrideTypeDef

OpensearchConfigurationTypeDef#

# OpensearchConfigurationTypeDef definition

class OpensearchConfigurationTypeDef(TypedDict):
    domainEndpoint: str,
    indexName: str,
    exactResponse: NotRequired[bool],
    exactResponseFields: NotRequired[ExactResponseFieldsTypeDef],  # (1)
    includeFields: NotRequired[Sequence[str]],
  1. See ExactResponseFieldsTypeDef

ExportResourceSpecificationTypeDef#

# ExportResourceSpecificationTypeDef definition

class ExportResourceSpecificationTypeDef(TypedDict):
    botExportSpecification: NotRequired[BotExportSpecificationTypeDef],  # (1)
    botLocaleExportSpecification: NotRequired[BotLocaleExportSpecificationTypeDef],  # (2)
    customVocabularyExportSpecification: NotRequired[CustomVocabularyExportSpecificationTypeDef],  # (3)
    testSetExportSpecification: NotRequired[TestSetExportSpecificationTypeDef],  # (4)
  1. See BotExportSpecificationTypeDef
  2. See BotLocaleExportSpecificationTypeDef
  3. See CustomVocabularyExportSpecificationTypeDef
  4. 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],
  1. See ExportSortByTypeDef
  2. See ExportFilterTypeDef

ListBotResourceGenerationsRequestRequestTypeDef#

# ListBotResourceGenerationsRequestRequestTypeDef definition

class ListBotResourceGenerationsRequestRequestTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    sortBy: NotRequired[GenerationSortByTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See GenerationSortByTypeDef

ListBotResourceGenerationsResponseTypeDef#

# ListBotResourceGenerationsResponseTypeDef definition

class ListBotResourceGenerationsResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    generationSummaries: List[GenerationSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GenerationSummaryTypeDef
  2. See ResponseMetadataTypeDef

GrammarSlotTypeSettingTypeDef#

# GrammarSlotTypeSettingTypeDef definition

class GrammarSlotTypeSettingTypeDef(TypedDict):
    source: NotRequired[GrammarSlotTypeSourceTypeDef],  # (1)
  1. See GrammarSlotTypeSourceTypeDef

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],
  1. See ImportSortByTypeDef
  2. See ImportFilterTypeDef

ListImportsResponseTypeDef#

# ListImportsResponseTypeDef definition

class ListImportsResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    importSummaries: List[ImportSummaryTypeDef],  # (1)
    nextToken: str,
    localeId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportSummaryTypeDef
  2. See ResponseMetadataTypeDef

InputSessionStateSpecificationTypeDef#

# InputSessionStateSpecificationTypeDef definition

class InputSessionStateSpecificationTypeDef(TypedDict):
    sessionAttributes: NotRequired[Dict[str, str]],
    activeContexts: NotRequired[List[ActiveContextTypeDef]],  # (1)
    runtimeHints: NotRequired[RuntimeHintsTypeDef],  # (2)
  1. See ActiveContextTypeDef
  2. See RuntimeHintsTypeDef

IntentClassificationTestResultItemTypeDef#

# IntentClassificationTestResultItemTypeDef definition

class IntentClassificationTestResultItemTypeDef(TypedDict):
    intentName: str,
    multiTurnConversation: bool,
    resultCounts: IntentClassificationTestResultItemCountsTypeDef,  # (1)
  1. See IntentClassificationTestResultItemCountsTypeDef

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],
  1. See IntentSortByTypeDef
  2. See IntentFilterTypeDef

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],
  1. See ConversationEndStateType
  2. See AnalyticsModalityType
  3. See InvokedIntentSampleTypeDef

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],
  1. See AnalyticsIntentMetricTypeDef
  2. See AnalyticsBinBySpecificationTypeDef
  3. See AnalyticsIntentGroupBySpecificationTypeDef
  4. 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)
  1. See AnalyticsPathFilterTypeDef

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],
  1. See AnalyticsIntentStageMetricTypeDef
  2. See AnalyticsBinBySpecificationTypeDef
  3. See AnalyticsIntentStageGroupBySpecificationTypeDef
  4. 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],
  1. See AnalyticsSessionMetricTypeDef
  2. See AnalyticsBinBySpecificationTypeDef
  3. See AnalyticsSessionGroupBySpecificationTypeDef
  4. 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],
  1. See AnalyticsUtteranceMetricTypeDef
  2. See AnalyticsBinBySpecificationTypeDef
  3. See AnalyticsUtteranceGroupBySpecificationTypeDef
  4. See AnalyticsUtteranceAttributeTypeDef
  5. 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)
  1. See RecommendedIntentSummaryTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See SessionDataSortByTypeDef
  2. See AnalyticsSessionFilterTypeDef

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],
  1. See SlotTypeSortByTypeDef
  2. See SlotTypeFilterTypeDef

ListSlotTypesResponseTypeDef#

# ListSlotTypesResponseTypeDef definition

class ListSlotTypesResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    slotTypeSummaries: List[SlotTypeSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SlotTypeSummaryTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See SlotSortByTypeDef
  2. See SlotFilterTypeDef

ListTestExecutionsRequestRequestTypeDef#

# ListTestExecutionsRequestRequestTypeDef definition

class ListTestExecutionsRequestRequestTypeDef(TypedDict):
    sortBy: NotRequired[TestExecutionSortByTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See TestExecutionSortByTypeDef

ListTestSetsRequestRequestTypeDef#

# ListTestSetsRequestRequestTypeDef definition

class ListTestSetsRequestRequestTypeDef(TypedDict):
    sortBy: NotRequired[TestSetSortByTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See TestSetSortByTypeDef

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],
  1. See UtteranceDataSortByTypeDef
  2. See AnalyticsUtteranceFilterTypeDef

OverallTestResultsTypeDef#

# OverallTestResultsTypeDef definition

class OverallTestResultsTypeDef(TypedDict):
    items: List[OverallTestResultItemTypeDef],  # (1)
  1. See OverallTestResultItemTypeDef

UtteranceAggregationDurationTypeDef#

# UtteranceAggregationDurationTypeDef definition

class UtteranceAggregationDurationTypeDef(TypedDict):
    relativeAggregationDuration: RelativeAggregationDurationTypeDef,  # (1)
  1. See RelativeAggregationDurationTypeDef

RuntimeHintDetailsTypeDef#

# RuntimeHintDetailsTypeDef definition

class RuntimeHintDetailsTypeDef(TypedDict):
    runtimeHintValues: NotRequired[List[RuntimeHintValueTypeDef]],  # (1)
    subSlotHints: NotRequired[Dict[str, Dict[str, Any]]],
  1. See RuntimeHintValueTypeDef

SlotTypeValueTypeDef#

# SlotTypeValueTypeDef definition

class SlotTypeValueTypeDef(TypedDict):
    sampleValue: NotRequired[SampleValueTypeDef],  # (1)
    synonyms: NotRequired[Sequence[SampleValueTypeDef]],  # (2)
  1. See SampleValueTypeDef
  2. See SampleValueTypeDef

SlotDefaultValueSpecificationTypeDef#

# SlotDefaultValueSpecificationTypeDef definition

class SlotDefaultValueSpecificationTypeDef(TypedDict):
    defaultValueList: Sequence[SlotDefaultValueTypeDef],  # (1)
  1. See SlotDefaultValueTypeDef

SlotResolutionTestResultItemTypeDef#

# SlotResolutionTestResultItemTypeDef definition

class SlotResolutionTestResultItemTypeDef(TypedDict):
    slotName: str,
    resultCounts: SlotResolutionTestResultItemCountsTypeDef,  # (1)
  1. See SlotResolutionTestResultItemCountsTypeDef

SlotValueOverrideTypeDef#

# SlotValueOverrideTypeDef definition

class SlotValueOverrideTypeDef(TypedDict):
    shape: NotRequired[SlotShapeType],  # (1)
    value: NotRequired[SlotValueTypeDef],  # (2)
    values: NotRequired[Sequence[Dict[str, Any]]],
  1. See SlotShapeType
  2. See SlotValueTypeDef

SlotValueSelectionSettingTypeDef#

# SlotValueSelectionSettingTypeDef definition

class SlotValueSelectionSettingTypeDef(TypedDict):
    resolutionStrategy: SlotValueResolutionStrategyType,  # (1)
    regexFilter: NotRequired[SlotValueRegexFilterTypeDef],  # (2)
    advancedRecognitionSetting: NotRequired[AdvancedRecognitionSettingTypeDef],  # (3)
  1. See SlotValueResolutionStrategyType
  2. See SlotValueRegexFilterTypeDef
  3. See AdvancedRecognitionSettingTypeDef

TestSetDiscrepancyErrorsTypeDef#

# TestSetDiscrepancyErrorsTypeDef definition

class TestSetDiscrepancyErrorsTypeDef(TypedDict):
    intentDiscrepancies: List[TestSetIntentDiscrepancyItemTypeDef],  # (1)
    slotDiscrepancies: List[TestSetSlotDiscrepancyItemTypeDef],  # (2)
  1. See TestSetIntentDiscrepancyItemTypeDef
  2. See TestSetSlotDiscrepancyItemTypeDef

TestSetDiscrepancyReportResourceTargetTypeDef#

# TestSetDiscrepancyReportResourceTargetTypeDef definition

class TestSetDiscrepancyReportResourceTargetTypeDef(TypedDict):
    botAliasTarget: NotRequired[TestSetDiscrepancyReportBotAliasTargetTypeDef],  # (1)
  1. See TestSetDiscrepancyReportBotAliasTargetTypeDef

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]],
  1. See TestSetStorageLocationTypeDef
  2. See TestSetImportInputLocationTypeDef
  3. See TestSetModalityType

UserTurnOutputSpecificationTypeDef#

# UserTurnOutputSpecificationTypeDef definition

class UserTurnOutputSpecificationTypeDef(TypedDict):
    intent: UserTurnIntentOutputTypeDef,  # (1)
    activeContexts: NotRequired[List[ActiveContextTypeDef]],  # (2)
    transcript: NotRequired[str],
  1. See UserTurnIntentOutputTypeDef
  2. See ActiveContextTypeDef

UtteranceInputSpecificationTypeDef#

# UtteranceInputSpecificationTypeDef definition

class UtteranceInputSpecificationTypeDef(TypedDict):
    textInput: NotRequired[str],
    audioInput: NotRequired[UtteranceAudioInputSpecificationTypeDef],  # (1)
  1. See UtteranceAudioInputSpecificationTypeDef

ListIntentMetricsResponseTypeDef#

# ListIntentMetricsResponseTypeDef definition

class ListIntentMetricsResponseTypeDef(TypedDict):
    botId: str,
    results: List[AnalyticsIntentResultTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalyticsIntentResultTypeDef
  2. See ResponseMetadataTypeDef

ListIntentStageMetricsResponseTypeDef#

# ListIntentStageMetricsResponseTypeDef definition

class ListIntentStageMetricsResponseTypeDef(TypedDict):
    botId: str,
    results: List[AnalyticsIntentStageResultTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalyticsIntentStageResultTypeDef
  2. See ResponseMetadataTypeDef

ListSessionMetricsResponseTypeDef#

# ListSessionMetricsResponseTypeDef definition

class ListSessionMetricsResponseTypeDef(TypedDict):
    botId: str,
    results: List[AnalyticsSessionResultTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalyticsSessionResultTypeDef
  2. See ResponseMetadataTypeDef

ListUtteranceMetricsResponseTypeDef#

# ListUtteranceMetricsResponseTypeDef definition

class ListUtteranceMetricsResponseTypeDef(TypedDict):
    botId: str,
    results: List[AnalyticsUtteranceResultTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalyticsUtteranceResultTypeDef
  2. See ResponseMetadataTypeDef

PromptAttemptSpecificationTypeDef#

# PromptAttemptSpecificationTypeDef definition

class PromptAttemptSpecificationTypeDef(TypedDict):
    allowedInputTypes: AllowedInputTypesTypeDef,  # (1)
    allowInterrupt: NotRequired[bool],
    audioAndDTMFInputSpecification: NotRequired[AudioAndDTMFInputSpecificationTypeDef],  # (2)
    textInputSpecification: NotRequired[TextInputSpecificationTypeDef],  # (3)
  1. See AllowedInputTypesTypeDef
  2. See AudioAndDTMFInputSpecificationTypeDef
  3. See TextInputSpecificationTypeDef

AudioLogSettingTypeDef#

# AudioLogSettingTypeDef definition

class AudioLogSettingTypeDef(TypedDict):
    enabled: bool,
    destination: AudioLogDestinationTypeDef,  # (1)
    selectiveLoggingEnabled: NotRequired[bool],
  1. See AudioLogDestinationTypeDef

BuildtimeSettingsTypeDef#

# BuildtimeSettingsTypeDef definition

class BuildtimeSettingsTypeDef(TypedDict):
    descriptiveBotBuilder: NotRequired[DescriptiveBotBuilderSpecificationTypeDef],  # (1)
    sampleUtteranceGeneration: NotRequired[SampleUtteranceGenerationSpecificationTypeDef],  # (2)
  1. See DescriptiveBotBuilderSpecificationTypeDef
  2. See SampleUtteranceGenerationSpecificationTypeDef

RuntimeSettingsTypeDef#

# RuntimeSettingsTypeDef definition

class RuntimeSettingsTypeDef(TypedDict):
    slotResolutionImprovement: NotRequired[SlotResolutionImprovementSpecificationTypeDef],  # (1)
  1. See SlotResolutionImprovementSpecificationTypeDef

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)
  1. See TestExecutionStatusType
  2. See TestExecutionTargetTypeDef
  3. See TestExecutionApiModeType
  4. See TestExecutionModalityType
  5. See ResponseMetadataTypeDef

StartTestExecutionRequestRequestTypeDef#

# StartTestExecutionRequestRequestTypeDef definition

class StartTestExecutionRequestRequestTypeDef(TypedDict):
    testSetId: str,
    target: TestExecutionTargetTypeDef,  # (1)
    apiMode: TestExecutionApiModeType,  # (2)
    testExecutionModality: NotRequired[TestExecutionModalityType],  # (3)
  1. See TestExecutionTargetTypeDef
  2. See TestExecutionApiModeType
  3. See TestExecutionModalityType

StartTestExecutionResponseTypeDef#

# StartTestExecutionResponseTypeDef definition

class StartTestExecutionResponseTypeDef(TypedDict):
    testExecutionId: str,
    creationDateTime: datetime,
    testSetId: str,
    target: TestExecutionTargetTypeDef,  # (1)
    apiMode: TestExecutionApiModeType,  # (2)
    testExecutionModality: TestExecutionModalityType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See TestExecutionTargetTypeDef
  2. See TestExecutionApiModeType
  3. See TestExecutionModalityType
  4. 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)
  1. See TestExecutionStatusType
  2. See TestExecutionTargetTypeDef
  3. See TestExecutionApiModeType
  4. See TestExecutionModalityType

BotRecommendationResultsTypeDef#

# BotRecommendationResultsTypeDef definition

class BotRecommendationResultsTypeDef(TypedDict):
    botLocaleExportUrl: NotRequired[str],
    associatedTranscriptsUrl: NotRequired[str],
    statistics: NotRequired[BotRecommendationResultStatisticsTypeDef],  # (1)
  1. See BotRecommendationResultStatisticsTypeDef

MessageTypeDef#

# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    plainTextMessage: NotRequired[PlainTextMessageTypeDef],  # (1)
    customPayload: NotRequired[CustomPayloadTypeDef],  # (2)
    ssmlMessage: NotRequired[SSMLMessageTypeDef],  # (3)
    imageResponseCard: NotRequired[ImageResponseCardTypeDef],  # (4)
  1. See PlainTextMessageTypeDef
  2. See CustomPayloadTypeDef
  3. See SSMLMessageTypeDef
  4. See ImageResponseCardTypeDef

UtteranceBotResponseTypeDef#

# UtteranceBotResponseTypeDef definition

class UtteranceBotResponseTypeDef(TypedDict):
    content: NotRequired[str],
    contentType: NotRequired[UtteranceContentTypeType],  # (1)
    imageResponseCard: NotRequired[ImageResponseCardTypeDef],  # (2)
  1. See UtteranceContentTypeType
  2. See ImageResponseCardTypeDef

TextLogSettingTypeDef#

# TextLogSettingTypeDef definition

class TextLogSettingTypeDef(TypedDict):
    enabled: bool,
    destination: TextLogDestinationTypeDef,  # (1)
    selectiveLoggingEnabled: NotRequired[bool],
  1. See TextLogDestinationTypeDef

BotAliasLocaleSettingsTypeDef#

# BotAliasLocaleSettingsTypeDef definition

class BotAliasLocaleSettingsTypeDef(TypedDict):
    enabled: bool,
    codeHookSpecification: NotRequired[CodeHookSpecificationTypeDef],  # (1)
  1. See CodeHookSpecificationTypeDef

ConversationLevelTestResultsTypeDef#

# ConversationLevelTestResultsTypeDef definition

class ConversationLevelTestResultsTypeDef(TypedDict):
    items: List[ConversationLevelTestResultItemTypeDef],  # (1)
  1. See ConversationLevelTestResultItemTypeDef

ListTestExecutionResultItemsRequestRequestTypeDef#

# ListTestExecutionResultItemsRequestRequestTypeDef definition

class ListTestExecutionResultItemsRequestRequestTypeDef(TypedDict):
    testExecutionId: str,
    resultFilterBy: TestExecutionResultFilterByTypeDef,  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See TestExecutionResultFilterByTypeDef

TestSetGenerationDataSourceTypeDef#

# TestSetGenerationDataSourceTypeDef definition

class TestSetGenerationDataSourceTypeDef(TypedDict):
    conversationLogsDataSource: NotRequired[ConversationLogsDataSourceTypeDef],  # (1)
  1. See ConversationLogsDataSourceTypeDef

ListIntentsResponseTypeDef#

# ListIntentsResponseTypeDef definition

class ListIntentsResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    intentSummaries: List[IntentSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IntentSummaryTypeDef
  2. See ResponseMetadataTypeDef

TranscriptFilterTypeDef#

# TranscriptFilterTypeDef definition

class TranscriptFilterTypeDef(TypedDict):
    lexTranscriptFilter: NotRequired[LexTranscriptFilterTypeDef],  # (1)
  1. See LexTranscriptFilterTypeDef

ListTestSetsResponseTypeDef#

# ListTestSetsResponseTypeDef definition

class ListTestSetsResponseTypeDef(TypedDict):
    testSets: List[TestSetSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TestSetSummaryTypeDef
  2. See ResponseMetadataTypeDef

DataSourceConfigurationTypeDef#

# DataSourceConfigurationTypeDef definition

class DataSourceConfigurationTypeDef(TypedDict):
    opensearchConfiguration: NotRequired[OpensearchConfigurationTypeDef],  # (1)
    kendraConfiguration: NotRequired[QnAKendraConfigurationTypeDef],  # (2)
    bedrockKnowledgeStoreConfiguration: NotRequired[BedrockKnowledgeStoreConfigurationTypeDef],  # (3)
  1. See OpensearchConfigurationTypeDef
  2. See QnAKendraConfigurationTypeDef
  3. See BedrockKnowledgeStoreConfigurationTypeDef

CreateExportRequestRequestTypeDef#

# CreateExportRequestRequestTypeDef definition

class CreateExportRequestRequestTypeDef(TypedDict):
    resourceSpecification: ExportResourceSpecificationTypeDef,  # (1)
    fileFormat: ImportExportFileFormatType,  # (2)
    filePassword: NotRequired[str],
  1. See ExportResourceSpecificationTypeDef
  2. See ImportExportFileFormatType

CreateExportResponseTypeDef#

# CreateExportResponseTypeDef definition

class CreateExportResponseTypeDef(TypedDict):
    exportId: str,
    resourceSpecification: ExportResourceSpecificationTypeDef,  # (1)
    fileFormat: ImportExportFileFormatType,  # (2)
    exportStatus: ExportStatusType,  # (3)
    creationDateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ExportResourceSpecificationTypeDef
  2. See ImportExportFileFormatType
  3. See ExportStatusType
  4. 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)
  1. See ExportResourceSpecificationTypeDef
  2. See ImportExportFileFormatType
  3. See ExportStatusType
  4. 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],
  1. See ExportResourceSpecificationTypeDef
  2. See ImportExportFileFormatType
  3. See ExportStatusType

UpdateExportResponseTypeDef#

# UpdateExportResponseTypeDef definition

class UpdateExportResponseTypeDef(TypedDict):
    exportId: str,
    resourceSpecification: ExportResourceSpecificationTypeDef,  # (1)
    fileFormat: ImportExportFileFormatType,  # (2)
    exportStatus: ExportStatusType,  # (3)
    creationDateTime: datetime,
    lastUpdatedDateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ExportResourceSpecificationTypeDef
  2. See ImportExportFileFormatType
  3. See ExportStatusType
  4. See ResponseMetadataTypeDef

ExternalSourceSettingTypeDef#

# ExternalSourceSettingTypeDef definition

class ExternalSourceSettingTypeDef(TypedDict):
    grammarSlotTypeSetting: NotRequired[GrammarSlotTypeSettingTypeDef],  # (1)
  1. See GrammarSlotTypeSettingTypeDef

IntentClassificationTestResultsTypeDef#

# IntentClassificationTestResultsTypeDef definition

class IntentClassificationTestResultsTypeDef(TypedDict):
    items: List[IntentClassificationTestResultItemTypeDef],  # (1)
  1. See IntentClassificationTestResultItemTypeDef

ListSessionAnalyticsDataResponseTypeDef#

# ListSessionAnalyticsDataResponseTypeDef definition

class ListSessionAnalyticsDataResponseTypeDef(TypedDict):
    botId: str,
    nextToken: str,
    sessions: List[SessionSpecificationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionSpecificationTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See UtteranceAggregationDurationTypeDef
  2. See AggregatedUtterancesSortByTypeDef
  3. 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)
  1. See UtteranceAggregationDurationTypeDef
  2. See AggregatedUtterancesSummaryTypeDef
  3. See ResponseMetadataTypeDef

IntentLevelSlotResolutionTestResultItemTypeDef#

# IntentLevelSlotResolutionTestResultItemTypeDef definition

class IntentLevelSlotResolutionTestResultItemTypeDef(TypedDict):
    intentName: str,
    multiTurnConversation: bool,
    slotResolutionResults: List[SlotResolutionTestResultItemTypeDef],  # (1)
  1. See SlotResolutionTestResultItemTypeDef

CreateTestSetDiscrepancyReportRequestRequestTypeDef#

# CreateTestSetDiscrepancyReportRequestRequestTypeDef definition

class CreateTestSetDiscrepancyReportRequestRequestTypeDef(TypedDict):
    testSetId: str,
    target: TestSetDiscrepancyReportResourceTargetTypeDef,  # (1)
  1. See TestSetDiscrepancyReportResourceTargetTypeDef

CreateTestSetDiscrepancyReportResponseTypeDef#

# CreateTestSetDiscrepancyReportResponseTypeDef definition

class CreateTestSetDiscrepancyReportResponseTypeDef(TypedDict):
    testSetDiscrepancyReportId: str,
    creationDateTime: datetime,
    testSetId: str,
    target: TestSetDiscrepancyReportResourceTargetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TestSetDiscrepancyReportResourceTargetTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See TestSetDiscrepancyReportResourceTargetTypeDef
  2. See TestSetDiscrepancyReportStatusType
  3. See TestSetDiscrepancyErrorsTypeDef
  4. See ResponseMetadataTypeDef

ImportResourceSpecificationTypeDef#

# ImportResourceSpecificationTypeDef definition

class ImportResourceSpecificationTypeDef(TypedDict):
    botImportSpecification: NotRequired[BotImportSpecificationTypeDef],  # (1)
    botLocaleImportSpecification: NotRequired[BotLocaleImportSpecificationTypeDef],  # (2)
    customVocabularyImportSpecification: NotRequired[CustomVocabularyImportSpecificationTypeDef],  # (3)
    testSetImportResourceSpecification: NotRequired[TestSetImportResourceSpecificationTypeDef],  # (4)
  1. See BotImportSpecificationTypeDef
  2. See BotLocaleImportSpecificationTypeDef
  3. See CustomVocabularyImportSpecificationTypeDef
  4. See TestSetImportResourceSpecificationTypeDef

UserTurnInputSpecificationTypeDef#

# UserTurnInputSpecificationTypeDef definition

class UserTurnInputSpecificationTypeDef(TypedDict):
    utteranceInput: UtteranceInputSpecificationTypeDef,  # (1)
    requestAttributes: NotRequired[Dict[str, str]],
    sessionState: NotRequired[InputSessionStateSpecificationTypeDef],  # (2)
  1. See UtteranceInputSpecificationTypeDef
  2. See InputSessionStateSpecificationTypeDef

GenerativeAISettingsTypeDef#

# GenerativeAISettingsTypeDef definition

class GenerativeAISettingsTypeDef(TypedDict):
    runtimeSettings: NotRequired[RuntimeSettingsTypeDef],  # (1)
    buildtimeSettings: NotRequired[BuildtimeSettingsTypeDef],  # (2)
  1. See RuntimeSettingsTypeDef
  2. See BuildtimeSettingsTypeDef

ListTestExecutionsResponseTypeDef#

# ListTestExecutionsResponseTypeDef definition

class ListTestExecutionsResponseTypeDef(TypedDict):
    testExecutions: List[TestExecutionSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TestExecutionSummaryTypeDef
  2. See ResponseMetadataTypeDef

MessageGroupTypeDef#

# MessageGroupTypeDef definition

class MessageGroupTypeDef(TypedDict):
    message: MessageTypeDef,  # (1)
    variations: NotRequired[Sequence[MessageTypeDef]],  # (2)
  1. See MessageTypeDef
  2. 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)
  1. See AnalyticsModalityType
  2. See IntentStateType
  3. See UtteranceBotResponseTypeDef

ConversationLogSettingsTypeDef#

# ConversationLogSettingsTypeDef definition

class ConversationLogSettingsTypeDef(TypedDict):
    textLogSettings: NotRequired[Sequence[TextLogSettingTypeDef]],  # (1)
    audioLogSettings: NotRequired[Sequence[AudioLogSettingTypeDef]],  # (2)
  1. See TextLogSettingTypeDef
  2. See AudioLogSettingTypeDef

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)
  1. See TestSetGenerationStatusType
  2. See TestSetStorageLocationTypeDef
  3. See TestSetGenerationDataSourceTypeDef
  4. 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]],
  1. See TestSetStorageLocationTypeDef
  2. See TestSetGenerationDataSourceTypeDef

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)
  1. See TestSetGenerationStatusType
  2. See TestSetStorageLocationTypeDef
  3. See TestSetGenerationDataSourceTypeDef
  4. See ResponseMetadataTypeDef

S3BucketTranscriptSourceTypeDef#

# S3BucketTranscriptSourceTypeDef definition

class S3BucketTranscriptSourceTypeDef(TypedDict):
    s3BucketName: str,
    transcriptFormat: TranscriptFormatType,  # (2)
    pathFormat: NotRequired[PathFormatTypeDef],  # (1)
    transcriptFilter: NotRequired[TranscriptFilterTypeDef],  # (3)
    kmsKeyArn: NotRequired[str],
  1. See PathFormatTypeDef
  2. See TranscriptFormatType
  3. See TranscriptFilterTypeDef

QnAIntentConfigurationTypeDef#

# QnAIntentConfigurationTypeDef definition

class QnAIntentConfigurationTypeDef(TypedDict):
    dataSourceConfiguration: NotRequired[DataSourceConfigurationTypeDef],  # (1)
    bedrockModelConfiguration: NotRequired[BedrockModelSpecificationTypeDef],  # (2)
  1. See DataSourceConfigurationTypeDef
  2. See BedrockModelSpecificationTypeDef

ListExportsResponseTypeDef#

# ListExportsResponseTypeDef definition

class ListExportsResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    exportSummaries: List[ExportSummaryTypeDef],  # (1)
    nextToken: str,
    localeId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExportSummaryTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See SlotTypeValueTypeDef
  2. See SlotValueSelectionSettingTypeDef
  3. See ExternalSourceSettingTypeDef
  4. 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)
  1. See SlotTypeValueTypeDef
  2. See SlotValueSelectionSettingTypeDef
  3. See ExternalSourceSettingTypeDef
  4. See CompositeSlotTypeSettingTypeDef
  5. 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)
  1. See SlotTypeValueTypeDef
  2. See SlotValueSelectionSettingTypeDef
  3. See ExternalSourceSettingTypeDef
  4. See CompositeSlotTypeSettingTypeDef
  5. 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)
  1. See SlotTypeValueTypeDef
  2. See SlotValueSelectionSettingTypeDef
  3. See ExternalSourceSettingTypeDef
  4. 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)
  1. See SlotTypeValueTypeDef
  2. See SlotValueSelectionSettingTypeDef
  3. See ExternalSourceSettingTypeDef
  4. See CompositeSlotTypeSettingTypeDef
  5. See ResponseMetadataTypeDef

IntentLevelSlotResolutionTestResultsTypeDef#

# IntentLevelSlotResolutionTestResultsTypeDef definition

class IntentLevelSlotResolutionTestResultsTypeDef(TypedDict):
    items: List[IntentLevelSlotResolutionTestResultItemTypeDef],  # (1)
  1. See IntentLevelSlotResolutionTestResultItemTypeDef

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)
  1. See ImportResourceSpecificationTypeDef
  2. See MergeStrategyType
  3. See ImportStatusType
  4. See ResponseMetadataTypeDef

StartImportRequestRequestTypeDef#

# StartImportRequestRequestTypeDef definition

class StartImportRequestRequestTypeDef(TypedDict):
    importId: str,
    resourceSpecification: ImportResourceSpecificationTypeDef,  # (1)
    mergeStrategy: MergeStrategyType,  # (2)
    filePassword: NotRequired[str],
  1. See ImportResourceSpecificationTypeDef
  2. See MergeStrategyType

StartImportResponseTypeDef#

# StartImportResponseTypeDef definition

class StartImportResponseTypeDef(TypedDict):
    importId: str,
    resourceSpecification: ImportResourceSpecificationTypeDef,  # (1)
    mergeStrategy: MergeStrategyType,  # (2)
    importStatus: ImportStatusType,  # (3)
    creationDateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ImportResourceSpecificationTypeDef
  2. See MergeStrategyType
  3. See ImportStatusType
  4. 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)
  1. See UserTurnInputSpecificationTypeDef
  2. See UserTurnOutputSpecificationTypeDef
  3. See UserTurnOutputSpecificationTypeDef
  4. See ExecutionErrorDetailsTypeDef
  5. See TestResultMatchStatusType
  6. See TestResultMatchStatusType
  7. See TestResultMatchStatusType
  8. See TestResultMatchStatusType
  9. See ConversationLevelResultDetailTypeDef

UserTurnSpecificationTypeDef#

# UserTurnSpecificationTypeDef definition

class UserTurnSpecificationTypeDef(TypedDict):
    input: UserTurnInputSpecificationTypeDef,  # (1)
    expected: UserTurnOutputSpecificationTypeDef,  # (2)
  1. See UserTurnInputSpecificationTypeDef
  2. See UserTurnOutputSpecificationTypeDef

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)
  1. See VoiceSettingsTypeDef
  2. See GenerativeAISettingsTypeDef

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)
  1. See VoiceSettingsTypeDef
  2. See BotLocaleStatusType
  3. See GenerativeAISettingsTypeDef
  4. 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)
  1. See VoiceSettingsTypeDef
  2. See BotLocaleStatusType
  3. See BotLocaleHistoryEventTypeDef
  4. See GenerativeAISettingsTypeDef
  5. 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)
  1. See VoiceSettingsTypeDef
  2. See GenerativeAISettingsTypeDef

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)
  1. See VoiceSettingsTypeDef
  2. See BotLocaleStatusType
  3. See GenerativeAISettingsTypeDef
  4. See ResponseMetadataTypeDef

FulfillmentStartResponseSpecificationTypeDef#

# FulfillmentStartResponseSpecificationTypeDef definition

class FulfillmentStartResponseSpecificationTypeDef(TypedDict):
    delayInSeconds: int,
    messageGroups: Sequence[MessageGroupTypeDef],  # (1)
    allowInterrupt: NotRequired[bool],
  1. See MessageGroupTypeDef

FulfillmentUpdateResponseSpecificationTypeDef#

# FulfillmentUpdateResponseSpecificationTypeDef definition

class FulfillmentUpdateResponseSpecificationTypeDef(TypedDict):
    frequencyInSeconds: int,
    messageGroups: Sequence[MessageGroupTypeDef],  # (1)
    allowInterrupt: NotRequired[bool],
  1. See MessageGroupTypeDef

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)
  1. See MessageGroupTypeDef
  2. See MessageSelectionStrategyType
  3. See PromptAttemptType PromptAttemptSpecificationTypeDef

ResponseSpecificationTypeDef#

# ResponseSpecificationTypeDef definition

class ResponseSpecificationTypeDef(TypedDict):
    messageGroups: Sequence[MessageGroupTypeDef],  # (1)
    allowInterrupt: NotRequired[bool],
  1. See MessageGroupTypeDef

StillWaitingResponseSpecificationTypeDef#

# StillWaitingResponseSpecificationTypeDef definition

class StillWaitingResponseSpecificationTypeDef(TypedDict):
    messageGroups: Sequence[MessageGroupTypeDef],  # (1)
    frequencyInSeconds: int,
    timeoutInSeconds: int,
    allowInterrupt: NotRequired[bool],
  1. See MessageGroupTypeDef

ListUtteranceAnalyticsDataResponseTypeDef#

# ListUtteranceAnalyticsDataResponseTypeDef definition

class ListUtteranceAnalyticsDataResponseTypeDef(TypedDict):
    botId: str,
    nextToken: str,
    utterances: List[UtteranceSpecificationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UtteranceSpecificationTypeDef
  2. See ResponseMetadataTypeDef

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]],
  1. See BotAliasLocaleSettingsTypeDef
  2. See ConversationLogSettingsTypeDef
  3. 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)
  1. See BotAliasLocaleSettingsTypeDef
  2. See ConversationLogSettingsTypeDef
  3. See SentimentAnalysisSettingsTypeDef
  4. See BotAliasStatusType
  5. 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)
  1. See BotAliasLocaleSettingsTypeDef
  2. See ConversationLogSettingsTypeDef
  3. See SentimentAnalysisSettingsTypeDef
  4. See BotAliasHistoryEventTypeDef
  5. See BotAliasStatusType
  6. See ParentBotNetworkTypeDef
  7. 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)
  1. See BotAliasLocaleSettingsTypeDef
  2. See ConversationLogSettingsTypeDef
  3. 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)
  1. See BotAliasLocaleSettingsTypeDef
  2. See ConversationLogSettingsTypeDef
  3. See SentimentAnalysisSettingsTypeDef
  4. See BotAliasStatusType
  5. See ResponseMetadataTypeDef

TranscriptSourceSettingTypeDef#

# TranscriptSourceSettingTypeDef definition

class TranscriptSourceSettingTypeDef(TypedDict):
    s3BucketTranscriptSource: NotRequired[S3BucketTranscriptSourceTypeDef],  # (1)
  1. See S3BucketTranscriptSourceTypeDef

TestSetTurnResultTypeDef#

# TestSetTurnResultTypeDef definition

class TestSetTurnResultTypeDef(TypedDict):
    agent: NotRequired[AgentTurnResultTypeDef],  # (1)
    user: NotRequired[UserTurnResultTypeDef],  # (2)
  1. See AgentTurnResultTypeDef
  2. See UserTurnResultTypeDef

TurnSpecificationTypeDef#

# TurnSpecificationTypeDef definition

class TurnSpecificationTypeDef(TypedDict):
    agentTurn: NotRequired[AgentTurnSpecificationTypeDef],  # (1)
    userTurn: NotRequired[UserTurnSpecificationTypeDef],  # (2)
  1. See AgentTurnSpecificationTypeDef
  2. See UserTurnSpecificationTypeDef

FulfillmentUpdatesSpecificationTypeDef#

# FulfillmentUpdatesSpecificationTypeDef definition

class FulfillmentUpdatesSpecificationTypeDef(TypedDict):
    active: bool,
    startResponse: NotRequired[FulfillmentStartResponseSpecificationTypeDef],  # (1)
    updateResponse: NotRequired[FulfillmentUpdateResponseSpecificationTypeDef],  # (2)
    timeoutInSeconds: NotRequired[int],
  1. See FulfillmentStartResponseSpecificationTypeDef
  2. See FulfillmentUpdateResponseSpecificationTypeDef

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],
  1. See SlotConstraintType
  2. See PromptSpecificationTypeDef

ConditionalBranchTypeDef#

# ConditionalBranchTypeDef definition

class ConditionalBranchTypeDef(TypedDict):
    name: str,
    condition: ConditionTypeDef,  # (1)
    nextStep: DialogStateTypeDef,  # (2)
    response: NotRequired[ResponseSpecificationTypeDef],  # (3)
  1. See ConditionTypeDef
  2. See DialogStateTypeDef
  3. See ResponseSpecificationTypeDef

DefaultConditionalBranchTypeDef#

# DefaultConditionalBranchTypeDef definition

class DefaultConditionalBranchTypeDef(TypedDict):
    nextStep: NotRequired[DialogStateTypeDef],  # (1)
    response: NotRequired[ResponseSpecificationTypeDef],  # (2)
  1. See DialogStateTypeDef
  2. See ResponseSpecificationTypeDef

WaitAndContinueSpecificationTypeDef#

# WaitAndContinueSpecificationTypeDef definition

class WaitAndContinueSpecificationTypeDef(TypedDict):
    waitingResponse: ResponseSpecificationTypeDef,  # (1)
    continueResponse: ResponseSpecificationTypeDef,  # (1)
    stillWaitingResponse: NotRequired[StillWaitingResponseSpecificationTypeDef],  # (3)
    active: NotRequired[bool],
  1. See ResponseSpecificationTypeDef
  2. See ResponseSpecificationTypeDef
  3. 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)
  1. See BotRecommendationStatusType
  2. See TranscriptSourceSettingTypeDef
  3. See EncryptionSettingTypeDef
  4. See BotRecommendationResultsTypeDef
  5. See ResponseMetadataTypeDef

StartBotRecommendationRequestRequestTypeDef#

# StartBotRecommendationRequestRequestTypeDef definition

class StartBotRecommendationRequestRequestTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    transcriptSourceSetting: TranscriptSourceSettingTypeDef,  # (1)
    encryptionSetting: NotRequired[EncryptionSettingTypeDef],  # (2)
  1. See TranscriptSourceSettingTypeDef
  2. See EncryptionSettingTypeDef

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)
  1. See BotRecommendationStatusType
  2. See TranscriptSourceSettingTypeDef
  3. See EncryptionSettingTypeDef
  4. 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)
  1. See BotRecommendationStatusType
  2. See TranscriptSourceSettingTypeDef
  3. See EncryptionSettingTypeDef
  4. See ResponseMetadataTypeDef

UtteranceLevelTestResultItemTypeDef#

# UtteranceLevelTestResultItemTypeDef definition

class UtteranceLevelTestResultItemTypeDef(TypedDict):
    recordNumber: int,
    turnResult: TestSetTurnResultTypeDef,  # (1)
    conversationId: NotRequired[str],
  1. See TestSetTurnResultTypeDef

TestSetTurnRecordTypeDef#

# TestSetTurnRecordTypeDef definition

class TestSetTurnRecordTypeDef(TypedDict):
    recordNumber: int,
    turnSpecification: TurnSpecificationTypeDef,  # (1)
    conversationId: NotRequired[str],
    turnNumber: NotRequired[int],
  1. See TurnSpecificationTypeDef

ListSlotsResponseTypeDef#

# ListSlotsResponseTypeDef definition

class ListSlotsResponseTypeDef(TypedDict):
    botId: str,
    botVersion: str,
    localeId: str,
    intentId: str,
    slotSummaries: List[SlotSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SlotSummaryTypeDef
  2. See ResponseMetadataTypeDef

ConditionalSpecificationTypeDef#

# ConditionalSpecificationTypeDef definition

class ConditionalSpecificationTypeDef(TypedDict):
    active: bool,
    conditionalBranches: Sequence[ConditionalBranchTypeDef],  # (1)
    defaultBranch: DefaultConditionalBranchTypeDef,  # (2)
  1. See ConditionalBranchTypeDef
  2. See DefaultConditionalBranchTypeDef

SubSlotValueElicitationSettingTypeDef#

# SubSlotValueElicitationSettingTypeDef definition

class SubSlotValueElicitationSettingTypeDef(TypedDict):
    promptSpecification: PromptSpecificationTypeDef,  # (2)
    defaultValueSpecification: NotRequired[SlotDefaultValueSpecificationTypeDef],  # (1)
    sampleUtterances: NotRequired[Sequence[SampleUtteranceTypeDef]],  # (3)
    waitAndContinueSpecification: NotRequired[WaitAndContinueSpecificationTypeDef],  # (4)
  1. See SlotDefaultValueSpecificationTypeDef
  2. See PromptSpecificationTypeDef
  3. See SampleUtteranceTypeDef
  4. See WaitAndContinueSpecificationTypeDef

UtteranceLevelTestResultsTypeDef#

# UtteranceLevelTestResultsTypeDef definition

class UtteranceLevelTestResultsTypeDef(TypedDict):
    items: List[UtteranceLevelTestResultItemTypeDef],  # (1)
  1. See UtteranceLevelTestResultItemTypeDef

ListTestSetRecordsResponseTypeDef#

# ListTestSetRecordsResponseTypeDef definition

class ListTestSetRecordsResponseTypeDef(TypedDict):
    testSetRecords: List[TestSetTurnRecordTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TestSetTurnRecordTypeDef
  2. See ResponseMetadataTypeDef

IntentClosingSettingTypeDef#

# IntentClosingSettingTypeDef definition

class IntentClosingSettingTypeDef(TypedDict):
    closingResponse: NotRequired[ResponseSpecificationTypeDef],  # (1)
    active: NotRequired[bool],
    nextStep: NotRequired[DialogStateTypeDef],  # (2)
    conditional: NotRequired[ConditionalSpecificationTypeDef],  # (3)
  1. See ResponseSpecificationTypeDef
  2. See DialogStateTypeDef
  3. See ConditionalSpecificationTypeDef

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)
  1. See ResponseSpecificationTypeDef
  2. See DialogStateTypeDef
  3. See ConditionalSpecificationTypeDef
  4. See ResponseSpecificationTypeDef
  5. See DialogStateTypeDef
  6. See ConditionalSpecificationTypeDef
  7. See ResponseSpecificationTypeDef
  8. See DialogStateTypeDef
  9. 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)
  1. See ResponseSpecificationTypeDef
  2. See ResponseSpecificationTypeDef
  3. See ResponseSpecificationTypeDef
  4. See DialogStateTypeDef
  5. See ConditionalSpecificationTypeDef
  6. See DialogStateTypeDef
  7. See ConditionalSpecificationTypeDef
  8. See DialogStateTypeDef
  9. See ConditionalSpecificationTypeDef

SpecificationsTypeDef#

# SpecificationsTypeDef definition

class SpecificationsTypeDef(TypedDict):
    slotTypeId: str,
    valueElicitationSetting: SubSlotValueElicitationSettingTypeDef,  # (1)
  1. See SubSlotValueElicitationSettingTypeDef

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)
  1. See OverallTestResultsTypeDef
  2. See ConversationLevelTestResultsTypeDef
  3. See IntentClassificationTestResultsTypeDef
  4. See IntentLevelSlotResolutionTestResultsTypeDef
  5. See UtteranceLevelTestResultsTypeDef

DialogCodeHookInvocationSettingTypeDef#

# DialogCodeHookInvocationSettingTypeDef definition

class DialogCodeHookInvocationSettingTypeDef(TypedDict):
    enableCodeHookInvocation: bool,
    active: bool,
    postCodeHookSpecification: PostDialogCodeHookInvocationSpecificationTypeDef,  # (1)
    invocationLabel: NotRequired[str],
  1. See PostDialogCodeHookInvocationSpecificationTypeDef

FulfillmentCodeHookSettingsTypeDef#

# FulfillmentCodeHookSettingsTypeDef definition

class FulfillmentCodeHookSettingsTypeDef(TypedDict):
    enabled: bool,
    postFulfillmentStatusSpecification: NotRequired[PostFulfillmentStatusSpecificationTypeDef],  # (1)
    fulfillmentUpdatesSpecification: NotRequired[FulfillmentUpdatesSpecificationTypeDef],  # (2)
    active: NotRequired[bool],
  1. See PostFulfillmentStatusSpecificationTypeDef
  2. See FulfillmentUpdatesSpecificationTypeDef

SubSlotSettingTypeDef#

# SubSlotSettingTypeDef definition

class SubSlotSettingTypeDef(TypedDict):
    expression: NotRequired[str],
    slotSpecifications: NotRequired[Mapping[str, SpecificationsTypeDef]],  # (1)
  1. See SpecificationsTypeDef

ListTestExecutionResultItemsResponseTypeDef#

# ListTestExecutionResultItemsResponseTypeDef definition

class ListTestExecutionResultItemsResponseTypeDef(TypedDict):
    testExecutionResults: TestExecutionResultItemsTypeDef,  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TestExecutionResultItemsTypeDef
  2. See ResponseMetadataTypeDef

InitialResponseSettingTypeDef#

# InitialResponseSettingTypeDef definition

class InitialResponseSettingTypeDef(TypedDict):
    initialResponse: NotRequired[ResponseSpecificationTypeDef],  # (1)
    nextStep: NotRequired[DialogStateTypeDef],  # (2)
    conditional: NotRequired[ConditionalSpecificationTypeDef],  # (3)
    codeHook: NotRequired[DialogCodeHookInvocationSettingTypeDef],  # (4)
  1. See ResponseSpecificationTypeDef
  2. See DialogStateTypeDef
  3. See ConditionalSpecificationTypeDef
  4. 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)
  1. See PromptSpecificationTypeDef
  2. See ResponseSpecificationTypeDef
  3. See ResponseSpecificationTypeDef
  4. See DialogStateTypeDef
  5. See ConditionalSpecificationTypeDef
  6. See DialogStateTypeDef
  7. See ConditionalSpecificationTypeDef
  8. See ResponseSpecificationTypeDef
  9. See DialogStateTypeDef
  10. See ConditionalSpecificationTypeDef
  11. See DialogCodeHookInvocationSettingTypeDef
  12. 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)
  1. See ResponseSpecificationTypeDef
  2. See DialogStateTypeDef
  3. See ConditionalSpecificationTypeDef
  4. See ResponseSpecificationTypeDef
  5. See DialogStateTypeDef
  6. See ConditionalSpecificationTypeDef
  7. See DialogCodeHookInvocationSettingTypeDef
  8. 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)
    qnAIntentConfiguration: NotRequired[QnAIntentConfigurationTypeDef],  # (10)
  1. See SampleUtteranceTypeDef
  2. See DialogCodeHookSettingsTypeDef
  3. See FulfillmentCodeHookSettingsTypeDef
  4. See IntentConfirmationSettingTypeDef
  5. See IntentClosingSettingTypeDef
  6. See InputContextTypeDef
  7. See OutputContextTypeDef
  8. See KendraConfigurationTypeDef
  9. See InitialResponseSettingTypeDef
  10. See QnAIntentConfigurationTypeDef

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)
    qnAIntentConfiguration: QnAIntentConfigurationTypeDef,  # (10)
    ResponseMetadata: ResponseMetadataTypeDef,  # (11)
  1. See SampleUtteranceTypeDef
  2. See DialogCodeHookSettingsTypeDef
  3. See FulfillmentCodeHookSettingsTypeDef
  4. See IntentConfirmationSettingTypeDef
  5. See IntentClosingSettingTypeDef
  6. See InputContextTypeDef
  7. See OutputContextTypeDef
  8. See KendraConfigurationTypeDef
  9. See InitialResponseSettingTypeDef
  10. See QnAIntentConfigurationTypeDef
  11. 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)
    qnAIntentConfiguration: QnAIntentConfigurationTypeDef,  # (11)
    ResponseMetadata: ResponseMetadataTypeDef,  # (12)
  1. See SampleUtteranceTypeDef
  2. See DialogCodeHookSettingsTypeDef
  3. See FulfillmentCodeHookSettingsTypeDef
  4. See SlotPriorityTypeDef
  5. See IntentConfirmationSettingTypeDef
  6. See IntentClosingSettingTypeDef
  7. See InputContextTypeDef
  8. See OutputContextTypeDef
  9. See KendraConfigurationTypeDef
  10. See InitialResponseSettingTypeDef
  11. See QnAIntentConfigurationTypeDef
  12. 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)
    qnAIntentConfiguration: NotRequired[QnAIntentConfigurationTypeDef],  # (11)
  1. See SampleUtteranceTypeDef
  2. See DialogCodeHookSettingsTypeDef
  3. See FulfillmentCodeHookSettingsTypeDef
  4. See SlotPriorityTypeDef
  5. See IntentConfirmationSettingTypeDef
  6. See IntentClosingSettingTypeDef
  7. See InputContextTypeDef
  8. See OutputContextTypeDef
  9. See KendraConfigurationTypeDef
  10. See InitialResponseSettingTypeDef
  11. See QnAIntentConfigurationTypeDef

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)
    qnAIntentConfiguration: QnAIntentConfigurationTypeDef,  # (11)
    ResponseMetadata: ResponseMetadataTypeDef,  # (12)
  1. See SampleUtteranceTypeDef
  2. See DialogCodeHookSettingsTypeDef
  3. See FulfillmentCodeHookSettingsTypeDef
  4. See SlotPriorityTypeDef
  5. See IntentConfirmationSettingTypeDef
  6. See IntentClosingSettingTypeDef
  7. See InputContextTypeDef
  8. See OutputContextTypeDef
  9. See KendraConfigurationTypeDef
  10. See InitialResponseSettingTypeDef
  11. See QnAIntentConfigurationTypeDef
  12. 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)
  1. See SlotDefaultValueSpecificationTypeDef
  2. See SlotConstraintType
  3. See PromptSpecificationTypeDef
  4. See SampleUtteranceTypeDef
  5. See WaitAndContinueSpecificationTypeDef
  6. See SlotCaptureSettingTypeDef
  7. 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)
  1. See SlotValueElicitationSettingTypeDef
  2. See ObfuscationSettingTypeDef
  3. See MultipleValuesSettingTypeDef
  4. 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)
  1. See SlotValueElicitationSettingTypeDef
  2. See ObfuscationSettingTypeDef
  3. See MultipleValuesSettingTypeDef
  4. See SubSlotSettingTypeDef
  5. 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)
  1. See SlotValueElicitationSettingTypeDef
  2. See ObfuscationSettingTypeDef
  3. See MultipleValuesSettingTypeDef
  4. See SubSlotSettingTypeDef
  5. 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)
  1. See SlotValueElicitationSettingTypeDef
  2. See ObfuscationSettingTypeDef
  3. See MultipleValuesSettingTypeDef
  4. 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)
  1. See SlotValueElicitationSettingTypeDef
  2. See ObfuscationSettingTypeDef
  3. See MultipleValuesSettingTypeDef
  4. See SubSlotSettingTypeDef
  5. See ResponseMetadataTypeDef