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 AWS CloudFormation template, use the following syntax:
JSON
{ "Description" :
String
, "MultipleValuesSetting" :MultipleValuesSetting
, "Name" :String
, "ObfuscationSetting" :ObfuscationSetting
, "SlotTypeName" :String
, "ValueElicitationSetting" :SlotValueElicitationSetting
}
YAML
Description:
String
MultipleValuesSetting:MultipleValuesSetting
Name:String
ObfuscationSetting:ObfuscationSetting
SlotTypeName:String
ValueElicitationSetting:SlotValueElicitationSetting
Properties
Description
-
The description of the slot.
Required: No
Type: String
Maximum:
200
Update requires: No interruption
MultipleValuesSetting
-
Indicates whether a slot can return multiple values.
Required: No
Type: MultipleValuesSetting
Update requires: No interruption
Name
-
The name given to the slot.
Required: Yes
Type: String
Pattern:
^([0-9a-zA-Z][_-]?)+$
Minimum:
1
Maximum:
100
Update requires: No interruption
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
Update requires: No interruption
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
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_VALUE - Returns the value entered by the user, if the user value is similar to a 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 isORIGINAL_VALUE
.Required: Yes
Type: SlotValueElicitationSetting
Update requires: No interruption
-