Skip to content
This repository was archived by the owner on Dec 7, 2023. It is now read-only.

Commit 59def38

Browse files
raksit-awsraksit-aws
committed
updating Lex docs due to broken links (ticket V824199282)
1 parent 516929f commit 59def38

File tree

101 files changed

+5256
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+5256
-0
lines changed

‎AWS_Lex.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Lex resource type reference<a name="AWS_Lex"></a>
2+
3+
**Resource types**
4+
+ [AWS::Lex::Bot](aws-resource-lex-bot.md)
5+
+ [AWS::Lex::BotAlias](aws-resource-lex-botalias.md)
6+
+ [AWS::Lex::BotVersion](aws-resource-lex-botversion.md)
7+
+ [AWS::Lex::ResourcePolicy](aws-resource-lex-resourcepolicy.md)

‎aws-properties-lex-bot-advancedrecognitionsetting.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# AWS::Lex::Bot AdvancedRecognitionSetting<a name="aws-properties-lex-bot-advancedrecognitionsetting"></a>
2+
3+
Specifies settings that enable advanced audio recognition for slot values\.
4+
5+
## Syntax<a name="aws-properties-lex-bot-advancedrecognitionsetting-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-lex-bot-advancedrecognitionsetting-syntax.json"></a>
10+
11+
```
12+
{
13+
"[AudioRecognitionStrategy](#cfn-lex-bot-advancedrecognitionsetting-audiorecognitionstrategy)" : String
14+
}
15+
```
16+
17+
### YAML<a name="aws-properties-lex-bot-advancedrecognitionsetting-syntax.yaml"></a>
18+
19+
```
20+
[AudioRecognitionStrategy](#cfn-lex-bot-advancedrecognitionsetting-audiorecognitionstrategy): String
21+
```
22+
23+
## Properties<a name="aws-properties-lex-bot-advancedrecognitionsetting-properties"></a>
24+
25+
`AudioRecognitionStrategy` <a name="cfn-lex-bot-advancedrecognitionsetting-audiorecognitionstrategy"></a>
26+
Specifies that Amazon Lex should use slot values as a custom vocabulary when recognizing user utterances\.
27+
*Required*: No
28+
*Type*: String
29+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎aws-properties-lex-bot-allowedinputtypes.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# AWS::Lex::Bot AllowedInputTypes<a name="aws-properties-lex-bot-allowedinputtypes"></a>
2+
3+
<a name="aws-properties-lex-bot-allowedinputtypes-description"></a>The `AllowedInputTypes` property type specifies Property description not available\. for an [AWS::Lex::Bot](aws-resource-lex-bot.md)\.
4+
5+
## Syntax<a name="aws-properties-lex-bot-allowedinputtypes-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-lex-bot-allowedinputtypes-syntax.json"></a>
10+
11+
```
12+
{
13+
"[AllowAudioInput](#cfn-lex-bot-allowedinputtypes-allowaudioinput)" : Boolean,
14+
"[AllowDTMFInput](#cfn-lex-bot-allowedinputtypes-allowdtmfinput)" : Boolean
15+
}
16+
```
17+
18+
### YAML<a name="aws-properties-lex-bot-allowedinputtypes-syntax.yaml"></a>
19+
20+
```
21+
[AllowAudioInput](#cfn-lex-bot-allowedinputtypes-allowaudioinput): Boolean
22+
[AllowDTMFInput](#cfn-lex-bot-allowedinputtypes-allowdtmfinput): Boolean
23+
```
24+
25+
## Properties<a name="aws-properties-lex-bot-allowedinputtypes-properties"></a>
26+
27+
`AllowAudioInput` <a name="cfn-lex-bot-allowedinputtypes-allowaudioinput"></a>
28+
Property description not available\.
29+
*Required*: Yes
30+
*Type*: Boolean
31+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
32+
33+
`AllowDTMFInput` <a name="cfn-lex-bot-allowedinputtypes-allowdtmfinput"></a>
34+
Property description not available\.
35+
*Required*: Yes
36+
*Type*: Boolean
37+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎aws-properties-lex-bot-audioanddtmfinputspecification.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# AWS::Lex::Bot AudioAndDTMFInputSpecification<a name="aws-properties-lex-bot-audioanddtmfinputspecification"></a>
2+
3+
<a name="aws-properties-lex-bot-audioanddtmfinputspecification-description"></a>The `AudioAndDTMFInputSpecification` property type specifies Property description not available\. for an [AWS::Lex::Bot](aws-resource-lex-bot.md)\.
4+
5+
## Syntax<a name="aws-properties-lex-bot-audioanddtmfinputspecification-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-lex-bot-audioanddtmfinputspecification-syntax.json"></a>
10+
11+
```
12+
{
13+
"[AudioSpecification](#cfn-lex-bot-audioanddtmfinputspecification-audiospecification)" : AudioSpecification,
14+
"[DTMFSpecification](#cfn-lex-bot-audioanddtmfinputspecification-dtmfspecification)" : DTMFSpecification,
15+
"[StartTimeoutMs](#cfn-lex-bot-audioanddtmfinputspecification-starttimeoutms)" : Integer
16+
}
17+
```
18+
19+
### YAML<a name="aws-properties-lex-bot-audioanddtmfinputspecification-syntax.yaml"></a>
20+
21+
```
22+
[AudioSpecification](#cfn-lex-bot-audioanddtmfinputspecification-audiospecification):
23+
AudioSpecification
24+
[DTMFSpecification](#cfn-lex-bot-audioanddtmfinputspecification-dtmfspecification):
25+
DTMFSpecification
26+
[StartTimeoutMs](#cfn-lex-bot-audioanddtmfinputspecification-starttimeoutms): Integer
27+
```
28+
29+
## Properties<a name="aws-properties-lex-bot-audioanddtmfinputspecification-properties"></a>
30+
31+
`AudioSpecification` <a name="cfn-lex-bot-audioanddtmfinputspecification-audiospecification"></a>
32+
Property description not available\.
33+
*Required*: No
34+
*Type*: [AudioSpecification](aws-properties-lex-bot-audiospecification.md)
35+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
36+
37+
`DTMFSpecification` <a name="cfn-lex-bot-audioanddtmfinputspecification-dtmfspecification"></a>
38+
Property description not available\.
39+
*Required*: No
40+
*Type*: [DTMFSpecification](aws-properties-lex-bot-dtmfspecification.md)
41+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
42+
43+
`StartTimeoutMs` <a name="cfn-lex-bot-audioanddtmfinputspecification-starttimeoutms"></a>
44+
Property description not available\.
45+
*Required*: Yes
46+
*Type*: Integer
47+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎aws-properties-lex-bot-audiologdestination.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# AWS::Lex::Bot AudioLogDestination<a name="aws-properties-lex-bot-audiologdestination"></a>
2+
3+
Specifies the location of audio log files collected when conversation logging is enabled for a bot\.
4+
5+
## Syntax<a name="aws-properties-lex-bot-audiologdestination-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-lex-bot-audiologdestination-syntax.json"></a>
10+
11+
```
12+
{
13+
"[S3Bucket](#cfn-lex-bot-audiologdestination-s3bucket)" : S3BucketLogDestination
14+
}
15+
```
16+
17+
### YAML<a name="aws-properties-lex-bot-audiologdestination-syntax.yaml"></a>
18+
19+
```
20+
[S3Bucket](#cfn-lex-bot-audiologdestination-s3bucket):
21+
S3BucketLogDestination
22+
```
23+
24+
## Properties<a name="aws-properties-lex-bot-audiologdestination-properties"></a>
25+
26+
`S3Bucket` <a name="cfn-lex-bot-audiologdestination-s3bucket"></a>
27+
Specifies the Amazon S3 bucket where the audio files are stored\.
28+
*Required*: Yes
29+
*Type*: [S3BucketLogDestination](aws-properties-lex-bot-s3bucketlogdestination.md)
30+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎aws-properties-lex-bot-audiologsetting.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# AWS::Lex::Bot AudioLogSetting<a name="aws-properties-lex-bot-audiologsetting"></a>
2+
3+
Specifies settings for logging the 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\.
4+
5+
## Syntax<a name="aws-properties-lex-bot-audiologsetting-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-lex-bot-audiologsetting-syntax.json"></a>
10+
11+
```
12+
{
13+
"[Destination](#cfn-lex-bot-audiologsetting-destination)" : AudioLogDestination,
14+
"[Enabled](#cfn-lex-bot-audiologsetting-enabled)" : Boolean
15+
}
16+
```
17+
18+
### YAML<a name="aws-properties-lex-bot-audiologsetting-syntax.yaml"></a>
19+
20+
```
21+
[Destination](#cfn-lex-bot-audiologsetting-destination):
22+
AudioLogDestination
23+
[Enabled](#cfn-lex-bot-audiologsetting-enabled): Boolean
24+
```
25+
26+
## Properties<a name="aws-properties-lex-bot-audiologsetting-properties"></a>
27+
28+
`Destination` <a name="cfn-lex-bot-audiologsetting-destination"></a>
29+
Specifies the location of the audio log files collected when conversation logging is enabled for a bot\.
30+
*Required*: Yes
31+
*Type*: [AudioLogDestination](aws-properties-lex-bot-audiologdestination.md)
32+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
33+
34+
`Enabled` <a name="cfn-lex-bot-audiologsetting-enabled"></a>
35+
Specifies whether audio logging is enabled for the bot\.
36+
*Required*: Yes
37+
*Type*: Boolean
38+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎aws-properties-lex-bot-audiospecification.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# AWS::Lex::Bot AudioSpecification<a name="aws-properties-lex-bot-audiospecification"></a>
2+
3+
<a name="aws-properties-lex-bot-audiospecification-description"></a>The `AudioSpecification` property type specifies Property description not available\. for an [AWS::Lex::Bot](aws-resource-lex-bot.md)\.
4+
5+
## Syntax<a name="aws-properties-lex-bot-audiospecification-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-lex-bot-audiospecification-syntax.json"></a>
10+
11+
```
12+
{
13+
"[EndTimeoutMs](#cfn-lex-bot-audiospecification-endtimeoutms)" : Integer,
14+
"[MaxLengthMs](#cfn-lex-bot-audiospecification-maxlengthms)" : Integer
15+
}
16+
```
17+
18+
### YAML<a name="aws-properties-lex-bot-audiospecification-syntax.yaml"></a>
19+
20+
```
21+
[EndTimeoutMs](#cfn-lex-bot-audiospecification-endtimeoutms): Integer
22+
[MaxLengthMs](#cfn-lex-bot-audiospecification-maxlengthms): Integer
23+
```
24+
25+
## Properties<a name="aws-properties-lex-bot-audiospecification-properties"></a>
26+
27+
`EndTimeoutMs` <a name="cfn-lex-bot-audiospecification-endtimeoutms"></a>
28+
Property description not available\.
29+
*Required*: Yes
30+
*Type*: Integer
31+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
32+
33+
`MaxLengthMs` <a name="cfn-lex-bot-audiospecification-maxlengthms"></a>
34+
Property description not available\.
35+
*Required*: Yes
36+
*Type*: Integer
37+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎aws-properties-lex-bot-botaliaslocalesettings.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# AWS::Lex::Bot BotAliasLocaleSettings<a name="aws-properties-lex-bot-botaliaslocalesettings"></a>
2+
3+
Specifies settings that are unique to a locale\. For example, you can use a different Lambda function for each locale\.
4+
5+
## Syntax<a name="aws-properties-lex-bot-botaliaslocalesettings-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-lex-bot-botaliaslocalesettings-syntax.json"></a>
10+
11+
```
12+
{
13+
"[CodeHookSpecification](#cfn-lex-bot-botaliaslocalesettings-codehookspecification)" : CodeHookSpecification,
14+
"[Enabled](#cfn-lex-bot-botaliaslocalesettings-enabled)" : Boolean
15+
}
16+
```
17+
18+
### YAML<a name="aws-properties-lex-bot-botaliaslocalesettings-syntax.yaml"></a>
19+
20+
```
21+
[CodeHookSpecification](#cfn-lex-bot-botaliaslocalesettings-codehookspecification):
22+
CodeHookSpecification
23+
[Enabled](#cfn-lex-bot-botaliaslocalesettings-enabled): Boolean
24+
```
25+
26+
## Properties<a name="aws-properties-lex-bot-botaliaslocalesettings-properties"></a>
27+
28+
`CodeHookSpecification` <a name="cfn-lex-bot-botaliaslocalesettings-codehookspecification"></a>
29+
Specifies the Lambda function to use in this locale\.
30+
*Required*: No
31+
*Type*: [CodeHookSpecification](aws-properties-lex-bot-codehookspecification.md)
32+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
33+
34+
`Enabled` <a name="cfn-lex-bot-botaliaslocalesettings-enabled"></a>
35+
Specifies whether the locale is enabled for the bot\. If the value is false, the locale isn't available for use\.
36+
*Required*: Yes
37+
*Type*: Boolean
38+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎aws-properties-lex-bot-botaliaslocalesettingsitem.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# AWS::Lex::Bot BotAliasLocaleSettingsItem<a name="aws-properties-lex-bot-botaliaslocalesettingsitem"></a>
2+
3+
Specifies locale settings for a single locale\.
4+
5+
## Syntax<a name="aws-properties-lex-bot-botaliaslocalesettingsitem-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-lex-bot-botaliaslocalesettingsitem-syntax.json"></a>
10+
11+
```
12+
{
13+
"[BotAliasLocaleSetting](#cfn-lex-bot-botaliaslocalesettingsitem-botaliaslocalesetting)" : BotAliasLocaleSettings,
14+
"[LocaleId](#cfn-lex-bot-botaliaslocalesettingsitem-localeid)" : String
15+
}
16+
```
17+
18+
### YAML<a name="aws-properties-lex-bot-botaliaslocalesettingsitem-syntax.yaml"></a>
19+
20+
```
21+
[BotAliasLocaleSetting](#cfn-lex-bot-botaliaslocalesettingsitem-botaliaslocalesetting):
22+
BotAliasLocaleSettings
23+
[LocaleId](#cfn-lex-bot-botaliaslocalesettingsitem-localeid): String
24+
```
25+
26+
## Properties<a name="aws-properties-lex-bot-botaliaslocalesettingsitem-properties"></a>
27+
28+
`BotAliasLocaleSetting` <a name="cfn-lex-bot-botaliaslocalesettingsitem-botaliaslocalesetting"></a>
29+
Specifies locale settings for a locale\.
30+
*Required*: Yes
31+
*Type*: [BotAliasLocaleSettings](aws-properties-lex-bot-botaliaslocalesettings.md)
32+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
33+
34+
`LocaleId` <a name="cfn-lex-bot-botaliaslocalesettingsitem-localeid"></a>
35+
Specifies the locale that the settings apply to\.
36+
*Required*: Yes
37+
*Type*: String
38+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

0 commit comments

Comments
 (0)