This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::Lex::Bot **Note** Amazon Lex V2 is the only supported version in CloudFormation. Specifies an Amazon Lex conversational bot. You must configure an intent based on the `AMAZON.FallbackIntent` built-in intent. If you don't add one, creating the bot will fail. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Lex::Bot", "Properties" : { "[AutoBuildBotLocales](#cfn-lex-bot-autobuildbotlocales)" : Boolean, "[BotFileS3Location](#cfn-lex-bot-botfiles3location)" : S3Location, "[BotLocales](#cfn-lex-bot-botlocales)" : [ BotLocale, ... ], "[BotTags](#cfn-lex-bot-bottags)" : [ Tag, ... ], "[DataPrivacy](#cfn-lex-bot-dataprivacy)" : DataPrivacy, "[Description](#cfn-lex-bot-description)" : String, "[ErrorLogSettings](#cfn-lex-bot-errorlogsettings)" : ErrorLogSettings, "[IdleSessionTTLInSeconds](#cfn-lex-bot-idlesessionttlinseconds)" : Integer, "[Name](#cfn-lex-bot-name)" : String, "[Replication](#cfn-lex-bot-replication)" : Replication, "[RoleArn](#cfn-lex-bot-rolearn)" : String, "[TestBotAliasSettings](#cfn-lex-bot-testbotaliassettings)" : TestBotAliasSettings, "[TestBotAliasTags](#cfn-lex-bot-testbotaliastags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::Lex::Bot Properties: [AutoBuildBotLocales](#cfn-lex-bot-autobuildbotlocales): Boolean [BotFileS3Location](#cfn-lex-bot-botfiles3location): S3Location [BotLocales](#cfn-lex-bot-botlocales): - BotLocale [BotTags](#cfn-lex-bot-bottags): - Tag [DataPrivacy](#cfn-lex-bot-dataprivacy): DataPrivacy [Description](#cfn-lex-bot-description): String [ErrorLogSettings](#cfn-lex-bot-errorlogsettings): ErrorLogSettings [IdleSessionTTLInSeconds](#cfn-lex-bot-idlesessionttlinseconds): Integer [Name](#cfn-lex-bot-name): String [Replication](#cfn-lex-bot-replication): Replication [RoleArn](#cfn-lex-bot-rolearn): String [TestBotAliasSettings](#cfn-lex-bot-testbotaliassettings): TestBotAliasSettings [TestBotAliasTags](#cfn-lex-bot-testbotaliastags): - Tag ``` ## Properties `AutoBuildBotLocales` Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BotFileS3Location` The Amazon S3 location of files used to import a bot. The files must be in the import format specified in [JSON format for importing and exporting](https://docs.aws.amazon.com/lexv2/latest/dg/import-export-format.html) in the *Amazon Lex developer guide.* *Required*: No *Type*: [S3Location](aws-properties-lex-bot-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BotLocales` A list of locales for the bot. *Required*: No *Type*: Array of [BotLocale](aws-properties-lex-bot-botlocale.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BotTags` A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the `UpdateBot` operation to update tags. To update tags, use the `TagResource` operation. *Required*: No *Type*: Array of [Tag](aws-properties-lex-bot-tag.md) *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataPrivacy` 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. *Required*: Yes *Type*: [DataPrivacy](aws-properties-lex-bot-dataprivacy.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the version. *Required*: No *Type*: String *Maximum*: `2000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ErrorLogSettings` Property description not available. *Required*: No *Type*: [ErrorLogSettings](aws-properties-lex-bot-errorlogsettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdleSessionTTLInSeconds` The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout. You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. *Required*: Yes *Type*: Integer *Minimum*: `60` *Maximum*: `86400` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the bot locale. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Replication` Property description not available. *Required*: No *Type*: [Replication](aws-properties-lex-bot-replication.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The Amazon Resource Name (ARN) of the IAM role used to build and run the bot. *Required*: Yes *Type*: String *Pattern*: `^arn:aws[a-zA-Z-]*:iam::[0-9]{12}:role/.*$` *Minimum*: `32` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TestBotAliasSettings` Specifies configuration settings for the alias used to test the bot. If the `TestBotAliasSettings` property is not specified, the settings are configured with default values. *Required*: No *Type*: [TestBotAliasSettings](aws-properties-lex-bot-testbotaliassettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TestBotAliasTags` A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the `UpdateAlias` operation to update tags. To update tags on the test alias, use the `TagResource` operation. *Required*: No *Type*: Array of [Tag](aws-properties-lex-bot-tag.md) *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` The Amazon Resource Name (ARN) of the bot. `Id` The unique identifier of the bot. ## Examples **Topics** + [Order flowers example bot](#aws-resource-lex-bot--examples--Order_flowers_example_bot) + [Book trip example bot](#aws-resource-lex-bot--examples--Book_trip_example_bot) ### Order flowers example bot The example creates a bot to order flowers. It is the same as the example bot that you can create using the console. #### YAML ``` # The OrderFlower bot consists of the following: # 1. IAM role that is used by the bot at runtime # 2. Inline Bot # 3. Bot Version # 4. Alias Resources: # 1. IAM Role used by the Lex service to make runtime calls BotRuntimeRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Principal: Service: - lexv2.amazonaws.com Action: - "sts:AssumeRole" Path: "/" Policies: - PolicyName: LexRuntimeRolePolicy PolicyDocument: Version: 2012-10-17 Statement: - Effect: Allow Action: - "polly:SynthesizeSpeech" - "comprehend:DetectSentiment" Resource: "*" # 2. Inline bot definition that depends on the IAM role. # The bot definition consists of combining all the child resources into one CFN resource. # This includes Locales, Intents, Slots, and SlotTypes. OrderFlowersTemplateBot: DependsOn: BotRuntimeRole Type: AWS::Lex::Bot Properties: Name: "OrderFlowersWithCFN" RoleArn: !GetAtt BotRuntimeRole.Arn DataPrivacy: ChildDirected: false IdleSessionTTLInSeconds: 300 Description: "How to create a OrderFlowers bot with CFN" # We provide a setting that allows you to auto build the locales provided. # Locale builds are also kicked off if you attempt to create a bot version # that depends on an unbuilt locale. AutoBuildBotLocales: false BotLocales: - LocaleId: "en_US" Description: "Book a trip bot Locale" NluConfidenceThreshold: 0.40 VoiceSettings: VoiceId: "Ivy" SlotTypes: - Name: "FlowerTypes" Description: "Slot Type description" SlotTypeValues: - SampleValue: Value: lilies - SampleValue: Value: roses - SampleValue: Value: tulips ValueSelectionSetting: ResolutionStrategy: ORIGINAL_VALUE Intents: - Name: "OrderFlowers" Description: "Intent to order a bouquet of flowers for pick up" SampleUtterances: - Utterance: "I would like to pick up flowers" - Utterance: "I would like to order some flowers" IntentConfirmationSetting: PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "Okay, your {FlowerType} will be ready for pickup by {PickupTime} on {PickupDate}. Does this sound okay?" MaxRetries: 3 AllowInterrupt: false DeclinationResponse: MessageGroupsList: - Message: PlainTextMessage: Value: "Okay, I will not place your order." AllowInterrupt: false SlotPriorities: - Priority: 2 SlotName: PickupDate - Priority: 1 SlotName: FlowerType - Priority: 3 SlotName: PickupTime Slots: - Name: "FlowerType" Description: "something" SlotTypeName: "FlowerTypes" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "What type of flowers would you like to order?" MaxRetries: 3 AllowInterrupt: false - Name: "PickupDate" Description: "something" SlotTypeName: "AMAZON.Date" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "What day do you want the {FlowerType} to be picked up?" MaxRetries: 3 AllowInterrupt: false - Name: "PickupTime" Description: "something" SlotTypeName: "AMAZON.Time" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "At what time do you want the {FlowerType} to be picked up?" MaxRetries: 3 AllowInterrupt: false - Name: "FallbackIntent" Description: "Default intent when no other intent matches" ParentIntentSignature: "AMAZON.FallbackIntent" # 3. Define a bot version that depends on the DRAFT version of the Lex Bot. OrderFlowersTemplateBotVersionWithCFN: DependsOn: OrderFlowersTemplateBot Type: AWS::Lex::BotVersion Properties: BotId: !Ref OrderFlowersTemplateBot BotVersionLocaleSpecification: - LocaleId: en_US BotVersionLocaleDetails: SourceBotVersion: DRAFT Description: OrderFlowers Version # 4. Define the alias by providing the bot version created by the # AWS::Lex::BotVersion resource above. FirstBotAliasWithCFN: DependsOn: OrderFlowersTemplateBotVersionWithCFN Type: AWS::Lex::BotAlias Properties: BotId: !Ref OrderFlowersTemplateBot BotAliasName: "OrderFlowersVersion1Alias" BotVersion: !GetAtt OrderFlowersTemplateBotVersionWithCFN.BotVersion SentimentAnalysisSettings: DetectSentiment: true ``` ### Book trip example bot The example creates a bot to book hotel rooms and rental cars. It is the same as the example bot that you can create using the console. #### YAML ``` # The BookTrip bot consists of the following: # 1. IAM role that is used by the bot at runtime # 2. Inline Bot # 3. Bot Version # 4. Alias Resources: # 1. IAM Role used by the Lex service to make runtime calls BotRuntimeRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Principal: Service: - lexv2.amazonaws.com Action: - "sts:AssumeRole" Path: "/" Policies: - PolicyName: LexRuntimeRolePolicy PolicyDocument: Version: 2012-10-17 Statement: - Effect: Allow Action: - "polly:SynthesizeSpeech" - "comprehend:DetectSentiment" Resource: "*" # 2. Inline bot definition which depends on the IAM role # The bot definition consists of combining all the child resources into one CFN resource. # This includes Locales, Intents, Slots, and SlotTypes. BookTripTemplateBot: DependsOn: BotRuntimeRole Type: AWS::Lex::Bot Properties: Name: "BookTripWithCFN" RoleArn: !GetAtt BotRuntimeRole.Arn DataPrivacy: ChildDirected: false IdleSessionTTLInSeconds: 300 Description: "How to create a BookTrip bot with CFN" # Provide a setting that allows you to either auto build the locales provided. # Locale builds are also kicked off if you attempt to create a bot version # that depends on an unbuilt locale. AutoBuildBotLocales: false BotLocales: - LocaleId: "en_US" Description: "Book a trip bot Locale" NluConfidenceThreshold: 0.40 VoiceSettings: VoiceId: "Ivy" SlotTypes: - Name: "CarTypeValues" Description: "Slot Type description" SlotTypeValues: - SampleValue: Value: economy - SampleValue: Value: standard - SampleValue: Value: midsize - SampleValue: Value: full size - SampleValue: Value: luxury - SampleValue: Value: minivan ValueSelectionSetting: ResolutionStrategy: ORIGINAL_VALUE - Name: "RoomTypeValues" Description: "Slot Type description" SlotTypeValues: - SampleValue: Value: queen - SampleValue: Value: king - SampleValue: Value: deluxe ValueSelectionSetting: ResolutionStrategy: ORIGINAL_VALUE Intents: - Name: "BookCar" Description: "Intent to book a car on StayBooker" SampleUtterances: - Utterance: "Book a car" - Utterance: "Reserve a car" - Utterance: "Make a car reservation" SlotPriorities: - Priority: 4 SlotName: DriverAge - Priority: 1 SlotName: PickUpCity - Priority: 3 SlotName: ReturnDate - Priority: 5 SlotName: CarType - Priority: 2 SlotName: PickUpDate IntentConfirmationSetting: PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "Okay, I have you down for a {CarType} rental in {PickUpCity} from {PickUpDate} to {ReturnDate}. Should I book the reservation?" MaxRetries: 3 AllowInterrupt: false DeclinationResponse: MessageGroupsList: - Message: PlainTextMessage: Value: "Okay, I have cancelled your reservation in progress." AllowInterrupt: false Slots: - Name: "PickUpCity" Description: "something" SlotTypeName: "AMAZON.City" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "In what city do you need to rent a car?" MaxRetries: 3 AllowInterrupt: false - Name: "PickUpDate" Description: "something" SlotTypeName: "AMAZON.Date" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "What day do you want to start your rental?" MaxRetries: 3 AllowInterrupt: false - Name: "ReturnDate" Description: "something" SlotTypeName: "AMAZON.Date" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "What day do you want to return the car?" MaxRetries: 3 AllowInterrupt: false - Name: "DriverAge" Description: "something" SlotTypeName: "AMAZON.Number" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "How old is the driver for this rental?" MaxRetries: 3 AllowInterrupt: false - Name: "CarType" Description: "something" SlotTypeName: "CarTypeValues" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "What type of car would you like to rent? Our most popular options are economy, midsize, and luxury" MaxRetries: 3 AllowInterrupt: false # We expect developers to provide the FallbackIntent when generating their bot. # The service will throw an exception if it isn't provided. - Name: "BookHotel" Description: "Intent to book a hotel on StayBooker" SampleUtterances: - Utterance: "Book a hotel" - Utterance: "I want a make hotel reservations" - Utterance: "Book a {Nights} night stay in {Location}" IntentConfirmationSetting: PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "Okay, I have you down for a {Nights} night stay in {Location} starting {CheckInDate}. Shall I book the reservation?" MaxRetries: 3 AllowInterrupt: false DeclinationResponse: MessageGroupsList: - Message: PlainTextMessage: Value: "Okay, I have cancelled your reservation in progress." AllowInterrupt: true SlotPriorities: - Priority: 4 SlotName: RoomType - Priority: 1 SlotName: Location - Priority: 3 SlotName: Nights - Priority: 2 SlotName: CheckInDate Slots: - Name: "Location" Description: "something" SlotTypeName: "AMAZON.City" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "What city will you be staying in?" MaxRetries: 3 AllowInterrupt: false - Name: "CheckInDate" Description: "something" SlotTypeName: "AMAZON.Date" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "What day do you want to check in?" MaxRetries: 3 AllowInterrupt: false - Name: "Nights" Description: "something" SlotTypeName: "AMAZON.Number" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "How many nights will you be staying?" MaxRetries: 3 AllowInterrupt: false - Name: "RoomType" Description: "something" SlotTypeName: "RoomTypeValues" ValueElicitationSetting: SlotConstraint: "Required" PromptSpecification: MessageGroupsList: - Message: PlainTextMessage: Value: "What type of room would you like, queen, king or deluxe?" MaxRetries: 3 AllowInterrupt: false - Name: "FallbackIntent" Description: "Default intent when no other intent matches" ParentIntentSignature: "AMAZON.FallbackIntent" # 3. Define a bot version which depends on the DRAFT version of the Lex Bot BookTripBotVersionWithCFN: DependsOn: BookTripTemplateBot Type: AWS::Lex::BotVersion Properties: BotId: !Ref BookTripTemplateBot BotVersionLocaleSpecification: - LocaleId: en_US BotVersionLocaleDetails: SourceBotVersion: DRAFT Description: BookTrip Version # 4. We define the alias by providing the bot version created by the AWS::Lex::BotVersion resource above FirstBotAliasWithCFN: DependsOn: BookTripBotVersionWithCFN Type: AWS::Lex::BotAlias Properties: BotId: !Ref BookTripTemplateBot BotAliasName: "BookTripVersion1Alias" # Remove BotAliasLocaleSettings if you aren't concerned with Lambda setup. # If you are you can modify the LambdaArn below to get started. # BotAliasLocaleSettings: # - LocaleId: en_US # BotAliasLocaleSetting: # Enabled: false # CodeHookSpecification: # LambdaCodeHook: # CodeHookInterfaceVersion: "1.0" # LambdaArn: "arn:aws:lambda:us-east-1:111111111111:function:ReplaceWithYourOwnLambda" BotVersion: !GetAtt BookTripBotVersionWithCFN.BotVersion SentimentAnalysisSettings: DetectSentiment: true ``` # AWS::Lex::Bot AdvancedRecognitionSetting Provides settings that enable advanced recognition settings for slot values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AudioRecognitionStrategy](#cfn-lex-bot-advancedrecognitionsetting-audiorecognitionstrategy)" : String } ``` ### YAML ``` [AudioRecognitionStrategy](#cfn-lex-bot-advancedrecognitionsetting-audiorecognitionstrategy): String ``` ## Properties `AudioRecognitionStrategy` Enables using the slot values as a custom vocabulary for recognizing user utterances. *Required*: No *Type*: String *Allowed values*: `UseSlotValuesAsCustomVocabulary` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot AllowedInputTypes Specifies the allowed input types. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowAudioInput](#cfn-lex-bot-allowedinputtypes-allowaudioinput)" : Boolean, "[AllowDTMFInput](#cfn-lex-bot-allowedinputtypes-allowdtmfinput)" : Boolean } ``` ### YAML ``` [AllowAudioInput](#cfn-lex-bot-allowedinputtypes-allowaudioinput): Boolean [AllowDTMFInput](#cfn-lex-bot-allowedinputtypes-allowdtmfinput): Boolean ``` ## Properties `AllowAudioInput` Indicates whether audio input is allowed. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowDTMFInput` Indicates whether DTMF input is allowed. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot AudioAndDTMFInputSpecification Specifies the audio and DTMF input specification. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AudioSpecification](#cfn-lex-bot-audioanddtmfinputspecification-audiospecification)" : AudioSpecification, "[DTMFSpecification](#cfn-lex-bot-audioanddtmfinputspecification-dtmfspecification)" : DTMFSpecification, "[StartTimeoutMs](#cfn-lex-bot-audioanddtmfinputspecification-starttimeoutms)" : Integer } ``` ### YAML ``` [AudioSpecification](#cfn-lex-bot-audioanddtmfinputspecification-audiospecification): AudioSpecification [DTMFSpecification](#cfn-lex-bot-audioanddtmfinputspecification-dtmfspecification): DTMFSpecification [StartTimeoutMs](#cfn-lex-bot-audioanddtmfinputspecification-starttimeoutms): Integer ``` ## Properties `AudioSpecification` Specifies the settings on audio input. *Required*: No *Type*: [AudioSpecification](aws-properties-lex-bot-audiospecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DTMFSpecification` Specifies the settings on DTMF input. *Required*: No *Type*: [DTMFSpecification](aws-properties-lex-bot-dtmfspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StartTimeoutMs` Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs. *Required*: Yes *Type*: Integer *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot AudioLogDestination The location of audio log files collected when conversation logging is enabled for a bot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3Bucket](#cfn-lex-bot-audiologdestination-s3bucket)" : S3BucketLogDestination } ``` ### YAML ``` [S3Bucket](#cfn-lex-bot-audiologdestination-s3bucket): S3BucketLogDestination ``` ## Properties `S3Bucket` Specifies the Amazon S3 bucket where the audio files are stored. *Required*: Yes *Type*: [S3BucketLogDestination](aws-properties-lex-bot-s3bucketlogdestination.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot AudioLogSetting 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Destination](#cfn-lex-bot-audiologsetting-destination)" : AudioLogDestination, "[Enabled](#cfn-lex-bot-audiologsetting-enabled)" : Boolean } ``` ### YAML ``` [Destination](#cfn-lex-bot-audiologsetting-destination): AudioLogDestination [Enabled](#cfn-lex-bot-audiologsetting-enabled): Boolean ``` ## Properties `Destination` Specifies the location of the audio log files collected when conversation logging is enabled for a bot. *Required*: Yes *Type*: [AudioLogDestination](aws-properties-lex-bot-audiologdestination.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` Determines whether audio logging in enabled for the bot. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot AudioSpecification Specifies the audio input specifications. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EndTimeoutMs](#cfn-lex-bot-audiospecification-endtimeoutms)" : Integer, "[MaxLengthMs](#cfn-lex-bot-audiospecification-maxlengthms)" : Integer } ``` ### YAML ``` [EndTimeoutMs](#cfn-lex-bot-audiospecification-endtimeoutms): Integer [MaxLengthMs](#cfn-lex-bot-audiospecification-maxlengthms): Integer ``` ## Properties `EndTimeoutMs` Time for which a bot waits after the customer stops speaking to assume the utterance is finished. *Required*: Yes *Type*: Integer *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxLengthMs` Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application. *Required*: Yes *Type*: Integer *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BedrockAgentConfiguration The `BedrockAgentConfiguration` property type specifies Property description not available. for an [AWS::Lex::Bot](aws-resource-lex-bot.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockAgentAliasId](#cfn-lex-bot-bedrockagentconfiguration-bedrockagentaliasid)" : String, "[BedrockAgentId](#cfn-lex-bot-bedrockagentconfiguration-bedrockagentid)" : String } ``` ### YAML ``` [BedrockAgentAliasId](#cfn-lex-bot-bedrockagentconfiguration-bedrockagentaliasid): String [BedrockAgentId](#cfn-lex-bot-bedrockagentconfiguration-bedrockagentid): String ``` ## Properties `BedrockAgentAliasId` Property description not available. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BedrockAgentId` Property description not available. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BedrockAgentIntentConfiguration The `BedrockAgentIntentConfiguration` property type specifies Property description not available. for an [AWS::Lex::Bot](aws-resource-lex-bot.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockAgentConfiguration](#cfn-lex-bot-bedrockagentintentconfiguration-bedrockagentconfiguration)" : BedrockAgentConfiguration, "[BedrockAgentIntentKnowledgeBaseConfiguration](#cfn-lex-bot-bedrockagentintentconfiguration-bedrockagentintentknowledgebaseconfiguration)" : BedrockAgentIntentKnowledgeBaseConfiguration } ``` ### YAML ``` [BedrockAgentConfiguration](#cfn-lex-bot-bedrockagentintentconfiguration-bedrockagentconfiguration): BedrockAgentConfiguration [BedrockAgentIntentKnowledgeBaseConfiguration](#cfn-lex-bot-bedrockagentintentconfiguration-bedrockagentintentknowledgebaseconfiguration): BedrockAgentIntentKnowledgeBaseConfiguration ``` ## Properties `BedrockAgentConfiguration` Property description not available. *Required*: No *Type*: [BedrockAgentConfiguration](aws-properties-lex-bot-bedrockagentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BedrockAgentIntentKnowledgeBaseConfiguration` Property description not available. *Required*: No *Type*: [BedrockAgentIntentKnowledgeBaseConfiguration](aws-properties-lex-bot-bedrockagentintentknowledgebaseconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BedrockAgentIntentKnowledgeBaseConfiguration The `BedrockAgentIntentKnowledgeBaseConfiguration` property type specifies Property description not available. for an [AWS::Lex::Bot](aws-resource-lex-bot.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockKnowledgeBaseArn](#cfn-lex-bot-bedrockagentintentknowledgebaseconfiguration-bedrockknowledgebasearn)" : String, "[BedrockModelConfiguration](#cfn-lex-bot-bedrockagentintentknowledgebaseconfiguration-bedrockmodelconfiguration)" : BedrockModelSpecification } ``` ### YAML ``` [BedrockKnowledgeBaseArn](#cfn-lex-bot-bedrockagentintentknowledgebaseconfiguration-bedrockknowledgebasearn): String [BedrockModelConfiguration](#cfn-lex-bot-bedrockagentintentknowledgebaseconfiguration-bedrockmodelconfiguration): BedrockModelSpecification ``` ## Properties `BedrockKnowledgeBaseArn` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BedrockModelConfiguration` Property description not available. *Required*: Yes *Type*: [BedrockModelSpecification](aws-properties-lex-bot-bedrockmodelspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BedrockGuardrailConfiguration The details on the Bedrock guardrail configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockGuardrailIdentifier](#cfn-lex-bot-bedrockguardrailconfiguration-bedrockguardrailidentifier)" : String, "[BedrockGuardrailVersion](#cfn-lex-bot-bedrockguardrailconfiguration-bedrockguardrailversion)" : String } ``` ### YAML ``` [BedrockGuardrailIdentifier](#cfn-lex-bot-bedrockguardrailconfiguration-bedrockguardrailidentifier): String [BedrockGuardrailVersion](#cfn-lex-bot-bedrockguardrailconfiguration-bedrockguardrailversion): String ``` ## Properties `BedrockGuardrailIdentifier` Property description not available. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BedrockGuardrailVersion` Property description not available. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BedrockKnowledgeStoreConfiguration Contains details about the configuration of a Amazon Bedrock knowledge base. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockKnowledgeBaseArn](#cfn-lex-bot-bedrockknowledgestoreconfiguration-bedrockknowledgebasearn)" : String, "[BKBExactResponseFields](#cfn-lex-bot-bedrockknowledgestoreconfiguration-bkbexactresponsefields)" : BKBExactResponseFields, "[ExactResponse](#cfn-lex-bot-bedrockknowledgestoreconfiguration-exactresponse)" : Boolean } ``` ### YAML ``` [BedrockKnowledgeBaseArn](#cfn-lex-bot-bedrockknowledgestoreconfiguration-bedrockknowledgebasearn): String [BKBExactResponseFields](#cfn-lex-bot-bedrockknowledgestoreconfiguration-bkbexactresponsefields): BKBExactResponseFields [ExactResponse](#cfn-lex-bot-bedrockknowledgestoreconfiguration-exactresponse): Boolean ``` ## Properties `BedrockKnowledgeBaseArn` The base ARN of the knowledge base used. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BKBExactResponseFields` Property description not available. *Required*: No *Type*: [BKBExactResponseFields](aws-properties-lex-bot-bkbexactresponsefields.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExactResponse` Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BedrockModelSpecification Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockGuardrailConfiguration](#cfn-lex-bot-bedrockmodelspecification-bedrockguardrailconfiguration)" : BedrockGuardrailConfiguration, "[BedrockModelCustomPrompt](#cfn-lex-bot-bedrockmodelspecification-bedrockmodelcustomprompt)" : String, "[BedrockTraceStatus](#cfn-lex-bot-bedrockmodelspecification-bedrocktracestatus)" : String, "[ModelArn](#cfn-lex-bot-bedrockmodelspecification-modelarn)" : String } ``` ### YAML ``` [BedrockGuardrailConfiguration](#cfn-lex-bot-bedrockmodelspecification-bedrockguardrailconfiguration): BedrockGuardrailConfiguration [BedrockModelCustomPrompt](#cfn-lex-bot-bedrockmodelspecification-bedrockmodelcustomprompt): String [BedrockTraceStatus](#cfn-lex-bot-bedrockmodelspecification-bedrocktracestatus): String [ModelArn](#cfn-lex-bot-bedrockmodelspecification-modelarn): String ``` ## Properties `BedrockGuardrailConfiguration` Property description not available. *Required*: No *Type*: [BedrockGuardrailConfiguration](aws-properties-lex-bot-bedrockguardrailconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BedrockModelCustomPrompt` Property description not available. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BedrockTraceStatus` Property description not available. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelArn` The ARN of the foundation model used in descriptive bot building. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BKBExactResponseFields The `BKBExactResponseFields` property type specifies Property description not available. for an [AWS::Lex::Bot](aws-resource-lex-bot.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AnswerField](#cfn-lex-bot-bkbexactresponsefields-answerfield)" : String } ``` ### YAML ``` [AnswerField](#cfn-lex-bot-bkbexactresponsefields-answerfield): String ``` ## Properties `AnswerField` Property description not available. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BotAliasLocaleSettings Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CodeHookSpecification](#cfn-lex-bot-botaliaslocalesettings-codehookspecification)" : CodeHookSpecification, "[Enabled](#cfn-lex-bot-botaliaslocalesettings-enabled)" : Boolean } ``` ### YAML ``` [CodeHookSpecification](#cfn-lex-bot-botaliaslocalesettings-codehookspecification): CodeHookSpecification [Enabled](#cfn-lex-bot-botaliaslocalesettings-enabled): Boolean ``` ## Properties `CodeHookSpecification` Specifies the Lambda function that should be used in the locale. *Required*: No *Type*: [CodeHookSpecification](aws-properties-lex-bot-codehookspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` Determines whether the locale is enabled for the bot. If the value is `false`, the locale isn't available for use. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BotAliasLocaleSettingsItem Specifies locale settings for a single locale. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BotAliasLocaleSetting](#cfn-lex-bot-botaliaslocalesettingsitem-botaliaslocalesetting)" : BotAliasLocaleSettings, "[LocaleId](#cfn-lex-bot-botaliaslocalesettingsitem-localeid)" : String } ``` ### YAML ``` [BotAliasLocaleSetting](#cfn-lex-bot-botaliaslocalesettingsitem-botaliaslocalesetting): BotAliasLocaleSettings [LocaleId](#cfn-lex-bot-botaliaslocalesettingsitem-localeid): String ``` ## Properties `BotAliasLocaleSetting` Specifies locale settings for a locale. *Required*: Yes *Type*: [BotAliasLocaleSettings](aws-properties-lex-bot-botaliaslocalesettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LocaleId` Specifies the locale that the settings apply to. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BotLocale Provides configuration information for a locale. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomVocabulary](#cfn-lex-bot-botlocale-customvocabulary)" : CustomVocabulary, "[Description](#cfn-lex-bot-botlocale-description)" : String, "[GenerativeAISettings](#cfn-lex-bot-botlocale-generativeaisettings)" : GenerativeAISettings, "[Intents](#cfn-lex-bot-botlocale-intents)" : [ Intent, ... ], "[LocaleId](#cfn-lex-bot-botlocale-localeid)" : String, "[NluConfidenceThreshold](#cfn-lex-bot-botlocale-nluconfidencethreshold)" : Number, "[SlotTypes](#cfn-lex-bot-botlocale-slottypes)" : [ SlotType, ... ], "[SpeechDetectionSensitivity](#cfn-lex-bot-botlocale-speechdetectionsensitivity)" : String, "[SpeechRecognitionSettings](#cfn-lex-bot-botlocale-speechrecognitionsettings)" : SpeechRecognitionSettings, "[UnifiedSpeechSettings](#cfn-lex-bot-botlocale-unifiedspeechsettings)" : UnifiedSpeechSettings, "[VoiceSettings](#cfn-lex-bot-botlocale-voicesettings)" : VoiceSettings } ``` ### YAML ``` [CustomVocabulary](#cfn-lex-bot-botlocale-customvocabulary): CustomVocabulary [Description](#cfn-lex-bot-botlocale-description): String [GenerativeAISettings](#cfn-lex-bot-botlocale-generativeaisettings): GenerativeAISettings [Intents](#cfn-lex-bot-botlocale-intents): - Intent [LocaleId](#cfn-lex-bot-botlocale-localeid): String [NluConfidenceThreshold](#cfn-lex-bot-botlocale-nluconfidencethreshold): Number [SlotTypes](#cfn-lex-bot-botlocale-slottypes): - SlotType [SpeechDetectionSensitivity](#cfn-lex-bot-botlocale-speechdetectionsensitivity): String [SpeechRecognitionSettings](#cfn-lex-bot-botlocale-speechrecognitionsettings): SpeechRecognitionSettings [UnifiedSpeechSettings](#cfn-lex-bot-botlocale-unifiedspeechsettings): UnifiedSpeechSettings [VoiceSettings](#cfn-lex-bot-botlocale-voicesettings): VoiceSettings ``` ## Properties `CustomVocabulary` Specifies a custom vocabulary to use with a specific locale. *Required*: No *Type*: [CustomVocabulary](aws-properties-lex-bot-customvocabulary.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description of the bot locale. Use this to help identify the bot locale in lists. *Required*: No *Type*: String *Maximum*: `2000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GenerativeAISettings` Property description not available. *Required*: No *Type*: [GenerativeAISettings](aws-properties-lex-bot-generativeaisettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Intents` One or more intents defined for the locale. *Required*: No *Type*: Array of [Intent](aws-properties-lex-bot-intent.md) *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LocaleId` The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NluConfidenceThreshold` Determines the threshold where Amazon Lex will insert the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents. You must configure an `AMAZON.FallbackIntent`. `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot. *Required*: Yes *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotTypes` One or more slot types defined for the locale. *Required*: No *Type*: Array of [SlotType](aws-properties-lex-bot-slottype.md) *Maximum*: `250` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SpeechDetectionSensitivity` Property description not available. *Required*: No *Type*: String *Allowed values*: `Default | HighNoiseTolerance | MaximumNoiseTolerance` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SpeechRecognitionSettings` Property description not available. *Required*: No *Type*: [SpeechRecognitionSettings](aws-properties-lex-bot-speechrecognitionsettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UnifiedSpeechSettings` Property description not available. *Required*: No *Type*: [UnifiedSpeechSettings](aws-properties-lex-bot-unifiedspeechsettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VoiceSettings` Defines settings for using an Amazon Polly voice to communicate with a user. Valid values include: + `standard` + `neural` + `long-form` + `generative` *Required*: No *Type*: [VoiceSettings](aws-properties-lex-bot-voicesettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot BuildtimeSettings Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DescriptiveBotBuilderSpecification](#cfn-lex-bot-buildtimesettings-descriptivebotbuilderspecification)" : DescriptiveBotBuilderSpecification, "[SampleUtteranceGenerationSpecification](#cfn-lex-bot-buildtimesettings-sampleutterancegenerationspecification)" : SampleUtteranceGenerationSpecification } ``` ### YAML ``` [DescriptiveBotBuilderSpecification](#cfn-lex-bot-buildtimesettings-descriptivebotbuilderspecification): DescriptiveBotBuilderSpecification [SampleUtteranceGenerationSpecification](#cfn-lex-bot-buildtimesettings-sampleutterancegenerationspecification): SampleUtteranceGenerationSpecification ``` ## Properties `DescriptiveBotBuilderSpecification` Property description not available. *Required*: No *Type*: [DescriptiveBotBuilderSpecification](aws-properties-lex-bot-descriptivebotbuilderspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SampleUtteranceGenerationSpecification` Property description not available. *Required*: No *Type*: [SampleUtteranceGenerationSpecification](aws-properties-lex-bot-sampleutterancegenerationspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot Button Describes a button to use on a response card used to gather slot values from a user. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Text](#cfn-lex-bot-button-text)" : String, "[Value](#cfn-lex-bot-button-value)" : String } ``` ### YAML ``` [Text](#cfn-lex-bot-button-text): String [Value](#cfn-lex-bot-button-value): String ``` ## Properties `Text` The text that appears on the button. Use this to tell the user what value is returned when they choose this button. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot CloudWatchLogGroupLogDestination The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CloudWatchLogGroupArn](#cfn-lex-bot-cloudwatchloggrouplogdestination-cloudwatchloggrouparn)" : String, "[LogPrefix](#cfn-lex-bot-cloudwatchloggrouplogdestination-logprefix)" : String } ``` ### YAML ``` [CloudWatchLogGroupArn](#cfn-lex-bot-cloudwatchloggrouplogdestination-cloudwatchloggrouparn): String [LogPrefix](#cfn-lex-bot-cloudwatchloggrouplogdestination-logprefix): String ``` ## Properties `CloudWatchLogGroupArn` The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogPrefix` The prefix of the log stream name within the log group that you specified *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot CodeHookSpecification Contains information about code hooks that Amazon Lex calls during a conversation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LambdaCodeHook](#cfn-lex-bot-codehookspecification-lambdacodehook)" : LambdaCodeHook } ``` ### YAML ``` [LambdaCodeHook](#cfn-lex-bot-codehookspecification-lambdacodehook): LambdaCodeHook ``` ## Properties `LambdaCodeHook` Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot. *Required*: Yes *Type*: [LambdaCodeHook](aws-properties-lex-bot-lambdacodehook.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot CompositeSlotTypeSetting A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SubSlots](#cfn-lex-bot-compositeslottypesetting-subslots)" : [ SubSlotTypeComposition, ... ] } ``` ### YAML ``` [SubSlots](#cfn-lex-bot-compositeslottypesetting-subslots): - SubSlotTypeComposition ``` ## Properties `SubSlots` Subslots in the composite slot. *Required*: No *Type*: Array of [SubSlotTypeComposition](aws-properties-lex-bot-subslottypecomposition.md) *Minimum*: `1` *Maximum*: `6` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot Condition Provides an expression that evaluates to true or false. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ExpressionString](#cfn-lex-bot-condition-expressionstring)" : String } ``` ### YAML ``` [ExpressionString](#cfn-lex-bot-condition-expressionstring): String ``` ## Properties `ExpressionString` The expression string that is evaluated. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ConditionalBranch A set of actions that Amazon Lex should run if the condition is matched. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Condition](#cfn-lex-bot-conditionalbranch-condition)" : Condition, "[Name](#cfn-lex-bot-conditionalbranch-name)" : String, "[NextStep](#cfn-lex-bot-conditionalbranch-nextstep)" : DialogState, "[Response](#cfn-lex-bot-conditionalbranch-response)" : ResponseSpecification } ``` ### YAML ``` [Condition](#cfn-lex-bot-conditionalbranch-condition): Condition [Name](#cfn-lex-bot-conditionalbranch-name): String [NextStep](#cfn-lex-bot-conditionalbranch-nextstep): DialogState [Response](#cfn-lex-bot-conditionalbranch-response): ResponseSpecification ``` ## Properties `Condition` Contains the expression to evaluate. If the condition is true, the branch's actions are taken. *Required*: Yes *Type*: [Condition](aws-properties-lex-bot-condition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the branch. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NextStep` The next step in the conversation. *Required*: Yes *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Response` Specifies a list of message groups that Amazon Lex uses to respond the user input. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ConditionalSpecification 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConditionalBranches](#cfn-lex-bot-conditionalspecification-conditionalbranches)" : [ ConditionalBranch, ... ], "[DefaultBranch](#cfn-lex-bot-conditionalspecification-defaultbranch)" : DefaultConditionalBranch, "[IsActive](#cfn-lex-bot-conditionalspecification-isactive)" : Boolean } ``` ### YAML ``` [ConditionalBranches](#cfn-lex-bot-conditionalspecification-conditionalbranches): - ConditionalBranch [DefaultBranch](#cfn-lex-bot-conditionalspecification-defaultbranch): DefaultConditionalBranch [IsActive](#cfn-lex-bot-conditionalspecification-isactive): Boolean ``` ## Properties `ConditionalBranches` A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true. *Required*: Yes *Type*: Array of [ConditionalBranch](aws-properties-lex-bot-conditionalbranch.md) *Minimum*: `1` *Maximum*: `4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefaultBranch` The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step. *Required*: Yes *Type*: [DefaultConditionalBranch](aws-properties-lex-bot-defaultconditionalbranch.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsActive` Determines whether a conditional branch is active. When `IsActive` is false, the conditions are not evaluated. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ConversationLogSettings Configures conversation logging that saves audio, text, and metadata for the conversations with your users. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AudioLogSettings](#cfn-lex-bot-conversationlogsettings-audiologsettings)" : [ AudioLogSetting, ... ], "[TextLogSettings](#cfn-lex-bot-conversationlogsettings-textlogsettings)" : [ TextLogSetting, ... ] } ``` ### YAML ``` [AudioLogSettings](#cfn-lex-bot-conversationlogsettings-audiologsettings): - AudioLogSetting [TextLogSettings](#cfn-lex-bot-conversationlogsettings-textlogsettings): - TextLogSetting ``` ## Properties `AudioLogSettings` The Amazon S3 settings for logging audio to an S3 bucket. *Required*: No *Type*: Array of [AudioLogSetting](aws-properties-lex-bot-audiologsetting.md) *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TextLogSettings` The Amazon CloudWatch Logs settings for logging text and metadata. *Required*: No *Type*: Array of [TextLogSetting](aws-properties-lex-bot-textlogsetting.md) *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot CustomPayload A custom response string that Amazon Lex sends to your application. You define the content and structure the string. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Value](#cfn-lex-bot-custompayload-value)" : String } ``` ### YAML ``` [Value](#cfn-lex-bot-custompayload-value): String ``` ## Properties `Value` The string that is sent to your application. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot CustomVocabulary Specifies a custom vocabulary. A custom vocabulary is a list of words that you expect to be used during a conversation with your bot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomVocabularyItems](#cfn-lex-bot-customvocabulary-customvocabularyitems)" : [ CustomVocabularyItem, ... ] } ``` ### YAML ``` [CustomVocabularyItems](#cfn-lex-bot-customvocabulary-customvocabularyitems): - CustomVocabularyItem ``` ## Properties `CustomVocabularyItems` Specifies a list of words that you expect to be used during a conversation with your bot. *Required*: Yes *Type*: Array of [CustomVocabularyItem](aws-properties-lex-bot-customvocabularyitem.md) *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot CustomVocabularyItem Specifies an entry in a custom vocabulary. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DisplayAs](#cfn-lex-bot-customvocabularyitem-displayas)" : String, "[Phrase](#cfn-lex-bot-customvocabularyitem-phrase)" : String, "[Weight](#cfn-lex-bot-customvocabularyitem-weight)" : Integer } ``` ### YAML ``` [DisplayAs](#cfn-lex-bot-customvocabularyitem-displayas): String [Phrase](#cfn-lex-bot-customvocabularyitem-phrase): String [Weight](#cfn-lex-bot-customvocabularyitem-weight): Integer ``` ## Properties `DisplayAs` The DisplayAs value for the custom vocabulary item from the custom vocabulary list. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Phrase` Specifies 1 - 4 words that should be recognized. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Weight` Specifies the degree to which the phrase recognition is boosted. The default value is 1. *Required*: No *Type*: Integer *Minimum*: `0` *Maximum*: `3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DataPrivacy 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ChildDirected](#cfn-lex-bot-dataprivacy-childdirected)" : Boolean } ``` ### YAML ``` [ChildDirected](#cfn-lex-bot-dataprivacy-childdirected): Boolean ``` ## Properties `ChildDirected` For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying `true` or `false` in the `childDirected` field. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex **is** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ](https://aws.amazon.com/lex/faqs#data-security). *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DataSourceConfiguration 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockKnowledgeStoreConfiguration](#cfn-lex-bot-datasourceconfiguration-bedrockknowledgestoreconfiguration)" : BedrockKnowledgeStoreConfiguration, "[KendraConfiguration](#cfn-lex-bot-datasourceconfiguration-kendraconfiguration)" : QnAKendraConfiguration, "[OpensearchConfiguration](#cfn-lex-bot-datasourceconfiguration-opensearchconfiguration)" : OpensearchConfiguration } ``` ### YAML ``` [BedrockKnowledgeStoreConfiguration](#cfn-lex-bot-datasourceconfiguration-bedrockknowledgestoreconfiguration): BedrockKnowledgeStoreConfiguration [KendraConfiguration](#cfn-lex-bot-datasourceconfiguration-kendraconfiguration): QnAKendraConfiguration [OpensearchConfiguration](#cfn-lex-bot-datasourceconfiguration-opensearchconfiguration): OpensearchConfiguration ``` ## Properties `BedrockKnowledgeStoreConfiguration` Contains details about the configuration of the Amazon Bedrock knowledge base used for the `AMAZON.QnAIntent`. To set up a knowledge base, follow the steps at [Building a knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html). *Required*: No *Type*: [BedrockKnowledgeStoreConfiguration](aws-properties-lex-bot-bedrockknowledgestoreconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KendraConfiguration` Contains details about the configuration of the Amazon Kendra index used for the `AMAZON.QnAIntent`. To create a Amazon Kendra index, follow the steps at [Creating an index](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html). *Required*: No *Type*: [QnAKendraConfiguration](aws-properties-lex-bot-qnakendraconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OpensearchConfiguration` Contains details about the configuration of the Amazon OpenSearch Service database used for the `AMAZON.QnAIntent`. To create a domain, follow the steps at [Creating and managing Amazon OpenSearch Service domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html). *Required*: No *Type*: [OpensearchConfiguration](aws-properties-lex-bot-opensearchconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DeepgramSpeechModelConfig Configuration settings for integrating Deepgram speech-to-text models with Amazon Lex. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiTokenSecretArn](#cfn-lex-bot-deepgramspeechmodelconfig-apitokensecretarn)" : String, "[ModelId](#cfn-lex-bot-deepgramspeechmodelconfig-modelid)" : String } ``` ### YAML ``` [ApiTokenSecretArn](#cfn-lex-bot-deepgramspeechmodelconfig-apitokensecretarn): String [ModelId](#cfn-lex-bot-deepgramspeechmodelconfig-modelid): String ``` ## Properties `ApiTokenSecretArn` The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the Deepgram API token. *Required*: Yes *Type*: String *Pattern*: `^arn:aws[A-Za-z-]*:secretsmanager:[a-z0-9-]{1,20}:[0-9]{12}:secret:[A-Za-z0-9/_+=.@-]{1,512}-[A-Za-z0-9]{6}$` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelId` The identifier of the Deepgram speech-to-text model to use for processing speech input. *Required*: No *Type*: String *Pattern*: `[A-Za-z0-9-_]+` *Minimum*: `4` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DefaultConditionalBranch A set of actions that Amazon Lex should run if none of the other conditions are met. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[NextStep](#cfn-lex-bot-defaultconditionalbranch-nextstep)" : DialogState, "[Response](#cfn-lex-bot-defaultconditionalbranch-response)" : ResponseSpecification } ``` ### YAML ``` [NextStep](#cfn-lex-bot-defaultconditionalbranch-nextstep): DialogState [Response](#cfn-lex-bot-defaultconditionalbranch-response): ResponseSpecification ``` ## Properties `NextStep` The next step in the conversation. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Response` Specifies a list of message groups that Amazon Lex uses to respond the user input. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DescriptiveBotBuilderSpecification Contains specifications for the descriptive bot building feature. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockModelSpecification](#cfn-lex-bot-descriptivebotbuilderspecification-bedrockmodelspecification)" : BedrockModelSpecification, "[Enabled](#cfn-lex-bot-descriptivebotbuilderspecification-enabled)" : Boolean } ``` ### YAML ``` [BedrockModelSpecification](#cfn-lex-bot-descriptivebotbuilderspecification-bedrockmodelspecification): BedrockModelSpecification [Enabled](#cfn-lex-bot-descriptivebotbuilderspecification-enabled): Boolean ``` ## Properties `BedrockModelSpecification` An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building. *Required*: No *Type*: [BedrockModelSpecification](aws-properties-lex-bot-bedrockmodelspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` Specifies whether the descriptive bot building feature is activated or not. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DialogAction Defines the action that the bot executes at runtime when the conversation reaches this step. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SlotToElicit](#cfn-lex-bot-dialogaction-slottoelicit)" : String, "[SuppressNextMessage](#cfn-lex-bot-dialogaction-suppressnextmessage)" : Boolean, "[Type](#cfn-lex-bot-dialogaction-type)" : String } ``` ### YAML ``` [SlotToElicit](#cfn-lex-bot-dialogaction-slottoelicit): String [SuppressNextMessage](#cfn-lex-bot-dialogaction-suppressnextmessage): Boolean [Type](#cfn-lex-bot-dialogaction-type): String ``` ## Properties `SlotToElicit` If the dialog action is `ElicitSlot`, defines the slot to elicit from the user. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SuppressNextMessage` When true the next message for the intent is not used. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The action that the bot should execute. *Required*: Yes *Type*: String *Allowed values*: `CloseIntent | ConfirmIntent | ElicitIntent | ElicitSlot | StartIntent | FulfillIntent | EndConversation | EvaluateConditional | InvokeDialogCodeHook` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DialogCodeHookInvocationSetting Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnableCodeHookInvocation](#cfn-lex-bot-dialogcodehookinvocationsetting-enablecodehookinvocation)" : Boolean, "[InvocationLabel](#cfn-lex-bot-dialogcodehookinvocationsetting-invocationlabel)" : String, "[IsActive](#cfn-lex-bot-dialogcodehookinvocationsetting-isactive)" : Boolean, "[PostCodeHookSpecification](#cfn-lex-bot-dialogcodehookinvocationsetting-postcodehookspecification)" : PostDialogCodeHookInvocationSpecification } ``` ### YAML ``` [EnableCodeHookInvocation](#cfn-lex-bot-dialogcodehookinvocationsetting-enablecodehookinvocation): Boolean [InvocationLabel](#cfn-lex-bot-dialogcodehookinvocationsetting-invocationlabel): String [IsActive](#cfn-lex-bot-dialogcodehookinvocationsetting-isactive): Boolean [PostCodeHookSpecification](#cfn-lex-bot-dialogcodehookinvocationsetting-postcodehookspecification): PostDialogCodeHookInvocationSpecification ``` ## Properties `EnableCodeHookInvocation` Indicates whether a Lambda function should be invoked for the dialog. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InvocationLabel` A label that indicates the dialog step from which the dialog code hook is happening. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsActive` Determines whether a dialog code hook is used when the intent is activated. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PostCodeHookSpecification` Contains the responses and actions that Amazon Lex takes after the Lambda function is complete. *Required*: Yes *Type*: [PostDialogCodeHookInvocationSpecification](aws-properties-lex-bot-postdialogcodehookinvocationspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DialogCodeHookSetting Settings that determine the Lambda function that Amazon Lex uses for processing user responses. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Enabled](#cfn-lex-bot-dialogcodehooksetting-enabled)" : Boolean } ``` ### YAML ``` [Enabled](#cfn-lex-bot-dialogcodehooksetting-enabled): Boolean ``` ## Properties `Enabled` Enables the dialog code hook so that it processes user requests. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DialogState The current state of the conversation with the user. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DialogAction](#cfn-lex-bot-dialogstate-dialogaction)" : DialogAction, "[Intent](#cfn-lex-bot-dialogstate-intent)" : IntentOverride, "[SessionAttributes](#cfn-lex-bot-dialogstate-sessionattributes)" : [ SessionAttribute, ... ] } ``` ### YAML ``` [DialogAction](#cfn-lex-bot-dialogstate-dialogaction): DialogAction [Intent](#cfn-lex-bot-dialogstate-intent): IntentOverride [SessionAttributes](#cfn-lex-bot-dialogstate-sessionattributes): - SessionAttribute ``` ## Properties `DialogAction` Defines the action that the bot executes at runtime when the conversation reaches this step. *Required*: No *Type*: [DialogAction](aws-properties-lex-bot-dialogaction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Intent` Override settings to configure the intent state. *Required*: No *Type*: [IntentOverride](aws-properties-lex-bot-intentoverride.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SessionAttributes` Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application. *Required*: No *Type*: Array of [SessionAttribute](aws-properties-lex-bot-sessionattribute.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot DTMFSpecification Specifies the DTMF input specifications. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DeletionCharacter](#cfn-lex-bot-dtmfspecification-deletioncharacter)" : String, "[EndCharacter](#cfn-lex-bot-dtmfspecification-endcharacter)" : String, "[EndTimeoutMs](#cfn-lex-bot-dtmfspecification-endtimeoutms)" : Integer, "[MaxLength](#cfn-lex-bot-dtmfspecification-maxlength)" : Integer } ``` ### YAML ``` [DeletionCharacter](#cfn-lex-bot-dtmfspecification-deletioncharacter): String [EndCharacter](#cfn-lex-bot-dtmfspecification-endcharacter): String [EndTimeoutMs](#cfn-lex-bot-dtmfspecification-endtimeoutms): Integer [MaxLength](#cfn-lex-bot-dtmfspecification-maxlength): Integer ``` ## Properties `DeletionCharacter` The DTMF character that clears the accumulated DTMF digits and immediately ends the input. *Required*: Yes *Type*: String *Pattern*: `^[A-D0-9#*]{1}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EndCharacter` The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout. *Required*: Yes *Type*: String *Pattern*: `^[A-D0-9#*]{1}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EndTimeoutMs` How long the bot should wait after the last DTMF character input before assuming that the input has concluded. *Required*: Yes *Type*: Integer *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxLength` The maximum number of DTMF digits allowed in an utterance. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ElicitationCodeHookInvocationSetting Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnableCodeHookInvocation](#cfn-lex-bot-elicitationcodehookinvocationsetting-enablecodehookinvocation)" : Boolean, "[InvocationLabel](#cfn-lex-bot-elicitationcodehookinvocationsetting-invocationlabel)" : String } ``` ### YAML ``` [EnableCodeHookInvocation](#cfn-lex-bot-elicitationcodehookinvocationsetting-enablecodehookinvocation): Boolean [InvocationLabel](#cfn-lex-bot-elicitationcodehookinvocationsetting-invocationlabel): String ``` ## Properties `EnableCodeHookInvocation` Indicates whether a Lambda function should be invoked for the dialog. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InvocationLabel` A label that indicates the dialog step from which the dialog code hook is happening. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ErrorLogSettings The `ErrorLogSettings` property type specifies Property description not available. for an [AWS::Lex::Bot](aws-resource-lex-bot.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Enabled](#cfn-lex-bot-errorlogsettings-enabled)" : Boolean } ``` ### YAML ``` [Enabled](#cfn-lex-bot-errorlogsettings-enabled): Boolean ``` ## Properties `Enabled` Property description not available. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ExactResponseFields Contains the names of the fields used for an exact response to the user. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AnswerField](#cfn-lex-bot-exactresponsefields-answerfield)" : String, "[QuestionField](#cfn-lex-bot-exactresponsefields-questionfield)" : String } ``` ### YAML ``` [AnswerField](#cfn-lex-bot-exactresponsefields-answerfield): String [QuestionField](#cfn-lex-bot-exactresponsefields-questionfield): String ``` ## Properties `AnswerField` The name of the field that contains the answer to the query made to the OpenSearch Service database. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QuestionField` The name of the field that contains the query made to the OpenSearch Service database. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ExternalSourceSetting Provides information about the external source of the slot type's definition. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GrammarSlotTypeSetting](#cfn-lex-bot-externalsourcesetting-grammarslottypesetting)" : GrammarSlotTypeSetting } ``` ### YAML ``` [GrammarSlotTypeSetting](#cfn-lex-bot-externalsourcesetting-grammarslottypesetting): GrammarSlotTypeSetting ``` ## Properties `GrammarSlotTypeSetting` Settings required for a slot type based on a grammar that you provide. *Required*: No *Type*: [GrammarSlotTypeSetting](aws-properties-lex-bot-grammarslottypesetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot FulfillmentCodeHookSetting Determines if a Lambda function should be invoked for a specific intent. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Enabled](#cfn-lex-bot-fulfillmentcodehooksetting-enabled)" : Boolean, "[FulfillmentUpdatesSpecification](#cfn-lex-bot-fulfillmentcodehooksetting-fulfillmentupdatesspecification)" : FulfillmentUpdatesSpecification, "[IsActive](#cfn-lex-bot-fulfillmentcodehooksetting-isactive)" : Boolean, "[PostFulfillmentStatusSpecification](#cfn-lex-bot-fulfillmentcodehooksetting-postfulfillmentstatusspecification)" : PostFulfillmentStatusSpecification } ``` ### YAML ``` [Enabled](#cfn-lex-bot-fulfillmentcodehooksetting-enabled): Boolean [FulfillmentUpdatesSpecification](#cfn-lex-bot-fulfillmentcodehooksetting-fulfillmentupdatesspecification): FulfillmentUpdatesSpecification [IsActive](#cfn-lex-bot-fulfillmentcodehooksetting-isactive): Boolean [PostFulfillmentStatusSpecification](#cfn-lex-bot-fulfillmentcodehooksetting-postfulfillmentstatusspecification): PostFulfillmentStatusSpecification ``` ## Properties `Enabled` Indicates whether a Lambda function should be invoked to fulfill a specific intent. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FulfillmentUpdatesSpecification` Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations. *Required*: No *Type*: [FulfillmentUpdatesSpecification](aws-properties-lex-bot-fulfillmentupdatesspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsActive` Determines whether the fulfillment code hook is used. When `active` is false, the code hook doesn't run. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PostFulfillmentStatusSpecification` Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations. *Required*: No *Type*: [PostFulfillmentStatusSpecification](aws-properties-lex-bot-postfulfillmentstatusspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot FulfillmentStartResponseSpecification Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowInterrupt](#cfn-lex-bot-fulfillmentstartresponsespecification-allowinterrupt)" : Boolean, "[DelayInSeconds](#cfn-lex-bot-fulfillmentstartresponsespecification-delayinseconds)" : Integer, "[MessageGroups](#cfn-lex-bot-fulfillmentstartresponsespecification-messagegroups)" : [ MessageGroup, ... ] } ``` ### YAML ``` [AllowInterrupt](#cfn-lex-bot-fulfillmentstartresponsespecification-allowinterrupt): Boolean [DelayInSeconds](#cfn-lex-bot-fulfillmentstartresponsespecification-delayinseconds): Integer [MessageGroups](#cfn-lex-bot-fulfillmentstartresponsespecification-messagegroups): - MessageGroup ``` ## Properties `AllowInterrupt` Determines whether the user can interrupt the start message while it is playing. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DelayInSeconds` The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `900` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MessageGroups` 1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user. *Required*: Yes *Type*: Array of [MessageGroup](aws-properties-lex-bot-messagegroup.md) *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot FulfillmentUpdateResponseSpecification Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowInterrupt](#cfn-lex-bot-fulfillmentupdateresponsespecification-allowinterrupt)" : Boolean, "[FrequencyInSeconds](#cfn-lex-bot-fulfillmentupdateresponsespecification-frequencyinseconds)" : Integer, "[MessageGroups](#cfn-lex-bot-fulfillmentupdateresponsespecification-messagegroups)" : [ MessageGroup, ... ] } ``` ### YAML ``` [AllowInterrupt](#cfn-lex-bot-fulfillmentupdateresponsespecification-allowinterrupt): Boolean [FrequencyInSeconds](#cfn-lex-bot-fulfillmentupdateresponsespecification-frequencyinseconds): Integer [MessageGroups](#cfn-lex-bot-fulfillmentupdateresponsespecification-messagegroups): - MessageGroup ``` ## Properties `AllowInterrupt` Determines whether the user can interrupt an update message while it is playing. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FrequencyInSeconds` The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `900` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MessageGroups` 1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. *Required*: Yes *Type*: Array of [MessageGroup](aws-properties-lex-bot-messagegroup.md) *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot FulfillmentUpdatesSpecification Provides information for updating the user on the progress of fulfilling an intent. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Active](#cfn-lex-bot-fulfillmentupdatesspecification-active)" : Boolean, "[StartResponse](#cfn-lex-bot-fulfillmentupdatesspecification-startresponse)" : FulfillmentStartResponseSpecification, "[TimeoutInSeconds](#cfn-lex-bot-fulfillmentupdatesspecification-timeoutinseconds)" : Integer, "[UpdateResponse](#cfn-lex-bot-fulfillmentupdatesspecification-updateresponse)" : FulfillmentUpdateResponseSpecification } ``` ### YAML ``` [Active](#cfn-lex-bot-fulfillmentupdatesspecification-active): Boolean [StartResponse](#cfn-lex-bot-fulfillmentupdatesspecification-startresponse): FulfillmentStartResponseSpecification [TimeoutInSeconds](#cfn-lex-bot-fulfillmentupdatesspecification-timeoutinseconds): Integer [UpdateResponse](#cfn-lex-bot-fulfillmentupdatesspecification-updateresponse): FulfillmentUpdateResponseSpecification ``` ## Properties `Active` Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent. If the `active` field is set to true, the `startResponse`, `updateResponse`, and `timeoutInSeconds` fields are required. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StartResponse` Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running. *Required*: No *Type*: [FulfillmentStartResponseSpecification](aws-properties-lex-bot-fulfillmentstartresponsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeoutInSeconds` The length of time that the fulfillment Lambda function should run before it times out. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `900` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UpdateResponse` Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running. *Required*: No *Type*: [FulfillmentUpdateResponseSpecification](aws-properties-lex-bot-fulfillmentupdateresponsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot GenerativeAISettings Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BuildtimeSettings](#cfn-lex-bot-generativeaisettings-buildtimesettings)" : BuildtimeSettings, "[RuntimeSettings](#cfn-lex-bot-generativeaisettings-runtimesettings)" : RuntimeSettings } ``` ### YAML ``` [BuildtimeSettings](#cfn-lex-bot-generativeaisettings-buildtimesettings): BuildtimeSettings [RuntimeSettings](#cfn-lex-bot-generativeaisettings-runtimesettings): RuntimeSettings ``` ## Properties `BuildtimeSettings` Property description not available. *Required*: No *Type*: [BuildtimeSettings](aws-properties-lex-bot-buildtimesettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RuntimeSettings` Property description not available. *Required*: No *Type*: [RuntimeSettings](aws-properties-lex-bot-runtimesettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot GrammarSlotTypeSetting Settings requried for a slot type based on a grammar that you provide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Source](#cfn-lex-bot-grammarslottypesetting-source)" : GrammarSlotTypeSource } ``` ### YAML ``` [Source](#cfn-lex-bot-grammarslottypesetting-source): GrammarSlotTypeSource ``` ## Properties `Source` The source of the grammar used to create the slot type. *Required*: No *Type*: [GrammarSlotTypeSource](aws-properties-lex-bot-grammarslottypesource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot GrammarSlotTypeSource Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyArn](#cfn-lex-bot-grammarslottypesource-kmskeyarn)" : String, "[S3BucketName](#cfn-lex-bot-grammarslottypesource-s3bucketname)" : String, "[S3ObjectKey](#cfn-lex-bot-grammarslottypesource-s3objectkey)" : String } ``` ### YAML ``` [KmsKeyArn](#cfn-lex-bot-grammarslottypesource-kmskeyarn): String [S3BucketName](#cfn-lex-bot-grammarslottypesource-s3bucketname): String [S3ObjectKey](#cfn-lex-bot-grammarslottypesource-s3objectkey): String ``` ## Properties `KmsKeyArn` The AWS KMS key required to decrypt the contents of the grammar, if any. *Required*: No *Type*: String *Pattern*: `^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3BucketName` The name of the Amazon S3 bucket that contains the grammar source. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3ObjectKey` The path to the grammar in the Amazon S3 bucket. *Required*: Yes *Type*: String *Pattern*: `[\.\-\!\*\_\'a-zA-Z0-9][\.\-\!\*\_\'\/a-zA-Z0-9]*$` *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ImageResponseCard A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform. When you use a response card, the response from the user is constrained to the text associated with a button on the card. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Buttons](#cfn-lex-bot-imageresponsecard-buttons)" : [ Button, ... ], "[ImageUrl](#cfn-lex-bot-imageresponsecard-imageurl)" : String, "[Subtitle](#cfn-lex-bot-imageresponsecard-subtitle)" : String, "[Title](#cfn-lex-bot-imageresponsecard-title)" : String } ``` ### YAML ``` [Buttons](#cfn-lex-bot-imageresponsecard-buttons): - Button [ImageUrl](#cfn-lex-bot-imageresponsecard-imageurl): String [Subtitle](#cfn-lex-bot-imageresponsecard-subtitle): String [Title](#cfn-lex-bot-imageresponsecard-title): String ``` ## Properties `Buttons` A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button. *Required*: No *Type*: Array of [Button](aws-properties-lex-bot-button.md) *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ImageUrl` The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `250` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Subtitle` The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `250` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Title` The title to display on the response card. The format of the title is determined by the platform displaying the response card. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `250` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot InitialResponseSetting Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CodeHook](#cfn-lex-bot-initialresponsesetting-codehook)" : DialogCodeHookInvocationSetting, "[Conditional](#cfn-lex-bot-initialresponsesetting-conditional)" : ConditionalSpecification, "[InitialResponse](#cfn-lex-bot-initialresponsesetting-initialresponse)" : ResponseSpecification, "[NextStep](#cfn-lex-bot-initialresponsesetting-nextstep)" : DialogState } ``` ### YAML ``` [CodeHook](#cfn-lex-bot-initialresponsesetting-codehook): DialogCodeHookInvocationSetting [Conditional](#cfn-lex-bot-initialresponsesetting-conditional): ConditionalSpecification [InitialResponse](#cfn-lex-bot-initialresponsesetting-initialresponse): ResponseSpecification [NextStep](#cfn-lex-bot-initialresponsesetting-nextstep): DialogState ``` ## Properties `CodeHook` Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation. *Required*: No *Type*: [DialogCodeHookInvocationSetting](aws-properties-lex-bot-dialogcodehookinvocationsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Conditional` 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. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InitialResponse` Specifies a list of message groups that Amazon Lex uses to respond the user input. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NextStep` The next step in the conversation. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot InputContext A context that must be active for an intent to be selected by Amazon Lex. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-lex-bot-inputcontext-name)" : String } ``` ### YAML ``` [Name](#cfn-lex-bot-inputcontext-name): String ``` ## Properties `Name` The name of the context. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot Intent Represents an action that the user wants to perform. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockAgentIntentConfiguration](#cfn-lex-bot-intent-bedrockagentintentconfiguration)" : BedrockAgentIntentConfiguration, "[Description](#cfn-lex-bot-intent-description)" : String, "[DialogCodeHook](#cfn-lex-bot-intent-dialogcodehook)" : DialogCodeHookSetting, "[DisplayName](#cfn-lex-bot-intent-displayname)" : String, "[FulfillmentCodeHook](#cfn-lex-bot-intent-fulfillmentcodehook)" : FulfillmentCodeHookSetting, "[InitialResponseSetting](#cfn-lex-bot-intent-initialresponsesetting)" : InitialResponseSetting, "[InputContexts](#cfn-lex-bot-intent-inputcontexts)" : [ InputContext, ... ], "[IntentClosingSetting](#cfn-lex-bot-intent-intentclosingsetting)" : IntentClosingSetting, "[IntentConfirmationSetting](#cfn-lex-bot-intent-intentconfirmationsetting)" : IntentConfirmationSetting, "[KendraConfiguration](#cfn-lex-bot-intent-kendraconfiguration)" : KendraConfiguration, "[Name](#cfn-lex-bot-intent-name)" : String, "[OutputContexts](#cfn-lex-bot-intent-outputcontexts)" : [ OutputContext, ... ], "[ParentIntentSignature](#cfn-lex-bot-intent-parentintentsignature)" : String, "[QInConnectIntentConfiguration](#cfn-lex-bot-intent-qinconnectintentconfiguration)" : QInConnectIntentConfiguration, "[QnAIntentConfiguration](#cfn-lex-bot-intent-qnaintentconfiguration)" : QnAIntentConfiguration, "[SampleUtterances](#cfn-lex-bot-intent-sampleutterances)" : [ SampleUtterance, ... ], "[SlotPriorities](#cfn-lex-bot-intent-slotpriorities)" : [ SlotPriority, ... ], "[Slots](#cfn-lex-bot-intent-slots)" : [ Slot, ... ] } ``` ### YAML ``` [BedrockAgentIntentConfiguration](#cfn-lex-bot-intent-bedrockagentintentconfiguration): BedrockAgentIntentConfiguration [Description](#cfn-lex-bot-intent-description): String [DialogCodeHook](#cfn-lex-bot-intent-dialogcodehook): DialogCodeHookSetting [DisplayName](#cfn-lex-bot-intent-displayname): String [FulfillmentCodeHook](#cfn-lex-bot-intent-fulfillmentcodehook): FulfillmentCodeHookSetting [InitialResponseSetting](#cfn-lex-bot-intent-initialresponsesetting): InitialResponseSetting [InputContexts](#cfn-lex-bot-intent-inputcontexts): - InputContext [IntentClosingSetting](#cfn-lex-bot-intent-intentclosingsetting): IntentClosingSetting [IntentConfirmationSetting](#cfn-lex-bot-intent-intentconfirmationsetting): IntentConfirmationSetting [KendraConfiguration](#cfn-lex-bot-intent-kendraconfiguration): KendraConfiguration [Name](#cfn-lex-bot-intent-name): String [OutputContexts](#cfn-lex-bot-intent-outputcontexts): - OutputContext [ParentIntentSignature](#cfn-lex-bot-intent-parentintentsignature): String [QInConnectIntentConfiguration](#cfn-lex-bot-intent-qinconnectintentconfiguration): QInConnectIntentConfiguration [QnAIntentConfiguration](#cfn-lex-bot-intent-qnaintentconfiguration): QnAIntentConfiguration [SampleUtterances](#cfn-lex-bot-intent-sampleutterances): - SampleUtterance [SlotPriorities](#cfn-lex-bot-intent-slotpriorities): - SlotPriority [Slots](#cfn-lex-bot-intent-slots): - Slot ``` ## Properties `BedrockAgentIntentConfiguration` Property description not available. *Required*: No *Type*: [BedrockAgentIntentConfiguration](aws-properties-lex-bot-bedrockagentintentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description of the intent. Use the description to help identify the intent in lists. *Required*: No *Type*: String *Maximum*: `2000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DialogCodeHook` Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction. *Required*: No *Type*: [DialogCodeHookSetting](aws-properties-lex-bot-dialogcodehooksetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisplayName` Property description not available. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FulfillmentCodeHook` Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user. *Required*: No *Type*: [FulfillmentCodeHookSetting](aws-properties-lex-bot-fulfillmentcodehooksetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InitialResponseSetting` Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots. *Required*: No *Type*: [InitialResponseSetting](aws-properties-lex-bot-initialresponsesetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputContexts` A list of contexts that must be active for this intent to be considered by Amazon Lex. *Required*: No *Type*: Array of [InputContext](aws-properties-lex-bot-inputcontext.md) *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IntentClosingSetting` Sets the response that Amazon Lex sends to the user when the intent is closed. *Required*: No *Type*: [IntentClosingSetting](aws-properties-lex-bot-intentclosingsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IntentConfirmationSetting` Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent. *Required*: No *Type*: [IntentConfirmationSetting](aws-properties-lex-bot-intentconfirmationsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KendraConfiguration` 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. *Required*: No *Type*: [KendraConfiguration](aws-properties-lex-bot-kendraconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the intent. Intent names must be unique within the locale that contains the intent and can't match the name of any built-in intent. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputContexts` A list of contexts that the intent activates when it is fulfilled. *Required*: No *Type*: Array of [OutputContext](aws-properties-lex-bot-outputcontext.md) *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ParentIntentSignature` A unique identifier for the built-in intent to base this intent on. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QInConnectIntentConfiguration` Property description not available. *Required*: No *Type*: [QInConnectIntentConfiguration](aws-properties-lex-bot-qinconnectintentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QnAIntentConfiguration` Property description not available. *Required*: No *Type*: [QnAIntentConfiguration](aws-properties-lex-bot-qnaintentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SampleUtterances` A list of utterances that a user might say to signal the intent. *Required*: No *Type*: Array of [SampleUtterance](aws-properties-lex-bot-sampleutterance.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotPriorities` Indicates the priority for slots. Amazon Lex prompts the user for slot values in priority order. *Required*: No *Type*: Array of [SlotPriority](aws-properties-lex-bot-slotpriority.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Slots` A list of slots that the intent requires for fulfillment. *Required*: No *Type*: Array of [Slot](aws-properties-lex-bot-slot.md) *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot IntentClosingSetting Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ClosingResponse](#cfn-lex-bot-intentclosingsetting-closingresponse)" : ResponseSpecification, "[Conditional](#cfn-lex-bot-intentclosingsetting-conditional)" : ConditionalSpecification, "[IsActive](#cfn-lex-bot-intentclosingsetting-isactive)" : Boolean, "[NextStep](#cfn-lex-bot-intentclosingsetting-nextstep)" : DialogState } ``` ### YAML ``` [ClosingResponse](#cfn-lex-bot-intentclosingsetting-closingresponse): ResponseSpecification [Conditional](#cfn-lex-bot-intentclosingsetting-conditional): ConditionalSpecification [IsActive](#cfn-lex-bot-intentclosingsetting-isactive): Boolean [NextStep](#cfn-lex-bot-intentclosingsetting-nextstep): DialogState ``` ## Properties `ClosingResponse` The response that Amazon Lex sends to the user when the intent is complete. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Conditional` A list of conditional branches associated with the intent's closing response. These branches are executed when the `nextStep` attribute is set to `EvalutateConditional`. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsActive` Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the `IsActive` field isn't specified, the default is true. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NextStep` Specifies the next step that the bot executes after playing the intent's closing response. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot IntentConfirmationSetting Provides a prompt for making sure that the user is ready for the intent to be fulfilled. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CodeHook](#cfn-lex-bot-intentconfirmationsetting-codehook)" : DialogCodeHookInvocationSetting, "[ConfirmationConditional](#cfn-lex-bot-intentconfirmationsetting-confirmationconditional)" : ConditionalSpecification, "[ConfirmationNextStep](#cfn-lex-bot-intentconfirmationsetting-confirmationnextstep)" : DialogState, "[ConfirmationResponse](#cfn-lex-bot-intentconfirmationsetting-confirmationresponse)" : ResponseSpecification, "[DeclinationConditional](#cfn-lex-bot-intentconfirmationsetting-declinationconditional)" : ConditionalSpecification, "[DeclinationNextStep](#cfn-lex-bot-intentconfirmationsetting-declinationnextstep)" : DialogState, "[DeclinationResponse](#cfn-lex-bot-intentconfirmationsetting-declinationresponse)" : ResponseSpecification, "[ElicitationCodeHook](#cfn-lex-bot-intentconfirmationsetting-elicitationcodehook)" : ElicitationCodeHookInvocationSetting, "[FailureConditional](#cfn-lex-bot-intentconfirmationsetting-failureconditional)" : ConditionalSpecification, "[FailureNextStep](#cfn-lex-bot-intentconfirmationsetting-failurenextstep)" : DialogState, "[FailureResponse](#cfn-lex-bot-intentconfirmationsetting-failureresponse)" : ResponseSpecification, "[IsActive](#cfn-lex-bot-intentconfirmationsetting-isactive)" : Boolean, "[PromptSpecification](#cfn-lex-bot-intentconfirmationsetting-promptspecification)" : PromptSpecification } ``` ### YAML ``` [CodeHook](#cfn-lex-bot-intentconfirmationsetting-codehook): DialogCodeHookInvocationSetting [ConfirmationConditional](#cfn-lex-bot-intentconfirmationsetting-confirmationconditional): ConditionalSpecification [ConfirmationNextStep](#cfn-lex-bot-intentconfirmationsetting-confirmationnextstep): DialogState [ConfirmationResponse](#cfn-lex-bot-intentconfirmationsetting-confirmationresponse): ResponseSpecification [DeclinationConditional](#cfn-lex-bot-intentconfirmationsetting-declinationconditional): ConditionalSpecification [DeclinationNextStep](#cfn-lex-bot-intentconfirmationsetting-declinationnextstep): DialogState [DeclinationResponse](#cfn-lex-bot-intentconfirmationsetting-declinationresponse): ResponseSpecification [ElicitationCodeHook](#cfn-lex-bot-intentconfirmationsetting-elicitationcodehook): ElicitationCodeHookInvocationSetting [FailureConditional](#cfn-lex-bot-intentconfirmationsetting-failureconditional): ConditionalSpecification [FailureNextStep](#cfn-lex-bot-intentconfirmationsetting-failurenextstep): DialogState [FailureResponse](#cfn-lex-bot-intentconfirmationsetting-failureresponse): ResponseSpecification [IsActive](#cfn-lex-bot-intentconfirmationsetting-isactive): Boolean [PromptSpecification](#cfn-lex-bot-intentconfirmationsetting-promptspecification): PromptSpecification ``` ## Properties `CodeHook` The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is `InvokeDialogCodeHook`. *Required*: No *Type*: [DialogCodeHookInvocationSetting](aws-properties-lex-bot-dialogcodehookinvocationsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConfirmationConditional` A list of conditional branches to evaluate after the intent is closed. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConfirmationNextStep` Specifies the next step that the bot executes when the customer confirms the intent. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConfirmationResponse` Specifies a list of message groups that Amazon Lex uses to respond the user input. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DeclinationConditional` A list of conditional branches to evaluate after the intent is declined. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DeclinationNextStep` Specifies the next step that the bot executes when the customer declines the intent. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DeclinationResponse` When the user answers "no" to the question defined in `promptSpecification`, Amazon Lex responds with this response to acknowledge that the intent was canceled. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ElicitationCodeHook` The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries. *Required*: No *Type*: [ElicitationCodeHookInvocationSetting](aws-properties-lex-bot-elicitationcodehookinvocationsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureConditional` 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. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureNextStep` The next step to take in the conversation if the confirmation step fails. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureResponse` Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsActive` Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the `IsActive` field isn't specified, the default is true. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptSpecification` Prompts the user to confirm the intent. This question should have a yes or no answer. Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the `OrderPizza` intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information. *Required*: Yes *Type*: [PromptSpecification](aws-properties-lex-bot-promptspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot IntentDisambiguationSettings Configures the Intent Disambiguation feature that helps resolve ambiguous user inputs when multiple intents could match. When enabled, the system presents clarifying questions to users, helping them specify their exact intent for improved conversation accuracy. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomDisambiguationMessage](#cfn-lex-bot-intentdisambiguationsettings-customdisambiguationmessage)" : String, "[Enabled](#cfn-lex-bot-intentdisambiguationsettings-enabled)" : Boolean, "[MaxDisambiguationIntents](#cfn-lex-bot-intentdisambiguationsettings-maxdisambiguationintents)" : Integer } ``` ### YAML ``` [CustomDisambiguationMessage](#cfn-lex-bot-intentdisambiguationsettings-customdisambiguationmessage): String [Enabled](#cfn-lex-bot-intentdisambiguationsettings-enabled): Boolean [MaxDisambiguationIntents](#cfn-lex-bot-intentdisambiguationsettings-maxdisambiguationintents): Integer ``` ## Properties `CustomDisambiguationMessage` Provides a custom message that will be displayed before presenting the disambiguation options to users. This message helps set the context for users and can be customized to match your bot's tone and brand. If not specified, a default message will be used. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` Determines whether the Intent Disambiguation feature is enabled. When set to `true`, Amazon Lex will present disambiguation options to users when multiple intents could match their input, with the default being `false`. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxDisambiguationIntents` Specifies the maximum number of intent options (2-5) to present to users when disambiguation is needed. This setting determines how many intent options will be shown to users when the system detects ambiguous input. The default value is 3. *Required*: No *Type*: Integer *Minimum*: `2` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot IntentOverride Override settings to configure the intent state. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-lex-bot-intentoverride-name)" : String, "[Slots](#cfn-lex-bot-intentoverride-slots)" : [ SlotValueOverrideMap, ... ] } ``` ### YAML ``` [Name](#cfn-lex-bot-intentoverride-name): String [Slots](#cfn-lex-bot-intentoverride-slots): - SlotValueOverrideMap ``` ## Properties `Name` The name of the intent. Only required when you're switching intents. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Slots` A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden. *Required*: No *Type*: Array of [SlotValueOverrideMap](aws-properties-lex-bot-slotvalueoverridemap.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot KendraConfiguration 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KendraIndex](#cfn-lex-bot-kendraconfiguration-kendraindex)" : String, "[QueryFilterString](#cfn-lex-bot-kendraconfiguration-queryfilterstring)" : String, "[QueryFilterStringEnabled](#cfn-lex-bot-kendraconfiguration-queryfilterstringenabled)" : Boolean } ``` ### YAML ``` [KendraIndex](#cfn-lex-bot-kendraconfiguration-kendraindex): String [QueryFilterString](#cfn-lex-bot-kendraconfiguration-queryfilterstring): String [QueryFilterStringEnabled](#cfn-lex-bot-kendraconfiguration-queryfilterstringenabled): Boolean ``` ## Properties `KendraIndex` The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the `AMAZON.KendraSearchIntent` intent to search. The index must be in the same account and Region as the Amazon Lex bot. *Required*: Yes *Type*: String *Pattern*: `^arn:aws[a-zA-Z-]*:kendra:[a-z]+-(?:[a-z]+-)*[0-9]:[0-9]{12}:index/[a-zA-Z0-9][a-zA-Z0-9_-]*$` *Minimum*: `32` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QueryFilterString` A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see [Filtering queries](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html). *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QueryFilterStringEnabled` Determines whether the `AMAZON.KendraSearchIntent` intent uses a custom query string to query the Amazon Kendra index. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot LambdaCodeHook Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CodeHookInterfaceVersion](#cfn-lex-bot-lambdacodehook-codehookinterfaceversion)" : String, "[LambdaArn](#cfn-lex-bot-lambdacodehook-lambdaarn)" : String } ``` ### YAML ``` [CodeHookInterfaceVersion](#cfn-lex-bot-lambdacodehook-codehookinterfaceversion): String [LambdaArn](#cfn-lex-bot-lambdacodehook-lambdaarn): String ``` ## Properties `CodeHookInterfaceVersion` The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LambdaArn` The Amazon Resource Name (ARN) of the Lambda function. *Required*: Yes *Type*: String *Minimum*: `20` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot Message The object that provides message text and its type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomPayload](#cfn-lex-bot-message-custompayload)" : CustomPayload, "[ImageResponseCard](#cfn-lex-bot-message-imageresponsecard)" : ImageResponseCard, "[PlainTextMessage](#cfn-lex-bot-message-plaintextmessage)" : PlainTextMessage, "[SSMLMessage](#cfn-lex-bot-message-ssmlmessage)" : SSMLMessage } ``` ### YAML ``` [CustomPayload](#cfn-lex-bot-message-custompayload): CustomPayload [ImageResponseCard](#cfn-lex-bot-message-imageresponsecard): ImageResponseCard [PlainTextMessage](#cfn-lex-bot-message-plaintextmessage): PlainTextMessage [SSMLMessage](#cfn-lex-bot-message-ssmlmessage): SSMLMessage ``` ## Properties `CustomPayload` A message in a custom format defined by the client application. *Required*: No *Type*: [CustomPayload](aws-properties-lex-bot-custompayload.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ImageResponseCard` A message that defines a response card that the client application can show to the user. *Required*: No *Type*: [ImageResponseCard](aws-properties-lex-bot-imageresponsecard.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PlainTextMessage` A message in plain text format. *Required*: No *Type*: [PlainTextMessage](aws-properties-lex-bot-plaintextmessage.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SSMLMessage` A message in Speech Synthesis Markup Language (SSML). *Required*: No *Type*: [SSMLMessage](aws-properties-lex-bot-ssmlmessage.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot MessageGroup Provides one or more messages that Amazon Lex should send to the user. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Message](#cfn-lex-bot-messagegroup-message)" : Message, "[Variations](#cfn-lex-bot-messagegroup-variations)" : [ Message, ... ] } ``` ### YAML ``` [Message](#cfn-lex-bot-messagegroup-message): Message [Variations](#cfn-lex-bot-messagegroup-variations): - Message ``` ## Properties `Message` The primary message that Amazon Lex should send to the user. *Required*: Yes *Type*: [Message](aws-properties-lex-bot-message.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Variations` Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user. *Required*: No *Type*: Array of [Message](aws-properties-lex-bot-message.md) *Maximum*: `2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot MultipleValuesSetting Indicates whether a slot can return multiple values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowMultipleValues](#cfn-lex-bot-multiplevaluessetting-allowmultiplevalues)" : Boolean } ``` ### YAML ``` [AllowMultipleValues](#cfn-lex-bot-multiplevaluessetting-allowmultiplevalues): Boolean ``` ## Properties `AllowMultipleValues` Indicates whether a slot can return multiple values. When `true`, the slot may return more than one value in a response. When `false`, the slot returns only a single value. Multi-value slots are only available in the en-US locale. If you set this value to `true` in any other locale, Amazon Lex throws a `ValidationException`. If the `allowMutlipleValues` is not set, the default value is `false`. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot NluImprovementSpecification Configures the Assisted Natural Language Understanding (NLU) feature for your bot. This specification determines whether enhanced intent recognition and utterance understanding capabilities are active. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AssistedNluMode](#cfn-lex-bot-nluimprovementspecification-assistednlumode)" : String, "[Enabled](#cfn-lex-bot-nluimprovementspecification-enabled)" : Boolean, "[IntentDisambiguationSettings](#cfn-lex-bot-nluimprovementspecification-intentdisambiguationsettings)" : IntentDisambiguationSettings } ``` ### YAML ``` [AssistedNluMode](#cfn-lex-bot-nluimprovementspecification-assistednlumode): String [Enabled](#cfn-lex-bot-nluimprovementspecification-enabled): Boolean [IntentDisambiguationSettings](#cfn-lex-bot-nluimprovementspecification-intentdisambiguationsettings): IntentDisambiguationSettings ``` ## Properties `AssistedNluMode` Specifies the mode for Assisted NLU operation. Use `Primary` to make Assisted NLU the primary intent recognition method, or `Fallback` to use it only when standard NLU confidence is low. *Required*: No *Type*: String *Allowed values*: `Primary | Fallback` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` Determines whether the Assisted NLU feature is enabled for the bot. When set to `true`, Amazon Lex uses advanced models to improve intent recognition and slot resolution, with the default being `false`. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IntentDisambiguationSettings` An object containing specifications for the Intent Disambiguation feature within the Assisted NLU settings. These settings determine how the bot handles ambiguous user inputs that could match multiple intents. *Required*: No *Type*: [IntentDisambiguationSettings](aws-properties-lex-bot-intentdisambiguationsettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ObfuscationSetting Determines whether Amazon Lex obscures slot values in conversation logs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ObfuscationSettingType](#cfn-lex-bot-obfuscationsetting-obfuscationsettingtype)" : String } ``` ### YAML ``` [ObfuscationSettingType](#cfn-lex-bot-obfuscationsetting-obfuscationsettingtype): String ``` ## Properties `ObfuscationSettingType` Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values. *Required*: Yes *Type*: String *Allowed values*: `None | DefaultObfuscation` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot OpensearchConfiguration Contains details about the configuration of the Amazon OpenSearch Service database used for the `AMAZON.QnAIntent`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DomainEndpoint](#cfn-lex-bot-opensearchconfiguration-domainendpoint)" : String, "[ExactResponse](#cfn-lex-bot-opensearchconfiguration-exactresponse)" : Boolean, "[ExactResponseFields](#cfn-lex-bot-opensearchconfiguration-exactresponsefields)" : ExactResponseFields, "[IncludeFields](#cfn-lex-bot-opensearchconfiguration-includefields)" : [ String, ... ], "[IndexName](#cfn-lex-bot-opensearchconfiguration-indexname)" : String } ``` ### YAML ``` [DomainEndpoint](#cfn-lex-bot-opensearchconfiguration-domainendpoint): String [ExactResponse](#cfn-lex-bot-opensearchconfiguration-exactresponse): Boolean [ExactResponseFields](#cfn-lex-bot-opensearchconfiguration-exactresponsefields): ExactResponseFields [IncludeFields](#cfn-lex-bot-opensearchconfiguration-includefields): - String [IndexName](#cfn-lex-bot-opensearchconfiguration-indexname): String ``` ## Properties `DomainEndpoint` The endpoint of the Amazon OpenSearch Service domain. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExactResponse` Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExactResponseFields` Contains the names of the fields used for an exact response to the user. *Required*: No *Type*: [ExactResponseFields](aws-properties-lex-bot-exactresponsefields.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludeFields` Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IndexName` The name of the Amazon OpenSearch Service index. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot OutputContext Describes a session context that is activated when an intent is fulfilled. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-lex-bot-outputcontext-name)" : String, "[TimeToLiveInSeconds](#cfn-lex-bot-outputcontext-timetoliveinseconds)" : Integer, "[TurnsToLive](#cfn-lex-bot-outputcontext-turnstolive)" : Integer } ``` ### YAML ``` [Name](#cfn-lex-bot-outputcontext-name): String [TimeToLiveInSeconds](#cfn-lex-bot-outputcontext-timetoliveinseconds): Integer [TurnsToLive](#cfn-lex-bot-outputcontext-turnstolive): Integer ``` ## Properties `Name` The name of the output context. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeToLiveInSeconds` The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user. *Required*: Yes *Type*: Integer *Minimum*: `5` *Maximum*: `86400` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TurnsToLive` The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot PlainTextMessage Defines an ASCII text message to send to the user. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Value](#cfn-lex-bot-plaintextmessage-value)" : String } ``` ### YAML ``` [Value](#cfn-lex-bot-plaintextmessage-value): String ``` ## Properties `Value` The message to send to the user. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot PostDialogCodeHookInvocationSpecification Specifies next steps to run after the dialog code hook finishes. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FailureConditional](#cfn-lex-bot-postdialogcodehookinvocationspecification-failureconditional)" : ConditionalSpecification, "[FailureNextStep](#cfn-lex-bot-postdialogcodehookinvocationspecification-failurenextstep)" : DialogState, "[FailureResponse](#cfn-lex-bot-postdialogcodehookinvocationspecification-failureresponse)" : ResponseSpecification, "[SuccessConditional](#cfn-lex-bot-postdialogcodehookinvocationspecification-successconditional)" : ConditionalSpecification, "[SuccessNextStep](#cfn-lex-bot-postdialogcodehookinvocationspecification-successnextstep)" : DialogState, "[SuccessResponse](#cfn-lex-bot-postdialogcodehookinvocationspecification-successresponse)" : ResponseSpecification, "[TimeoutConditional](#cfn-lex-bot-postdialogcodehookinvocationspecification-timeoutconditional)" : ConditionalSpecification, "[TimeoutNextStep](#cfn-lex-bot-postdialogcodehookinvocationspecification-timeoutnextstep)" : DialogState, "[TimeoutResponse](#cfn-lex-bot-postdialogcodehookinvocationspecification-timeoutresponse)" : ResponseSpecification } ``` ### YAML ``` [FailureConditional](#cfn-lex-bot-postdialogcodehookinvocationspecification-failureconditional): ConditionalSpecification [FailureNextStep](#cfn-lex-bot-postdialogcodehookinvocationspecification-failurenextstep): DialogState [FailureResponse](#cfn-lex-bot-postdialogcodehookinvocationspecification-failureresponse): ResponseSpecification [SuccessConditional](#cfn-lex-bot-postdialogcodehookinvocationspecification-successconditional): ConditionalSpecification [SuccessNextStep](#cfn-lex-bot-postdialogcodehookinvocationspecification-successnextstep): DialogState [SuccessResponse](#cfn-lex-bot-postdialogcodehookinvocationspecification-successresponse): ResponseSpecification [TimeoutConditional](#cfn-lex-bot-postdialogcodehookinvocationspecification-timeoutconditional): ConditionalSpecification [TimeoutNextStep](#cfn-lex-bot-postdialogcodehookinvocationspecification-timeoutnextstep): DialogState [TimeoutResponse](#cfn-lex-bot-postdialogcodehookinvocationspecification-timeoutresponse): ResponseSpecification ``` ## Properties `FailureConditional` A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureNextStep` Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureResponse` Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SuccessConditional` A list of conditional branches to evaluate after the dialog code hook finishes successfully. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SuccessNextStep` Specifics the next step the bot runs after the dialog code hook finishes successfully. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SuccessResponse` Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeoutConditional` A list of conditional branches to evaluate if the code hook times out. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeoutNextStep` Specifies the next step that the bot runs when the code hook times out. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeoutResponse` Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot PostFulfillmentStatusSpecification Provides a setting that determines whether the post-fulfillment response is sent to the user. For more information, see [https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete](https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete) ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FailureConditional](#cfn-lex-bot-postfulfillmentstatusspecification-failureconditional)" : ConditionalSpecification, "[FailureNextStep](#cfn-lex-bot-postfulfillmentstatusspecification-failurenextstep)" : DialogState, "[FailureResponse](#cfn-lex-bot-postfulfillmentstatusspecification-failureresponse)" : ResponseSpecification, "[SuccessConditional](#cfn-lex-bot-postfulfillmentstatusspecification-successconditional)" : ConditionalSpecification, "[SuccessNextStep](#cfn-lex-bot-postfulfillmentstatusspecification-successnextstep)" : DialogState, "[SuccessResponse](#cfn-lex-bot-postfulfillmentstatusspecification-successresponse)" : ResponseSpecification, "[TimeoutConditional](#cfn-lex-bot-postfulfillmentstatusspecification-timeoutconditional)" : ConditionalSpecification, "[TimeoutNextStep](#cfn-lex-bot-postfulfillmentstatusspecification-timeoutnextstep)" : DialogState, "[TimeoutResponse](#cfn-lex-bot-postfulfillmentstatusspecification-timeoutresponse)" : ResponseSpecification } ``` ### YAML ``` [FailureConditional](#cfn-lex-bot-postfulfillmentstatusspecification-failureconditional): ConditionalSpecification [FailureNextStep](#cfn-lex-bot-postfulfillmentstatusspecification-failurenextstep): DialogState [FailureResponse](#cfn-lex-bot-postfulfillmentstatusspecification-failureresponse): ResponseSpecification [SuccessConditional](#cfn-lex-bot-postfulfillmentstatusspecification-successconditional): ConditionalSpecification [SuccessNextStep](#cfn-lex-bot-postfulfillmentstatusspecification-successnextstep): DialogState [SuccessResponse](#cfn-lex-bot-postfulfillmentstatusspecification-successresponse): ResponseSpecification [TimeoutConditional](#cfn-lex-bot-postfulfillmentstatusspecification-timeoutconditional): ConditionalSpecification [TimeoutNextStep](#cfn-lex-bot-postfulfillmentstatusspecification-timeoutnextstep): DialogState [TimeoutResponse](#cfn-lex-bot-postfulfillmentstatusspecification-timeoutresponse): ResponseSpecification ``` ## Properties `FailureConditional` A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureNextStep` Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureResponse` Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't successful. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SuccessConditional` A list of conditional branches to evaluate after the fulfillment code hook finishes successfully. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SuccessNextStep` Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SuccessResponse` Specifies a list of message groups that Amazon Lex uses to respond when the fulfillment is successful. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeoutConditional` A list of conditional branches to evaluate if the fulfillment code hook times out. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeoutNextStep` Specifies the next step that the bot runs when the fulfillment code hook times out. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeoutResponse` Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't completed within the timeout period. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot PromptAttemptSpecification Specifies the settings on a prompt attempt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowedInputTypes](#cfn-lex-bot-promptattemptspecification-allowedinputtypes)" : AllowedInputTypes, "[AllowInterrupt](#cfn-lex-bot-promptattemptspecification-allowinterrupt)" : Boolean, "[AudioAndDTMFInputSpecification](#cfn-lex-bot-promptattemptspecification-audioanddtmfinputspecification)" : AudioAndDTMFInputSpecification, "[TextInputSpecification](#cfn-lex-bot-promptattemptspecification-textinputspecification)" : TextInputSpecification } ``` ### YAML ``` [AllowedInputTypes](#cfn-lex-bot-promptattemptspecification-allowedinputtypes): AllowedInputTypes [AllowInterrupt](#cfn-lex-bot-promptattemptspecification-allowinterrupt): Boolean [AudioAndDTMFInputSpecification](#cfn-lex-bot-promptattemptspecification-audioanddtmfinputspecification): AudioAndDTMFInputSpecification [TextInputSpecification](#cfn-lex-bot-promptattemptspecification-textinputspecification): TextInputSpecification ``` ## Properties `AllowedInputTypes` Indicates the allowed input types of the prompt attempt. *Required*: Yes *Type*: [AllowedInputTypes](aws-properties-lex-bot-allowedinputtypes.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AllowInterrupt` Indicates whether the user can interrupt a speech prompt attempt from the bot. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AudioAndDTMFInputSpecification` Specifies the settings on audio and DTMF input. *Required*: No *Type*: [AudioAndDTMFInputSpecification](aws-properties-lex-bot-audioanddtmfinputspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TextInputSpecification` Specifies the settings on text input. *Required*: No *Type*: [TextInputSpecification](aws-properties-lex-bot-textinputspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot PromptSpecification Specifies a list of message groups that Amazon Lex sends to a user to elicit a response. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowInterrupt](#cfn-lex-bot-promptspecification-allowinterrupt)" : Boolean, "[MaxRetries](#cfn-lex-bot-promptspecification-maxretries)" : Integer, "[MessageGroupsList](#cfn-lex-bot-promptspecification-messagegroupslist)" : [ MessageGroup, ... ], "[MessageSelectionStrategy](#cfn-lex-bot-promptspecification-messageselectionstrategy)" : String, "[PromptAttemptsSpecification](#cfn-lex-bot-promptspecification-promptattemptsspecification)" : {Key: Value, ...} } ``` ### YAML ``` [AllowInterrupt](#cfn-lex-bot-promptspecification-allowinterrupt): Boolean [MaxRetries](#cfn-lex-bot-promptspecification-maxretries): Integer [MessageGroupsList](#cfn-lex-bot-promptspecification-messagegroupslist): - MessageGroup [MessageSelectionStrategy](#cfn-lex-bot-promptspecification-messageselectionstrategy): String [PromptAttemptsSpecification](#cfn-lex-bot-promptspecification-promptattemptsspecification): Key: Value ``` ## Properties `AllowInterrupt` Indicates whether the user can interrupt a speech prompt from the bot. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxRetries` The maximum number of times the bot tries to elicit a response from the user using this prompt. *Required*: Yes *Type*: Integer *Minimum*: `0` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MessageGroupsList` A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime. *Required*: Yes *Type*: Array of [MessageGroup](aws-properties-lex-bot-messagegroup.md) *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MessageSelectionStrategy` Indicates how a message is selected from a message group among retries. *Required*: No *Type*: String *Allowed values*: `Random | Ordered` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptAttemptsSpecification` Specifies the advanced settings on each attempt of the prompt. *Required*: No *Type*: Object of [PromptAttemptSpecification](aws-properties-lex-bot-promptattemptspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot QInConnectAssistantConfiguration The `QInConnectAssistantConfiguration` property type specifies Property description not available. for an [AWS::Lex::Bot](aws-resource-lex-bot.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AssistantArn](#cfn-lex-bot-qinconnectassistantconfiguration-assistantarn)" : String } ``` ### YAML ``` [AssistantArn](#cfn-lex-bot-qinconnectassistantconfiguration-assistantarn): String ``` ## Properties `AssistantArn` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$` *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot QInConnectIntentConfiguration The `QInConnectIntentConfiguration` property type specifies Property description not available. for an [AWS::Lex::Bot](aws-resource-lex-bot.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[QInConnectAssistantConfiguration](#cfn-lex-bot-qinconnectintentconfiguration-qinconnectassistantconfiguration)" : QInConnectAssistantConfiguration } ``` ### YAML ``` [QInConnectAssistantConfiguration](#cfn-lex-bot-qinconnectintentconfiguration-qinconnectassistantconfiguration): QInConnectAssistantConfiguration ``` ## Properties `QInConnectAssistantConfiguration` Property description not available. *Required*: No *Type*: [QInConnectAssistantConfiguration](aws-properties-lex-bot-qinconnectassistantconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot QnAIntentConfiguration Details about the the configuration of the built-in `Amazon.QnAIntent`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockModelConfiguration](#cfn-lex-bot-qnaintentconfiguration-bedrockmodelconfiguration)" : BedrockModelSpecification, "[DataSourceConfiguration](#cfn-lex-bot-qnaintentconfiguration-datasourceconfiguration)" : DataSourceConfiguration } ``` ### YAML ``` [BedrockModelConfiguration](#cfn-lex-bot-qnaintentconfiguration-bedrockmodelconfiguration): BedrockModelSpecification [DataSourceConfiguration](#cfn-lex-bot-qnaintentconfiguration-datasourceconfiguration): DataSourceConfiguration ``` ## Properties `BedrockModelConfiguration` Property description not available. *Required*: Yes *Type*: [BedrockModelSpecification](aws-properties-lex-bot-bedrockmodelspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataSourceConfiguration` Contains details about the configuration of the data source used for the `AMAZON.QnAIntent`. *Required*: Yes *Type*: [DataSourceConfiguration](aws-properties-lex-bot-datasourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot QnAKendraConfiguration Contains details about the configuration of the Amazon Kendra index used for the `AMAZON.QnAIntent`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ExactResponse](#cfn-lex-bot-qnakendraconfiguration-exactresponse)" : Boolean, "[KendraIndex](#cfn-lex-bot-qnakendraconfiguration-kendraindex)" : String, "[QueryFilterString](#cfn-lex-bot-qnakendraconfiguration-queryfilterstring)" : String, "[QueryFilterStringEnabled](#cfn-lex-bot-qnakendraconfiguration-queryfilterstringenabled)" : Boolean } ``` ### YAML ``` [ExactResponse](#cfn-lex-bot-qnakendraconfiguration-exactresponse): Boolean [KendraIndex](#cfn-lex-bot-qnakendraconfiguration-kendraindex): String [QueryFilterString](#cfn-lex-bot-qnakendraconfiguration-queryfilterstring): String [QueryFilterStringEnabled](#cfn-lex-bot-qnakendraconfiguration-queryfilterstringenabled): Boolean ``` ## Properties `ExactResponse` Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at [Adding frequently asked questions (FAQs) to an index](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html). *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KendraIndex` The ARN of the Amazon Kendra index to use. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QueryFilterString` Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see [Using document attributes to filter search results](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering). *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QueryFilterStringEnabled` Specifies whether to enable an Amazon Kendra filter string or not. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot Replication The `Replication` property type specifies Property description not available. for an [AWS::Lex::Bot](aws-resource-lex-bot.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReplicaRegions](#cfn-lex-bot-replication-replicaregions)" : [ String, ... ] } ``` ### YAML ``` [ReplicaRegions](#cfn-lex-bot-replication-replicaregions): - String ``` ## Properties `ReplicaRegions` Property description not available. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot ResponseSpecification Specifies a list of message groups that Amazon Lex uses to respond the user input. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowInterrupt](#cfn-lex-bot-responsespecification-allowinterrupt)" : Boolean, "[MessageGroupsList](#cfn-lex-bot-responsespecification-messagegroupslist)" : [ MessageGroup, ... ] } ``` ### YAML ``` [AllowInterrupt](#cfn-lex-bot-responsespecification-allowinterrupt): Boolean [MessageGroupsList](#cfn-lex-bot-responsespecification-messagegroupslist): - MessageGroup ``` ## Properties `AllowInterrupt` Indicates whether the user can interrupt a speech response from Amazon Lex. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MessageGroupsList` A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime. *Required*: Yes *Type*: Array of [MessageGroup](aws-properties-lex-bot-messagegroup.md) *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot RuntimeSettings Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[NluImprovementSpecification](#cfn-lex-bot-runtimesettings-nluimprovementspecification)" : NluImprovementSpecification, "[SlotResolutionImprovementSpecification](#cfn-lex-bot-runtimesettings-slotresolutionimprovementspecification)" : SlotResolutionImprovementSpecification } ``` ### YAML ``` [NluImprovementSpecification](#cfn-lex-bot-runtimesettings-nluimprovementspecification): NluImprovementSpecification [SlotResolutionImprovementSpecification](#cfn-lex-bot-runtimesettings-slotresolutionimprovementspecification): SlotResolutionImprovementSpecification ``` ## Properties `NluImprovementSpecification` Property description not available. *Required*: No *Type*: [NluImprovementSpecification](aws-properties-lex-bot-nluimprovementspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotResolutionImprovementSpecification` Property description not available. *Required*: No *Type*: [SlotResolutionImprovementSpecification](aws-properties-lex-bot-slotresolutionimprovementspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot S3BucketLogDestination Specifies an Amazon S3 bucket for logging audio conversations ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyArn](#cfn-lex-bot-s3bucketlogdestination-kmskeyarn)" : String, "[LogPrefix](#cfn-lex-bot-s3bucketlogdestination-logprefix)" : String, "[S3BucketArn](#cfn-lex-bot-s3bucketlogdestination-s3bucketarn)" : String } ``` ### YAML ``` [KmsKeyArn](#cfn-lex-bot-s3bucketlogdestination-kmskeyarn): String [LogPrefix](#cfn-lex-bot-s3bucketlogdestination-logprefix): String [S3BucketArn](#cfn-lex-bot-s3bucketlogdestination-s3bucketarn): String ``` ## Properties `KmsKeyArn` The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an Amazon S3 bucket. *Required*: No *Type*: String *Pattern*: `^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogPrefix` The S3 prefix to assign to audio log files. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3BucketArn` The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored. *Required*: Yes *Type*: String *Pattern*: `^arn:[\w\-]+:s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot S3Location Defines an Amazon S3 bucket location. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3Bucket](#cfn-lex-bot-s3location-s3bucket)" : String, "[S3ObjectKey](#cfn-lex-bot-s3location-s3objectkey)" : String, "[S3ObjectVersion](#cfn-lex-bot-s3location-s3objectversion)" : String } ``` ### YAML ``` [S3Bucket](#cfn-lex-bot-s3location-s3bucket): String [S3ObjectKey](#cfn-lex-bot-s3location-s3objectkey): String [S3ObjectVersion](#cfn-lex-bot-s3location-s3objectversion): String ``` ## Properties `S3Bucket` The S3 bucket name. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3ObjectKey` The path and file name to the object in the S3 bucket. *Required*: Yes *Type*: String *Pattern*: `[\.\-\!\*\_\'a-zA-Z0-9][\.\-\!\*\_\'\/a-zA-Z0-9]*$` *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3ObjectVersion` The version of the object in the S3 bucket. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SampleUtterance A sample utterance that invokes an intent or respond to a slot elicitation prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Utterance](#cfn-lex-bot-sampleutterance-utterance)" : String } ``` ### YAML ``` [Utterance](#cfn-lex-bot-sampleutterance-utterance): String ``` ## Properties `Utterance` A sample utterance that invokes an intent or respond to a slot elicitation prompt. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SampleUtteranceGenerationSpecification Contains specifications for the sample utterance generation feature. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockModelSpecification](#cfn-lex-bot-sampleutterancegenerationspecification-bedrockmodelspecification)" : BedrockModelSpecification, "[Enabled](#cfn-lex-bot-sampleutterancegenerationspecification-enabled)" : Boolean } ``` ### YAML ``` [BedrockModelSpecification](#cfn-lex-bot-sampleutterancegenerationspecification-bedrockmodelspecification): BedrockModelSpecification [Enabled](#cfn-lex-bot-sampleutterancegenerationspecification-enabled): Boolean ``` ## Properties `BedrockModelSpecification` Property description not available. *Required*: No *Type*: [BedrockModelSpecification](aws-properties-lex-bot-bedrockmodelspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` Specifies whether to enable sample utterance generation or not. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SampleValue Defines one of the values for a slot type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Value](#cfn-lex-bot-samplevalue-value)" : String } ``` ### YAML ``` [Value](#cfn-lex-bot-samplevalue-value): String ``` ## Properties `Value` The value that can be used for a slot type. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `140` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SentimentAnalysisSettings Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DetectSentiment](#cfn-lex-bot-sentimentanalysissettings-detectsentiment)" : Boolean } ``` ### YAML ``` [DetectSentiment](#cfn-lex-bot-sentimentanalysissettings-detectsentiment): Boolean ``` ## Properties `DetectSentiment` Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SessionAttribute A key/value pair representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-lex-bot-sessionattribute-key)" : String, "[Value](#cfn-lex-bot-sessionattribute-value)" : String } ``` ### YAML ``` [Key](#cfn-lex-bot-sessionattribute-key): String [Value](#cfn-lex-bot-sessionattribute-value): String ``` ## Properties `Key` The name of the session attribute. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The session-specific context information for the session attribute. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot Slot Specifies the definition of a slot. Amazon Lex elicits slot values from uses to fulfill the user's intent. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-lex-bot-slot-description)" : String, "[MultipleValuesSetting](#cfn-lex-bot-slot-multiplevaluessetting)" : MultipleValuesSetting, "[Name](#cfn-lex-bot-slot-name)" : String, "[ObfuscationSetting](#cfn-lex-bot-slot-obfuscationsetting)" : ObfuscationSetting, "[SlotTypeName](#cfn-lex-bot-slot-slottypename)" : String, "[SubSlotSetting](#cfn-lex-bot-slot-subslotsetting)" : SubSlotSetting, "[ValueElicitationSetting](#cfn-lex-bot-slot-valueelicitationsetting)" : SlotValueElicitationSetting } ``` ### YAML ``` [Description](#cfn-lex-bot-slot-description): String [MultipleValuesSetting](#cfn-lex-bot-slot-multiplevaluessetting): MultipleValuesSetting [Name](#cfn-lex-bot-slot-name): String [ObfuscationSetting](#cfn-lex-bot-slot-obfuscationsetting): ObfuscationSetting [SlotTypeName](#cfn-lex-bot-slot-slottypename): String [SubSlotSetting](#cfn-lex-bot-slot-subslotsetting): SubSlotSetting [ValueElicitationSetting](#cfn-lex-bot-slot-valueelicitationsetting): SlotValueElicitationSetting ``` ## Properties `Description` The description of the slot. *Required*: No *Type*: String *Maximum*: `2000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MultipleValuesSetting` Indicates whether a slot can return multiple values. *Required*: No *Type*: [MultipleValuesSetting](aws-properties-lex-bot-multiplevaluessetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name given to the slot. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObfuscationSetting` Determines whether the contents of the slot are obfuscated in Amazon CloudWatch Logs logs. Use obfuscated slots to protect information such as personally identifiable information (PII) in logs. *Required*: No *Type*: [ObfuscationSetting](aws-properties-lex-bot-obfuscationsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotTypeName` The name of the slot type that this slot is based on. The slot type defines the acceptable values for the slot. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubSlotSetting` Property description not available. *Required*: No *Type*: [SubSlotSetting](aws-properties-lex-bot-subslotsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueElicitationSetting` Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: + ORIGINAL\$1VALUE - Returns the value entered by the user, if the user value is similar to a slot value. + TOP\$1RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`. *Required*: Yes *Type*: [SlotValueElicitationSetting](aws-properties-lex-bot-slotvalueelicitationsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotCaptureSetting Settings used when Amazon Lex successfully captures a slot value from a user. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CaptureConditional](#cfn-lex-bot-slotcapturesetting-captureconditional)" : ConditionalSpecification, "[CaptureNextStep](#cfn-lex-bot-slotcapturesetting-capturenextstep)" : DialogState, "[CaptureResponse](#cfn-lex-bot-slotcapturesetting-captureresponse)" : ResponseSpecification, "[CodeHook](#cfn-lex-bot-slotcapturesetting-codehook)" : DialogCodeHookInvocationSetting, "[ElicitationCodeHook](#cfn-lex-bot-slotcapturesetting-elicitationcodehook)" : ElicitationCodeHookInvocationSetting, "[FailureConditional](#cfn-lex-bot-slotcapturesetting-failureconditional)" : ConditionalSpecification, "[FailureNextStep](#cfn-lex-bot-slotcapturesetting-failurenextstep)" : DialogState, "[FailureResponse](#cfn-lex-bot-slotcapturesetting-failureresponse)" : ResponseSpecification } ``` ### YAML ``` [CaptureConditional](#cfn-lex-bot-slotcapturesetting-captureconditional): ConditionalSpecification [CaptureNextStep](#cfn-lex-bot-slotcapturesetting-capturenextstep): DialogState [CaptureResponse](#cfn-lex-bot-slotcapturesetting-captureresponse): ResponseSpecification [CodeHook](#cfn-lex-bot-slotcapturesetting-codehook): DialogCodeHookInvocationSetting [ElicitationCodeHook](#cfn-lex-bot-slotcapturesetting-elicitationcodehook): ElicitationCodeHookInvocationSetting [FailureConditional](#cfn-lex-bot-slotcapturesetting-failureconditional): ConditionalSpecification [FailureNextStep](#cfn-lex-bot-slotcapturesetting-failurenextstep): DialogState [FailureResponse](#cfn-lex-bot-slotcapturesetting-failureresponse): ResponseSpecification ``` ## Properties `CaptureConditional` A list of conditional branches to evaluate after the slot value is captured. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CaptureNextStep` Specifies the next step that the bot runs when the slot value is captured before the code hook times out. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CaptureResponse` Specifies a list of message groups that Amazon Lex uses to respond the user input. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CodeHook` Code hook called after Amazon Lex successfully captures a slot value. *Required*: No *Type*: [DialogCodeHookInvocationSetting](aws-properties-lex-bot-dialogcodehookinvocationsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ElicitationCodeHook` Code hook called when Amazon Lex doesn't capture a slot value. *Required*: No *Type*: [ElicitationCodeHookInvocationSetting](aws-properties-lex-bot-elicitationcodehookinvocationsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureConditional` A list of conditional branches to evaluate when the slot value isn't captured. *Required*: No *Type*: [ConditionalSpecification](aws-properties-lex-bot-conditionalspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureNextStep` Specifies the next step that the bot runs when the slot value code is not recognized. *Required*: No *Type*: [DialogState](aws-properties-lex-bot-dialogstate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureResponse` Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured. *Required*: No *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotDefaultValue Specifies the default value to use when a user doesn't provide a value for a slot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DefaultValue](#cfn-lex-bot-slotdefaultvalue-defaultvalue)" : String } ``` ### YAML ``` [DefaultValue](#cfn-lex-bot-slotdefaultvalue-defaultvalue): String ``` ## Properties `DefaultValue` The default value to use when a user doesn't provide a value for a slot. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `202` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotDefaultValueSpecification The default value to use when a user doesn't provide a value for a slot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DefaultValueList](#cfn-lex-bot-slotdefaultvaluespecification-defaultvaluelist)" : [ SlotDefaultValue, ... ] } ``` ### YAML ``` [DefaultValueList](#cfn-lex-bot-slotdefaultvaluespecification-defaultvaluelist): - SlotDefaultValue ``` ## Properties `DefaultValueList` A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list. *Required*: Yes *Type*: Array of [SlotDefaultValue](aws-properties-lex-bot-slotdefaultvalue.md) *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotPriority Sets the priority that Amazon Lex should use when eliciting slot values from a user. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Priority](#cfn-lex-bot-slotpriority-priority)" : Integer, "[SlotName](#cfn-lex-bot-slotpriority-slotname)" : String } ``` ### YAML ``` [Priority](#cfn-lex-bot-slotpriority-priority): Integer [SlotName](#cfn-lex-bot-slotpriority-slotname): String ``` ## Properties `Priority` The priority that Amazon Lex should apply to the slot. *Required*: Yes *Type*: Integer *Minimum*: `0` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotName` The name of the slot. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotResolutionImprovementSpecification Contains specifications for the assisted slot resolution feature. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockModelSpecification](#cfn-lex-bot-slotresolutionimprovementspecification-bedrockmodelspecification)" : BedrockModelSpecification, "[Enabled](#cfn-lex-bot-slotresolutionimprovementspecification-enabled)" : Boolean } ``` ### YAML ``` [BedrockModelSpecification](#cfn-lex-bot-slotresolutionimprovementspecification-bedrockmodelspecification): BedrockModelSpecification [Enabled](#cfn-lex-bot-slotresolutionimprovementspecification-enabled): Boolean ``` ## Properties `BedrockModelSpecification` An object containing information about the Amazon Bedrock model used to assist slot resolution. *Required*: No *Type*: [BedrockModelSpecification](aws-properties-lex-bot-bedrockmodelspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` Specifies whether assisted slot resolution is turned on or off. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotType Describes a slot type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CompositeSlotTypeSetting](#cfn-lex-bot-slottype-compositeslottypesetting)" : CompositeSlotTypeSetting, "[Description](#cfn-lex-bot-slottype-description)" : String, "[ExternalSourceSetting](#cfn-lex-bot-slottype-externalsourcesetting)" : ExternalSourceSetting, "[Name](#cfn-lex-bot-slottype-name)" : String, "[ParentSlotTypeSignature](#cfn-lex-bot-slottype-parentslottypesignature)" : String, "[SlotTypeValues](#cfn-lex-bot-slottype-slottypevalues)" : [ SlotTypeValue, ... ], "[ValueSelectionSetting](#cfn-lex-bot-slottype-valueselectionsetting)" : SlotValueSelectionSetting } ``` ### YAML ``` [CompositeSlotTypeSetting](#cfn-lex-bot-slottype-compositeslottypesetting): CompositeSlotTypeSetting [Description](#cfn-lex-bot-slottype-description): String [ExternalSourceSetting](#cfn-lex-bot-slottype-externalsourcesetting): ExternalSourceSetting [Name](#cfn-lex-bot-slottype-name): String [ParentSlotTypeSignature](#cfn-lex-bot-slottype-parentslottypesignature): String [SlotTypeValues](#cfn-lex-bot-slottype-slottypevalues): - SlotTypeValue [ValueSelectionSetting](#cfn-lex-bot-slottype-valueselectionsetting): SlotValueSelectionSetting ``` ## Properties `CompositeSlotTypeSetting` Property description not available. *Required*: No *Type*: [CompositeSlotTypeSetting](aws-properties-lex-bot-compositeslottypesetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description of the slot type. Use the description to help identify the slot type in lists. *Required*: No *Type*: String *Maximum*: `2000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExternalSourceSetting` Sets the type of external information used to create the slot type. *Required*: No *Type*: [ExternalSourceSetting](aws-properties-lex-bot-externalsourcesetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the slot type. A slot type name must be unique withing the account. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ParentSlotTypeSignature` The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent lot type. Only `AMAZON.AlphaNumeric` is supported. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotTypeValues` A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for the slot. *Required*: No *Type*: Array of [SlotTypeValue](aws-properties-lex-bot-slottypevalue.md) *Maximum*: `10000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueSelectionSetting` Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: + `ORIGINAL_VALUE` - Returns the value entered by the user, if the user value is similar to the slot value. + `TOP_RESOLUTION` - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`. *Required*: No *Type*: [SlotValueSelectionSetting](aws-properties-lex-bot-slotvalueselectionsetting.md) *Allowed values*: `OriginalValue | TopResolution | Concatenation` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotTypeValue Each slot type can have a set of values. Each `SlotTypeValue` represents a value that the slot type can take. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SampleValue](#cfn-lex-bot-slottypevalue-samplevalue)" : SampleValue, "[Synonyms](#cfn-lex-bot-slottypevalue-synonyms)" : [ SampleValue, ... ] } ``` ### YAML ``` [SampleValue](#cfn-lex-bot-slottypevalue-samplevalue): SampleValue [Synonyms](#cfn-lex-bot-slottypevalue-synonyms): - SampleValue ``` ## Properties `SampleValue` The value of the slot type entry. *Required*: Yes *Type*: [SampleValue](aws-properties-lex-bot-samplevalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Synonyms` Additional values related to the slot type entry. *Required*: No *Type*: Array of [SampleValue](aws-properties-lex-bot-samplevalue.md) *Maximum*: `10000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotValue The value to set in a slot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InterpretedValue](#cfn-lex-bot-slotvalue-interpretedvalue)" : String } ``` ### YAML ``` [InterpretedValue](#cfn-lex-bot-slotvalue-interpretedvalue): String ``` ## Properties `InterpretedValue` The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the `resolvedValues` list. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `202` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotValueElicitationSetting Specifies the elicitation setting details eliciting a slot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DefaultValueSpecification](#cfn-lex-bot-slotvalueelicitationsetting-defaultvaluespecification)" : SlotDefaultValueSpecification, "[PromptSpecification](#cfn-lex-bot-slotvalueelicitationsetting-promptspecification)" : PromptSpecification, "[SampleUtterances](#cfn-lex-bot-slotvalueelicitationsetting-sampleutterances)" : [ SampleUtterance, ... ], "[SlotCaptureSetting](#cfn-lex-bot-slotvalueelicitationsetting-slotcapturesetting)" : SlotCaptureSetting, "[SlotConstraint](#cfn-lex-bot-slotvalueelicitationsetting-slotconstraint)" : String, "[WaitAndContinueSpecification](#cfn-lex-bot-slotvalueelicitationsetting-waitandcontinuespecification)" : WaitAndContinueSpecification } ``` ### YAML ``` [DefaultValueSpecification](#cfn-lex-bot-slotvalueelicitationsetting-defaultvaluespecification): SlotDefaultValueSpecification [PromptSpecification](#cfn-lex-bot-slotvalueelicitationsetting-promptspecification): PromptSpecification [SampleUtterances](#cfn-lex-bot-slotvalueelicitationsetting-sampleutterances): - SampleUtterance [SlotCaptureSetting](#cfn-lex-bot-slotvalueelicitationsetting-slotcapturesetting): SlotCaptureSetting [SlotConstraint](#cfn-lex-bot-slotvalueelicitationsetting-slotconstraint): String [WaitAndContinueSpecification](#cfn-lex-bot-slotvalueelicitationsetting-waitandcontinuespecification): WaitAndContinueSpecification ``` ## Properties `DefaultValueSpecification` A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values. *Required*: No *Type*: [SlotDefaultValueSpecification](aws-properties-lex-bot-slotdefaultvaluespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptSpecification` The prompt that Amazon Lex uses to elicit the slot value from the user. *Required*: No *Type*: [PromptSpecification](aws-properties-lex-bot-promptspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SampleUtterances` If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances. *Required*: No *Type*: Array of [SampleUtterance](aws-properties-lex-bot-sampleutterance.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotCaptureSetting` Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user. *Required*: No *Type*: [SlotCaptureSetting](aws-properties-lex-bot-slotcapturesetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotConstraint` Specifies whether the slot is required or optional. *Required*: Yes *Type*: String *Allowed values*: `Required | Optional` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WaitAndContinueSpecification` Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input. *Required*: No *Type*: [WaitAndContinueSpecification](aws-properties-lex-bot-waitandcontinuespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotValueOverride The slot values that Amazon Lex uses when it sets slot values in a dialog step. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Shape](#cfn-lex-bot-slotvalueoverride-shape)" : String, "[Value](#cfn-lex-bot-slotvalueoverride-value)" : SlotValue, "[Values](#cfn-lex-bot-slotvalueoverride-values)" : [ SlotValueOverride, ... ] } ``` ### YAML ``` [Shape](#cfn-lex-bot-slotvalueoverride-shape): String [Value](#cfn-lex-bot-slotvalueoverride-value): SlotValue [Values](#cfn-lex-bot-slotvalueoverride-values): - SlotValueOverride ``` ## Properties `Shape` When the shape value is `List`, it indicates that the `values` field contains a list of slot values. When the value is `Scalar`, it indicates that the `value` field contains a single value. *Required*: No *Type*: String *Allowed values*: `Scalar | List` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The current value of the slot. *Required*: No *Type*: [SlotValue](aws-properties-lex-bot-slotvalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Values` A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple." *Required*: No *Type*: Array of [SlotValueOverride](#aws-properties-lex-bot-slotvalueoverride) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotValueOverrideMap Maps a slot name to the [SlotValueOverride](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_SlotValueOverride.html) object. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SlotName](#cfn-lex-bot-slotvalueoverridemap-slotname)" : String, "[SlotValueOverride](#cfn-lex-bot-slotvalueoverridemap-slotvalueoverride)" : SlotValueOverride } ``` ### YAML ``` [SlotName](#cfn-lex-bot-slotvalueoverridemap-slotname): String [SlotValueOverride](#cfn-lex-bot-slotvalueoverridemap-slotvalueoverride): SlotValueOverride ``` ## Properties `SlotName` The name of the slot. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?)+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotValueOverride` The SlotValueOverride object to which the slot name will be mapped. *Required*: No *Type*: [SlotValueOverride](aws-properties-lex-bot-slotvalueoverride.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotValueRegexFilter Provides a regular expression used to validate the value of a slot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Pattern](#cfn-lex-bot-slotvalueregexfilter-pattern)" : String } ``` ### YAML ``` [Pattern](#cfn-lex-bot-slotvalueregexfilter-pattern): String ``` ## Properties `Pattern` A regular expression used to validate the value of a slot. Use a standard regular expression. Amazon Lex supports the following characters in the regular expression: + A-Z, a-z + 0-9 + Unicode characters ("\$1⁠u") Represent Unicode characters with four digits, for example "\$1⁠u0041" or "\$1⁠u005A". The following regular expression operators are not supported: + Infinite repeaters: \$1, \$1, or \$1x,\$1 with no upper bound. + Wild card (.) *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `300` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SlotValueSelectionSetting Contains settings used by Amazon Lex to select a slot value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdvancedRecognitionSetting](#cfn-lex-bot-slotvalueselectionsetting-advancedrecognitionsetting)" : AdvancedRecognitionSetting, "[RegexFilter](#cfn-lex-bot-slotvalueselectionsetting-regexfilter)" : SlotValueRegexFilter, "[ResolutionStrategy](#cfn-lex-bot-slotvalueselectionsetting-resolutionstrategy)" : String } ``` ### YAML ``` [AdvancedRecognitionSetting](#cfn-lex-bot-slotvalueselectionsetting-advancedrecognitionsetting): AdvancedRecognitionSetting [RegexFilter](#cfn-lex-bot-slotvalueselectionsetting-regexfilter): SlotValueRegexFilter [ResolutionStrategy](#cfn-lex-bot-slotvalueselectionsetting-resolutionstrategy): String ``` ## Properties `AdvancedRecognitionSetting` Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances. *Required*: No *Type*: [AdvancedRecognitionSetting](aws-properties-lex-bot-advancedrecognitionsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RegexFilter` A regular expression used to validate the value of a slot. *Required*: No *Type*: [SlotValueRegexFilter](aws-properties-lex-bot-slotvalueregexfilter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResolutionStrategy` Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: + `ORIGINAL_VALUE` - Returns the value entered by the user, if the user value is similar to the slot value. + `TOP_RESOLUTION` - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`. *Required*: Yes *Type*: String *Allowed values*: `ORIGINAL_VALUE | TOP_RESOLUTION | CONCATENATION` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot Specifications Subslot specifications. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SlotTypeId](#cfn-lex-bot-specifications-slottypeid)" : String, "[SlotTypeName](#cfn-lex-bot-specifications-slottypename)" : String, "[ValueElicitationSetting](#cfn-lex-bot-specifications-valueelicitationsetting)" : SubSlotValueElicitationSetting } ``` ### YAML ``` [SlotTypeId](#cfn-lex-bot-specifications-slottypeid): String [SlotTypeName](#cfn-lex-bot-specifications-slottypename): String [ValueElicitationSetting](#cfn-lex-bot-specifications-valueelicitationsetting): SubSlotValueElicitationSetting ``` ## Properties `SlotTypeId` The unique identifier assigned to the slot type. *Required*: No *Type*: String *Pattern*: `^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$` *Minimum*: `1` *Maximum*: `25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotTypeName` Property description not available. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueElicitationSetting` Specifies the elicitation setting details for constituent sub slots of a composite slot. *Required*: Yes *Type*: [SubSlotValueElicitationSetting](aws-properties-lex-bot-subslotvalueelicitationsetting.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SpeechFoundationModel Configuration for a foundation model used for speech synthesis and recognition capabilities. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ModelArn](#cfn-lex-bot-speechfoundationmodel-modelarn)" : String, "[VoiceId](#cfn-lex-bot-speechfoundationmodel-voiceid)" : String } ``` ### YAML ``` [ModelArn](#cfn-lex-bot-speechfoundationmodel-modelarn): String [VoiceId](#cfn-lex-bot-speechfoundationmodel-voiceid): String ``` ## Properties `ModelArn` Property description not available. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VoiceId` The identifier of the voice to use for speech synthesis with the foundation model. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SpeechModelConfig Configuration settings that define which speech-to-text model to use for processing speech input. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DeepgramConfig](#cfn-lex-bot-speechmodelconfig-deepgramconfig)" : DeepgramSpeechModelConfig } ``` ### YAML ``` [DeepgramConfig](#cfn-lex-bot-speechmodelconfig-deepgramconfig): DeepgramSpeechModelConfig ``` ## Properties `DeepgramConfig` Configuration settings for using Deepgram as the speech-to-text provider. *Required*: No *Type*: [DeepgramSpeechModelConfig](aws-properties-lex-bot-deepgramspeechmodelconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SpeechRecognitionSettings Settings that control how Amazon Lex processes and recognizes speech input from users. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SpeechModelConfig](#cfn-lex-bot-speechrecognitionsettings-speechmodelconfig)" : SpeechModelConfig, "[SpeechModelPreference](#cfn-lex-bot-speechrecognitionsettings-speechmodelpreference)" : String } ``` ### YAML ``` [SpeechModelConfig](#cfn-lex-bot-speechrecognitionsettings-speechmodelconfig): SpeechModelConfig [SpeechModelPreference](#cfn-lex-bot-speechrecognitionsettings-speechmodelpreference): String ``` ## Properties `SpeechModelConfig` Configuration settings for the selected speech-to-text model. *Required*: No *Type*: [SpeechModelConfig](aws-properties-lex-bot-speechmodelconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SpeechModelPreference` The speech-to-text model to use. *Required*: No *Type*: String *Allowed values*: `Standard | Neural | Deepgram` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SSMLMessage Defines a Speech Synthesis Markup Language (SSML) prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Value](#cfn-lex-bot-ssmlmessage-value)" : String } ``` ### YAML ``` [Value](#cfn-lex-bot-ssmlmessage-value): String ``` ## Properties `Value` The SSML text that defines the prompt. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot StillWaitingResponseSpecification Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowInterrupt](#cfn-lex-bot-stillwaitingresponsespecification-allowinterrupt)" : Boolean, "[FrequencyInSeconds](#cfn-lex-bot-stillwaitingresponsespecification-frequencyinseconds)" : Integer, "[MessageGroupsList](#cfn-lex-bot-stillwaitingresponsespecification-messagegroupslist)" : [ MessageGroup, ... ], "[TimeoutInSeconds](#cfn-lex-bot-stillwaitingresponsespecification-timeoutinseconds)" : Integer } ``` ### YAML ``` [AllowInterrupt](#cfn-lex-bot-stillwaitingresponsespecification-allowinterrupt): Boolean [FrequencyInSeconds](#cfn-lex-bot-stillwaitingresponsespecification-frequencyinseconds): Integer [MessageGroupsList](#cfn-lex-bot-stillwaitingresponsespecification-messagegroupslist): - MessageGroup [TimeoutInSeconds](#cfn-lex-bot-stillwaitingresponsespecification-timeoutinseconds): Integer ``` ## Properties `AllowInterrupt` Indicates that the user can interrupt the response by speaking while the message is being played. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FrequencyInSeconds` How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `300` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MessageGroupsList` One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user. *Required*: Yes *Type*: Array of [MessageGroup](aws-properties-lex-bot-messagegroup.md) *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeoutInSeconds` If Amazon Lex waits longer than this length of time for a response, it will stop sending messages. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `900` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SubSlotSetting Specifications for the constituent sub slots and the expression for the composite slot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Expression](#cfn-lex-bot-subslotsetting-expression)" : String, "[SlotSpecifications](#cfn-lex-bot-subslotsetting-slotspecifications)" : {Key: Value, ...} } ``` ### YAML ``` [Expression](#cfn-lex-bot-subslotsetting-expression): String [SlotSpecifications](#cfn-lex-bot-subslotsetting-slotspecifications): Key: Value ``` ## Properties `Expression` The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators. *Required*: No *Type*: String *Pattern*: `[0-9A-Za-z_\-\s]+` *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotSpecifications` Specifications for the constituent sub slots of a composite slot. *Required*: No *Type*: Object of [Specifications](aws-properties-lex-bot-specifications.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SubSlotTypeComposition Subslot type composition. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-lex-bot-subslottypecomposition-name)" : String, "[SlotTypeId](#cfn-lex-bot-subslottypecomposition-slottypeid)" : String, "[SlotTypeName](#cfn-lex-bot-subslottypecomposition-slottypename)" : String } ``` ### YAML ``` [Name](#cfn-lex-bot-subslottypecomposition-name): String [SlotTypeId](#cfn-lex-bot-subslottypecomposition-slottypeid): String [SlotTypeName](#cfn-lex-bot-subslottypecomposition-slottypename): String ``` ## Properties `Name` Name of a constituent sub slot inside a composite slot. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotTypeId` The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type. *Required*: No *Type*: String *Pattern*: `^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$` *Minimum*: `1` *Maximum*: `25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SlotTypeName` Property description not available. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot SubSlotValueElicitationSetting Subslot elicitation settings. `DefaultValueSpecification` is a list of default values for a constituent sub slot in a composite slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values. This is similar to `DefaultValueSpecification` for slots. `PromptSpecification` is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to `PromptSpecification` for slots. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DefaultValueSpecification](#cfn-lex-bot-subslotvalueelicitationsetting-defaultvaluespecification)" : SlotDefaultValueSpecification, "[PromptSpecification](#cfn-lex-bot-subslotvalueelicitationsetting-promptspecification)" : PromptSpecification, "[SampleUtterances](#cfn-lex-bot-subslotvalueelicitationsetting-sampleutterances)" : [ SampleUtterance, ... ], "[WaitAndContinueSpecification](#cfn-lex-bot-subslotvalueelicitationsetting-waitandcontinuespecification)" : WaitAndContinueSpecification } ``` ### YAML ``` [DefaultValueSpecification](#cfn-lex-bot-subslotvalueelicitationsetting-defaultvaluespecification): SlotDefaultValueSpecification [PromptSpecification](#cfn-lex-bot-subslotvalueelicitationsetting-promptspecification): PromptSpecification [SampleUtterances](#cfn-lex-bot-subslotvalueelicitationsetting-sampleutterances): - SampleUtterance [WaitAndContinueSpecification](#cfn-lex-bot-subslotvalueelicitationsetting-waitandcontinuespecification): WaitAndContinueSpecification ``` ## Properties `DefaultValueSpecification` Property description not available. *Required*: No *Type*: [SlotDefaultValueSpecification](aws-properties-lex-bot-slotdefaultvaluespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptSpecification` Property description not available. *Required*: No *Type*: [PromptSpecification](aws-properties-lex-bot-promptspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SampleUtterances` If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to `SampleUtterances` for slots. *Required*: No *Type*: Array of [SampleUtterance](aws-properties-lex-bot-sampleutterance.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WaitAndContinueSpecification` Property description not available. *Required*: No *Type*: [WaitAndContinueSpecification](aws-properties-lex-bot-waitandcontinuespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot Tag The `Tag` property type specifies Property description not available. for an [AWS::Lex::Bot](aws-resource-lex-bot.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-lex-bot-tag-key)" : String, "[Value](#cfn-lex-bot-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-lex-bot-tag-key): String [Value](#cfn-lex-bot-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot TestBotAliasSettings Specifies configuration settings for the alias used to test the bot. If the `TestBotAliasSettings` property is not specified, the settings are configured with default values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BotAliasLocaleSettings](#cfn-lex-bot-testbotaliassettings-botaliaslocalesettings)" : [ BotAliasLocaleSettingsItem, ... ], "[ConversationLogSettings](#cfn-lex-bot-testbotaliassettings-conversationlogsettings)" : ConversationLogSettings, "[Description](#cfn-lex-bot-testbotaliassettings-description)" : String, "[SentimentAnalysisSettings](#cfn-lex-bot-testbotaliassettings-sentimentanalysissettings)" : SentimentAnalysisSettings } ``` ### YAML ``` [BotAliasLocaleSettings](#cfn-lex-bot-testbotaliassettings-botaliaslocalesettings): - BotAliasLocaleSettingsItem [ConversationLogSettings](#cfn-lex-bot-testbotaliassettings-conversationlogsettings): ConversationLogSettings [Description](#cfn-lex-bot-testbotaliassettings-description): String [SentimentAnalysisSettings](#cfn-lex-bot-testbotaliassettings-sentimentanalysissettings): SentimentAnalysisSettings ``` ## Properties `BotAliasLocaleSettings` Specifies settings that are unique to a locale. For example, you can use a different Lambda function depending on the bot's locale. *Required*: No *Type*: [Array](aws-properties-lex-bot-botaliaslocalesettings.md) of [BotAliasLocaleSettingsItem](aws-properties-lex-bot-botaliaslocalesettingsitem.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConversationLogSettings` Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users. *Required*: No *Type*: [ConversationLogSettings](aws-properties-lex-bot-conversationlogsettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` Specifies a description for the test bot alias. *Required*: No *Type*: String *Maximum*: `2000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SentimentAnalysisSettings` Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. *Required*: No *Type*: [SentimentAnalysisSettings](aws-properties-lex-bot-sentimentanalysissettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot TextInputSpecification Specifies the text input specifications. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StartTimeoutMs](#cfn-lex-bot-textinputspecification-starttimeoutms)" : Integer } ``` ### YAML ``` [StartTimeoutMs](#cfn-lex-bot-textinputspecification-starttimeoutms): Integer ``` ## Properties `StartTimeoutMs` Time for which a bot waits before re-prompting a customer for text input. *Required*: Yes *Type*: Integer *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot TextLogDestination Defines the Amazon CloudWatch Logs destination log group for conversation text logs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CloudWatch](#cfn-lex-bot-textlogdestination-cloudwatch)" : CloudWatchLogGroupLogDestination } ``` ### YAML ``` [CloudWatch](#cfn-lex-bot-textlogdestination-cloudwatch): CloudWatchLogGroupLogDestination ``` ## Properties `CloudWatch` Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered. *Required*: Yes *Type*: [CloudWatchLogGroupLogDestination](aws-properties-lex-bot-cloudwatchloggrouplogdestination.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot TextLogSetting Defines settings to enable text conversation logs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Destination](#cfn-lex-bot-textlogsetting-destination)" : TextLogDestination, "[Enabled](#cfn-lex-bot-textlogsetting-enabled)" : Boolean } ``` ### YAML ``` [Destination](#cfn-lex-bot-textlogsetting-destination): TextLogDestination [Enabled](#cfn-lex-bot-textlogsetting-enabled): Boolean ``` ## Properties `Destination` Specifies the Amazon CloudWatch Logs destination log group for conversation text logs. *Required*: Yes *Type*: [TextLogDestination](aws-properties-lex-bot-textlogdestination.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` Determines whether conversation logs should be stored for an alias. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot UnifiedSpeechSettings Unified configuration settings that combine speech recognition and synthesis capabilities. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SpeechFoundationModel](#cfn-lex-bot-unifiedspeechsettings-speechfoundationmodel)" : SpeechFoundationModel } ``` ### YAML ``` [SpeechFoundationModel](#cfn-lex-bot-unifiedspeechsettings-speechfoundationmodel): SpeechFoundationModel ``` ## Properties `SpeechFoundationModel` The foundation model configuration to use for unified speech processing capabilities. *Required*: Yes *Type*: [SpeechFoundationModel](aws-properties-lex-bot-speechfoundationmodel.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot VoiceSettings Defines settings for using an Amazon Polly voice to communicate with a user. Valid values include: + `standard` + `neural` + `long-form` + `generative` ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Engine](#cfn-lex-bot-voicesettings-engine)" : String, "[VoiceId](#cfn-lex-bot-voicesettings-voiceid)" : String } ``` ### YAML ``` [Engine](#cfn-lex-bot-voicesettings-engine): String [VoiceId](#cfn-lex-bot-voicesettings-voiceid): String ``` ## Properties `Engine` Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the [`engine` parameter of the `SynthesizeSpeech` operation](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) in the *Amazon Polly developer guide*. If you do not specify a value, the default is `standard`. *Required*: No *Type*: String *Allowed values*: `standard | neural | long-form | generative` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VoiceId` The identifier of the Amazon Polly voice to use. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Lex::Bot WaitAndContinueSpecification Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ContinueResponse](#cfn-lex-bot-waitandcontinuespecification-continueresponse)" : ResponseSpecification, "[IsActive](#cfn-lex-bot-waitandcontinuespecification-isactive)" : Boolean, "[StillWaitingResponse](#cfn-lex-bot-waitandcontinuespecification-stillwaitingresponse)" : StillWaitingResponseSpecification, "[WaitingResponse](#cfn-lex-bot-waitandcontinuespecification-waitingresponse)" : ResponseSpecification } ``` ### YAML ``` [ContinueResponse](#cfn-lex-bot-waitandcontinuespecification-continueresponse): ResponseSpecification [IsActive](#cfn-lex-bot-waitandcontinuespecification-isactive): Boolean [StillWaitingResponse](#cfn-lex-bot-waitandcontinuespecification-stillwaitingresponse): StillWaitingResponseSpecification [WaitingResponse](#cfn-lex-bot-waitandcontinuespecification-waitingresponse): ResponseSpecification ``` ## Properties `ContinueResponse` The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation. *Required*: Yes *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsActive` Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the `IsActive` field isn't specified, the default is true. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StillWaitingResponse` A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user. *Required*: No *Type*: [StillWaitingResponseSpecification](aws-properties-lex-bot-stillwaitingresponsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WaitingResponse` The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue. *Required*: Yes *Type*: [ResponseSpecification](aws-properties-lex-bot-responsespecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)