AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

getBot

Provides details about a specific Amazon Lex Bot.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var orderFlowersBot = Output.Create(Aws.Lex.GetBot.InvokeAsync(new Aws.Lex.GetBotArgs
        {
            Name = "OrderFlowers",
            Version = "$LATEST",
        }));
    }

}
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/lex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lex.LookupBot(ctx, &lex.LookupBotArgs{
			Name:    "OrderFlowers",
			Version: pulumi.StringRef(fmt.Sprintf("%v%v", "$", "LATEST")),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var orderFlowersBot = Output.of(LexFunctions.getBot(GetBotArgs.builder()
            .name("OrderFlowers")
            .version("$LATEST")
            .build()));

    }
}
import pulumi
import pulumi_aws as aws

order_flowers_bot = aws.lex.get_bot(name="OrderFlowers",
    version="$LATEST")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const orderFlowersBot = pulumi.output(aws.lex.getBot({
    name: "OrderFlowers",
    version: "$LATEST",
}));
variables:
  orderFlowersBot:
    Fn::Invoke:
      Function: aws:lex:getBot
      Arguments:
        name: OrderFlowers
        version: $LATEST

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(name: Optional[str] = None,
            version: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetBotResult
def get_bot_output(name: Optional[pulumi.Input[str]] = None,
            version: 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:lex/getBot:getBot
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

The name of the bot. The name is case sensitive.

Version string

The version or alias of the bot.

Name string

The name of the bot. The name is case sensitive.

Version string

The version or alias of the bot.

name String

The name of the bot. The name is case sensitive.

version String

The version or alias of the bot.

name string

The name of the bot. The name is case sensitive.

version string

The version or alias of the bot.

name str

The name of the bot. The name is case sensitive.

version str

The version or alias of the bot.

name String

The name of the bot. The name is case sensitive.

version String

The version or alias of the bot.

getBot Result

The following output properties are available:

Arn string

The ARN of the bot.

Checksum string

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

ChildDirected bool

Specifies if this Amazon Lex Bot 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.

CreatedDate string

The date that the bot was created.

Description string

A description of the bot.

DetectSentiment bool

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis.

EnableModelImprovements bool

Set to true if natural language understanding improvements are enabled.

FailureReason string

If the status is FAILED, the reason why the bot failed to build.

Id string

The provider-assigned unique ID for this managed resource.

IdleSessionTtlInSeconds int

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

LastUpdatedDate string

The date that the bot was updated.

Locale string

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

Name string

The name of the bot, case sensitive.

NluIntentConfidenceThreshold double

The threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

Status string

The status of the bot.

VoiceId string

The Amazon Polly voice ID that the Amazon Lex Bot uses for voice interactions with the user.

Version string

The version of the bot. For a new bot, the version is always $LATEST.

Arn string

The ARN of the bot.

Checksum string

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

ChildDirected bool

Specifies if this Amazon Lex Bot 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.

CreatedDate string

The date that the bot was created.

Description string

A description of the bot.

DetectSentiment bool

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis.

EnableModelImprovements bool

Set to true if natural language understanding improvements are enabled.

FailureReason string

If the status is FAILED, the reason why the bot failed to build.

Id string

The provider-assigned unique ID for this managed resource.

IdleSessionTtlInSeconds int

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

LastUpdatedDate string

The date that the bot was updated.

Locale string

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

Name string

The name of the bot, case sensitive.

NluIntentConfidenceThreshold float64

The threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

Status string

The status of the bot.

VoiceId string

The Amazon Polly voice ID that the Amazon Lex Bot uses for voice interactions with the user.

Version string

The version of the bot. For a new bot, the version is always $LATEST.

arn String

The ARN of the bot.

checksum String

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

childDirected Boolean

Specifies if this Amazon Lex Bot 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.

createdDate String

The date that the bot was created.

description String

A description of the bot.

detectSentiment Boolean

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis.

enableModelImprovements Boolean

Set to true if natural language understanding improvements are enabled.

failureReason String

If the status is FAILED, the reason why the bot failed to build.

id String

The provider-assigned unique ID for this managed resource.

idleSessionTtlInSeconds Integer

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

lastUpdatedDate String

The date that the bot was updated.

locale String

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

name String

The name of the bot, case sensitive.

nluIntentConfidenceThreshold Double

The threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

status String

The status of the bot.

voiceId String

The Amazon Polly voice ID that the Amazon Lex Bot uses for voice interactions with the user.

version String

The version of the bot. For a new bot, the version is always $LATEST.

arn string

The ARN of the bot.

checksum string

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

childDirected boolean

Specifies if this Amazon Lex Bot 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.

createdDate string

The date that the bot was created.

description string

A description of the bot.

detectSentiment boolean

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis.

enableModelImprovements boolean

Set to true if natural language understanding improvements are enabled.

failureReason string

If the status is FAILED, the reason why the bot failed to build.

id string

The provider-assigned unique ID for this managed resource.

idleSessionTtlInSeconds number

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

lastUpdatedDate string

The date that the bot was updated.

locale string

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

name string

The name of the bot, case sensitive.

nluIntentConfidenceThreshold number

The threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

status string

The status of the bot.

voiceId string

The Amazon Polly voice ID that the Amazon Lex Bot uses for voice interactions with the user.

version string

The version of the bot. For a new bot, the version is always $LATEST.

arn str

The ARN of the bot.

checksum str

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

child_directed bool

Specifies if this Amazon Lex Bot 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.

created_date str

The date that the bot was created.

description str

A description of the bot.

detect_sentiment bool

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis.

enable_model_improvements bool

Set to true if natural language understanding improvements are enabled.

failure_reason str

If the status is FAILED, the reason why the bot failed to build.

id str

The provider-assigned unique ID for this managed resource.

idle_session_ttl_in_seconds int

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

last_updated_date str

The date that the bot was updated.

locale str

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

name str

The name of the bot, case sensitive.

nlu_intent_confidence_threshold float

The threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

status str

The status of the bot.

voice_id str

The Amazon Polly voice ID that the Amazon Lex Bot uses for voice interactions with the user.

version str

The version of the bot. For a new bot, the version is always $LATEST.

arn String

The ARN of the bot.

checksum String

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

childDirected Boolean

Specifies if this Amazon Lex Bot 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.

createdDate String

The date that the bot was created.

description String

A description of the bot.

detectSentiment Boolean

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis.

enableModelImprovements Boolean

Set to true if natural language understanding improvements are enabled.

failureReason String

If the status is FAILED, the reason why the bot failed to build.

id String

The provider-assigned unique ID for this managed resource.

idleSessionTtlInSeconds Number

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

lastUpdatedDate String

The date that the bot was updated.

locale String

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

name String

The name of the bot, case sensitive.

nluIntentConfidenceThreshold Number

The threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

status String

The status of the bot.

voiceId String

The Amazon Polly voice ID that the Amazon Lex Bot uses for voice interactions with the user.

version String

The version of the bot. For a new bot, the version is always $LATEST.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.