Namespace Amazon.CDK.AWS.Lex
AWS::Lex Construct Library
---
AWS CDK v1 has reached End-of-Support on 2023-06-01.
This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.
This module is part of the AWS Cloud Development Kit project.
using Amazon.CDK.AWS.Lex;There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
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.)
Classes
| CfnBot | A CloudFormation |
| CfnBot.AdvancedRecognitionSettingProperty | Provides settings that enable advanced recognition settings for slot values. |
| CfnBot.AllowedInputTypesProperty | Specifies the allowed input types. |
| CfnBot.AudioAndDTMFInputSpecificationProperty | Specifies the audio and DTMF input specification. |
| CfnBot.AudioLogDestinationProperty | The location of audio log files collected when conversation logging is enabled for a bot. |
| CfnBot.AudioLogSettingProperty | Settings for logging audio of conversations between Amazon Lex and a user. |
| CfnBot.AudioSpecificationProperty | Specifies the audio input specifications. |
| CfnBot.BotAliasLocaleSettingsItemProperty | Specifies locale settings for a single locale. |
| CfnBot.BotAliasLocaleSettingsProperty | Specifies settings that are unique to a locale. |
| CfnBot.BotLocaleProperty | Provides configuration information for a locale. |
| CfnBot.ButtonProperty | Describes a button to use on a response card used to gather slot values from a user. |
| CfnBot.CloudWatchLogGroupLogDestinationProperty | The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. |
| CfnBot.CodeHookSpecificationProperty | Contains information about code hooks that Amazon Lex calls during a conversation. |
| CfnBot.ConditionalBranchProperty | A set of actions that Amazon Lex should run if the condition is matched. |
| CfnBot.ConditionalSpecificationProperty | Provides a list of conditional branches. |
| CfnBot.ConditionProperty | Provides an expression that evaluates to true or false. |
| CfnBot.ConversationLogSettingsProperty | Configures conversation logging that saves audio, text, and metadata for the conversations with your users. |
| CfnBot.CustomPayloadProperty | A custom response string that Amazon Lex sends to your application. |
| CfnBot.CustomVocabularyItemProperty | Specifies an entry in a custom vocabulary. |
| CfnBot.CustomVocabularyProperty | Specifies a custom vocabulary. |
| CfnBot.DataPrivacyProperty | By default, data stored by Amazon Lex is encrypted. |
| CfnBot.DefaultConditionalBranchProperty | A set of actions that Amazon Lex should run if none of the other conditions are met. |
| CfnBot.DialogActionProperty | Defines the action that the bot executes at runtime when the conversation reaches this step. |
| CfnBot.DialogCodeHookInvocationSettingProperty | Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation. |
| CfnBot.DialogCodeHookSettingProperty | Settings that determine the Lambda function that Amazon Lex uses for processing user responses. |
| CfnBot.DialogStateProperty | The current state of the conversation with the user. |
| CfnBot.DTMFSpecificationProperty | Specifies the DTMF input specifications. |
| CfnBot.ElicitationCodeHookInvocationSettingProperty | Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values. |
| CfnBot.ExternalSourceSettingProperty | Provides information about the external source of the slot type's definition. |
| CfnBot.FulfillmentCodeHookSettingProperty | Determines if a Lambda function should be invoked for a specific intent. |
| CfnBot.FulfillmentStartResponseSpecificationProperty | Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running. |
| CfnBot.FulfillmentUpdateResponseSpecificationProperty | Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running. |
| CfnBot.FulfillmentUpdatesSpecificationProperty | Provides information for updating the user on the progress of fulfilling an intent. |
| CfnBot.GrammarSlotTypeSettingProperty | Settings requried for a slot type based on a grammar that you provide. |
| CfnBot.GrammarSlotTypeSourceProperty | Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type. |
| CfnBot.ImageResponseCardProperty | A card that is shown to the user by a messaging platform. |
| CfnBot.InitialResponseSettingProperty | Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots. |
| CfnBot.InputContextProperty | A context that must be active for an intent to be selected by Amazon Lex. |
| CfnBot.IntentClosingSettingProperty | Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled. |
| CfnBot.IntentConfirmationSettingProperty | Provides a prompt for making sure that the user is ready for the intent to be fulfilled. |
| CfnBot.IntentOverrideProperty | Override settings to configure the intent state. |
| CfnBot.IntentProperty | Represents an action that the user wants to perform. |
| CfnBot.KendraConfigurationProperty | Provides configuration information for the |
| CfnBot.LambdaCodeHookProperty | Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot. |
| CfnBot.MessageGroupProperty | Provides one or more messages that Amazon Lex should send to the user. |
| CfnBot.MessageProperty | The object that provides message text and its type. |
| CfnBot.MultipleValuesSettingProperty | Indicates whether a slot can return multiple values. |
| CfnBot.ObfuscationSettingProperty | Determines whether Amazon Lex obscures slot values in conversation logs. |
| CfnBot.OutputContextProperty | Describes a session context that is activated when an intent is fulfilled. |
| CfnBot.PlainTextMessageProperty | Defines an ASCII text message to send to the user. |
| CfnBot.PostDialogCodeHookInvocationSpecificationProperty | Specifies next steps to run after the dialog code hook finishes. |
| CfnBot.PostFulfillmentStatusSpecificationProperty | Provides a setting that determines whether the post-fulfillment response is sent to the user. |
| CfnBot.PromptAttemptSpecificationProperty | Specifies the settings on a prompt attempt. |
| CfnBot.PromptSpecificationProperty | Specifies a list of message groups that Amazon Lex sends to a user to elicit a response. |
| CfnBot.ResponseSpecificationProperty | Specifies a list of message groups that Amazon Lex uses to respond the user input. |
| CfnBot.S3BucketLogDestinationProperty | Specifies an Amazon S3 bucket for logging audio conversations. |
| CfnBot.S3LocationProperty | Defines an Amazon S3 bucket location. |
| CfnBot.SampleUtteranceProperty | A sample utterance that invokes an intent or respond to a slot elicitation prompt. |
| CfnBot.SampleValueProperty | Defines one of the values for a slot type. |
| CfnBot.SentimentAnalysisSettingsProperty | Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. |
| CfnBot.SessionAttributeProperty | A key/value pair representing session-specific context information. |
| CfnBot.SlotCaptureSettingProperty | Settings used when Amazon Lex successfully captures a slot value from a user. |
| CfnBot.SlotDefaultValueProperty | Specifies the default value to use when a user doesn't provide a value for a slot. |
| CfnBot.SlotDefaultValueSpecificationProperty | The default value to use when a user doesn't provide a value for a slot. |
| CfnBot.SlotPriorityProperty | Sets the priority that Amazon Lex should use when eliciting slot values from a user. |
| CfnBot.SlotProperty | Specifies the definition of a slot. |
| CfnBot.SlotTypeProperty | Describes a slot type. |
| CfnBot.SlotTypeValueProperty | Each slot type can have a set of values. |
| CfnBot.SlotValueElicitationSettingProperty | Specifies the elicitation setting details eliciting a slot. |
| CfnBot.SlotValueOverrideMapProperty | Maps a slot name to the SlotValueOverride object. |
| CfnBot.SlotValueOverrideProperty | The slot values that Amazon Lex uses when it sets slot values in a dialog step. |
| CfnBot.SlotValueProperty | The value to set in a slot. |
| CfnBot.SlotValueRegexFilterProperty | Provides a regular expression used to validate the value of a slot. |
| CfnBot.SlotValueSelectionSettingProperty | Contains settings used by Amazon Lex to select a slot value. |
| CfnBot.SSMLMessageProperty | Defines a Speech Synthesis Markup Language (SSML) prompt. |
| CfnBot.StillWaitingResponseSpecificationProperty | Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response. |
| CfnBot.TestBotAliasSettingsProperty | Specifies configuration settings for the alias used to test the bot. |
| CfnBot.TextInputSpecificationProperty | Specifies the text input specifications. |
| CfnBot.TextLogDestinationProperty | Defines the Amazon CloudWatch Logs destination log group for conversation text logs. |
| CfnBot.TextLogSettingProperty | Defines settings to enable text conversation logs. |
| CfnBot.VoiceSettingsProperty | Defines settings for using an Amazon Polly voice to communicate with a user. |
| CfnBot.WaitAndContinueSpecificationProperty | Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input. |
| CfnBotAlias | A CloudFormation |
| CfnBotAlias.AudioLogDestinationProperty | Specifies the S3 bucket location where audio logs are stored. |
| CfnBotAlias.AudioLogSettingProperty | Settings for logging audio of conversations between Amazon Lex and a user. |
| CfnBotAlias.BotAliasLocaleSettingsItemProperty | Specifies settings that are unique to a locale. |
| CfnBotAlias.BotAliasLocaleSettingsProperty | Specifies settings that are unique to a locale. |
| CfnBotAlias.CloudWatchLogGroupLogDestinationProperty | The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. |
| CfnBotAlias.CodeHookSpecificationProperty | Contains information about code hooks that Amazon Lex calls during a conversation. |
| CfnBotAlias.ConversationLogSettingsProperty | Configures conversation logging that saves audio, text, and metadata for the conversations with your users. |
| CfnBotAlias.LambdaCodeHookProperty | Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot. |
| CfnBotAlias.S3BucketLogDestinationProperty | Specifies an Amazon S3 bucket for logging audio conversations. |
| CfnBotAlias.SentimentAnalysisSettingsProperty | Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. |
| CfnBotAlias.TextLogDestinationProperty | Defines the Amazon CloudWatch Logs destination log group for conversation text logs. |
| CfnBotAlias.TextLogSettingProperty | Defines settings to enable text conversation logs. |
| CfnBotAliasProps | Properties for defining a |
| CfnBotProps | Properties for defining a |
| CfnBotVersion | A CloudFormation |
| CfnBotVersion.BotVersionLocaleDetailsProperty | The version of a bot used for a bot locale. |
| CfnBotVersion.BotVersionLocaleSpecificationProperty | Specifies the locale that Amazon Lex adds to this version. |
| CfnBotVersionProps | Properties for defining a |
| CfnResourcePolicy | A CloudFormation |
| CfnResourcePolicyProps | Properties for defining a |
Interfaces
| CfnBot.IAdvancedRecognitionSettingProperty | Provides settings that enable advanced recognition settings for slot values. |
| CfnBot.IAllowedInputTypesProperty | Specifies the allowed input types. |
| CfnBot.IAudioAndDTMFInputSpecificationProperty | Specifies the audio and DTMF input specification. |
| CfnBot.IAudioLogDestinationProperty | The location of audio log files collected when conversation logging is enabled for a bot. |
| CfnBot.IAudioLogSettingProperty | Settings for logging audio of conversations between Amazon Lex and a user. |
| CfnBot.IAudioSpecificationProperty | Specifies the audio input specifications. |
| CfnBot.IBotAliasLocaleSettingsItemProperty | Specifies locale settings for a single locale. |
| CfnBot.IBotAliasLocaleSettingsProperty | Specifies settings that are unique to a locale. |
| CfnBot.IBotLocaleProperty | Provides configuration information for a locale. |
| CfnBot.IButtonProperty | Describes a button to use on a response card used to gather slot values from a user. |
| CfnBot.ICloudWatchLogGroupLogDestinationProperty | The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. |
| CfnBot.ICodeHookSpecificationProperty | Contains information about code hooks that Amazon Lex calls during a conversation. |
| CfnBot.IConditionalBranchProperty | A set of actions that Amazon Lex should run if the condition is matched. |
| CfnBot.IConditionalSpecificationProperty | Provides a list of conditional branches. |
| CfnBot.IConditionProperty | Provides an expression that evaluates to true or false. |
| CfnBot.IConversationLogSettingsProperty | Configures conversation logging that saves audio, text, and metadata for the conversations with your users. |
| CfnBot.ICustomPayloadProperty | A custom response string that Amazon Lex sends to your application. |
| CfnBot.ICustomVocabularyItemProperty | Specifies an entry in a custom vocabulary. |
| CfnBot.ICustomVocabularyProperty | Specifies a custom vocabulary. |
| CfnBot.IDataPrivacyProperty | By default, data stored by Amazon Lex is encrypted. |
| CfnBot.IDefaultConditionalBranchProperty | A set of actions that Amazon Lex should run if none of the other conditions are met. |
| CfnBot.IDialogActionProperty | Defines the action that the bot executes at runtime when the conversation reaches this step. |
| CfnBot.IDialogCodeHookInvocationSettingProperty | Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation. |
| CfnBot.IDialogCodeHookSettingProperty | Settings that determine the Lambda function that Amazon Lex uses for processing user responses. |
| CfnBot.IDialogStateProperty | The current state of the conversation with the user. |
| CfnBot.IDTMFSpecificationProperty | Specifies the DTMF input specifications. |
| CfnBot.IElicitationCodeHookInvocationSettingProperty | Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values. |
| CfnBot.IExternalSourceSettingProperty | Provides information about the external source of the slot type's definition. |
| CfnBot.IFulfillmentCodeHookSettingProperty | Determines if a Lambda function should be invoked for a specific intent. |
| CfnBot.IFulfillmentStartResponseSpecificationProperty | Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running. |
| CfnBot.IFulfillmentUpdateResponseSpecificationProperty | Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running. |
| CfnBot.IFulfillmentUpdatesSpecificationProperty | Provides information for updating the user on the progress of fulfilling an intent. |
| CfnBot.IGrammarSlotTypeSettingProperty | Settings requried for a slot type based on a grammar that you provide. |
| CfnBot.IGrammarSlotTypeSourceProperty | Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type. |
| CfnBot.IImageResponseCardProperty | A card that is shown to the user by a messaging platform. |
| CfnBot.IInitialResponseSettingProperty | Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots. |
| CfnBot.IInputContextProperty | A context that must be active for an intent to be selected by Amazon Lex. |
| CfnBot.IIntentClosingSettingProperty | Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled. |
| CfnBot.IIntentConfirmationSettingProperty | Provides a prompt for making sure that the user is ready for the intent to be fulfilled. |
| CfnBot.IIntentOverrideProperty | Override settings to configure the intent state. |
| CfnBot.IIntentProperty | Represents an action that the user wants to perform. |
| CfnBot.IKendraConfigurationProperty | Provides configuration information for the |
| CfnBot.ILambdaCodeHookProperty | Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot. |
| CfnBot.IMessageGroupProperty | Provides one or more messages that Amazon Lex should send to the user. |
| CfnBot.IMessageProperty | The object that provides message text and its type. |
| CfnBot.IMultipleValuesSettingProperty | Indicates whether a slot can return multiple values. |
| CfnBot.IObfuscationSettingProperty | Determines whether Amazon Lex obscures slot values in conversation logs. |
| CfnBot.IOutputContextProperty | Describes a session context that is activated when an intent is fulfilled. |
| CfnBot.IPlainTextMessageProperty | Defines an ASCII text message to send to the user. |
| CfnBot.IPostDialogCodeHookInvocationSpecificationProperty | Specifies next steps to run after the dialog code hook finishes. |
| CfnBot.IPostFulfillmentStatusSpecificationProperty | Provides a setting that determines whether the post-fulfillment response is sent to the user. |
| CfnBot.IPromptAttemptSpecificationProperty | Specifies the settings on a prompt attempt. |
| CfnBot.IPromptSpecificationProperty | Specifies a list of message groups that Amazon Lex sends to a user to elicit a response. |
| CfnBot.IResponseSpecificationProperty | Specifies a list of message groups that Amazon Lex uses to respond the user input. |
| CfnBot.IS3BucketLogDestinationProperty | Specifies an Amazon S3 bucket for logging audio conversations. |
| CfnBot.IS3LocationProperty | Defines an Amazon S3 bucket location. |
| CfnBot.ISampleUtteranceProperty | A sample utterance that invokes an intent or respond to a slot elicitation prompt. |
| CfnBot.ISampleValueProperty | Defines one of the values for a slot type. |
| CfnBot.ISentimentAnalysisSettingsProperty | Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. |
| CfnBot.ISessionAttributeProperty | A key/value pair representing session-specific context information. |
| CfnBot.ISlotCaptureSettingProperty | Settings used when Amazon Lex successfully captures a slot value from a user. |
| CfnBot.ISlotDefaultValueProperty | Specifies the default value to use when a user doesn't provide a value for a slot. |
| CfnBot.ISlotDefaultValueSpecificationProperty | The default value to use when a user doesn't provide a value for a slot. |
| CfnBot.ISlotPriorityProperty | Sets the priority that Amazon Lex should use when eliciting slot values from a user. |
| CfnBot.ISlotProperty | Specifies the definition of a slot. |
| CfnBot.ISlotTypeProperty | Describes a slot type. |
| CfnBot.ISlotTypeValueProperty | Each slot type can have a set of values. |
| CfnBot.ISlotValueElicitationSettingProperty | Specifies the elicitation setting details eliciting a slot. |
| CfnBot.ISlotValueOverrideMapProperty | Maps a slot name to the SlotValueOverride object. |
| CfnBot.ISlotValueOverrideProperty | The slot values that Amazon Lex uses when it sets slot values in a dialog step. |
| CfnBot.ISlotValueProperty | The value to set in a slot. |
| CfnBot.ISlotValueRegexFilterProperty | Provides a regular expression used to validate the value of a slot. |
| CfnBot.ISlotValueSelectionSettingProperty | Contains settings used by Amazon Lex to select a slot value. |
| CfnBot.ISSMLMessageProperty | Defines a Speech Synthesis Markup Language (SSML) prompt. |
| CfnBot.IStillWaitingResponseSpecificationProperty | Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response. |
| CfnBot.ITestBotAliasSettingsProperty | Specifies configuration settings for the alias used to test the bot. |
| CfnBot.ITextInputSpecificationProperty | Specifies the text input specifications. |
| CfnBot.ITextLogDestinationProperty | Defines the Amazon CloudWatch Logs destination log group for conversation text logs. |
| CfnBot.ITextLogSettingProperty | Defines settings to enable text conversation logs. |
| CfnBot.IVoiceSettingsProperty | Defines settings for using an Amazon Polly voice to communicate with a user. |
| CfnBot.IWaitAndContinueSpecificationProperty | Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input. |
| CfnBotAlias.IAudioLogDestinationProperty | Specifies the S3 bucket location where audio logs are stored. |
| CfnBotAlias.IAudioLogSettingProperty | Settings for logging audio of conversations between Amazon Lex and a user. |
| CfnBotAlias.IBotAliasLocaleSettingsItemProperty | Specifies settings that are unique to a locale. |
| CfnBotAlias.IBotAliasLocaleSettingsProperty | Specifies settings that are unique to a locale. |
| CfnBotAlias.ICloudWatchLogGroupLogDestinationProperty | The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. |
| CfnBotAlias.ICodeHookSpecificationProperty | Contains information about code hooks that Amazon Lex calls during a conversation. |
| CfnBotAlias.IConversationLogSettingsProperty | Configures conversation logging that saves audio, text, and metadata for the conversations with your users. |
| CfnBotAlias.ILambdaCodeHookProperty | Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot. |
| CfnBotAlias.IS3BucketLogDestinationProperty | Specifies an Amazon S3 bucket for logging audio conversations. |
| CfnBotAlias.ISentimentAnalysisSettingsProperty | Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. |
| CfnBotAlias.ITextLogDestinationProperty | Defines the Amazon CloudWatch Logs destination log group for conversation text logs. |
| CfnBotAlias.ITextLogSettingProperty | Defines settings to enable text conversation logs. |
| CfnBotVersion.IBotVersionLocaleDetailsProperty | The version of a bot used for a bot locale. |
| CfnBotVersion.IBotVersionLocaleSpecificationProperty | Specifies the locale that Amazon Lex adds to this version. |
| ICfnBotAliasProps | Properties for defining a |
| ICfnBotProps | Properties for defining a |
| ICfnBotVersionProps | Properties for defining a |
| ICfnResourcePolicyProps | Properties for defining a |