Package software.amazon.awscdk.services.lex
package software.amazon.awscdk.services.lex
AWS::Lex Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.lex.*;
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.)
-
ClassDescriptionProvides settings that enable advanced recognition settings for slot values.A builder for
CfnBot.AdvancedRecognitionSettingPropertyAn implementation forCfnBot.AdvancedRecognitionSettingPropertySpecifies the allowed input types.A builder forCfnBot.AllowedInputTypesPropertyAn implementation forCfnBot.AllowedInputTypesPropertySpecifies the audio and DTMF input specification.A builder forCfnBot.AudioAndDTMFInputSpecificationPropertyAn implementation forCfnBot.AudioAndDTMFInputSpecificationPropertyThe location of audio log files collected when conversation logging is enabled for a bot.A builder forCfnBot.AudioLogDestinationPropertyAn implementation forCfnBot.AudioLogDestinationPropertySettings for logging audio of conversations between Amazon Lex and a user.A builder forCfnBot.AudioLogSettingPropertyAn implementation forCfnBot.AudioLogSettingPropertySpecifies the audio input specifications.A builder forCfnBot.AudioSpecificationPropertyAn implementation forCfnBot.AudioSpecificationPropertyExample:A builder forCfnBot.BedrockAgentConfigurationPropertyAn implementation forCfnBot.BedrockAgentConfigurationPropertyExample:A builder forCfnBot.BedrockAgentIntentConfigurationPropertyAn implementation forCfnBot.BedrockAgentIntentConfigurationPropertyExample:An implementation forCfnBot.BedrockAgentIntentKnowledgeBaseConfigurationPropertyThe details on the Bedrock guardrail configuration.A builder forCfnBot.BedrockGuardrailConfigurationPropertyAn implementation forCfnBot.BedrockGuardrailConfigurationPropertyContains details about the configuration of a Amazon Bedrock knowledge base.A builder forCfnBot.BedrockKnowledgeStoreConfigurationPropertyAn implementation forCfnBot.BedrockKnowledgeStoreConfigurationPropertyContains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.A builder forCfnBot.BedrockModelSpecificationPropertyAn implementation forCfnBot.BedrockModelSpecificationPropertyExample:A builder forCfnBot.BKBExactResponseFieldsPropertyAn implementation forCfnBot.BKBExactResponseFieldsPropertySpecifies locale settings for a single locale.A builder forCfnBot.BotAliasLocaleSettingsItemPropertyAn implementation forCfnBot.BotAliasLocaleSettingsItemPropertySpecifies settings that are unique to a locale.A builder forCfnBot.BotAliasLocaleSettingsPropertyAn implementation forCfnBot.BotAliasLocaleSettingsPropertyProvides configuration information for a locale.A builder forCfnBot.BotLocalePropertyAn implementation forCfnBot.BotLocalePropertyA fluent builder forCfnBot.Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.A builder forCfnBot.BuildtimeSettingsPropertyAn implementation forCfnBot.BuildtimeSettingsPropertyDescribes a button to use on a response card used to gather slot values from a user.A builder forCfnBot.ButtonPropertyAn implementation forCfnBot.ButtonPropertyThe Amazon CloudWatch Logs log group where the text and metadata logs are delivered.A builder forCfnBot.CloudWatchLogGroupLogDestinationPropertyAn implementation forCfnBot.CloudWatchLogGroupLogDestinationPropertyContains information about code hooks that Amazon Lex calls during a conversation.A builder forCfnBot.CodeHookSpecificationPropertyAn implementation forCfnBot.CodeHookSpecificationPropertyA composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.A builder forCfnBot.CompositeSlotTypeSettingPropertyAn implementation forCfnBot.CompositeSlotTypeSettingPropertyA set of actions that Amazon Lex should run if the condition is matched.A builder forCfnBot.ConditionalBranchPropertyAn implementation forCfnBot.ConditionalBranchPropertyProvides a list of conditional branches.A builder forCfnBot.ConditionalSpecificationPropertyAn implementation forCfnBot.ConditionalSpecificationPropertyProvides an expression that evaluates to true or false.A builder forCfnBot.ConditionPropertyAn implementation forCfnBot.ConditionPropertyConfigures conversation logging that saves audio, text, and metadata for the conversations with your users.A builder forCfnBot.ConversationLogSettingsPropertyAn implementation forCfnBot.ConversationLogSettingsPropertyA custom response string that Amazon Lex sends to your application.A builder forCfnBot.CustomPayloadPropertyAn implementation forCfnBot.CustomPayloadPropertySpecifies an entry in a custom vocabulary.A builder forCfnBot.CustomVocabularyItemPropertyAn implementation forCfnBot.CustomVocabularyItemPropertySpecifies a custom vocabulary.A builder forCfnBot.CustomVocabularyPropertyAn implementation forCfnBot.CustomVocabularyPropertyBy default, data stored by Amazon Lex is encrypted.A builder forCfnBot.DataPrivacyPropertyAn implementation forCfnBot.DataPrivacyPropertyContains details about the configuration of the knowledge store used for theAMAZON.QnAIntent.A builder forCfnBot.DataSourceConfigurationPropertyAn implementation forCfnBot.DataSourceConfigurationPropertyA set of actions that Amazon Lex should run if none of the other conditions are met.A builder forCfnBot.DefaultConditionalBranchPropertyAn implementation forCfnBot.DefaultConditionalBranchPropertyContains specifications for the descriptive bot building feature.A builder forCfnBot.DescriptiveBotBuilderSpecificationPropertyAn implementation forCfnBot.DescriptiveBotBuilderSpecificationPropertyDefines the action that the bot executes at runtime when the conversation reaches this step.A builder forCfnBot.DialogActionPropertyAn implementation forCfnBot.DialogActionPropertySettings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.A builder forCfnBot.DialogCodeHookInvocationSettingPropertyAn implementation forCfnBot.DialogCodeHookInvocationSettingPropertySettings that determine the Lambda function that Amazon Lex uses for processing user responses.A builder forCfnBot.DialogCodeHookSettingPropertyAn implementation forCfnBot.DialogCodeHookSettingPropertyThe current state of the conversation with the user.A builder forCfnBot.DialogStatePropertyAn implementation forCfnBot.DialogStatePropertySpecifies the DTMF input specifications.A builder forCfnBot.DTMFSpecificationPropertyAn implementation forCfnBot.DTMFSpecificationPropertySettings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.A builder forCfnBot.ElicitationCodeHookInvocationSettingPropertyAn implementation forCfnBot.ElicitationCodeHookInvocationSettingPropertyExample:A builder forCfnBot.ErrorLogSettingsPropertyAn implementation forCfnBot.ErrorLogSettingsPropertyContains the names of the fields used for an exact response to the user.A builder forCfnBot.ExactResponseFieldsPropertyAn implementation forCfnBot.ExactResponseFieldsPropertyProvides information about the external source of the slot type's definition.A builder forCfnBot.ExternalSourceSettingPropertyAn implementation forCfnBot.ExternalSourceSettingPropertyDetermines if a Lambda function should be invoked for a specific intent.A builder forCfnBot.FulfillmentCodeHookSettingPropertyAn implementation forCfnBot.FulfillmentCodeHookSettingPropertyProvides settings for a message that is sent to the user when a fulfillment Lambda function starts running.A builder forCfnBot.FulfillmentStartResponseSpecificationPropertyAn implementation forCfnBot.FulfillmentStartResponseSpecificationPropertyProvides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.A builder forCfnBot.FulfillmentUpdateResponseSpecificationPropertyAn implementation forCfnBot.FulfillmentUpdateResponseSpecificationPropertyProvides information for updating the user on the progress of fulfilling an intent.A builder forCfnBot.FulfillmentUpdatesSpecificationPropertyAn implementation forCfnBot.FulfillmentUpdatesSpecificationPropertyContains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.A builder forCfnBot.GenerativeAISettingsPropertyAn implementation forCfnBot.GenerativeAISettingsPropertySettings requried for a slot type based on a grammar that you provide.A builder forCfnBot.GrammarSlotTypeSettingPropertyAn implementation forCfnBot.GrammarSlotTypeSettingPropertyDescribes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.A builder forCfnBot.GrammarSlotTypeSourcePropertyAn implementation forCfnBot.GrammarSlotTypeSourcePropertyA card that is shown to the user by a messaging platform.A builder forCfnBot.ImageResponseCardPropertyAn implementation forCfnBot.ImageResponseCardPropertyConfiguration setting for a response sent to the user before Amazon Lex starts eliciting slots.A builder forCfnBot.InitialResponseSettingPropertyAn implementation forCfnBot.InitialResponseSettingPropertyA context that must be active for an intent to be selected by Amazon Lex.A builder forCfnBot.InputContextPropertyAn implementation forCfnBot.InputContextPropertyProvides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.A builder forCfnBot.IntentClosingSettingPropertyAn implementation forCfnBot.IntentClosingSettingPropertyProvides a prompt for making sure that the user is ready for the intent to be fulfilled.A builder forCfnBot.IntentConfirmationSettingPropertyAn implementation forCfnBot.IntentConfirmationSettingPropertyOverride settings to configure the intent state.A builder forCfnBot.IntentOverridePropertyAn implementation forCfnBot.IntentOverridePropertyRepresents an action that the user wants to perform.A builder forCfnBot.IntentPropertyAn implementation forCfnBot.IntentPropertyProvides configuration information for theAMAZON.KendraSearchIntentintent.A builder forCfnBot.KendraConfigurationPropertyAn implementation forCfnBot.KendraConfigurationPropertySpecifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.A builder forCfnBot.LambdaCodeHookPropertyAn implementation forCfnBot.LambdaCodeHookPropertyProvides one or more messages that Amazon Lex should send to the user.A builder forCfnBot.MessageGroupPropertyAn implementation forCfnBot.MessageGroupPropertyThe object that provides message text and its type.A builder forCfnBot.MessagePropertyAn implementation forCfnBot.MessagePropertyIndicates whether a slot can return multiple values.A builder forCfnBot.MultipleValuesSettingPropertyAn implementation forCfnBot.MultipleValuesSettingPropertyConfigures the Assisted Natural Language Understanding (NLU) feature for your bot.A builder forCfnBot.NluImprovementSpecificationPropertyAn implementation forCfnBot.NluImprovementSpecificationPropertyDetermines whether Amazon Lex obscures slot values in conversation logs.A builder forCfnBot.ObfuscationSettingPropertyAn implementation forCfnBot.ObfuscationSettingPropertyContains details about the configuration of the Amazon OpenSearch Service database used for theAMAZON.QnAIntent.A builder forCfnBot.OpensearchConfigurationPropertyAn implementation forCfnBot.OpensearchConfigurationPropertyDescribes a session context that is activated when an intent is fulfilled.A builder forCfnBot.OutputContextPropertyAn implementation forCfnBot.OutputContextPropertyDefines an ASCII text message to send to the user.A builder forCfnBot.PlainTextMessagePropertyAn implementation forCfnBot.PlainTextMessagePropertySpecifies next steps to run after the dialog code hook finishes.A builder forCfnBot.PostDialogCodeHookInvocationSpecificationPropertyAn implementation forCfnBot.PostDialogCodeHookInvocationSpecificationPropertyProvides a setting that determines whether the post-fulfillment response is sent to the user.A builder forCfnBot.PostFulfillmentStatusSpecificationPropertyAn implementation forCfnBot.PostFulfillmentStatusSpecificationPropertySpecifies the settings on a prompt attempt.A builder forCfnBot.PromptAttemptSpecificationPropertyAn implementation forCfnBot.PromptAttemptSpecificationPropertySpecifies a list of message groups that Amazon Lex sends to a user to elicit a response.A builder forCfnBot.PromptSpecificationPropertyAn implementation forCfnBot.PromptSpecificationPropertyExample:A builder forCfnBot.QInConnectAssistantConfigurationPropertyAn implementation forCfnBot.QInConnectAssistantConfigurationPropertyExample:A builder forCfnBot.QInConnectIntentConfigurationPropertyAn implementation forCfnBot.QInConnectIntentConfigurationPropertyDetails about the the configuration of the built-inAmazon.QnAIntent.A builder forCfnBot.QnAIntentConfigurationPropertyAn implementation forCfnBot.QnAIntentConfigurationPropertyContains details about the configuration of the Amazon Kendra index used for theAMAZON.QnAIntent.A builder forCfnBot.QnAKendraConfigurationPropertyAn implementation forCfnBot.QnAKendraConfigurationPropertyExample:A builder forCfnBot.ReplicationPropertyAn implementation forCfnBot.ReplicationPropertySpecifies a list of message groups that Amazon Lex uses to respond the user input.A builder forCfnBot.ResponseSpecificationPropertyAn implementation forCfnBot.ResponseSpecificationPropertyContains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.A builder forCfnBot.RuntimeSettingsPropertyAn implementation forCfnBot.RuntimeSettingsPropertySpecifies an Amazon S3 bucket for logging audio conversations.A builder forCfnBot.S3BucketLogDestinationPropertyAn implementation forCfnBot.S3BucketLogDestinationPropertyDefines an Amazon S3 bucket location.A builder forCfnBot.S3LocationPropertyAn implementation forCfnBot.S3LocationPropertyContains specifications for the sample utterance generation feature.A builder forCfnBot.SampleUtteranceGenerationSpecificationPropertyAn implementation forCfnBot.SampleUtteranceGenerationSpecificationPropertyA sample utterance that invokes an intent or respond to a slot elicitation prompt.A builder forCfnBot.SampleUtterancePropertyAn implementation forCfnBot.SampleUtterancePropertyDefines one of the values for a slot type.A builder forCfnBot.SampleValuePropertyAn implementation forCfnBot.SampleValuePropertyDetermines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.A builder forCfnBot.SentimentAnalysisSettingsPropertyAn implementation forCfnBot.SentimentAnalysisSettingsPropertyA key/value pair representing session-specific context information.A builder forCfnBot.SessionAttributePropertyAn implementation forCfnBot.SessionAttributePropertySettings used when Amazon Lex successfully captures a slot value from a user.A builder forCfnBot.SlotCaptureSettingPropertyAn implementation forCfnBot.SlotCaptureSettingPropertySpecifies the default value to use when a user doesn't provide a value for a slot.A builder forCfnBot.SlotDefaultValuePropertyAn implementation forCfnBot.SlotDefaultValuePropertyThe default value to use when a user doesn't provide a value for a slot.A builder forCfnBot.SlotDefaultValueSpecificationPropertyAn implementation forCfnBot.SlotDefaultValueSpecificationPropertySets the priority that Amazon Lex should use when eliciting slot values from a user.A builder forCfnBot.SlotPriorityPropertyAn implementation forCfnBot.SlotPriorityPropertySpecifies the definition of a slot.A builder forCfnBot.SlotPropertyAn implementation forCfnBot.SlotPropertyContains specifications for the assisted slot resolution feature.A builder forCfnBot.SlotResolutionImprovementSpecificationPropertyAn implementation forCfnBot.SlotResolutionImprovementSpecificationPropertyDescribes a slot type.A builder forCfnBot.SlotTypePropertyAn implementation forCfnBot.SlotTypePropertyEach slot type can have a set of values.A builder forCfnBot.SlotTypeValuePropertyAn implementation forCfnBot.SlotTypeValuePropertySpecifies the elicitation setting details eliciting a slot.A builder forCfnBot.SlotValueElicitationSettingPropertyAn implementation forCfnBot.SlotValueElicitationSettingPropertyMaps a slot name to the SlotValueOverride object.A builder forCfnBot.SlotValueOverrideMapPropertyAn implementation forCfnBot.SlotValueOverrideMapPropertyThe slot values that Amazon Lex uses when it sets slot values in a dialog step.A builder forCfnBot.SlotValueOverridePropertyAn implementation forCfnBot.SlotValueOverridePropertyThe value to set in a slot.A builder forCfnBot.SlotValuePropertyAn implementation forCfnBot.SlotValuePropertyProvides a regular expression used to validate the value of a slot.A builder forCfnBot.SlotValueRegexFilterPropertyAn implementation forCfnBot.SlotValueRegexFilterPropertyContains settings used by Amazon Lex to select a slot value.A builder forCfnBot.SlotValueSelectionSettingPropertyAn implementation forCfnBot.SlotValueSelectionSettingPropertySubslot specifications.A builder forCfnBot.SpecificationsPropertyAn implementation forCfnBot.SpecificationsPropertyDefines a Speech Synthesis Markup Language (SSML) prompt.A builder forCfnBot.SSMLMessagePropertyAn implementation forCfnBot.SSMLMessagePropertyDefines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.A builder forCfnBot.StillWaitingResponseSpecificationPropertyAn implementation forCfnBot.StillWaitingResponseSpecificationPropertySpecifications for the constituent sub slots and the expression for the composite slot.A builder forCfnBot.SubSlotSettingPropertyAn implementation forCfnBot.SubSlotSettingPropertySubslot type composition.A builder forCfnBot.SubSlotTypeCompositionPropertyAn implementation forCfnBot.SubSlotTypeCompositionPropertySubslot elicitation settings.A builder forCfnBot.SubSlotValueElicitationSettingPropertyAn implementation forCfnBot.SubSlotValueElicitationSettingPropertySpecifies configuration settings for the alias used to test the bot.A builder forCfnBot.TestBotAliasSettingsPropertyAn implementation forCfnBot.TestBotAliasSettingsPropertySpecifies the text input specifications.A builder forCfnBot.TextInputSpecificationPropertyAn implementation forCfnBot.TextInputSpecificationPropertyDefines the Amazon CloudWatch Logs destination log group for conversation text logs.A builder forCfnBot.TextLogDestinationPropertyAn implementation forCfnBot.TextLogDestinationPropertyDefines settings to enable text conversation logs.A builder forCfnBot.TextLogSettingPropertyAn implementation forCfnBot.TextLogSettingPropertyDefines settings for using an Amazon Polly voice to communicate with a user.A builder forCfnBot.VoiceSettingsPropertyAn implementation forCfnBot.VoiceSettingsPropertySpecifies the prompts that Amazon Lex uses while a bot is waiting for customer input.A builder forCfnBot.WaitAndContinueSpecificationPropertyAn implementation forCfnBot.WaitAndContinueSpecificationPropertySpecifies the S3 bucket location where audio logs are stored.A builder forCfnBotAlias.AudioLogDestinationPropertyAn implementation forCfnBotAlias.AudioLogDestinationPropertySettings for logging audio of conversations between Amazon Lex and a user.A builder forCfnBotAlias.AudioLogSettingPropertyAn implementation forCfnBotAlias.AudioLogSettingPropertySpecifies settings that are unique to a locale.A builder forCfnBotAlias.BotAliasLocaleSettingsItemPropertyAn implementation forCfnBotAlias.BotAliasLocaleSettingsItemPropertySpecifies settings that are unique to a locale.A builder forCfnBotAlias.BotAliasLocaleSettingsPropertyAn implementation forCfnBotAlias.BotAliasLocaleSettingsPropertyA fluent builder forCfnBotAlias.The Amazon CloudWatch Logs log group where the text and metadata logs are delivered.A builder forCfnBotAlias.CloudWatchLogGroupLogDestinationPropertyAn implementation forCfnBotAlias.CloudWatchLogGroupLogDestinationPropertyContains information about code hooks that Amazon Lex calls during a conversation.A builder forCfnBotAlias.CodeHookSpecificationPropertyAn implementation forCfnBotAlias.CodeHookSpecificationPropertyConfigures conversation logging that saves audio, text, and metadata for the conversations with your users.A builder forCfnBotAlias.ConversationLogSettingsPropertyAn implementation forCfnBotAlias.ConversationLogSettingsPropertySpecifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.A builder forCfnBotAlias.LambdaCodeHookPropertyAn implementation forCfnBotAlias.LambdaCodeHookPropertySpecifies an Amazon S3 bucket for logging audio conversations.A builder forCfnBotAlias.S3BucketLogDestinationPropertyAn implementation forCfnBotAlias.S3BucketLogDestinationPropertyDetermines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.A builder forCfnBotAlias.SentimentAnalysisSettingsPropertyAn implementation forCfnBotAlias.SentimentAnalysisSettingsPropertyDefines the Amazon CloudWatch Logs destination log group for conversation text logs.A builder forCfnBotAlias.TextLogDestinationPropertyAn implementation forCfnBotAlias.TextLogDestinationPropertyDefines settings to enable text conversation logs.A builder forCfnBotAlias.TextLogSettingPropertyAn implementation forCfnBotAlias.TextLogSettingPropertyProperties for defining aCfnBotAlias.A builder forCfnBotAliasPropsAn implementation forCfnBotAliasPropsProperties for defining aCfnBot.A builder forCfnBotPropsAn implementation forCfnBotPropsThe version of a bot used for a bot locale.A builder forCfnBotVersion.BotVersionLocaleDetailsPropertyAn implementation forCfnBotVersion.BotVersionLocaleDetailsPropertySpecifies the locale that Amazon Lex adds to this version.A builder forCfnBotVersion.BotVersionLocaleSpecificationPropertyAn implementation forCfnBotVersion.BotVersionLocaleSpecificationPropertyA fluent builder forCfnBotVersion.Properties for defining aCfnBotVersion.A builder forCfnBotVersionPropsAn implementation forCfnBotVersionPropsA fluent builder forCfnResourcePolicy.Properties for defining aCfnResourcePolicy.A builder forCfnResourcePolicyPropsAn implementation forCfnResourcePolicyProps