aws-cdk-lib.aws_lex

AWS::Lex Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as lex from 'aws-cdk-lib/aws-lex';

import aws_cdk.aws_lex as lex

import software.amazon.awscdk.services.lex.*;

using Amazon.CDK.AWS.Lex;

import lex "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for Lex construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Lex resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Lex.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types

Name	Kind	Summary
CfnBot	Construct (L1)	> Amazon Lex V2 is the only supported version in CloudFormation .
CfnBotAlias	Construct (L1)	> Amazon Lex V2 is the only supported version in CloudFormation .
CfnBotVersion	Construct (L1)	> Amazon Lex V2 is the only supported version in CloudFormation .
CfnResourcePolicy	Construct (L1)	> Amazon Lex V2 is the only supported version in CloudFormation .
CfnBot.AdvancedRecognitionSettingProperty	Struct	Provides settings that enable advanced recognition settings for slot values.
CfnBot.AllowedInputTypesProperty	Struct	Specifies the allowed input types.
CfnBot.AudioAndDTMFInputSpecificationProperty	Struct	Specifies the audio and DTMF input specification.
CfnBot.AudioFillerSettingsProperty	Struct
CfnBot.AudioLogDestinationProperty	Struct	The location of audio log files collected when conversation logging is enabled for a bot.
CfnBot.AudioLogSettingProperty	Struct	Settings for logging audio of conversations between Amazon Lex and a user.
CfnBot.AudioSpecificationProperty	Struct	Specifies the audio input specifications.
CfnBot.BedrockAgentConfigurationProperty	Struct
CfnBot.BedrockAgentIntentConfigurationProperty	Struct
CfnBot.BedrockAgentIntentKnowledgeBaseConfigurationProperty	Struct
CfnBot.BedrockGuardrailConfigurationProperty	Struct	The details on the Bedrock guardrail configuration.
CfnBot.BedrockKnowledgeStoreConfigurationProperty	Struct	Contains details about the configuration of a Amazon Bedrock knowledge base.
CfnBot.BedrockModelSpecificationProperty	Struct	Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
CfnBot.BKBExactResponseFieldsProperty	Struct
CfnBot.BotAliasLocaleSettingsItemProperty	Struct	Specifies locale settings for a single locale.
CfnBot.BotAliasLocaleSettingsProperty	Struct	Specifies settings that are unique to a locale.
CfnBot.BotLocaleProperty	Struct	Provides configuration information for a locale.
CfnBot.BotMemberProperty	Struct	A bot that is a member of a bot network.
CfnBot.BuildtimeSettingsProperty	Struct	Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
CfnBot.ButtonProperty	Struct	Describes a button to use on a response card used to gather slot values from a user.
CfnBot.CloudWatchLogGroupLogDestinationProperty	Struct	The Amazon CloudWatch Logs log group where the text and metadata logs are delivered.
CfnBot.CodeHookSpecificationProperty	Struct	Contains information about code hooks that Amazon Lex calls during a conversation.
CfnBot.CompositeSlotTypeSettingProperty	Struct	A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.
CfnBot.ConditionalBranchProperty	Struct	A set of actions that Amazon Lex should run if the condition is matched.
CfnBot.ConditionalSpecificationProperty	Struct	Provides a list of conditional branches.
CfnBot.ConditionProperty	Struct	Provides an expression that evaluates to true or false.
CfnBot.ConversationLogSettingsProperty	Struct	Configures conversation logging that saves audio, text, and metadata for the conversations with your users.
CfnBot.CustomPayloadProperty	Struct	A custom response string that Amazon Lex sends to your application.
CfnBot.CustomVocabularyItemProperty	Struct	Specifies an entry in a custom vocabulary.
CfnBot.CustomVocabularyProperty	Struct	Specifies a custom vocabulary.
CfnBot.DataPrivacyProperty	Struct	By default, data stored by Amazon Lex is encrypted.
CfnBot.DataSourceConfigurationProperty	Struct	Contains details about the configuration of the knowledge store used for the AMAZON.QnAIntent . You must have already created the knowledge store and indexed the documents within it.
CfnBot.DeepgramSpeechModelConfigProperty	Struct
CfnBot.DefaultConditionalBranchProperty	Struct	A set of actions that Amazon Lex should run if none of the other conditions are met.
CfnBot.DescriptiveBotBuilderSpecificationProperty	Struct	Contains specifications for the descriptive bot building feature.
CfnBot.DialogActionProperty	Struct	Defines the action that the bot executes at runtime when the conversation reaches this step.
CfnBot.DialogCodeHookInvocationSettingProperty	Struct	Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
CfnBot.DialogCodeHookSettingProperty	Struct	Settings that determine the Lambda function that Amazon Lex uses for processing user responses.
CfnBot.DialogStateProperty	Struct	The current state of the conversation with the user.
CfnBot.DTMFSpecificationProperty	Struct	Specifies the DTMF input specifications.
CfnBot.ElicitationCodeHookInvocationSettingProperty	Struct	Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.
CfnBot.ErrorLogSettingsProperty	Struct
CfnBot.ExactResponseFieldsProperty	Struct	Contains the names of the fields used for an exact response to the user.
CfnBot.ExternalSourceSettingProperty	Struct	Provides information about the external source of the slot type's definition.
CfnBot.FulfillmentCodeHookSettingProperty	Struct	Determines if a Lambda function should be invoked for a specific intent.
CfnBot.FulfillmentStartResponseSpecificationProperty	Struct	Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.
CfnBot.FulfillmentUpdateResponseSpecificationProperty	Struct	Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.
CfnBot.FulfillmentUpdatesSpecificationProperty	Struct	Provides information for updating the user on the progress of fulfilling an intent.
CfnBot.GenerativeAISettingsProperty	Struct	Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
CfnBot.GrammarSlotTypeSettingProperty	Struct	Settings requried for a slot type based on a grammar that you provide.
CfnBot.GrammarSlotTypeSourceProperty	Struct	Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.
CfnBot.ImageResponseCardProperty	Struct	A card that is shown to the user by a messaging platform.
CfnBot.InitialResponseSettingProperty	Struct	Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
CfnBot.InputContextProperty	Struct	A context that must be active for an intent to be selected by Amazon Lex.
CfnBot.IntentClosingSettingProperty	Struct	Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.
CfnBot.IntentConfirmationSettingProperty	Struct	Provides a prompt for making sure that the user is ready for the intent to be fulfilled.
CfnBot.IntentDisambiguationSettingsProperty	Struct	Configures the Intent Disambiguation feature that helps resolve ambiguous user inputs when multiple intents could match.
CfnBot.IntentOverrideProperty	Struct	Override settings to configure the intent state.
CfnBot.IntentProperty	Struct	Represents an action that the user wants to perform.
CfnBot.KendraConfigurationProperty	Struct	Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.
CfnBot.LambdaCodeHookProperty	Struct	Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
CfnBot.MessageGroupProperty	Struct	Provides one or more messages that Amazon Lex should send to the user.
CfnBot.MessageProperty	Struct	The object that provides message text and its type.
CfnBot.MultipleValuesSettingProperty	Struct	Indicates whether a slot can return multiple values.
CfnBot.NluImprovementSpecificationProperty	Struct	Configures the Assisted Natural Language Understanding (NLU) feature for your bot.
CfnBot.ObfuscationSettingProperty	Struct	Determines whether Amazon Lex obscures slot values in conversation logs.
CfnBot.OpensearchConfigurationProperty	Struct	Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent .
CfnBot.OutputContextProperty	Struct	Describes a session context that is activated when an intent is fulfilled.
CfnBot.PlainTextMessageProperty	Struct	Defines an ASCII text message to send to the user.
CfnBot.PostDialogCodeHookInvocationSpecificationProperty	Struct	Specifies next steps to run after the dialog code hook finishes.
CfnBot.PostFulfillmentStatusSpecificationProperty	Struct	Provides a setting that determines whether the post-fulfillment response is sent to the user.
CfnBot.PromptAttemptSpecificationProperty	Struct	Specifies the settings on a prompt attempt.
CfnBot.PromptSpecificationProperty	Struct	Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
CfnBot.QInConnectAssistantConfigurationProperty	Struct
CfnBot.QInConnectIntentConfigurationProperty	Struct
CfnBot.QnAIntentConfigurationProperty	Struct	Details about the the configuration of the built-in Amazon.QnAIntent .
CfnBot.QnAKendraConfigurationProperty	Struct	Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent .
CfnBot.ReplicationProperty	Struct
CfnBot.ResponseSpecificationProperty	Struct	Specifies a list of message groups that Amazon Lex uses to respond the user input.
CfnBot.RuntimeSettingsProperty	Struct	Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
CfnBot.S3BucketLogDestinationProperty	Struct	Specifies an Amazon S3 bucket for logging audio conversations.
CfnBot.S3LocationProperty	Struct	Defines an Amazon S3 bucket location.
CfnBot.SampleUtteranceGenerationSpecificationProperty	Struct	Contains specifications for the sample utterance generation feature.
CfnBot.SampleUtteranceProperty	Struct	A sample utterance that invokes an intent or respond to a slot elicitation prompt.
CfnBot.SampleValueProperty	Struct	Defines one of the values for a slot type.
CfnBot.SentimentAnalysisSettingsProperty	Struct	Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
CfnBot.SessionAttributeProperty	Struct	A key/value pair representing session-specific context information.
CfnBot.SlotCaptureSettingProperty	Struct	Settings used when Amazon Lex successfully captures a slot value from a user.
CfnBot.SlotDefaultValueProperty	Struct	Specifies the default value to use when a user doesn't provide a value for a slot.
CfnBot.SlotDefaultValueSpecificationProperty	Struct	The default value to use when a user doesn't provide a value for a slot.
CfnBot.SlotPriorityProperty	Struct	Sets the priority that Amazon Lex should use when eliciting slot values from a user.
CfnBot.SlotProperty	Struct	Specifies the definition of a slot.
CfnBot.SlotResolutionImprovementSpecificationProperty	Struct	Contains specifications for the assisted slot resolution feature.
CfnBot.SlotTypeProperty	Struct	Describes a slot type.
CfnBot.SlotTypeValueProperty	Struct	Each slot type can have a set of values.
CfnBot.SlotValueElicitationSettingProperty	Struct	Specifies the elicitation setting details eliciting a slot.
CfnBot.SlotValueOverrideMapProperty	Struct	Maps a slot name to the SlotValueOverride object.
CfnBot.SlotValueOverrideProperty	Struct	The slot values that Amazon Lex uses when it sets slot values in a dialog step.
CfnBot.SlotValueProperty	Struct	The value to set in a slot.
CfnBot.SlotValueRegexFilterProperty	Struct	Provides a regular expression used to validate the value of a slot.
CfnBot.SlotValueSelectionSettingProperty	Struct	Contains settings used by Amazon Lex to select a slot value.
CfnBot.SpecificationsProperty	Struct	Subslot specifications.
CfnBot.SpeechFoundationModelProperty	Struct	Configuration for a foundation model used for speech synthesis and recognition capabilities.
CfnBot.SpeechModelConfigProperty	Struct
CfnBot.SpeechRecognitionSettingsProperty	Struct
CfnBot.SSMLMessageProperty	Struct	Defines a Speech Synthesis Markup Language (SSML) prompt.
CfnBot.StillWaitingResponseSpecificationProperty	Struct	Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.
CfnBot.SubSlotSettingProperty	Struct	Specifications for the constituent sub slots and the expression for the composite slot.
CfnBot.SubSlotTypeCompositionProperty	Struct	Subslot type composition.
CfnBot.SubSlotValueElicitationSettingProperty	Struct	Subslot elicitation settings.
CfnBot.TestBotAliasSettingsProperty	Struct	Specifies configuration settings for the alias used to test the bot.
CfnBot.TextInputSpecificationProperty	Struct	Specifies the text input specifications.
CfnBot.TextLogDestinationProperty	Struct	Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
CfnBot.TextLogSettingProperty	Struct	Defines settings to enable text conversation logs.
CfnBot.UnifiedSpeechSettingsProperty	Struct	Unified configuration settings that combine speech recognition and synthesis capabilities.
CfnBot.VoiceSettingsProperty	Struct	Defines settings for using an Amazon Polly voice to communicate with a user.
CfnBot.WaitAndContinueSpecificationProperty	Struct	Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
CfnBotAlias.AudioLogDestinationProperty	Struct	Specifies the S3 bucket location where audio logs are stored.
CfnBotAlias.AudioLogSettingProperty	Struct	Settings for logging audio of conversations between Amazon Lex and a user.
CfnBotAlias.BotAliasLocaleSettingsItemProperty	Struct	Specifies settings that are unique to a locale.
CfnBotAlias.BotAliasLocaleSettingsProperty	Struct	Specifies settings that are unique to a locale.
CfnBotAlias.CloudWatchLogGroupLogDestinationProperty	Struct	The Amazon CloudWatch Logs log group where the text and metadata logs are delivered.
CfnBotAlias.CodeHookSpecificationProperty	Struct	Contains information about code hooks that Amazon Lex calls during a conversation.
CfnBotAlias.ConversationLogSettingsProperty	Struct	Configures conversation logging that saves audio, text, and metadata for the conversations with your users.
CfnBotAlias.LambdaCodeHookProperty	Struct	Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
CfnBotAlias.S3BucketLogDestinationProperty	Struct	Specifies an Amazon S3 bucket for logging audio conversations.
CfnBotAlias.SentimentAnalysisSettingsProperty	Struct	Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
CfnBotAlias.TextLogDestinationProperty	Struct	Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
CfnBotAlias.TextLogSettingProperty	Struct	Defines settings to enable text conversation logs.
CfnBotAliasProps	Struct	Properties for defining a CfnBotAlias.
CfnBotProps	Struct	Properties for defining a CfnBot.
CfnBotVersion.BotVersionLocaleDetailsProperty	Struct	The version of a bot used for a bot locale.
CfnBotVersion.BotVersionLocaleSpecificationProperty	Struct	Specifies the locale that Amazon Lex adds to this version.
CfnBotVersionProps	Struct	Properties for defining a CfnBotVersion.
CfnResourcePolicyProps	Struct	Properties for defining a CfnResourcePolicy.