AWS Cloud Control v1.27.0, Apr 14 25

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.lex.getBot

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Using getBot

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 getBot(args: GetBotArgs, opts?: InvokeOptions): Promise<GetBotResult>
function getBotOutput(args: GetBotOutputArgs, opts?: InvokeOptions): Output<GetBotResult>

def get_bot(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetBotResult
def get_bot_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetBotResult]

func LookupBot(ctx *Context, args *LookupBotArgs, opts ...InvokeOption) (*LookupBotResult, error)
func LookupBotOutput(ctx *Context, args *LookupBotOutputArgs, opts ...InvokeOption) LookupBotResultOutput

> Note: This function is named LookupBot in the Go SDK.

public static class GetBot 
{
    public static Task<GetBotResult> InvokeAsync(GetBotArgs args, InvokeOptions? opts = null)
    public static Output<GetBotResult> Invoke(GetBotInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBotResult> getBot(GetBotArgs args, InvokeOptions options)
public static Output<GetBotResult> getBot(GetBotArgs args, InvokeOptions options)

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

The following arguments are supported:

Id string: The unique identifier of the bot.

Id string: The unique identifier of the bot.

id String: The unique identifier of the bot.

id string: The unique identifier of the bot.

id str: The unique identifier of the bot.

id String: The unique identifier of the bot.

getBot Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) of the bot.

DataPrivacy Pulumi.AwsNative.Lex.Outputs.DataPrivacyProperties

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

Description string

The description of the version.

Id string

The unique identifier of the bot.

IdleSessionTtlInSeconds int

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

Name string

The name of the bot locale.

RoleArn string

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

TestBotAliasSettings Pulumi.AwsNative.Lex.Outputs.BotTestBotAliasSettings

Specifies configuration settings for the alias used to test the bot. If the TestBotAliasSettings property is not specified, the settings are configured with default values.

Arn string

The Amazon Resource Name (ARN) of the bot.

DataPrivacy DataPrivacyProperties

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

Description string

The description of the version.

Id string

The unique identifier of the bot.

IdleSessionTtlInSeconds int

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

Name string

The name of the bot locale.

RoleArn string

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

TestBotAliasSettings BotTestBotAliasSettings

Specifies configuration settings for the alias used to test the bot. If the TestBotAliasSettings property is not specified, the settings are configured with default values.

arn String

The Amazon Resource Name (ARN) of the bot.

dataPrivacy DataPrivacyProperties

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

description String

The description of the version.

id String

The unique identifier of the bot.

idleSessionTtlInSeconds Integer

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

name String

The name of the bot locale.

roleArn String

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

testBotAliasSettings BotTestBotAliasSettings

Specifies configuration settings for the alias used to test the bot. If the TestBotAliasSettings property is not specified, the settings are configured with default values.

arn string

The Amazon Resource Name (ARN) of the bot.

dataPrivacy DataPrivacyProperties

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

description string

The description of the version.

id string

The unique identifier of the bot.

idleSessionTtlInSeconds number

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

name string

The name of the bot locale.

roleArn string

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

testBotAliasSettings BotTestBotAliasSettings

Specifies configuration settings for the alias used to test the bot. If the TestBotAliasSettings property is not specified, the settings are configured with default values.

arn str

The Amazon Resource Name (ARN) of the bot.

data_privacy DataPrivacyProperties

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

description str

The description of the version.

id str

The unique identifier of the bot.

idle_session_ttl_in_seconds int

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

name str

The name of the bot locale.

role_arn str

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

test_bot_alias_settings BotTestBotAliasSettings

Specifies configuration settings for the alias used to test the bot. If the TestBotAliasSettings property is not specified, the settings are configured with default values.

arn String

The Amazon Resource Name (ARN) of the bot.

dataPrivacy Property Map

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

description String

The description of the version.

id String

The unique identifier of the bot.

idleSessionTtlInSeconds Number

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

name String

The name of the bot locale.

roleArn String

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

testBotAliasSettings Property Map

Specifies configuration settings for the alias used to test the bot. If the TestBotAliasSettings property is not specified, the settings are configured with default values.

Supporting Types

BotAliasCodeHookSpecification

LambdaCodeHook Pulumi.AwsNative.Lex.Inputs.BotAliasLambdaCodeHook

LambdaCodeHook BotAliasLambdaCodeHook

lambdaCodeHook BotAliasLambdaCodeHook

lambdaCodeHook BotAliasLambdaCodeHook

lambda_code_hook BotAliasLambdaCodeHook

lambdaCodeHook Property Map

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

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

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

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

audio_log_settings Sequence[BotAudioLogSetting]: The Amazon S3 settings for logging audio to an S3 bucket.
text_log_settings Sequence[BotTextLogSetting]: 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.

BotS3BucketLogDestination

LogPrefix string
S3BucketArn string
KmsKeyArn string

LogPrefix string
S3BucketArn string
KmsKeyArn string

logPrefix String
s3BucketArn String
kmsKeyArn String

logPrefix string
s3BucketArn string
kmsKeyArn string

log_prefix str
s3_bucket_arn str
kms_key_arn str

logPrefix String
s3BucketArn String
kmsKeyArn String

BotTestBotAliasSettings

BotAliasLocaleSettings List<Pulumi.AwsNative.Lex.Inputs.BotAliasLocaleSettingsItem>: Specifies settings that are unique to a locale. For example, you can use a different Lambda function depending on the bot's locale.
ConversationLogSettings Pulumi.AwsNative.Lex.Inputs.BotConversationLogSettings: Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users.
Description string: Specifies a description for the test bot alias.
SentimentAnalysisSettings Pulumi.AwsNative.Lex.Inputs.BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

BotAliasLocaleSettings []BotAliasLocaleSettingsItem: Specifies settings that are unique to a locale. For example, you can use a different Lambda function depending on the bot's locale.
ConversationLogSettings BotConversationLogSettings: Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users.
Description string: Specifies a description for the test bot alias.
SentimentAnalysisSettings BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

botAliasLocaleSettings List<BotAliasLocaleSettingsItem>: Specifies settings that are unique to a locale. For example, you can use a different Lambda function depending on the bot's locale.
conversationLogSettings BotConversationLogSettings: Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users.
description String: Specifies a description for the test bot alias.
sentimentAnalysisSettings BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

botAliasLocaleSettings BotAliasLocaleSettingsItem[]: Specifies settings that are unique to a locale. For example, you can use a different Lambda function depending on the bot's locale.
conversationLogSettings BotConversationLogSettings: Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users.
description string: Specifies a description for the test bot alias.
sentimentAnalysisSettings BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

bot_alias_locale_settings Sequence[BotAliasLocaleSettingsItem]: Specifies settings that are unique to a locale. For example, you can use a different Lambda function depending on the bot's locale.
conversation_log_settings BotConversationLogSettings: Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users.
description str: Specifies a description for the test bot alias.
sentiment_analysis_settings BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

botAliasLocaleSettings List<Property Map>: Specifies settings that are unique to a locale. For example, you can use a different Lambda function depending on the bot's locale.
conversationLogSettings Property Map: Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users.
description String: Specifies a description for the test bot alias.
sentimentAnalysisSettings Property Map: Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

BotTestBotAliasSettingsSentimentAnalysisSettingsProperties

DetectSentiment bool

DetectSentiment bool

detectSentiment Boolean

detectSentiment boolean

detect_sentiment bool

detectSentiment Boolean

BotTextLogDestination

CloudWatch Pulumi.AwsNative.Lex.Inputs.BotCloudWatchLogGroupLogDestination

CloudWatch BotCloudWatchLogGroupLogDestination

cloudWatch BotCloudWatchLogGroupLogDestination

cloudWatch BotCloudWatchLogGroupLogDestination

cloud_watch BotCloudWatchLogGroupLogDestination

cloudWatch Property Map

BotTextLogSetting

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

Destination BotTextLogDestination
Enabled bool

destination BotTextLogDestination
enabled Boolean

destination BotTextLogDestination
enabled boolean

destination BotTextLogDestination
enabled bool

destination Property Map
enabled Boolean

DataPrivacyProperties

ChildDirected bool: For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

ChildDirected bool: For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

childDirected Boolean: For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

childDirected boolean: For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

child_directed bool: For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

childDirected Boolean: For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.lex.getBot

On this page

On this page

Using getBot

getBot Result

Supporting Types

BotAliasCodeHookSpecification

BotAliasLambdaCodeHook

BotAliasLocaleSettings

BotAliasLocaleSettingsItem

BotAudioLogDestination

BotAudioLogSetting

BotCloudWatchLogGroupLogDestination

BotConversationLogSettings

BotS3BucketLogDestination

BotTestBotAliasSettings

BotTestBotAliasSettingsSentimentAnalysisSettingsProperties

BotTextLogDestination

BotTextLogSetting

DataPrivacyProperties

Package Details

On this page

On this page