Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-lex-botalias.json
Parent schema serverless-framework-configuration
Type: object

A Bot Alias enables you to change the version of a bot without updating applications that use the bot. Source:- https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateBotAlias.html

Properties

BotId string | Aws_CF_FunctionString required

Unique ID of resource

BotAliasName string | Aws_CF_FunctionString required

A unique identifier for a resource.

BotAliasLocaleSettings BotAliasLocaleSettingsItem[]

A list of bot alias locale settings to add to the bot alias.

maxItems=50uniqueItems=true
BotVersion string | Aws_CF_FunctionString

The version of a bot.

ConversationLogSettings object

Contains information about code hooks that Amazon Lex calls during a conversation.

2 nested properties
AudioLogSettings AudioLogSetting[]

List of audio log settings

maxItems=1uniqueItems=true
TextLogSettings TextLogSetting[]

List of text log settings

maxItems=1uniqueItems=true
Description string | Aws_CF_FunctionString

A description of the bot alias. Use the description to help identify the bot alias in lists.

SentimentAnalysisSettings object

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

1 nested properties
DetectSentiment boolean required

Enable to call Amazon Comprehend for Sentiment natively within Lex

BotAliasTags Tag[]

A list of tags to add to the bot alias.

maxItems=200uniqueItems=true

Definitions

LocaleId string | Aws_CF_FunctionString

The identifier of the language and locale that the bot alias will be configured in.

BotAliasLocaleSettingsList BotAliasLocaleSettingsItem[]

A list of bot alias locale settings to add to the bot alias.

BotAliasStatus string | Aws_CF_FunctionString
BotAliasLocaleSettingsItem object

A locale setting in alias

LocaleId string | Aws_CF_FunctionString required

A string used to identify the locale

BotAliasLocaleSetting object required

You can use this parameter to specify a specific Lambda function to run different functions in different locales.

2 nested properties
Enabled boolean required

Whether the Lambda code hook is enabled

CodeHookSpecification object

Contains information about code hooks that Amazon Lex calls during a conversation.

1 nested properties
LambdaCodeHook object required

Contains information about code hooks that Amazon Lex calls during a conversation.

BotAliasLocaleSettings object

You can use this parameter to specify a specific Lambda function to run different functions in different locales.

Enabled boolean required

Whether the Lambda code hook is enabled

CodeHookSpecification object

Contains information about code hooks that Amazon Lex calls during a conversation.

1 nested properties
LambdaCodeHook object required

Contains information about code hooks that Amazon Lex calls during a conversation.

2 nested properties
CodeHookInterfaceVersion string | Aws_CF_FunctionString required

The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

LambdaArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the Lambda function.

CodeHookSpecification object

Contains information about code hooks that Amazon Lex calls during a conversation.

LambdaCodeHook object required

Contains information about code hooks that Amazon Lex calls during a conversation.

2 nested properties
CodeHookInterfaceVersion string | Aws_CF_FunctionString required

The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

LambdaArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the Lambda function.

LambdaCodeHook object

Contains information about code hooks that Amazon Lex calls during a conversation.

CodeHookInterfaceVersion string | Aws_CF_FunctionString required

The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

LambdaArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the Lambda function.

ConversationLogSettings object

Contains information about code hooks that Amazon Lex calls during a conversation.

AudioLogSettings AudioLogSetting[]

List of audio log settings

maxItems=1uniqueItems=true
TextLogSettings TextLogSetting[]

List of text log settings

maxItems=1uniqueItems=true
AudioLogSettings AudioLogSetting[]

List of audio log settings

TextLogSettings TextLogSetting[]

List of text log settings

AudioLogSetting object

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.

Destination object required

The location of audio log files collected when conversation logging is enabled for a bot.

1 nested properties
S3Bucket object required

Specifies an Amazon S3 bucket for logging audio conversations

3 nested properties
S3BucketArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

LogPrefix string | Aws_CF_FunctionString required

The Amazon S3 key of the deployment package.

KmsKeyArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

Enabled boolean required
TextLogSetting object

Contains information about code hooks that Amazon Lex calls during a conversation.

Destination object required

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

1 nested properties
CloudWatch object required
2 nested properties
CloudWatchLogGroupArn string | Aws_CF_FunctionString required

A string used to identify the groupArn for the Cloudwatch Log Group

LogPrefix string | Aws_CF_FunctionString required

A string containing the value for the Log Prefix

Enabled boolean required
AudioLogDestination object

The location of audio log files collected when conversation logging is enabled for a bot.

S3Bucket object required

Specifies an Amazon S3 bucket for logging audio conversations

3 nested properties
S3BucketArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

LogPrefix string | Aws_CF_FunctionString required

The Amazon S3 key of the deployment package.

KmsKeyArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

TextLogDestination object

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

CloudWatch object required
2 nested properties
CloudWatchLogGroupArn string | Aws_CF_FunctionString required

A string used to identify the groupArn for the Cloudwatch Log Group

LogPrefix string | Aws_CF_FunctionString required

A string containing the value for the Log Prefix

CloudWatchLogGroupLogDestination object
CloudWatchLogGroupArn string | Aws_CF_FunctionString required

A string used to identify the groupArn for the Cloudwatch Log Group

LogPrefix string | Aws_CF_FunctionString required

A string containing the value for the Log Prefix

S3BucketLogDestination object

Specifies an Amazon S3 bucket for logging audio conversations

S3BucketArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

LogPrefix string | Aws_CF_FunctionString required

The Amazon S3 key of the deployment package.

KmsKeyArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

Id string | Aws_CF_FunctionString

Unique ID of resource

Name string | Aws_CF_FunctionString

A unique identifier for a resource.

BotVersion string | Aws_CF_FunctionString

The version of a bot.

Description string | Aws_CF_FunctionString

A description of the bot alias. Use the description to help identify the bot alias in lists.

Arn string | Aws_CF_FunctionString
Tag object

A label for tagging Lex resources

Key string | Aws_CF_FunctionString required

A string used to identify this tag

Value string | Aws_CF_FunctionString required

A string containing the value for the tag