AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
aws-native.lex.getBotAlias
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
A Bot Alias enables you to change the version of a bot without updating applications that use the bot
Using getBotAlias
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBotAlias(args: GetBotAliasArgs, opts?: InvokeOptions): Promise<GetBotAliasResult>
function getBotAliasOutput(args: GetBotAliasOutputArgs, opts?: InvokeOptions): Output<GetBotAliasResult>
def get_bot_alias(bot_alias_id: Optional[str] = None,
bot_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBotAliasResult
def get_bot_alias_output(bot_alias_id: Optional[pulumi.Input[str]] = None,
bot_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBotAliasResult]
func LookupBotAlias(ctx *Context, args *LookupBotAliasArgs, opts ...InvokeOption) (*LookupBotAliasResult, error)
func LookupBotAliasOutput(ctx *Context, args *LookupBotAliasOutputArgs, opts ...InvokeOption) LookupBotAliasResultOutput
> Note: This function is named LookupBotAlias
in the Go SDK.
public static class GetBotAlias
{
public static Task<GetBotAliasResult> InvokeAsync(GetBotAliasArgs args, InvokeOptions? opts = null)
public static Output<GetBotAliasResult> Invoke(GetBotAliasInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBotAliasResult> getBotAlias(GetBotAliasArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:lex:getBotAlias
arguments:
# arguments dictionary
The following arguments are supported:
- Bot
Alias stringId - The unique identifier of the bot alias.
- Bot
Id string - The unique identifier of the bot.
- Bot
Alias stringId - The unique identifier of the bot alias.
- Bot
Id string - The unique identifier of the bot.
- bot
Alias StringId - The unique identifier of the bot alias.
- bot
Id String - The unique identifier of the bot.
- bot
Alias stringId - The unique identifier of the bot alias.
- bot
Id string - The unique identifier of the bot.
- bot_
alias_ strid - The unique identifier of the bot alias.
- bot_
id str - The unique identifier of the bot.
- bot
Alias StringId - The unique identifier of the bot alias.
- bot
Id String - The unique identifier of the bot.
getBotAlias Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the bot alias.
- Bot
Alias stringId - The unique identifier of the bot alias.
- Bot
Alias List<Pulumi.Locale Settings Aws Native. Lex. Outputs. Bot Alias Locale Settings Item> - Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
- Bot
Alias stringName - The name of the bot alias.
- Bot
Alias Pulumi.Status Aws Native. Lex. Bot Alias Status - The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
- Bot
Version string - The version of the bot that the bot alias references.
- Conversation
Log Pulumi.Settings Aws Native. Lex. Outputs. Bot Alias Conversation Log Settings - Specifies whether Amazon Lex logs text and audio for conversations with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch logs. Audio logs store input in Amazon S3 .
- Description string
- The description of the bot alias.
- Sentiment
Analysis Pulumi.Settings Aws Native. Lex. Outputs. Sentiment Analysis Settings Properties - Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
- Arn string
- The Amazon Resource Name (ARN) of the bot alias.
- Bot
Alias stringId - The unique identifier of the bot alias.
- Bot
Alias []BotLocale Settings Alias Locale Settings Item - Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
- Bot
Alias stringName - The name of the bot alias.
- Bot
Alias BotStatus Alias Status - The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
- Bot
Version string - The version of the bot that the bot alias references.
- Conversation
Log BotSettings Alias Conversation Log Settings - Specifies whether Amazon Lex logs text and audio for conversations with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch logs. Audio logs store input in Amazon S3 .
- Description string
- The description of the bot alias.
- Sentiment
Analysis SentimentSettings Analysis Settings Properties - Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
- arn String
- The Amazon Resource Name (ARN) of the bot alias.
- bot
Alias StringId - The unique identifier of the bot alias.
- bot
Alias List<BotLocale Settings Alias Locale Settings Item> - Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
- bot
Alias StringName - The name of the bot alias.
- bot
Alias BotStatus Alias Status - The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
- bot
Version String - The version of the bot that the bot alias references.
- conversation
Log BotSettings Alias Conversation Log Settings - Specifies whether Amazon Lex logs text and audio for conversations with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch logs. Audio logs store input in Amazon S3 .
- description String
- The description of the bot alias.
- sentiment
Analysis SentimentSettings Analysis Settings Properties - Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
- arn string
- The Amazon Resource Name (ARN) of the bot alias.
- bot
Alias stringId - The unique identifier of the bot alias.
- bot
Alias BotLocale Settings Alias Locale Settings Item[] - Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
- bot
Alias stringName - The name of the bot alias.
- bot
Alias BotStatus Alias Status - The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
- bot
Version string - The version of the bot that the bot alias references.
- conversation
Log BotSettings Alias Conversation Log Settings - Specifies whether Amazon Lex logs text and audio for conversations with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch logs. Audio logs store input in Amazon S3 .
- description string
- The description of the bot alias.
- sentiment
Analysis SentimentSettings Analysis Settings Properties - Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
- arn str
- The Amazon Resource Name (ARN) of the bot alias.
- bot_
alias_ strid - The unique identifier of the bot alias.
- bot_
alias_ Sequence[Botlocale_ settings Alias Locale Settings Item] - Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
- bot_
alias_ strname - The name of the bot alias.
- bot_
alias_ Botstatus Alias Status - The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
- bot_
version str - The version of the bot that the bot alias references.
- conversation_
log_ Botsettings Alias Conversation Log Settings - Specifies whether Amazon Lex logs text and audio for conversations with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch logs. Audio logs store input in Amazon S3 .
- description str
- The description of the bot alias.
- sentiment_
analysis_ Sentimentsettings Analysis Settings Properties - Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
- arn String
- The Amazon Resource Name (ARN) of the bot alias.
- bot
Alias StringId - The unique identifier of the bot alias.
- bot
Alias List<Property Map>Locale Settings - Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
- bot
Alias StringName - The name of the bot alias.
- bot
Alias "Creating" | "Available" | "Deleting" | "Failed"Status - The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
- bot
Version String - The version of the bot that the bot alias references.
- conversation
Log Property MapSettings - Specifies whether Amazon Lex logs text and audio for conversations with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch logs. Audio logs store input in Amazon S3 .
- description String
- The description of the bot alias.
- sentiment
Analysis Property MapSettings - Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
Supporting Types
BotAliasAudioLogDestination
BotAliasAudioLogSetting
- destination Property Map
- enabled Boolean
BotAliasCloudWatchLogGroupLogDestination
- Cloud
Watch stringLog Group Arn - A string used to identify the groupArn for the Cloudwatch Log Group
- Log
Prefix string - A string containing the value for the Log Prefix
- Cloud
Watch stringLog Group Arn - A string used to identify the groupArn for the Cloudwatch Log Group
- Log
Prefix string - A string containing the value for the Log Prefix
- cloud
Watch StringLog Group Arn - A string used to identify the groupArn for the Cloudwatch Log Group
- log
Prefix String - A string containing the value for the Log Prefix
- cloud
Watch stringLog Group Arn - A string used to identify the groupArn for the Cloudwatch Log Group
- log
Prefix string - A string containing the value for the Log Prefix
- cloud_
watch_ strlog_ group_ arn - A string used to identify the groupArn for the Cloudwatch Log Group
- log_
prefix str - A string containing the value for the Log Prefix
- cloud
Watch StringLog Group Arn - A string used to identify the groupArn for the Cloudwatch Log Group
- log
Prefix String - A string containing the value for the Log Prefix
BotAliasCodeHookSpecification
BotAliasConversationLogSettings
- Audio
Log List<Pulumi.Settings Aws Native. Lex. Inputs. Bot Alias Audio Log Setting> - The Amazon S3 settings for logging audio to an S3 bucket.
- Text
Log List<Pulumi.Settings Aws Native. Lex. Inputs. Bot Alias Text Log Setting> - The Amazon CloudWatch Logs settings for logging text and metadata.
- Audio
Log []BotSettings Alias Audio Log Setting - The Amazon S3 settings for logging audio to an S3 bucket.
- Text
Log []BotSettings Alias Text Log Setting - The Amazon CloudWatch Logs settings for logging text and metadata.
- audio
Log List<BotSettings Alias Audio Log Setting> - The Amazon S3 settings for logging audio to an S3 bucket.
- text
Log List<BotSettings Alias Text Log Setting> - The Amazon CloudWatch Logs settings for logging text and metadata.
- audio
Log BotSettings Alias Audio Log Setting[] - The Amazon S3 settings for logging audio to an S3 bucket.
- text
Log BotSettings Alias Text Log Setting[] - The Amazon CloudWatch Logs settings for logging text and metadata.
- audio_
log_ Sequence[Botsettings Alias Audio Log Setting] - The Amazon S3 settings for logging audio to an S3 bucket.
- text_
log_ Sequence[Botsettings Alias Text Log Setting] - The Amazon CloudWatch Logs settings for logging text and metadata.
- audio
Log List<Property Map>Settings - The Amazon S3 settings for logging audio to an S3 bucket.
- text
Log List<Property Map>Settings - The Amazon CloudWatch Logs settings for logging text and metadata.
BotAliasLambdaCodeHook
- Code
Hook stringInterface Version - The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
- Lambda
Arn string - The Amazon Resource Name (ARN) of the Lambda function.
- Code
Hook stringInterface Version - The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
- Lambda
Arn string - The Amazon Resource Name (ARN) of the Lambda function.
- code
Hook StringInterface Version - The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
- lambda
Arn String - The Amazon Resource Name (ARN) of the Lambda function.
- code
Hook stringInterface Version - The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
- lambda
Arn string - The Amazon Resource Name (ARN) of the Lambda function.
- code_
hook_ strinterface_ version - The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
- lambda_
arn str - The Amazon Resource Name (ARN) of the Lambda function.
- code
Hook StringInterface Version - The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
- lambda
Arn String - The Amazon Resource Name (ARN) of the Lambda function.
BotAliasLocaleSettings
- Enabled bool
- Whether the Lambda code hook is enabled
- Code
Hook Pulumi.Specification Aws Native. Lex. Inputs. Bot Alias Code Hook Specification
- Enabled bool
- Whether the Lambda code hook is enabled
- Code
Hook BotSpecification Alias Code Hook Specification
- enabled Boolean
- Whether the Lambda code hook is enabled
- code
Hook BotSpecification Alias Code Hook Specification
- enabled boolean
- Whether the Lambda code hook is enabled
- code
Hook BotSpecification Alias Code Hook Specification
- enabled bool
- Whether the Lambda code hook is enabled
- code_
hook_ Botspecification Alias Code Hook Specification
- enabled Boolean
- Whether the Lambda code hook is enabled
- code
Hook Property MapSpecification
BotAliasLocaleSettingsItem
- Bot
Alias Pulumi.Locale Setting Aws Native. Lex. Inputs. Bot Alias Locale Settings - Locale
Id string - A string used to identify the locale
- Bot
Alias BotLocale Setting Alias Locale Settings - Locale
Id string - A string used to identify the locale
- bot
Alias BotLocale Setting Alias Locale Settings - locale
Id String - A string used to identify the locale
- bot
Alias BotLocale Setting Alias Locale Settings - locale
Id string - A string used to identify the locale
- bot_
alias_ Botlocale_ setting Alias Locale Settings - locale_
id str - A string used to identify the locale
- bot
Alias Property MapLocale Setting - locale
Id String - A string used to identify the locale
BotAliasS3BucketLogDestination
- Log
Prefix string - The Amazon S3 key of the deployment package.
- S3Bucket
Arn string - The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
- Kms
Key stringArn - The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
- Log
Prefix string - The Amazon S3 key of the deployment package.
- S3Bucket
Arn string - The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
- Kms
Key stringArn - The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
- log
Prefix String - The Amazon S3 key of the deployment package.
- s3Bucket
Arn String - The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
- kms
Key StringArn - The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
- log
Prefix string - The Amazon S3 key of the deployment package.
- s3Bucket
Arn string - The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
- kms
Key stringArn - The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
- log_
prefix str - The Amazon S3 key of the deployment package.
- s3_
bucket_ strarn - The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
- kms_
key_ strarn - The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
- log
Prefix String - The Amazon S3 key of the deployment package.
- s3Bucket
Arn String - The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
- kms
Key StringArn - The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
BotAliasStatus
BotAliasTextLogDestination
BotAliasTextLogSetting
- destination Property Map
- enabled Boolean
SentimentAnalysisSettingsProperties
- Detect
Sentiment bool - Enable to call Amazon Comprehend for Sentiment natively within Lex
- Detect
Sentiment bool - Enable to call Amazon Comprehend for Sentiment natively within Lex
- detect
Sentiment Boolean - Enable to call Amazon Comprehend for Sentiment natively within Lex
- detect
Sentiment boolean - Enable to call Amazon Comprehend for Sentiment natively within Lex
- detect_
sentiment bool - Enable to call Amazon Comprehend for Sentiment natively within Lex
- detect
Sentiment Boolean - Enable to call Amazon Comprehend for Sentiment natively within Lex
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi