getBot

Provides details about a specific Amazon Lex Bot.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var orderFlowersBot = Aws.Lex.GetBot.Invoke(new()
    {
        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("$LATEST")),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lex.LexFunctions;
import com.pulumi.aws.lex.inputs.GetBotArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var orderFlowersBot = 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 = 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

Name of the bot. The name is case sensitive.

Version string

Version or alias of the bot.

Name string

Name of the bot. The name is case sensitive.

Version string

Version or alias of the bot.

name String

Name of the bot. The name is case sensitive.

version String

Version or alias of the bot.

name string

Name of the bot. The name is case sensitive.

version string

Version or alias of the bot.

name str

Name of the bot. The name is case sensitive.

version str

Version or alias of the bot.

name String

Name of the bot. The name is case sensitive.

version String

Version or alias of the bot.

getBot Result

The following output properties are available:

Arn string

ARN of the bot.

Checksum string

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

ChildDirected bool

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

Date that the bot was created.

Description string

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

Date that the bot was updated.

Locale string

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

Name string

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

Status of the bot.

VoiceId string

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

Version string

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

Arn string

ARN of the bot.

Checksum string

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

ChildDirected bool

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

Date that the bot was created.

Description string

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

Date that the bot was updated.

Locale string

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

Name string

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

Status of the bot.

VoiceId string

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

Version string

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

arn String

ARN of the bot.

checksum String

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

childDirected Boolean

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

Date that the bot was created.

description String

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

Date that the bot was updated.

locale String

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

name String

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

Status of the bot.

voiceId String

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

version String

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

arn string

ARN of the bot.

checksum string

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

childDirected boolean

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

Date that the bot was created.

description string

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

Date that the bot was updated.

locale string

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

name string

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

Status of the bot.

voiceId string

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

version string

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

arn str

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

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

Date that the bot was created.

description str

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

Date that the bot was updated.

locale str

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

name str

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

Status of the bot.

voice_id str

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

version str

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

arn String

ARN of the bot.

checksum String

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

childDirected Boolean

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

Date that the bot was created.

description String

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

Date that the bot was updated.

locale String

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

name String

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

Status of the bot.

voiceId String

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

version String

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.