Package-level declarations

Types

Link copied to clipboard
data class BotAdvancedRecognitionSetting(val audioRecognitionStrategy: BotAudioRecognitionStrategy? = null)
Link copied to clipboard

The location of audio log files collected when conversation logging is enabled for a bot.

Link copied to clipboard
data class BotAliasAudioLogSetting(val destination: BotAliasAudioLogDestination, val enabled: Boolean)

Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.

Link copied to clipboard
data class BotAliasCloudWatchLogGroupLogDestination(val cloudWatchLogGroupArn: String, val logPrefix: String)
Link copied to clipboard

Contains information about code hooks that Amazon Lex calls during a conversation.

Link copied to clipboard
data class BotAliasConversationLogSettings(val audioLogSettings: List<BotAliasAudioLogSetting>? = null, val textLogSettings: List<BotAliasTextLogSetting>? = null)

Contains information about code hooks that Amazon Lex calls during a conversation.

Link copied to clipboard
data class BotAliasLambdaCodeHook(val codeHookInterfaceVersion: String, val lambdaArn: String)

Contains information about code hooks that Amazon Lex calls during a conversation.

Link copied to clipboard
data class BotAliasLocaleSettings(val codeHookSpecification: BotAliasCodeHookSpecification? = null, val enabled: Boolean)

You can use this parameter to specify a specific Lambda function to run different functions in different locales.

Link copied to clipboard
data class BotAliasLocaleSettingsItem(val botAliasLocaleSetting: BotAliasLocaleSettings, val localeId: String)

A locale setting in alias

Link copied to clipboard
data class BotAliasS3BucketLogDestination(val kmsKeyArn: String? = null, val logPrefix: String, val s3BucketArn: String)

Specifies an Amazon S3 bucket for logging audio conversations

Link copied to clipboard
data class BotAliasTag(val key: String, val value: String)

A label for tagging Lex resources

Link copied to clipboard

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

Link copied to clipboard
data class BotAliasTextLogSetting(val destination: BotAliasTextLogDestination, val enabled: Boolean)

Contains information about code hooks that Amazon Lex calls during a conversation.

Link copied to clipboard
data class BotAllowedInputTypes(val allowAudioInput: Boolean, val allowDtmfInput: Boolean)
Link copied to clipboard
data class BotAudioAndDtmfInputSpecification(val audioSpecification: BotAudioSpecification? = null, val dtmfSpecification: BotDtmfSpecification? = null, val startTimeoutMs: Int)
Link copied to clipboard
Link copied to clipboard
data class BotAudioLogSetting(val destination: BotAudioLogDestination, val enabled: Boolean)
Link copied to clipboard
data class BotAudioSpecification(val endTimeoutMs: Int, val maxLengthMs: Int)
data class BotBedrockAgentIntentConfigurationBedrockAgentConfigurationProperties(val bedrockAgentAliasId: String? = null, val bedrockAgentId: String? = null)
Link copied to clipboard
data class BotBedrockModelSpecification(val bedrockGuardrailConfiguration: BotBedrockModelSpecificationBedrockGuardrailConfigurationProperties? = null, val bedrockModelCustomPrompt: String? = null, val bedrockTraceStatus: BotBedrockModelSpecificationBedrockTraceStatus? = null, val modelArn: String)
data class BotBedrockModelSpecificationBedrockGuardrailConfigurationProperties(val bedrockGuardrailIdentifier: String? = null, val bedrockGuardrailVersion: String? = null)
Link copied to clipboard
data class BotButton(val text: String, val value: String)
Link copied to clipboard
data class BotCloudWatchLogGroupLogDestination(val cloudWatchLogGroupArn: String, val logPrefix: String)
Link copied to clipboard
Link copied to clipboard
data class BotCondition(val expressionString: String)
Link copied to clipboard
data class BotConditionalBranch(val condition: BotCondition, val name: String, val nextStep: BotDialogState, val response: BotResponseSpecification? = null)
Link copied to clipboard
data class BotConditionalSpecification(val conditionalBranches: List<BotConditionalBranch>, val defaultBranch: BotDefaultConditionalBranch, val isActive: Boolean)
Link copied to clipboard
data class BotConversationLogSettings(val audioLogSettings: List<BotAudioLogSetting>? = null, val textLogSettings: List<BotTextLogSetting>? = null)
Link copied to clipboard
data class BotCustomPayload(val value: String)
Link copied to clipboard
data class BotCustomVocabulary(val customVocabularyItems: List<BotCustomVocabularyItem>)
Link copied to clipboard
data class BotCustomVocabularyItem(val displayAs: String? = null, val phrase: String, val weight: Int? = null)
Link copied to clipboard
data class BotDefaultConditionalBranch(val nextStep: BotDialogState? = null, val response: BotResponseSpecification? = null)
Link copied to clipboard
data class BotDialogAction(val slotToElicit: String? = null, val suppressNextMessage: Boolean? = null, val type: BotDialogActionType)
Link copied to clipboard
data class BotDialogCodeHookInvocationSetting(val enableCodeHookInvocation: Boolean, val invocationLabel: String? = null, val isActive: Boolean, val postCodeHookSpecification: BotPostDialogCodeHookInvocationSpecification)
Link copied to clipboard
data class BotDialogCodeHookSetting(val enabled: Boolean)
Link copied to clipboard
data class BotDialogState(val dialogAction: BotDialogAction? = null, val intent: BotIntentOverride? = null, val sessionAttributes: List<BotSessionAttribute>? = null)
Link copied to clipboard
data class BotDtmfSpecification(val deletionCharacter: String, val endCharacter: String, val endTimeoutMs: Int, val maxLength: Int)
Link copied to clipboard
data class BotElicitationCodeHookInvocationSetting(val enableCodeHookInvocation: Boolean, val invocationLabel: String? = null)
Link copied to clipboard
data class BotExternalSourceSetting(val grammarSlotTypeSetting: BotGrammarSlotTypeSetting? = null)
Link copied to clipboard
data class BotFulfillmentCodeHookSetting(val enabled: Boolean, val fulfillmentUpdatesSpecification: BotFulfillmentUpdatesSpecification? = null, val isActive: Boolean? = null, val postFulfillmentStatusSpecification: BotPostFulfillmentStatusSpecification? = null)
Link copied to clipboard
data class BotFulfillmentStartResponseSpecification(val allowInterrupt: Boolean? = null, val delayInSeconds: Int, val messageGroups: List<BotMessageGroup>)
data class BotFulfillmentUpdateResponseSpecification(val allowInterrupt: Boolean? = null, val frequencyInSeconds: Int, val messageGroups: List<BotMessageGroup>)
Link copied to clipboard
data class BotFulfillmentUpdatesSpecification(val active: Boolean, val startResponse: BotFulfillmentStartResponseSpecification? = null, val timeoutInSeconds: Int? = null, val updateResponse: BotFulfillmentUpdateResponseSpecification? = null)
Link copied to clipboard
data class BotGrammarSlotTypeSetting(val source: BotGrammarSlotTypeSource? = null)
Link copied to clipboard
data class BotGrammarSlotTypeSource(val kmsKeyArn: String? = null, val s3BucketName: String, val s3ObjectKey: String)
Link copied to clipboard
data class BotImageResponseCard(val buttons: List<BotButton>? = null, val imageUrl: String? = null, val subtitle: String? = null, val title: String)
Link copied to clipboard
data class BotInitialResponseSetting(val codeHook: BotDialogCodeHookInvocationSetting? = null, val conditional: BotConditionalSpecification? = null, val initialResponse: BotResponseSpecification? = null, val nextStep: BotDialogState? = null)
Link copied to clipboard
data class BotInputContext(val name: String)
Link copied to clipboard
data class BotIntent(val bedrockAgentIntentConfiguration: BotBedrockAgentIntentConfiguration? = null, val description: String? = null, val dialogCodeHook: BotDialogCodeHookSetting? = null, val fulfillmentCodeHook: BotFulfillmentCodeHookSetting? = null, val initialResponseSetting: BotInitialResponseSetting? = null, val inputContexts: List<BotInputContext>? = null, val intentClosingSetting: BotIntentClosingSetting? = null, val intentConfirmationSetting: BotIntentConfirmationSetting? = null, val kendraConfiguration: BotKendraConfiguration? = null, val name: String, val outputContexts: List<BotOutputContext>? = null, val parentIntentSignature: String? = null, val qInConnectIntentConfiguration: BotQInConnectIntentConfiguration? = null, val qnAIntentConfiguration: BotQnAIntentConfiguration? = null, val sampleUtterances: List<BotSampleUtterance>? = null, val slotPriorities: List<BotSlotPriority>? = null, val slots: List<BotSlot>? = null)
Link copied to clipboard
data class BotIntentClosingSetting(val closingResponse: BotResponseSpecification? = null, val conditional: BotConditionalSpecification? = null, val isActive: Boolean? = null, val nextStep: BotDialogState? = null)
Link copied to clipboard
data class BotIntentConfirmationSetting(val codeHook: BotDialogCodeHookInvocationSetting? = null, val confirmationConditional: BotConditionalSpecification? = null, val confirmationNextStep: BotDialogState? = null, val confirmationResponse: BotResponseSpecification? = null, val declinationConditional: BotConditionalSpecification? = null, val declinationNextStep: BotDialogState? = null, val declinationResponse: BotResponseSpecification? = null, val elicitationCodeHook: BotElicitationCodeHookInvocationSetting? = null, val failureConditional: BotConditionalSpecification? = null, val failureNextStep: BotDialogState? = null, val failureResponse: BotResponseSpecification? = null, val isActive: Boolean? = null, val promptSpecification: BotPromptSpecification)
Link copied to clipboard
data class BotIntentOverride(val name: String? = null, val slots: List<BotSlotValueOverrideMap>? = null)
Link copied to clipboard
data class BotKendraConfiguration(val kendraIndex: String, val queryFilterString: String? = null, val queryFilterStringEnabled: Boolean? = null)
Link copied to clipboard
data class BotLocale(val customVocabulary: BotCustomVocabulary? = null, val description: String? = null, val intents: List<BotIntent>? = null, val localeId: String, val nluConfidenceThreshold: Double, val slotTypes: List<BotSlotType>? = null, val voiceSettings: BotVoiceSettings? = null)
Link copied to clipboard
data class BotMessage(val customPayload: BotCustomPayload? = null, val imageResponseCard: BotImageResponseCard? = null, val plainTextMessage: BotPlainTextMessage? = null, val ssmlMessage: BotSsmlMessage? = null)
Link copied to clipboard
data class BotMessageGroup(val message: BotMessage, val variations: List<BotMessage>? = null)
Link copied to clipboard
data class BotMultipleValuesSetting(val allowMultipleValues: Boolean? = null)
Link copied to clipboard
Link copied to clipboard
data class BotOutputContext(val name: String, val timeToLiveInSeconds: Int, val turnsToLive: Int)
Link copied to clipboard
data class BotPlainTextMessage(val value: String)
data class BotPostDialogCodeHookInvocationSpecification(val failureConditional: BotConditionalSpecification? = null, val failureNextStep: BotDialogState? = null, val failureResponse: BotResponseSpecification? = null, val successConditional: BotConditionalSpecification? = null, val successNextStep: BotDialogState? = null, val successResponse: BotResponseSpecification? = null, val timeoutConditional: BotConditionalSpecification? = null, val timeoutNextStep: BotDialogState? = null, val timeoutResponse: BotResponseSpecification? = null)
Link copied to clipboard
data class BotPostFulfillmentStatusSpecification(val failureConditional: BotConditionalSpecification? = null, val failureNextStep: BotDialogState? = null, val failureResponse: BotResponseSpecification? = null, val successConditional: BotConditionalSpecification? = null, val successNextStep: BotDialogState? = null, val successResponse: BotResponseSpecification? = null, val timeoutConditional: BotConditionalSpecification? = null, val timeoutNextStep: BotDialogState? = null, val timeoutResponse: BotResponseSpecification? = null)
Link copied to clipboard
data class BotPromptAttemptSpecification(val allowInterrupt: Boolean? = null, val allowedInputTypes: BotAllowedInputTypes, val audioAndDtmfInputSpecification: BotAudioAndDtmfInputSpecification? = null, val textInputSpecification: BotTextInputSpecification? = null)
Link copied to clipboard
data class BotPromptSpecification(val allowInterrupt: Boolean? = null, val maxRetries: Int, val messageGroupsList: List<BotMessageGroup>, val messageSelectionStrategy: BotMessageSelectionStrategy? = null, val promptAttemptsSpecification: Map<String, BotPromptAttemptSpecification>? = null)
Link copied to clipboard
data class BotQnAIntentConfiguration(val bedrockModelConfiguration: BotBedrockModelSpecification, val dataSourceConfiguration: BotQnAIntentConfigurationDataSourceConfigurationProperties)

Contains details about the configuration of the data source used for the AMAZON.QnAIntent .

Link copied to clipboard
data class BotQnAKendraConfiguration(val exactResponse: Boolean, val kendraIndex: String, val queryFilterString: String? = null, val queryFilterStringEnabled: Boolean)
Link copied to clipboard
data class BotReplication(val replicaRegions: List<String>)
Link copied to clipboard
data class BotResponseSpecification(val allowInterrupt: Boolean? = null, val messageGroupsList: List<BotMessageGroup>)
Link copied to clipboard
data class BotS3BucketLogDestination(val kmsKeyArn: String? = null, val logPrefix: String, val s3BucketArn: String)
Link copied to clipboard
data class BotS3Location(val s3Bucket: String, val s3ObjectKey: String, val s3ObjectVersion: String? = null)
Link copied to clipboard
data class BotSampleUtterance(val utterance: String)
Link copied to clipboard
data class BotSampleValue(val value: String)
Link copied to clipboard
data class BotSessionAttribute(val key: String, val value: String? = null)
Link copied to clipboard
data class BotSlot(val description: String? = null, val multipleValuesSetting: BotMultipleValuesSetting? = null, val name: String, val obfuscationSetting: BotObfuscationSetting? = null, val slotTypeName: String, val valueElicitationSetting: BotSlotValueElicitationSetting)
Link copied to clipboard
data class BotSlotCaptureSetting(val captureConditional: BotConditionalSpecification? = null, val captureNextStep: BotDialogState? = null, val captureResponse: BotResponseSpecification? = null, val codeHook: BotDialogCodeHookInvocationSetting? = null, val elicitationCodeHook: BotElicitationCodeHookInvocationSetting? = null, val failureConditional: BotConditionalSpecification? = null, val failureNextStep: BotDialogState? = null, val failureResponse: BotResponseSpecification? = null)
Link copied to clipboard
data class BotSlotDefaultValue(val defaultValue: String)
Link copied to clipboard
data class BotSlotDefaultValueSpecification(val defaultValueList: List<BotSlotDefaultValue>)
Link copied to clipboard
data class BotSlotPriority(val priority: Int, val slotName: String)
Link copied to clipboard
data class BotSlotType(val compositeSlotTypeSetting: BotCompositeSlotTypeSetting? = null, val description: String? = null, val externalSourceSetting: BotExternalSourceSetting? = null, val name: String, val parentSlotTypeSignature: String? = null, val slotTypeValues: List<BotSlotTypeValue>? = null, val valueSelectionSetting: BotSlotValueSelectionSetting? = null)
Link copied to clipboard
data class BotSlotTypeValue(val sampleValue: BotSampleValue, val synonyms: List<BotSampleValue>? = null)
Link copied to clipboard
data class BotSlotValue(val interpretedValue: String? = null)
Link copied to clipboard
data class BotSlotValueElicitationSetting(val defaultValueSpecification: BotSlotDefaultValueSpecification? = null, val promptSpecification: BotPromptSpecification? = null, val sampleUtterances: List<BotSampleUtterance>? = null, val slotCaptureSetting: BotSlotCaptureSetting? = null, val slotConstraint: BotSlotConstraint, val waitAndContinueSpecification: BotWaitAndContinueSpecification? = null)
Link copied to clipboard
data class BotSlotValueOverride(val shape: BotSlotShape? = null, val value: BotSlotValue? = null, val values: List<BotSlotValueOverride>? = null)
Link copied to clipboard
data class BotSlotValueOverrideMap(val slotName: String? = null, val slotValueOverride: BotSlotValueOverride? = null)
Link copied to clipboard
data class BotSlotValueRegexFilter(val pattern: String)
Link copied to clipboard
data class BotSlotValueSelectionSetting(val advancedRecognitionSetting: BotAdvancedRecognitionSetting? = null, val regexFilter: BotSlotValueRegexFilter? = null, val resolutionStrategy: BotSlotValueResolutionStrategy)
Link copied to clipboard
data class BotSsmlMessage(val value: String)
Link copied to clipboard
data class BotStillWaitingResponseSpecification(val allowInterrupt: Boolean? = null, val frequencyInSeconds: Int, val messageGroupsList: List<BotMessageGroup>, val timeoutInSeconds: Int)
Link copied to clipboard
data class BotSubSlotTypeComposition(val name: String, val slotTypeId: String)
Link copied to clipboard
data class BotTag(val key: String, val value: String)
Link copied to clipboard
data class BotTestBotAliasSettings(val botAliasLocaleSettings: List<BotAliasLocaleSettingsItem>? = null, val conversationLogSettings: BotConversationLogSettings? = null, val description: String? = null, val sentimentAnalysisSettings: BotTestBotAliasSettingsSentimentAnalysisSettingsProperties? = null)

Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

Link copied to clipboard
data class BotTextInputSpecification(val startTimeoutMs: Int)
Link copied to clipboard
Link copied to clipboard
data class BotTextLogSetting(val destination: BotTextLogDestination, val enabled: Boolean)
Link copied to clipboard
data class BotVersionLocaleDetails(val sourceBotVersion: String)

The version of a bot used for a bot locale.

Link copied to clipboard
data class BotVersionLocaleSpecification(val botVersionLocaleDetails: BotVersionLocaleDetails, val localeId: String)
Link copied to clipboard
data class BotVoiceSettings(val engine: BotVoiceSettingsEngine? = null, val voiceId: String)
Link copied to clipboard
data class BotWaitAndContinueSpecification(val continueResponse: BotResponseSpecification, val isActive: Boolean? = null, val stillWaitingResponse: BotStillWaitingResponseSpecification? = null, val waitingResponse: BotResponseSpecification)
Link copied to clipboard
data class DataPrivacyProperties(val childDirected: Boolean)

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

Link copied to clipboard
data class GetBotAliasResult(val arn: String? = null, val botAliasId: String? = null, val botAliasLocaleSettings: List<BotAliasLocaleSettingsItem>? = null, val botAliasName: String? = null, val botAliasStatus: BotAliasStatus? = null, val botVersion: String? = null, val conversationLogSettings: BotAliasConversationLogSettings? = null, val description: String? = null, val sentimentAnalysisSettings: SentimentAnalysisSettingsProperties? = null)
Link copied to clipboard
data class GetBotResult(val arn: String? = null, val dataPrivacy: DataPrivacyProperties? = null, val description: String? = null, val id: String? = null, val idleSessionTtlInSeconds: Int? = null, val name: String? = null, val roleArn: String? = null, val testBotAliasSettings: BotTestBotAliasSettings? = null)
Link copied to clipboard
data class GetBotVersionResult(val botVersion: String? = null, val description: String? = null)
Link copied to clipboard
data class GetResourcePolicyResult(val id: String? = null, val policy: ResourcePolicyPolicy? = null, val resourceArn: String? = null, val revisionId: String? = null)
Link copied to clipboard

A resource policy to add to the resource. The policy is a JSON structure following the IAM syntax that contains one or more statements that define the policy.

Link copied to clipboard
data class SentimentAnalysisSettingsProperties(val detectSentiment: Boolean)

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.