AWS Native v0.54.0, Mar 21 23

aws-native.lex.getBot

Amazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.

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.

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)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Id string

Id string

id String

id string

id str

id String

getBot Result

The following output properties are available:

Arn string
DataPrivacy Pulumi.AwsNative.Lex.Outputs.DataPrivacyProperties: Data privacy setting of the Bot.
Description string
Id string
IdleSessionTTLInSeconds int: IdleSessionTTLInSeconds of the resource
Name string
RoleArn string
TestBotAliasSettings Pulumi.AwsNative.Lex.Outputs.BotTestBotAliasSettings

Arn string
DataPrivacy DataPrivacyProperties: Data privacy setting of the Bot.
Description string
Id string
IdleSessionTTLInSeconds int: IdleSessionTTLInSeconds of the resource
Name string
RoleArn string
TestBotAliasSettings BotTestBotAliasSettings

arn String
dataPrivacy DataPrivacyProperties: Data privacy setting of the Bot.
description String
id String
idleSessionTTLInSeconds Integer: IdleSessionTTLInSeconds of the resource
name String
roleArn String
testBotAliasSettings BotTestBotAliasSettings

arn string
dataPrivacy DataPrivacyProperties: Data privacy setting of the Bot.
description string
id string
idleSessionTTLInSeconds number: IdleSessionTTLInSeconds of the resource
name string
roleArn string
testBotAliasSettings BotTestBotAliasSettings

arn str
data_privacy DataPrivacyProperties: Data privacy setting of the Bot.
description str
id str
idle_session_ttl_in_seconds int: IdleSessionTTLInSeconds of the resource
name str
role_arn str
test_bot_alias_settings BotTestBotAliasSettings

arn String
dataPrivacy Property Map: Data privacy setting of the Bot.
description String
id String
idleSessionTTLInSeconds Number: IdleSessionTTLInSeconds of the resource
name String
roleArn String
testBotAliasSettings Property Map

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

BotAudioLogDestination

S3Bucket Pulumi.AwsNative.Lex.Inputs.BotS3BucketLogDestination

S3Bucket BotS3BucketLogDestination

s3Bucket BotS3BucketLogDestination

s3Bucket BotS3BucketLogDestination

s3_bucket BotS3BucketLogDestination

s3Bucket Property Map

BotAudioLogSetting

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

Destination BotAudioLogDestination
Enabled bool

destination BotAudioLogDestination
enabled Boolean

destination BotAudioLogDestination
enabled boolean

destination BotAudioLogDestination
enabled bool

destination Property Map
enabled Boolean

BotCloudWatchLogGroupLogDestination

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

BotConversationLogSettings

AudioLogSettings List<Pulumi.AwsNative.Lex.Inputs.BotAudioLogSetting>
TextLogSettings List<Pulumi.AwsNative.Lex.Inputs.BotTextLogSetting>

AudioLogSettings []BotAudioLogSetting
TextLogSettings []BotTextLogSetting

audioLogSettings List<BotAudioLogSetting>
textLogSettings List<BotTextLogSetting>

audioLogSettings BotAudioLogSetting[]
textLogSettings BotTextLogSetting[]

audio_log_settings Sequence[BotAudioLogSetting]
text_log_settings Sequence[BotTextLogSetting]

audioLogSettings List<Property Map>
textLogSettings List<Property Map>

BotS3BucketLogDestination

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.

BotTestBotAliasSettings

BotAliasLocaleSettings List<Pulumi.AwsNative.Lex.Inputs.BotAliasLocaleSettingsItem>
ConversationLogSettings Pulumi.AwsNative.Lex.Inputs.BotConversationLogSettings
Description string
SentimentAnalysisSettings Pulumi.AwsNative.Lex.Inputs.BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

BotAliasLocaleSettings []BotAliasLocaleSettingsItem
ConversationLogSettings BotConversationLogSettings
Description string
SentimentAnalysisSettings BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

botAliasLocaleSettings List<BotAliasLocaleSettingsItem>
conversationLogSettings BotConversationLogSettings
description String
sentimentAnalysisSettings BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

botAliasLocaleSettings BotAliasLocaleSettingsItem[]
conversationLogSettings BotConversationLogSettings
description string
sentimentAnalysisSettings BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

bot_alias_locale_settings Sequence[BotAliasLocaleSettingsItem]
conversation_log_settings BotConversationLogSettings
description str
sentiment_analysis_settings BotTestBotAliasSettingsSentimentAnalysisSettingsProperties: Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

botAliasLocaleSettings List<Property Map>
conversationLogSettings Property Map
description String
sentimentAnalysisSettings Property Map: Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

BotTestBotAliasSettingsSentimentAnalysisSettingsProperties

DetectSentiment bool: Enable to call Amazon Comprehend for Sentiment natively within Lex

DetectSentiment bool: Enable to call Amazon Comprehend for Sentiment natively within Lex

detectSentiment Boolean: Enable to call Amazon Comprehend for Sentiment natively within Lex

detectSentiment boolean: Enable to call Amazon Comprehend for Sentiment natively within Lex

detect_sentiment bool: Enable to call Amazon Comprehend for Sentiment natively within Lex

detectSentiment Boolean: Enable to call Amazon Comprehend for Sentiment natively within Lex

Package Details

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