AWS Cloud Control v1.26.0, Mar 12 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.lex.getBotAlias

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

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)
public static Output<GetBotAliasResult> getBotAlias(GetBotAliasArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:lex:getBotAlias
  arguments:
    # arguments dictionary

The following arguments are supported:

BotAliasId string: The unique identifier of the bot alias.
BotId string: The unique identifier of the bot.

BotAliasId string: The unique identifier of the bot alias.
BotId string: The unique identifier of the bot.

botAliasId String: The unique identifier of the bot alias.
botId String: The unique identifier of the bot.

botAliasId string: The unique identifier of the bot alias.
botId string: The unique identifier of the bot.

bot_alias_id str: The unique identifier of the bot alias.
bot_id str: The unique identifier of the bot.

botAliasId String: The unique identifier of the bot alias.
botId 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.
BotAliasId string: The unique identifier of the bot alias.
BotAliasLocaleSettings List<Pulumi.AwsNative.Lex.Outputs.BotAliasLocaleSettingsItem>: Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
BotAliasName string: The name of the bot alias.
BotAliasStatus Pulumi.AwsNative.Lex.BotAliasStatus: The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
BotVersion string: The version of the bot that the bot alias references.
ConversationLogSettings Pulumi.AwsNative.Lex.Outputs.BotAliasConversationLogSettings: 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.
SentimentAnalysisSettings Pulumi.AwsNative.Lex.Outputs.SentimentAnalysisSettingsProperties: 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.
BotAliasId string: The unique identifier of the bot alias.
BotAliasLocaleSettings []BotAliasLocaleSettingsItem: Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
BotAliasName string: The name of the bot alias.
BotAliasStatus BotAliasStatus: The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
BotVersion string: The version of the bot that the bot alias references.
ConversationLogSettings BotAliasConversationLogSettings: 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.
SentimentAnalysisSettings SentimentAnalysisSettingsProperties: 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.
botAliasId String: The unique identifier of the bot alias.
botAliasLocaleSettings List<BotAliasLocaleSettingsItem>: Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
botAliasName String: The name of the bot alias.
botAliasStatus BotAliasStatus: The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
botVersion String: The version of the bot that the bot alias references.
conversationLogSettings BotAliasConversationLogSettings: 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.
sentimentAnalysisSettings SentimentAnalysisSettingsProperties: 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.
botAliasId string: The unique identifier of the bot alias.
botAliasLocaleSettings BotAliasLocaleSettingsItem[]: Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
botAliasName string: The name of the bot alias.
botAliasStatus BotAliasStatus: The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
botVersion string: The version of the bot that the bot alias references.
conversationLogSettings BotAliasConversationLogSettings: 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.
sentimentAnalysisSettings SentimentAnalysisSettingsProperties: 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_id str: The unique identifier of the bot alias.
bot_alias_locale_settings Sequence[BotAliasLocaleSettingsItem]: Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
bot_alias_name str: The name of the bot alias.
bot_alias_status BotAliasStatus: 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_settings BotAliasConversationLogSettings: 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_settings SentimentAnalysisSettingsProperties: 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.
botAliasId String: The unique identifier of the bot alias.
botAliasLocaleSettings List<Property Map>: Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
botAliasName String: The name of the bot alias.
botAliasStatus "Creating" | "Available" | "Deleting" | "Failed": The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
botVersion String: The version of the bot that the bot alias references.
conversationLogSettings Property Map: 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.
sentimentAnalysisSettings Property Map: Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

Supporting Types

BotAliasAudioLogDestination

S3Bucket Pulumi.AwsNative.Lex.Inputs.BotAliasS3BucketLogDestination

S3Bucket BotAliasS3BucketLogDestination

s3Bucket BotAliasS3BucketLogDestination

s3Bucket BotAliasS3BucketLogDestination

s3_bucket BotAliasS3BucketLogDestination

s3Bucket Property Map

BotAliasAudioLogSetting

Destination Pulumi.AwsNative.Lex.Inputs.BotAliasAudioLogDestination
Enabled bool

Destination BotAliasAudioLogDestination
Enabled bool

destination BotAliasAudioLogDestination
enabled Boolean

destination BotAliasAudioLogDestination
enabled boolean

destination BotAliasAudioLogDestination
enabled bool

destination Property Map
enabled Boolean

BotAliasCloudWatchLogGroupLogDestination

CloudWatchLogGroupArn string: A string used to identify the groupArn for the Cloudwatch Log Group
LogPrefix string: A string containing the value for the Log Prefix

CloudWatchLogGroupArn string: A string used to identify the groupArn for the Cloudwatch Log Group
LogPrefix string: A string containing the value for the Log Prefix

cloudWatchLogGroupArn String: A string used to identify the groupArn for the Cloudwatch Log Group
logPrefix String: A string containing the value for the Log Prefix

cloudWatchLogGroupArn string: A string used to identify the groupArn for the Cloudwatch Log Group
logPrefix string: A string containing the value for the Log Prefix

cloud_watch_log_group_arn str: A string used to identify the groupArn for the Cloudwatch Log Group
log_prefix str: A string containing the value for the Log Prefix

cloudWatchLogGroupArn String: A string used to identify the groupArn for the Cloudwatch Log Group
logPrefix String: A string containing the value for the Log Prefix

BotAliasCodeHookSpecification

LambdaCodeHook Pulumi.AwsNative.Lex.Inputs.BotAliasLambdaCodeHook

LambdaCodeHook BotAliasLambdaCodeHook

lambdaCodeHook BotAliasLambdaCodeHook

lambdaCodeHook BotAliasLambdaCodeHook

lambda_code_hook BotAliasLambdaCodeHook

lambdaCodeHook Property Map

BotAliasConversationLogSettings

AudioLogSettings List<Pulumi.AwsNative.Lex.Inputs.BotAliasAudioLogSetting>: The Amazon S3 settings for logging audio to an S3 bucket.
TextLogSettings List<Pulumi.AwsNative.Lex.Inputs.BotAliasTextLogSetting>: The Amazon CloudWatch Logs settings for logging text and metadata.

AudioLogSettings []BotAliasAudioLogSetting: The Amazon S3 settings for logging audio to an S3 bucket.
TextLogSettings []BotAliasTextLogSetting: The Amazon CloudWatch Logs settings for logging text and metadata.

audioLogSettings List<BotAliasAudioLogSetting>: The Amazon S3 settings for logging audio to an S3 bucket.
textLogSettings List<BotAliasTextLogSetting>: The Amazon CloudWatch Logs settings for logging text and metadata.

audioLogSettings BotAliasAudioLogSetting[]: The Amazon S3 settings for logging audio to an S3 bucket.
textLogSettings BotAliasTextLogSetting[]: The Amazon CloudWatch Logs settings for logging text and metadata.

audio_log_settings Sequence[BotAliasAudioLogSetting]: The Amazon S3 settings for logging audio to an S3 bucket.
text_log_settings Sequence[BotAliasTextLogSetting]: The Amazon CloudWatch Logs settings for logging text and metadata.

audioLogSettings List<Property Map>: The Amazon S3 settings for logging audio to an S3 bucket.
textLogSettings List<Property Map>: The Amazon CloudWatch Logs settings for logging text and metadata.

BotAliasLambdaCodeHook

CodeHookInterfaceVersion string: The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
LambdaArn string: The Amazon Resource Name (ARN) of the Lambda function.

CodeHookInterfaceVersion string: The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
LambdaArn string: The Amazon Resource Name (ARN) of the Lambda function.

codeHookInterfaceVersion String: The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
lambdaArn String: The Amazon Resource Name (ARN) of the Lambda function.

codeHookInterfaceVersion string: The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
lambdaArn string: The Amazon Resource Name (ARN) of the Lambda function.

code_hook_interface_version str: 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.

codeHookInterfaceVersion String: The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
lambdaArn String: The Amazon Resource Name (ARN) of the Lambda function.

BotAliasLocaleSettings

Enabled bool: Whether the Lambda code hook is enabled
CodeHookSpecification Pulumi.AwsNative.Lex.Inputs.BotAliasCodeHookSpecification

Enabled bool: Whether the Lambda code hook is enabled
CodeHookSpecification BotAliasCodeHookSpecification

enabled Boolean: Whether the Lambda code hook is enabled
codeHookSpecification BotAliasCodeHookSpecification

enabled boolean: Whether the Lambda code hook is enabled
codeHookSpecification BotAliasCodeHookSpecification

enabled bool: Whether the Lambda code hook is enabled
code_hook_specification BotAliasCodeHookSpecification

enabled Boolean: Whether the Lambda code hook is enabled
codeHookSpecification Property Map

BotAliasLocaleSettingsItem

BotAliasLocaleSetting Pulumi.AwsNative.Lex.Inputs.BotAliasLocaleSettings
LocaleId string: A string used to identify the locale

BotAliasLocaleSetting BotAliasLocaleSettings
LocaleId string: A string used to identify the locale

botAliasLocaleSetting BotAliasLocaleSettings
localeId String: A string used to identify the locale

botAliasLocaleSetting BotAliasLocaleSettings
localeId string: A string used to identify the locale

bot_alias_locale_setting BotAliasLocaleSettings
locale_id str: A string used to identify the locale

botAliasLocaleSetting Property Map
localeId String: A string used to identify the locale

BotAliasS3BucketLogDestination

LogPrefix string: The Amazon S3 key of the deployment package.
S3BucketArn string: The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
KmsKeyArn string: The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

LogPrefix string: The Amazon S3 key of the deployment package.
S3BucketArn string: The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
KmsKeyArn string: The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

logPrefix String: The Amazon S3 key of the deployment package.
s3BucketArn String: The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
kmsKeyArn String: The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

logPrefix string: The Amazon S3 key of the deployment package.
s3BucketArn string: The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
kmsKeyArn string: 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_arn str: The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
kms_key_arn str: The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

logPrefix String: The Amazon S3 key of the deployment package.
s3BucketArn String: The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
kmsKeyArn String: The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.