pulumi-aws-native-kotlin/com.pulumi.awsnative.lex.kotlin.outputs

Package-level declarations

Types

BotAdvancedRecognitionSetting

data class BotAdvancedRecognitionSetting(val audioRecognitionStrategy: BotAudioRecognitionStrategy? = null)

Provides settings that enable advanced recognition settings for slot values.

BotAliasAudioLogDestination

data class BotAliasAudioLogDestination(val s3Bucket: BotAliasS3BucketLogDestination)

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

BotAliasAudioLogSetting

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.

BotAliasCloudWatchLogGroupLogDestination

data class BotAliasCloudWatchLogGroupLogDestination(val cloudWatchLogGroupArn: String, val logPrefix: String)

BotAliasCodeHookSpecification

data class BotAliasCodeHookSpecification(val lambdaCodeHook: BotAliasLambdaCodeHook)

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

BotAliasConversationLogSettings

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.

BotAliasLambdaCodeHook

data class BotAliasLambdaCodeHook(val codeHookInterfaceVersion: String, val lambdaArn: String)

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

BotAliasLocaleSettings

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.

BotAliasLocaleSettingsItem

data class BotAliasLocaleSettingsItem(val botAliasLocaleSetting: BotAliasLocaleSettings, val localeId: String)

A locale setting in alias

BotAliasS3BucketLogDestination

data class BotAliasS3BucketLogDestination(val kmsKeyArn: String? = null, val logPrefix: String, val s3BucketArn: String)

Specifies an Amazon S3 bucket for logging audio conversations

BotAliasTag

data class BotAliasTag(val key: String, val value: String)

A label for tagging Lex resources

BotAliasTextLogDestination

data class BotAliasTextLogDestination(val cloudWatch: BotAliasCloudWatchLogGroupLogDestination)

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

BotAliasTextLogSetting

data class BotAliasTextLogSetting(val destination: BotAliasTextLogDestination, val enabled: Boolean)

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

BotAllowedInputTypes

data class BotAllowedInputTypes(val allowAudioInput: Boolean, val allowDtmfInput: Boolean)

Specifies the allowed input types.

BotAudioAndDtmfInputSpecification

data class BotAudioAndDtmfInputSpecification(val audioSpecification: BotAudioSpecification? = null, val dtmfSpecification: BotDtmfSpecification? = null, val startTimeoutMs: Int)

Specifies the audio and DTMF input specification.

BotAudioLogDestination

data class BotAudioLogDestination(val s3Bucket: BotS3BucketLogDestination)

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

BotAudioLogSetting

data class BotAudioLogSetting(val destination: BotAudioLogDestination, 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.

BotAudioSpecification

data class BotAudioSpecification(val endTimeoutMs: Int, val maxLengthMs: Int)

Specifies the audio input specifications.

BotButton

data class BotButton(val text: String, val value: String)

A button to use on a response card used to gather slot values from a user.

BotCloudWatchLogGroupLogDestination

data class BotCloudWatchLogGroupLogDestination(val cloudWatchLogGroupArn: String, val logPrefix: String)

BotCondition

data class BotCondition(val expressionString: String)

Provides an expression that evaluates to true or false.

BotConditionalBranch

data class BotConditionalBranch(val condition: BotCondition, val name: String, val nextStep: BotDialogState, val response: BotResponseSpecification? = null)

A set of actions that Amazon Lex should run if the condition is matched.

BotConditionalSpecification

data class BotConditionalSpecification(val conditionalBranches: List<BotConditionalBranch>, val defaultBranch: BotDefaultConditionalBranch, val isActive: Boolean)

Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

BotConversationLogSettings

data class BotConversationLogSettings(val audioLogSettings: List<BotAudioLogSetting>? = null, val textLogSettings: List<BotTextLogSetting>? = null)

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

BotCustomPayload

data class BotCustomPayload(val value: String)

A message in a custom format defined by the client application.

BotCustomVocabulary

data class BotCustomVocabulary(val customVocabularyItems: List<BotCustomVocabularyItem>)

A custom vocabulary is a list of specific phrases that you want Amazon Lex V2 to recognize in the audio input.

BotCustomVocabularyItem

data class BotCustomVocabularyItem(val displayAs: String? = null, val phrase: String, val weight: Int? = null)

A custom vocabulary item that contains the phrase to recognize and a weight to give the boost.

BotDefaultConditionalBranch

data class BotDefaultConditionalBranch(val nextStep: BotDialogState? = null, val response: BotResponseSpecification? = null)

A set of actions that Amazon Lex should run if none of the other conditions are met.

BotDialogAction

data class BotDialogAction(val slotToElicit: String? = null, val suppressNextMessage: Boolean? = null, val type: BotDialogActionType)

Defines the action that the bot executes at runtime when the conversation reaches this step.

BotDialogCodeHookInvocationSetting

data class BotDialogCodeHookInvocationSetting(val enableCodeHookInvocation: Boolean, val invocationLabel: String? = null, val isActive: Boolean, val postCodeHookSpecification: BotPostDialogCodeHookInvocationSpecification)

Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.

BotDialogCodeHookSetting

data class BotDialogCodeHookSetting(val enabled: Boolean)

Settings that determine the Lambda function that Amazon Lex uses for processing user responses.

BotDialogState

data class BotDialogState(val dialogAction: BotDialogAction? = null, val intent: BotIntentOverride? = null, val sessionAttributes: List<BotSessionAttribute>? = null)

The current state of the conversation with the user.

BotDtmfSpecification

data class BotDtmfSpecification(val deletionCharacter: String, val endCharacter: String, val endTimeoutMs: Int, val maxLength: Int)

Specifies the settings on DTMF input.

BotElicitationCodeHookInvocationSetting

data class BotElicitationCodeHookInvocationSetting(val enableCodeHookInvocation: Boolean, val invocationLabel: String? = null)

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

BotExternalSourceSetting

data class BotExternalSourceSetting(val grammarSlotTypeSetting: BotGrammarSlotTypeSetting? = null)

Provides information about the external source of the slot type's definition.

BotFulfillmentCodeHookSetting

data class BotFulfillmentCodeHookSetting(val enabled: Boolean, val fulfillmentUpdatesSpecification: BotFulfillmentUpdatesSpecification? = null, val isActive: Boolean? = null, val postFulfillmentStatusSpecification: BotPostFulfillmentStatusSpecification? = null)

Settings that determine if a Lambda function should be invoked to fulfill a specific intent.

BotFulfillmentStartResponseSpecification

data class BotFulfillmentStartResponseSpecification(val allowInterrupt: Boolean? = null, val delayInSeconds: Int, val messageGroups: List<BotMessageGroup>)

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

BotFulfillmentUpdateResponseSpecification

data class BotFulfillmentUpdateResponseSpecification(val allowInterrupt: Boolean? = null, val frequencyInSeconds: Int, val messageGroups: List<BotMessageGroup>)

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

BotFulfillmentUpdatesSpecification

data class BotFulfillmentUpdatesSpecification(val active: Boolean, val startResponse: BotFulfillmentStartResponseSpecification? = null, val timeoutInSeconds: Int? = null, val updateResponse: BotFulfillmentUpdateResponseSpecification? = null)

Provides information for updating the user on the progress of fulfilling an intent.

BotGrammarSlotTypeSetting

data class BotGrammarSlotTypeSetting(val source: BotGrammarSlotTypeSource? = null)

Settings required for a slot type based on a grammar that you provide.

BotGrammarSlotTypeSource

data class BotGrammarSlotTypeSource(val kmsKeyArn: String? = null, val s3BucketName: String, val s3ObjectKey: String)

Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.

BotImageResponseCard

data class BotImageResponseCard(val buttons: List<BotButton>? = null, val imageUrl: String? = null, val subtitle: String? = null, val title: String)

A message that defines a response card that the client application can show to the user.

BotInitialResponseSetting

data class BotInitialResponseSetting(val codeHook: BotDialogCodeHookInvocationSetting? = null, val conditional: BotConditionalSpecification? = null, val initialResponse: BotResponseSpecification? = null, val nextStep: BotDialogState? = null)

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

BotInputContext

data class BotInputContext(val name: String)

InputContext specified for the intent.

BotIntent

data class BotIntent(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 sampleUtterances: List<BotSampleUtterance>? = null, val slotPriorities: List<BotSlotPriority>? = null, val slots: List<BotSlot>? = null)

Represents an action that the user wants to perform.

BotIntentClosingSetting

data class BotIntentClosingSetting(val closingResponse: BotResponseSpecification? = null, val conditional: BotConditionalSpecification? = null, val isActive: Boolean? = null, val nextStep: BotDialogState? = null)

Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.

BotIntentConfirmationSetting

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)

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

BotIntentOverride

data class BotIntentOverride(val name: String? = null, val slots: List<BotSlotValueOverrideMap>? = null)

Override settings to configure the intent state.

BotKendraConfiguration

data class BotKendraConfiguration(val kendraIndex: String, val queryFilterString: String? = null, val queryFilterStringEnabled: Boolean? = null)

Configuration for searching a Amazon Kendra index specified for the intent.

BotLocale

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)

A locale in the bot, which contains the intents and slot types that the bot uses in conversations with users in the specified language and locale.

BotMessage

data class BotMessage(val customPayload: BotCustomPayload? = null, val imageResponseCard: BotImageResponseCard? = null, val plainTextMessage: BotPlainTextMessage? = null, val ssmlMessage: BotSsmlMessage? = null)

The primary message that Amazon Lex should send to the user.

BotMessageGroup

data class BotMessageGroup(val message: BotMessage, val variations: List<BotMessage>? = null)

One or more messages that Amazon Lex can send to the user.

BotMultipleValuesSetting

data class BotMultipleValuesSetting(val allowMultipleValues: Boolean? = null)

Indicates whether a slot can return multiple values.

BotObfuscationSetting

data class BotObfuscationSetting(val obfuscationSettingType: BotObfuscationSettingObfuscationSettingType)

Determines whether Amazon Lex obscures slot values in conversation logs.

BotOutputContext

data class BotOutputContext(val name: String, val timeToLiveInSeconds: Int, val turnsToLive: Int)

A session context that is activated when an intent is fulfilled.

BotPlainTextMessage

data class BotPlainTextMessage(val value: String)

A message in plain text format.

BotPostDialogCodeHookInvocationSpecification

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)

Specifies next steps to run after the dialog code hook finishes.

BotPostFulfillmentStatusSpecification

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)

Provides a setting that determines whether the post-fulfillment response is sent to the user.

BotPromptAttemptSpecification

data class BotPromptAttemptSpecification(val allowInterrupt: Boolean? = null, val allowedInputTypes: BotAllowedInputTypes, val audioAndDtmfInputSpecification: BotAudioAndDtmfInputSpecification? = null, val textInputSpecification: BotTextInputSpecification? = null)

Specifies the settings on a prompt attempt.

BotPromptSpecification

data class BotPromptSpecification(val allowInterrupt: Boolean? = null, val maxRetries: Int, val messageGroupsList: List<BotMessageGroup>, val messageSelectionStrategy: BotMessageSelectionStrategy? = null, val promptAttemptsSpecification: Map<String, BotPromptAttemptSpecification>? = null)

Prompts the user to confirm the intent.

BotResponseSpecification

data class BotResponseSpecification(val allowInterrupt: Boolean? = null, val messageGroupsList: List<BotMessageGroup>)

A list of message groups that Amazon Lex uses to respond the user input.

BotS3BucketLogDestination

data class BotS3BucketLogDestination(val kmsKeyArn: String? = null, val logPrefix: String, val s3BucketArn: String)

Specifies an Amazon S3 bucket for logging audio conversations

BotS3Location

data class BotS3Location(val s3Bucket: String, val s3ObjectKey: String, val s3ObjectVersion: String? = null)

S3 location of bot definitions zip file, if it's not defined inline in CloudFormation.

BotSampleUtterance

data class BotSampleUtterance(val utterance: String)

A sample utterance that invokes an intent or respond to a slot elicitation prompt.

BotSampleValue

data class BotSampleValue(val value: String)

Defines one of the values for a slot type.

BotSessionAttribute

data class BotSessionAttribute(val key: String, val value: String? = null)

Key/value pair representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

BotSlot

data class BotSlot(val description: String? = null, val multipleValuesSetting: BotMultipleValuesSetting? = null, val name: String, val obfuscationSetting: BotObfuscationSetting? = null, val slotTypeName: String, val valueElicitationSetting: BotSlotValueElicitationSetting)

A slot is a variable needed to fulfill an intent, where an intent can require zero or more slots.

BotSlotCaptureSetting

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)

Settings used when Amazon Lex successfully captures a slot value from a user.

BotSlotDefaultValue

data class BotSlotDefaultValue(val defaultValue: String)

The default value to use when a user doesn't provide a value for a slot.

BotSlotDefaultValueSpecification

data class BotSlotDefaultValueSpecification(val defaultValueList: List<BotSlotDefaultValue>)

A list of values that Amazon Lex should use as the default value for a slot.

BotSlotPriority

data class BotSlotPriority(val priority: Int, val slotName: String)

The priority that Amazon Lex should use when eliciting slot values from a user.

BotSlotType

data class BotSlotType(val description: String? = null, val externalSourceSetting: BotExternalSourceSetting? = null, val name: String, val parentSlotTypeSignature: String? = null, val slotTypeValues: List<BotSlotTypeValue>? = null, val valueSelectionSetting: BotSlotValueSelectionSetting? = null)

A custom, extended built-in or a grammar slot type.

BotSlotTypeValue

data class BotSlotTypeValue(val sampleValue: BotSampleValue, val synonyms: List<BotSampleValue>? = null)

Value that the slot type can take.

BotSlotValue

data class BotSlotValue(val interpretedValue: String? = null)

The value to set in a slot.

BotSlotValueElicitationSetting

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)

Settings that you can use for eliciting a slot value.

BotSlotValueOverride

data class BotSlotValueOverride(val shape: BotSlotShape? = null, val value: BotSlotValue? = null, val values: List<BotSlotValueOverride>? = null)

The slot values that Amazon Lex uses when it sets slot values in a dialog step.

BotSlotValueOverrideMap

data class BotSlotValueOverrideMap(val slotName: String? = null, val slotValueOverride: BotSlotValueOverride? = null)

A map of slot names and their overridden values.

BotSlotValueRegexFilter

data class BotSlotValueRegexFilter(val pattern: String)

A regular expression used to validate the value of a slot.

BotSlotValueSelectionSetting

data class BotSlotValueSelectionSetting(val advancedRecognitionSetting: BotAdvancedRecognitionSetting? = null, val regexFilter: BotSlotValueRegexFilter? = null, val resolutionStrategy: BotSlotValueResolutionStrategy)

Contains settings used by Amazon Lex to select a slot value.

BotSsmlMessage

data class BotSsmlMessage(val value: String)

A message in Speech Synthesis Markup Language (SSML).

BotStillWaitingResponseSpecification

data class BotStillWaitingResponseSpecification(val allowInterrupt: Boolean? = null, val frequencyInSeconds: Int, val messageGroupsList: List<BotMessageGroup>, val timeoutInSeconds: Int)

StillWaitingResponseSpecification.

BotTag

data class BotTag(val key: String, val value: String)

A key-value pair for tagging Lex resources

BotTestBotAliasSettings

data class BotTestBotAliasSettings(val botAliasLocaleSettings: List<BotAliasLocaleSettingsItem>? = null, val conversationLogSettings: BotConversationLogSettings? = null, val description: String? = null, val sentimentAnalysisSettings: BotTestBotAliasSettingsSentimentAnalysisSettingsProperties? = null)

Configuring the test bot alias settings for a given bot

BotTestBotAliasSettingsSentimentAnalysisSettingsProperties

data class BotTestBotAliasSettingsSentimentAnalysisSettingsProperties(val detectSentiment: Boolean)

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

BotTextInputSpecification

data class BotTextInputSpecification(val startTimeoutMs: Int)

Specifies the text input specifications.

BotTextLogDestination

data class BotTextLogDestination(val cloudWatch: BotCloudWatchLogGroupLogDestination)

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

BotTextLogSetting

data class BotTextLogSetting(val destination: BotTextLogDestination, val enabled: Boolean)

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

BotVersionLocaleDetails

data class BotVersionLocaleDetails(val sourceBotVersion: String)

The version of a bot used for a bot locale.

BotVersionLocaleSpecification

data class BotVersionLocaleSpecification(val botVersionLocaleDetails: BotVersionLocaleDetails, val localeId: String)

BotVoiceSettings

data class BotVoiceSettings(val engine: BotVoiceSettingsEngine? = null, val voiceId: String)

Settings for using an Amazon Polly voice to communicate with a user.

BotWaitAndContinueSpecification

data class BotWaitAndContinueSpecification(val continueResponse: BotResponseSpecification, val isActive: Boolean? = null, val stillWaitingResponse: BotStillWaitingResponseSpecification? = null, val waitingResponse: BotResponseSpecification)

The prompts that Amazon Lex uses while a bot is waiting for customer input.

DataPrivacyProperties

data class DataPrivacyProperties(val childDirected: Boolean)

Data privacy setting of the Bot.

GetBotAliasResult

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)

GetBotResult

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)

GetBotVersionResult

data class GetBotVersionResult(val botVersion: String? = null, val description: String? = null)

GetResourcePolicyResult

data class GetResourcePolicyResult(val id: String? = null, val policy: ResourcePolicyPolicy? = null, val resourceArn: String? = null, val revisionId: String? = null)

ResourcePolicyPolicy

class ResourcePolicyPolicy

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.

SentimentAnalysisSettingsProperties

data class SentimentAnalysisSettingsProperties(val detectSentiment: Boolean)

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