awscc.lex_botalias¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - lex:DeleteBotAlias
update¶
Parent base class for filters and actions.
definitions:
Arn:
maxLength: 1000
type: string
AudioLogDestination:
additionalProperties: false
description: The location of audio log files collected when conversation logging
is enabled for a bot.
properties:
S3Bucket:
additionalProperties: false
description: Specifies an Amazon S3 bucket for logging audio conversations
properties:
KmsKeyArn:
description: The Amazon Resource Name (ARN) of an AWS Key Management Service
(KMS) key for encrypting audio log files stored in an S3 bucket.
maxLength: 2048
minLength: 20
pattern: ^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$
type: string
LogPrefix:
description: The Amazon S3 key of the deployment package.
maxLength: 1024
minLength: 0
type: string
S3BucketArn:
description: The Amazon Resource Name (ARN) of an Amazon S3 bucket where
audio log files are stored.
maxLength: 2048
minLength: 1
pattern: ^arn:[\w\-]+:s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
type: string
required:
- LogPrefix
- S3BucketArn
type: object
type: object
AudioLogSetting:
additionalProperties: false
description: 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.
properties:
Destination:
additionalProperties: false
description: The location of audio log files collected when conversation logging
is enabled for a bot.
properties:
S3Bucket:
additionalProperties: false
description: Specifies an Amazon S3 bucket for logging audio conversations
properties:
KmsKeyArn:
description: The Amazon Resource Name (ARN) of an AWS Key Management
Service (KMS) key for encrypting audio log files stored in an S3
bucket.
maxLength: 2048
minLength: 20
pattern: ^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$
type: string
LogPrefix:
description: The Amazon S3 key of the deployment package.
maxLength: 1024
minLength: 0
type: string
S3BucketArn:
description: The Amazon Resource Name (ARN) of an Amazon S3 bucket
where audio log files are stored.
maxLength: 2048
minLength: 1
pattern: ^arn:[\w\-]+:s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
type: string
required:
- LogPrefix
- S3BucketArn
type: object
type: object
Enabled:
description: ''
type: boolean
required:
- Destination
- Enabled
type: object
AudioLogSettings:
description: List of audio log settings
insertionOrder: false
items:
additionalProperties: false
description: 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.
properties:
Destination:
additionalProperties: false
description: The location of audio log files collected when conversation
logging is enabled for a bot.
properties:
S3Bucket:
additionalProperties: false
description: Specifies an Amazon S3 bucket for logging audio conversations
properties:
KmsKeyArn:
description: The Amazon Resource Name (ARN) of an AWS Key Management
Service (KMS) key for encrypting audio log files stored in an
S3 bucket.
maxLength: 2048
minLength: 20
pattern: ^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$
type: string
LogPrefix:
description: The Amazon S3 key of the deployment package.
maxLength: 1024
minLength: 0
type: string
S3BucketArn:
description: The Amazon Resource Name (ARN) of an Amazon S3 bucket
where audio log files are stored.
maxLength: 2048
minLength: 1
pattern: ^arn:[\w\-]+:s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
type: string
required:
- LogPrefix
- S3BucketArn
type: object
type: object
Enabled:
description: ''
type: boolean
required:
- Destination
- Enabled
type: object
maxItems: 1
type: array
uniqueItems: true
BotAliasLocaleSettings:
additionalProperties: false
description: You can use this parameter to specify a specific Lambda function
to run different functions in different locales.
properties:
CodeHookSpecification:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls during
a conversation.
properties:
LambdaCodeHook:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls
during a conversation.
properties:
CodeHookInterfaceVersion:
description: The version of the request-response that you want Amazon
Lex to use to invoke your Lambda function.
maxLength: 5
minLength: 1
type: string
LambdaArn:
description: The Amazon Resource Name (ARN) of the Lambda function.
maxLength: 2048
minLength: 20
type: string
required:
- CodeHookInterfaceVersion
- LambdaArn
type: object
required:
- LambdaCodeHook
type: object
Enabled:
description: Whether the Lambda code hook is enabled
type: boolean
required:
- Enabled
type: object
BotAliasLocaleSettingsItem:
additionalProperties: false
description: A locale setting in alias
properties:
BotAliasLocaleSetting:
additionalProperties: false
description: You can use this parameter to specify a specific Lambda function
to run different functions in different locales.
properties:
CodeHookSpecification:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls
during a conversation.
properties:
LambdaCodeHook:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex
calls during a conversation.
properties:
CodeHookInterfaceVersion:
description: The version of the request-response that you want
Amazon Lex to use to invoke your Lambda function.
maxLength: 5
minLength: 1
type: string
LambdaArn:
description: The Amazon Resource Name (ARN) of the Lambda function.
maxLength: 2048
minLength: 20
type: string
required:
- CodeHookInterfaceVersion
- LambdaArn
type: object
required:
- LambdaCodeHook
type: object
Enabled:
description: Whether the Lambda code hook is enabled
type: boolean
required:
- Enabled
type: object
LocaleId:
description: A string used to identify the locale
maxLength: 128
minLength: 1
type: string
required:
- LocaleId
- BotAliasLocaleSetting
type: object
BotAliasLocaleSettingsList:
description: A list of bot alias locale settings to add to the bot alias.
insertionOrder: false
items:
additionalProperties: false
description: A locale setting in alias
properties:
BotAliasLocaleSetting:
additionalProperties: false
description: You can use this parameter to specify a specific Lambda function
to run different functions in different locales.
properties:
CodeHookSpecification:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls
during a conversation.
properties:
LambdaCodeHook:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex
calls during a conversation.
properties:
CodeHookInterfaceVersion:
description: The version of the request-response that you want
Amazon Lex to use to invoke your Lambda function.
maxLength: 5
minLength: 1
type: string
LambdaArn:
description: The Amazon Resource Name (ARN) of the Lambda function.
maxLength: 2048
minLength: 20
type: string
required:
- CodeHookInterfaceVersion
- LambdaArn
type: object
required:
- LambdaCodeHook
type: object
Enabled:
description: Whether the Lambda code hook is enabled
type: boolean
required:
- Enabled
type: object
LocaleId:
description: A string used to identify the locale
maxLength: 128
minLength: 1
type: string
required:
- LocaleId
- BotAliasLocaleSetting
type: object
maxItems: 50
type: array
uniqueItems: true
BotAliasStatus:
enum:
- Creating
- Available
- Deleting
- Failed
type: string
BotVersion:
description: The version of a bot.
maxLength: 5
minLength: 1
pattern: ^(DRAFT|[0-9]+)$
type: string
CloudWatchLogGroupLogDestination:
additionalProperties: false
properties:
CloudWatchLogGroupArn:
description: A string used to identify this tag
maxLength: 2048
minLength: 1
type: string
LogPrefix:
description: A string containing the value for the tag
maxLength: 1024
minLength: 0
type: string
required:
- CloudWatchLogGroupArn
- LogPrefix
type: object
CodeHookSpecification:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls during
a conversation.
properties:
LambdaCodeHook:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls during
a conversation.
properties:
CodeHookInterfaceVersion:
description: The version of the request-response that you want Amazon
Lex to use to invoke your Lambda function.
maxLength: 5
minLength: 1
type: string
LambdaArn:
description: The Amazon Resource Name (ARN) of the Lambda function.
maxLength: 2048
minLength: 20
type: string
required:
- CodeHookInterfaceVersion
- LambdaArn
type: object
required:
- LambdaCodeHook
type: object
ConversationLogSettings:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls during
a conversation.
properties:
AudioLogSettings:
description: List of audio log settings
insertionOrder: false
items:
additionalProperties: false
description: 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.
properties:
Destination:
additionalProperties: false
description: The location of audio log files collected when conversation
logging is enabled for a bot.
properties:
S3Bucket:
additionalProperties: false
description: Specifies an Amazon S3 bucket for logging audio conversations
properties:
KmsKeyArn:
description: The Amazon Resource Name (ARN) of an AWS Key Management
Service (KMS) key for encrypting audio log files stored in
an S3 bucket.
maxLength: 2048
minLength: 20
pattern: ^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$
type: string
LogPrefix:
description: The Amazon S3 key of the deployment package.
maxLength: 1024
minLength: 0
type: string
S3BucketArn:
description: The Amazon Resource Name (ARN) of an Amazon S3
bucket where audio log files are stored.
maxLength: 2048
minLength: 1
pattern: ^arn:[\w\-]+:s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
type: string
required:
- LogPrefix
- S3BucketArn
type: object
type: object
Enabled:
description: ''
type: boolean
required:
- Destination
- Enabled
type: object
maxItems: 1
type: array
uniqueItems: true
TextLogSettings:
description: List of text log settings
insertionOrder: false
items:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls
during a conversation.
properties:
Destination:
additionalProperties: false
description: Defines the Amazon CloudWatch Logs destination log group
for conversation text logs.
properties:
CloudWatch:
additionalProperties: false
properties:
CloudWatchLogGroupArn:
description: A string used to identify this tag
maxLength: 2048
minLength: 1
type: string
LogPrefix:
description: A string containing the value for the tag
maxLength: 1024
minLength: 0
type: string
required:
- CloudWatchLogGroupArn
- LogPrefix
type: object
type: object
Enabled:
description: ''
type: boolean
type: object
maxItems: 1
type: array
uniqueItems: true
type: object
Description:
description: A description of the bot alias. Use the description to help identify
the bot alias in lists.
maxLength: 200
type: string
Id:
description: Unique ID of resource
maxLength: 10
minLength: 10
pattern: ^[0-9a-zA-Z]+$
type: string
LambdaCodeHook:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls during
a conversation.
properties:
CodeHookInterfaceVersion:
description: The version of the request-response that you want Amazon Lex
to use to invoke your Lambda function.
maxLength: 5
minLength: 1
type: string
LambdaArn:
description: The Amazon Resource Name (ARN) of the Lambda function.
maxLength: 2048
minLength: 20
type: string
required:
- CodeHookInterfaceVersion
- LambdaArn
type: object
LocaleId:
description: The identifier of the language and locale that the bot alias will
be configured in.
type: string
Name:
description: A unique identifier for a resource.
maxLength: 100
minLength: 1
pattern: ^([0-9a-zA-Z][_-]?)+$
type: string
S3BucketLogDestination:
additionalProperties: false
description: Specifies an Amazon S3 bucket for logging audio conversations
properties:
KmsKeyArn:
description: The Amazon Resource Name (ARN) of an AWS Key Management Service
(KMS) key for encrypting audio log files stored in an S3 bucket.
maxLength: 2048
minLength: 20
pattern: ^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$
type: string
LogPrefix:
description: The Amazon S3 key of the deployment package.
maxLength: 1024
minLength: 0
type: string
S3BucketArn:
description: The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio
log files are stored.
maxLength: 2048
minLength: 1
pattern: ^arn:[\w\-]+:s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
type: string
required:
- LogPrefix
- S3BucketArn
type: object
Tag:
additionalProperties: false
description: A label for tagging Lex resources
properties:
Key:
description: A string used to identify this tag
maxLength: 128
minLength: 1
type: string
Value:
description: A string containing the value for the tag
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
TextLogDestination:
additionalProperties: false
description: Defines the Amazon CloudWatch Logs destination log group for conversation
text logs.
properties:
CloudWatch:
additionalProperties: false
properties:
CloudWatchLogGroupArn:
description: A string used to identify this tag
maxLength: 2048
minLength: 1
type: string
LogPrefix:
description: A string containing the value for the tag
maxLength: 1024
minLength: 0
type: string
required:
- CloudWatchLogGroupArn
- LogPrefix
type: object
type: object
TextLogSetting:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls during
a conversation.
properties:
Destination:
additionalProperties: false
description: Defines the Amazon CloudWatch Logs destination log group for
conversation text logs.
properties:
CloudWatch:
additionalProperties: false
properties:
CloudWatchLogGroupArn:
description: A string used to identify this tag
maxLength: 2048
minLength: 1
type: string
LogPrefix:
description: A string containing the value for the tag
maxLength: 1024
minLength: 0
type: string
required:
- CloudWatchLogGroupArn
- LogPrefix
type: object
type: object
Enabled:
description: ''
type: boolean
type: object
TextLogSettings:
description: List of text log settings
insertionOrder: false
items:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls during
a conversation.
properties:
Destination:
additionalProperties: false
description: Defines the Amazon CloudWatch Logs destination log group for
conversation text logs.
properties:
CloudWatch:
additionalProperties: false
properties:
CloudWatchLogGroupArn:
description: A string used to identify this tag
maxLength: 2048
minLength: 1
type: string
LogPrefix:
description: A string containing the value for the tag
maxLength: 1024
minLength: 0
type: string
required:
- CloudWatchLogGroupArn
- LogPrefix
type: object
type: object
Enabled:
description: ''
type: boolean
type: object
maxItems: 1
type: array
uniqueItems: true
properties:
BotAliasLocaleSettings:
description: A list of bot alias locale settings to add to the bot alias.
insertionOrder: false
items:
additionalProperties: false
description: A locale setting in alias
properties:
BotAliasLocaleSetting:
additionalProperties: false
description: You can use this parameter to specify a specific Lambda function
to run different functions in different locales.
properties:
CodeHookSpecification:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls
during a conversation.
properties:
LambdaCodeHook:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex
calls during a conversation.
properties:
CodeHookInterfaceVersion:
description: The version of the request-response that you want
Amazon Lex to use to invoke your Lambda function.
maxLength: 5
minLength: 1
type: string
LambdaArn:
description: The Amazon Resource Name (ARN) of the Lambda function.
maxLength: 2048
minLength: 20
type: string
required:
- CodeHookInterfaceVersion
- LambdaArn
type: object
required:
- LambdaCodeHook
type: object
Enabled:
description: Whether the Lambda code hook is enabled
type: boolean
required:
- Enabled
type: object
LocaleId:
description: A string used to identify the locale
maxLength: 128
minLength: 1
type: string
required:
- LocaleId
- BotAliasLocaleSetting
type: object
maxItems: 50
type: array
uniqueItems: true
BotAliasName:
description: A unique identifier for a resource.
maxLength: 100
minLength: 1
pattern: ^([0-9a-zA-Z][_-]?)+$
type: string
BotAliasTags:
description: A list of tags to add to the bot alias.
insertionOrder: false
items:
additionalProperties: false
description: A label for tagging Lex resources
properties:
Key:
description: A string used to identify this tag
maxLength: 128
minLength: 1
type: string
Value:
description: A string containing the value for the tag
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
maxItems: 200
type: array
uniqueItems: true
BotVersion:
description: The version of a bot.
maxLength: 5
minLength: 1
pattern: ^(DRAFT|[0-9]+)$
type: string
ConversationLogSettings:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls during
a conversation.
properties:
AudioLogSettings:
description: List of audio log settings
insertionOrder: false
items:
additionalProperties: false
description: 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.
properties:
Destination:
additionalProperties: false
description: The location of audio log files collected when conversation
logging is enabled for a bot.
properties:
S3Bucket:
additionalProperties: false
description: Specifies an Amazon S3 bucket for logging audio conversations
properties:
KmsKeyArn:
description: The Amazon Resource Name (ARN) of an AWS Key Management
Service (KMS) key for encrypting audio log files stored in
an S3 bucket.
maxLength: 2048
minLength: 20
pattern: ^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$
type: string
LogPrefix:
description: The Amazon S3 key of the deployment package.
maxLength: 1024
minLength: 0
type: string
S3BucketArn:
description: The Amazon Resource Name (ARN) of an Amazon S3
bucket where audio log files are stored.
maxLength: 2048
minLength: 1
pattern: ^arn:[\w\-]+:s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
type: string
required:
- LogPrefix
- S3BucketArn
type: object
type: object
Enabled:
description: ''
type: boolean
required:
- Destination
- Enabled
type: object
maxItems: 1
type: array
uniqueItems: true
TextLogSettings:
description: List of text log settings
insertionOrder: false
items:
additionalProperties: false
description: Contains information about code hooks that Amazon Lex calls
during a conversation.
properties:
Destination:
additionalProperties: false
description: Defines the Amazon CloudWatch Logs destination log group
for conversation text logs.
properties:
CloudWatch:
additionalProperties: false
properties:
CloudWatchLogGroupArn:
description: A string used to identify this tag
maxLength: 2048
minLength: 1
type: string
LogPrefix:
description: A string containing the value for the tag
maxLength: 1024
minLength: 0
type: string
required:
- CloudWatchLogGroupArn
- LogPrefix
type: object
type: object
Enabled:
description: ''
type: boolean
type: object
maxItems: 1
type: array
uniqueItems: true
type: object
Description:
description: A description of the bot alias. Use the description to help identify
the bot alias in lists.
maxLength: 200
type: string
SentimentAnalysisSettings:
additionalProperties: false
description: Determines whether Amazon Lex will use Amazon Comprehend to detect
the sentiment of user utterances.
properties:
DetectSentiment:
description: Enable to call Amazon Comprehend for Sentiment natively within
Lex
type: boolean
required:
- DetectSentiment
type: object
type:
enum:
- update
Permissions - lex:UpdateBotAlias, lex:DescribeBotAlias, lex:ListTagsForResource, lex:TagResource, lex:UntagResource