Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. lex
  5. Bot
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.lex.Bot

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an Amazon Lex Bot resource. For more information see Amazon Lex: How It Works

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const orderFlowersBot = new aws.lex.Bot("order_flowers_bot", {
    abortStatement: {
        messages: [{
            content: "Sorry, I am not able to assist at this time",
            contentType: "PlainText",
        }],
    },
    childDirected: false,
    clarificationPrompt: {
        maxAttempts: 2,
        messages: [{
            content: "I didn't understand you, what would you like to do?",
            contentType: "PlainText",
        }],
    },
    createVersion: false,
    description: "Bot to order flowers on the behalf of a user",
    idleSessionTtlInSeconds: 600,
    intents: [{
        intentName: "OrderFlowers",
        intentVersion: "1",
    }],
    locale: "en-US",
    name: "OrderFlowers",
    processBehavior: "BUILD",
    voiceId: "Salli",
});

    import pulumi
import pulumi_aws as aws

order_flowers_bot = aws.lex.Bot("order_flowers_bot",
    abort_statement={
        "messages": [{
            "content": "Sorry, I am not able to assist at this time",
            "content_type": "PlainText",
        }],
    },
    child_directed=False,
    clarification_prompt={
        "max_attempts": 2,
        "messages": [{
            "content": "I didn't understand you, what would you like to do?",
            "content_type": "PlainText",
        }],
    },
    create_version=False,
    description="Bot to order flowers on the behalf of a user",
    idle_session_ttl_in_seconds=600,
    intents=[{
        "intent_name": "OrderFlowers",
        "intent_version": "1",
    }],
    locale="en-US",
    name="OrderFlowers",
    process_behavior="BUILD",
    voice_id="Salli")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lex.NewBot(ctx, "order_flowers_bot", &lex.BotArgs{
			AbortStatement: &lex.BotAbortStatementArgs{
				Messages: lex.BotAbortStatementMessageArray{
					&lex.BotAbortStatementMessageArgs{
						Content:     pulumi.String("Sorry, I am not able to assist at this time"),
						ContentType: pulumi.String("PlainText"),
					},
				},
			},
			ChildDirected: pulumi.Bool(false),
			ClarificationPrompt: &lex.BotClarificationPromptArgs{
				MaxAttempts: pulumi.Int(2),
				Messages: lex.BotClarificationPromptMessageArray{
					&lex.BotClarificationPromptMessageArgs{
						Content:     pulumi.String("I didn't understand you, what would you like to do?"),
						ContentType: pulumi.String("PlainText"),
					},
				},
			},
			CreateVersion:           pulumi.Bool(false),
			Description:             pulumi.String("Bot to order flowers on the behalf of a user"),
			IdleSessionTtlInSeconds: pulumi.Int(600),
			Intents: lex.BotIntentArray{
				&lex.BotIntentArgs{
					IntentName:    pulumi.String("OrderFlowers"),
					IntentVersion: pulumi.String("1"),
				},
			},
			Locale:          pulumi.String("en-US"),
			Name:            pulumi.String("OrderFlowers"),
			ProcessBehavior: pulumi.String("BUILD"),
			VoiceId:         pulumi.String("Salli"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var orderFlowersBot = new Aws.Lex.Bot("order_flowers_bot", new()
    {
        AbortStatement = new Aws.Lex.Inputs.BotAbortStatementArgs
        {
            Messages = new[]
            {
                new Aws.Lex.Inputs.BotAbortStatementMessageArgs
                {
                    Content = "Sorry, I am not able to assist at this time",
                    ContentType = "PlainText",
                },
            },
        },
        ChildDirected = false,
        ClarificationPrompt = new Aws.Lex.Inputs.BotClarificationPromptArgs
        {
            MaxAttempts = 2,
            Messages = new[]
            {
                new Aws.Lex.Inputs.BotClarificationPromptMessageArgs
                {
                    Content = "I didn't understand you, what would you like to do?",
                    ContentType = "PlainText",
                },
            },
        },
        CreateVersion = false,
        Description = "Bot to order flowers on the behalf of a user",
        IdleSessionTtlInSeconds = 600,
        Intents = new[]
        {
            new Aws.Lex.Inputs.BotIntentArgs
            {
                IntentName = "OrderFlowers",
                IntentVersion = "1",
            },
        },
        Locale = "en-US",
        Name = "OrderFlowers",
        ProcessBehavior = "BUILD",
        VoiceId = "Salli",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lex.Bot;
import com.pulumi.aws.lex.BotArgs;
import com.pulumi.aws.lex.inputs.BotAbortStatementArgs;
import com.pulumi.aws.lex.inputs.BotClarificationPromptArgs;
import com.pulumi.aws.lex.inputs.BotIntentArgs;
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) {
        var orderFlowersBot = new Bot("orderFlowersBot", BotArgs.builder()
            .abortStatement(BotAbortStatementArgs.builder()
                .messages(BotAbortStatementMessageArgs.builder()
                    .content("Sorry, I am not able to assist at this time")
                    .contentType("PlainText")
                    .build())
                .build())
            .childDirected(false)
            .clarificationPrompt(BotClarificationPromptArgs.builder()
                .maxAttempts(2)
                .messages(BotClarificationPromptMessageArgs.builder()
                    .content("I didn't understand you, what would you like to do?")
                    .contentType("PlainText")
                    .build())
                .build())
            .createVersion(false)
            .description("Bot to order flowers on the behalf of a user")
            .idleSessionTtlInSeconds(600)
            .intents(BotIntentArgs.builder()
                .intentName("OrderFlowers")
                .intentVersion("1")
                .build())
            .locale("en-US")
            .name("OrderFlowers")
            .processBehavior("BUILD")
            .voiceId("Salli")
            .build());

    }
}

    resources:
  orderFlowersBot:
    type: aws:lex:Bot
    name: order_flowers_bot
    properties:
      abortStatement:
        messages:
          - content: Sorry, I am not able to assist at this time
            contentType: PlainText
      childDirected: false
      clarificationPrompt:
        maxAttempts: 2
        messages:
          - content: I didn't understand you, what would you like to do?
            contentType: PlainText
      createVersion: false
      description: Bot to order flowers on the behalf of a user
      idleSessionTtlInSeconds: 600
      intents:
        - intentName: OrderFlowers
          intentVersion: '1'
      locale: en-US
      name: OrderFlowers
      processBehavior: BUILD
      voiceId: Salli

    Create Bot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Bot(name: string, args: BotArgs, opts?: CustomResourceOptions);
    @overload
def Bot(resource_name: str,
        args: BotArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Bot(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        abort_statement: Optional[BotAbortStatementArgs] = None,
        child_directed: Optional[bool] = None,
        intents: Optional[Sequence[BotIntentArgs]] = None,
        enable_model_improvements: Optional[bool] = None,
        description: Optional[str] = None,
        detect_sentiment: Optional[bool] = None,
        create_version: Optional[bool] = None,
        idle_session_ttl_in_seconds: Optional[int] = None,
        clarification_prompt: Optional[BotClarificationPromptArgs] = None,
        locale: Optional[str] = None,
        name: Optional[str] = None,
        nlu_intent_confidence_threshold: Optional[float] = None,
        process_behavior: Optional[str] = None,
        voice_id: Optional[str] = None)
    func NewBot(ctx *Context, name string, args BotArgs, opts ...ResourceOption) (*Bot, error)
    public Bot(string name, BotArgs args, CustomResourceOptions? opts = null)
    public Bot(String name, BotArgs args)
public Bot(String name, BotArgs args, CustomResourceOptions options)

    type: aws:lex:Bot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BotArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var botResource = new Aws.Lex.Bot("botResource", new()
{
    AbortStatement = new Aws.Lex.Inputs.BotAbortStatementArgs
    {
        Messages = new[]
        {
            new Aws.Lex.Inputs.BotAbortStatementMessageArgs
            {
                Content = "string",
                ContentType = "string",
                GroupNumber = 0,
            },
        },
        ResponseCard = "string",
    },
    ChildDirected = false,
    Intents = new[]
    {
        new Aws.Lex.Inputs.BotIntentArgs
        {
            IntentName = "string",
            IntentVersion = "string",
        },
    },
    EnableModelImprovements = false,
    Description = "string",
    DetectSentiment = false,
    CreateVersion = false,
    IdleSessionTtlInSeconds = 0,
    ClarificationPrompt = new Aws.Lex.Inputs.BotClarificationPromptArgs
    {
        MaxAttempts = 0,
        Messages = new[]
        {
            new Aws.Lex.Inputs.BotClarificationPromptMessageArgs
            {
                Content = "string",
                ContentType = "string",
                GroupNumber = 0,
            },
        },
        ResponseCard = "string",
    },
    Locale = "string",
    Name = "string",
    NluIntentConfidenceThreshold = 0,
    ProcessBehavior = "string",
    VoiceId = "string",
});

    example, err := lex.NewBot(ctx, "botResource", &lex.BotArgs{
	AbortStatement: &lex.BotAbortStatementArgs{
		Messages: lex.BotAbortStatementMessageArray{
			&lex.BotAbortStatementMessageArgs{
				Content:     pulumi.String("string"),
				ContentType: pulumi.String("string"),
				GroupNumber: pulumi.Int(0),
			},
		},
		ResponseCard: pulumi.String("string"),
	},
	ChildDirected: pulumi.Bool(false),
	Intents: lex.BotIntentArray{
		&lex.BotIntentArgs{
			IntentName:    pulumi.String("string"),
			IntentVersion: pulumi.String("string"),
		},
	},
	EnableModelImprovements: pulumi.Bool(false),
	Description:             pulumi.String("string"),
	DetectSentiment:         pulumi.Bool(false),
	CreateVersion:           pulumi.Bool(false),
	IdleSessionTtlInSeconds: pulumi.Int(0),
	ClarificationPrompt: &lex.BotClarificationPromptArgs{
		MaxAttempts: pulumi.Int(0),
		Messages: lex.BotClarificationPromptMessageArray{
			&lex.BotClarificationPromptMessageArgs{
				Content:     pulumi.String("string"),
				ContentType: pulumi.String("string"),
				GroupNumber: pulumi.Int(0),
			},
		},
		ResponseCard: pulumi.String("string"),
	},
	Locale:                       pulumi.String("string"),
	Name:                         pulumi.String("string"),
	NluIntentConfidenceThreshold: pulumi.Float64(0),
	ProcessBehavior:              pulumi.String("string"),
	VoiceId:                      pulumi.String("string"),
})

    var botResource = new Bot("botResource", BotArgs.builder()
    .abortStatement(BotAbortStatementArgs.builder()
        .messages(BotAbortStatementMessageArgs.builder()
            .content("string")
            .contentType("string")
            .groupNumber(0)
            .build())
        .responseCard("string")
        .build())
    .childDirected(false)
    .intents(BotIntentArgs.builder()
        .intentName("string")
        .intentVersion("string")
        .build())
    .enableModelImprovements(false)
    .description("string")
    .detectSentiment(false)
    .createVersion(false)
    .idleSessionTtlInSeconds(0)
    .clarificationPrompt(BotClarificationPromptArgs.builder()
        .maxAttempts(0)
        .messages(BotClarificationPromptMessageArgs.builder()
            .content("string")
            .contentType("string")
            .groupNumber(0)
            .build())
        .responseCard("string")
        .build())
    .locale("string")
    .name("string")
    .nluIntentConfidenceThreshold(0)
    .processBehavior("string")
    .voiceId("string")
    .build());

    bot_resource = aws.lex.Bot("botResource",
    abort_statement={
        "messages": [{
            "content": "string",
            "content_type": "string",
            "group_number": 0,
        }],
        "response_card": "string",
    },
    child_directed=False,
    intents=[{
        "intent_name": "string",
        "intent_version": "string",
    }],
    enable_model_improvements=False,
    description="string",
    detect_sentiment=False,
    create_version=False,
    idle_session_ttl_in_seconds=0,
    clarification_prompt={
        "max_attempts": 0,
        "messages": [{
            "content": "string",
            "content_type": "string",
            "group_number": 0,
        }],
        "response_card": "string",
    },
    locale="string",
    name="string",
    nlu_intent_confidence_threshold=0,
    process_behavior="string",
    voice_id="string")

    const botResource = new aws.lex.Bot("botResource", {
    abortStatement: {
        messages: [{
            content: "string",
            contentType: "string",
            groupNumber: 0,
        }],
        responseCard: "string",
    },
    childDirected: false,
    intents: [{
        intentName: "string",
        intentVersion: "string",
    }],
    enableModelImprovements: false,
    description: "string",
    detectSentiment: false,
    createVersion: false,
    idleSessionTtlInSeconds: 0,
    clarificationPrompt: {
        maxAttempts: 0,
        messages: [{
            content: "string",
            contentType: "string",
            groupNumber: 0,
        }],
        responseCard: "string",
    },
    locale: "string",
    name: "string",
    nluIntentConfidenceThreshold: 0,
    processBehavior: "string",
    voiceId: "string",
});

    type: aws:lex:Bot
properties:
    abortStatement:
        messages:
            - content: string
              contentType: string
              groupNumber: 0
        responseCard: string
    childDirected: false
    clarificationPrompt:
        maxAttempts: 0
        messages:
            - content: string
              contentType: string
              groupNumber: 0
        responseCard: string
    createVersion: false
    description: string
    detectSentiment: false
    enableModelImprovements: false
    idleSessionTtlInSeconds: 0
    intents:
        - intentName: string
          intentVersion: string
    locale: string
    name: string
    nluIntentConfidenceThreshold: 0
    processBehavior: string
    voiceId: string

    Bot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Bot resource accepts the following input properties:

    AbortStatement BotAbortStatement
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    ChildDirected bool
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    Intents List<BotIntent>
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    ClarificationPrompt BotClarificationPrompt
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    CreateVersion bool
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    Description string
    A description of the bot. Must be less than or equal to 200 characters in length.
    DetectSentiment bool
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    EnableModelImprovements bool
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    IdleSessionTtlInSeconds int
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    Locale string
    Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    Name string
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    NluIntentConfidenceThreshold double
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    ProcessBehavior string
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    VoiceId string
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    AbortStatement BotAbortStatementArgs
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    ChildDirected bool
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    Intents []BotIntentArgs
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    ClarificationPrompt BotClarificationPromptArgs
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    CreateVersion bool
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    Description string
    A description of the bot. Must be less than or equal to 200 characters in length.
    DetectSentiment bool
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    EnableModelImprovements bool
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    IdleSessionTtlInSeconds int
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    Locale string
    Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    Name string
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    NluIntentConfidenceThreshold float64
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    ProcessBehavior string
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    VoiceId string
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    abortStatement BotAbortStatement
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    childDirected Boolean
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    intents List<BotIntent>
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    clarificationPrompt BotClarificationPrompt
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    createVersion Boolean
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    description String
    A description of the bot. Must be less than or equal to 200 characters in length.
    detectSentiment Boolean
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    enableModelImprovements Boolean
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    idleSessionTtlInSeconds Integer
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    locale String
    Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    name String
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    nluIntentConfidenceThreshold Double
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    processBehavior String
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    voiceId String
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    abortStatement BotAbortStatement
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    childDirected boolean
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    intents BotIntent[]
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    clarificationPrompt BotClarificationPrompt
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    createVersion boolean
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    description string
    A description of the bot. Must be less than or equal to 200 characters in length.
    detectSentiment boolean
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    enableModelImprovements boolean
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    idleSessionTtlInSeconds number
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    locale string
    Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    name string
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    nluIntentConfidenceThreshold number
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    processBehavior string
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    voiceId string
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    abort_statement BotAbortStatementArgs
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    child_directed bool
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    intents Sequence[BotIntentArgs]
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    clarification_prompt BotClarificationPromptArgs
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    create_version bool
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    description str
    A description of the bot. Must be less than or equal to 200 characters in length.
    detect_sentiment bool
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    enable_model_improvements bool
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    idle_session_ttl_in_seconds int
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    locale str
    Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    name str
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    nlu_intent_confidence_threshold float
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    process_behavior str
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    voice_id str
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    abortStatement Property Map
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    childDirected Boolean
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    intents List<Property Map>
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    clarificationPrompt Property Map
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    createVersion Boolean
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    description String
    A description of the bot. Must be less than or equal to 200 characters in length.
    detectSentiment Boolean
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    enableModelImprovements Boolean
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    idleSessionTtlInSeconds Number
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    locale String
    Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    name String
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    nluIntentConfidenceThreshold Number
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    processBehavior String
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    voiceId String
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Bot resource produces the following output properties:

    Arn string
    Checksum string
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    CreatedDate string
    The date when the bot version was created.
    FailureReason string
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedDate string
    The date when the $LATEST version of this bot was updated.
    Status string
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    Version string
    The version of the bot.
    Arn string
    Checksum string
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    CreatedDate string
    The date when the bot version was created.
    FailureReason string
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedDate string
    The date when the $LATEST version of this bot was updated.
    Status string
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    Version string
    The version of the bot.
    arn String
    checksum String
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    createdDate String
    The date when the bot version was created.
    failureReason String
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    The date when the $LATEST version of this bot was updated.
    status String
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    version String
    The version of the bot.
    arn string
    checksum string
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    createdDate string
    The date when the bot version was created.
    failureReason string
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate string
    The date when the $LATEST version of this bot was updated.
    status string
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    version string
    The version of the bot.
    arn str
    checksum str
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    created_date str
    The date when the bot version was created.
    failure_reason str
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_date str
    The date when the $LATEST version of this bot was updated.
    status str
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    version str
    The version of the bot.
    arn String
    checksum String
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    createdDate String
    The date when the bot version was created.
    failureReason String
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    The date when the $LATEST version of this bot was updated.
    status String
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    version String
    The version of the bot.

    Look up Existing Bot Resource

    Get an existing Bot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BotState, opts?: CustomResourceOptions): Bot
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        abort_statement: Optional[BotAbortStatementArgs] = None,
        arn: Optional[str] = None,
        checksum: Optional[str] = None,
        child_directed: Optional[bool] = None,
        clarification_prompt: Optional[BotClarificationPromptArgs] = None,
        create_version: Optional[bool] = None,
        created_date: Optional[str] = None,
        description: Optional[str] = None,
        detect_sentiment: Optional[bool] = None,
        enable_model_improvements: Optional[bool] = None,
        failure_reason: Optional[str] = None,
        idle_session_ttl_in_seconds: Optional[int] = None,
        intents: Optional[Sequence[BotIntentArgs]] = None,
        last_updated_date: Optional[str] = None,
        locale: Optional[str] = None,
        name: Optional[str] = None,
        nlu_intent_confidence_threshold: Optional[float] = None,
        process_behavior: Optional[str] = None,
        status: Optional[str] = None,
        version: Optional[str] = None,
        voice_id: Optional[str] = None) -> Bot
    func GetBot(ctx *Context, name string, id IDInput, state *BotState, opts ...ResourceOption) (*Bot, error)
    public static Bot Get(string name, Input<string> id, BotState? state, CustomResourceOptions? opts = null)
    public static Bot get(String name, Output<String> id, BotState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AbortStatement BotAbortStatement
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    Arn string
    Checksum string
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    ChildDirected bool
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    ClarificationPrompt BotClarificationPrompt
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    CreateVersion bool
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    CreatedDate string
    The date when the bot version was created.
    Description string
    A description of the bot. Must be less than or equal to 200 characters in length.
    DetectSentiment bool
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    EnableModelImprovements bool
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    FailureReason string
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    IdleSessionTtlInSeconds int
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    Intents List<BotIntent>
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    LastUpdatedDate string
    The date when the $LATEST version of this 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. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    Name string
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    NluIntentConfidenceThreshold double
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    ProcessBehavior string
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    Status string
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    Version string
    The version of the bot.
    VoiceId string
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    AbortStatement BotAbortStatementArgs
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    Arn string
    Checksum string
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    ChildDirected bool
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    ClarificationPrompt BotClarificationPromptArgs
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    CreateVersion bool
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    CreatedDate string
    The date when the bot version was created.
    Description string
    A description of the bot. Must be less than or equal to 200 characters in length.
    DetectSentiment bool
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    EnableModelImprovements bool
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    FailureReason string
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    IdleSessionTtlInSeconds int
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    Intents []BotIntentArgs
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    LastUpdatedDate string
    The date when the $LATEST version of this 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. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    Name string
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    NluIntentConfidenceThreshold float64
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    ProcessBehavior string
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    Status string
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    Version string
    The version of the bot.
    VoiceId string
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    abortStatement BotAbortStatement
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    arn String
    checksum String
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    childDirected Boolean
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    clarificationPrompt BotClarificationPrompt
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    createVersion Boolean
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    createdDate String
    The date when the bot version was created.
    description String
    A description of the bot. Must be less than or equal to 200 characters in length.
    detectSentiment Boolean
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    enableModelImprovements Boolean
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    failureReason String
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    idleSessionTtlInSeconds Integer
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    intents List<BotIntent>
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    lastUpdatedDate String
    The date when the $LATEST version of this 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. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    name String
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    nluIntentConfidenceThreshold Double
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    processBehavior String
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    status String
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    version String
    The version of the bot.
    voiceId String
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    abortStatement BotAbortStatement
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    arn string
    checksum string
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    childDirected boolean
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    clarificationPrompt BotClarificationPrompt
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    createVersion boolean
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    createdDate string
    The date when the bot version was created.
    description string
    A description of the bot. Must be less than or equal to 200 characters in length.
    detectSentiment boolean
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    enableModelImprovements boolean
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    failureReason string
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    idleSessionTtlInSeconds number
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    intents BotIntent[]
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    lastUpdatedDate string
    The date when the $LATEST version of this 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. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    name string
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    nluIntentConfidenceThreshold number
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    processBehavior string
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    status string
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    version string
    The version of the bot.
    voiceId string
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    abort_statement BotAbortStatementArgs
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    arn str
    checksum str
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    child_directed bool
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    clarification_prompt BotClarificationPromptArgs
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    create_version bool
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    created_date str
    The date when the bot version was created.
    description str
    A description of the bot. Must be less than or equal to 200 characters in length.
    detect_sentiment bool
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    enable_model_improvements bool
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    failure_reason str
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    idle_session_ttl_in_seconds int
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    intents Sequence[BotIntentArgs]
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    last_updated_date str
    The date when the $LATEST version of this 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. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    name str
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    nlu_intent_confidence_threshold float
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    process_behavior str
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    status str
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    version str
    The version of the bot.
    voice_id str
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
    abortStatement Property Map
    The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
    arn String
    checksum String
    Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.
    childDirected Boolean
    By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
    clarificationPrompt Property Map
    The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
    createVersion Boolean
    Determines if a new bot version is created when the initial resource is created and on each update. Defaults to false.
    createdDate String
    The date when the bot version was created.
    description String
    A description of the bot. Must be less than or equal to 200 characters in length.
    detectSentiment Boolean
    When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
    enableModelImprovements Boolean
    Set to true to enable access to natural language understanding improvements. When you set the enable_model_improvements parameter to true you can use the nlu_intent_confidence_threshold parameter to configure confidence scores. For more information, see Confidence Scores. You can only set the enable_model_improvements parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.
    failureReason String
    If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
    idleSessionTtlInSeconds Number
    The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is 300. Must be a number between 60 and 86400 (inclusive).
    intents List<Property Map>
    A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
    lastUpdatedDate String
    The date when the $LATEST version of this 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. For available locales, see Amazon Lex Bot PutBot API Docs. Default is en-US.
    name String
    The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
    nluIntentConfidenceThreshold Number
    Determines 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. For more information see Amazon Lex Bot PutBot API Docs This value requires enable_model_improvements to be set to true and the default is 0. Must be a float between 0 and 1.
    processBehavior String
    If you set the process_behavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. Default is SAVE.
    status String
    When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failure_reason response element.
    version String
    The version of the bot.
    voiceId String
    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.

    Supporting Types

    BotAbortStatement, BotAbortStatementArgs

    BotAbortStatementMessage, BotAbortStatementMessageArgs

    Content string
    The text of the message.
    ContentType string
    The content type of the message string.
    GroupNumber int
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    Content string
    The text of the message.
    ContentType string
    The content type of the message string.
    GroupNumber int
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    content String
    The text of the message.
    contentType String
    The content type of the message string.
    groupNumber Integer
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    content string
    The text of the message.
    contentType string
    The content type of the message string.
    groupNumber number
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    content str
    The text of the message.
    content_type str
    The content type of the message string.
    group_number int
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    content String
    The text of the message.
    contentType String
    The content type of the message string.
    groupNumber Number
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

    BotClarificationPrompt, BotClarificationPromptArgs

    MaxAttempts int
    The number of times to prompt the user for information.
    Messages List<BotClarificationPromptMessage>
    ResponseCard string
    MaxAttempts int
    The number of times to prompt the user for information.
    Messages []BotClarificationPromptMessage
    ResponseCard string
    maxAttempts Integer
    The number of times to prompt the user for information.
    messages List<BotClarificationPromptMessage>
    responseCard String
    maxAttempts number
    The number of times to prompt the user for information.
    messages BotClarificationPromptMessage[]
    responseCard string
    max_attempts int
    The number of times to prompt the user for information.
    messages Sequence[BotClarificationPromptMessage]
    response_card str
    maxAttempts Number
    The number of times to prompt the user for information.
    messages List<Property Map>
    responseCard String

    BotClarificationPromptMessage, BotClarificationPromptMessageArgs

    Content string
    The text of the message.
    ContentType string
    The content type of the message string.
    GroupNumber int
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    Content string
    The text of the message.
    ContentType string
    The content type of the message string.
    GroupNumber int
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    content String
    The text of the message.
    contentType String
    The content type of the message string.
    groupNumber Integer
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    content string
    The text of the message.
    contentType string
    The content type of the message string.
    groupNumber number
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    content str
    The text of the message.
    content_type str
    The content type of the message string.
    group_number int
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
    content String
    The text of the message.
    contentType String
    The content type of the message string.
    groupNumber Number
    Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

    BotIntent, BotIntentArgs

    IntentName string
    The name of the intent. Must be less than or equal to 100 characters in length.
    IntentVersion string
    The version of the intent. Must be less than or equal to 64 characters in length.
    IntentName string
    The name of the intent. Must be less than or equal to 100 characters in length.
    IntentVersion string
    The version of the intent. Must be less than or equal to 64 characters in length.
    intentName String
    The name of the intent. Must be less than or equal to 100 characters in length.
    intentVersion String
    The version of the intent. Must be less than or equal to 64 characters in length.
    intentName string
    The name of the intent. Must be less than or equal to 100 characters in length.
    intentVersion string
    The version of the intent. Must be less than or equal to 64 characters in length.
    intent_name str
    The name of the intent. Must be less than or equal to 100 characters in length.
    intent_version str
    The version of the intent. Must be less than or equal to 64 characters in length.
    intentName String
    The name of the intent. Must be less than or equal to 100 characters in length.
    intentVersion String
    The version of the intent. Must be less than or equal to 64 characters in length.

    Import

    Using pulumi import, import bots using their name. For example:

    $ pulumi import aws:lex/bot:Bot order_flowers_bot OrderFlowers

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws