CreateBotCommand

Suggest an Edit

Creates an Amazon Lex conversational bot.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LexModelsV2Client, CreateBotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import
// const { LexModelsV2Client, CreateBotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import
const client = new LexModelsV2Client(config);
const input = { // CreateBotRequest
  botName: "STRING_VALUE", // required
  description: "STRING_VALUE",
  roleArn: "STRING_VALUE", // required
  dataPrivacy: { // DataPrivacy
    childDirected: true || false, // required
  },
  idleSessionTTLInSeconds: Number("int"), // required
  botTags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
  testBotAliasTags: {
    "<keys>": "STRING_VALUE",
  },
  botType: "Bot" || "BotNetwork",
  botMembers: [ // BotMembers
    { // BotMember
      botMemberId: "STRING_VALUE", // required
      botMemberName: "STRING_VALUE", // required
      botMemberAliasId: "STRING_VALUE", // required
      botMemberAliasName: "STRING_VALUE", // required
      botMemberVersion: "STRING_VALUE", // required
    },
  ],
  errorLogSettings: { // ErrorLogSettings
    enabled: true || false, // required
  },
};
const command = new CreateBotCommand(input);
const response = await client.send(command);
// { // CreateBotResponse
//   botId: "STRING_VALUE",
//   botName: "STRING_VALUE",
//   description: "STRING_VALUE",
//   roleArn: "STRING_VALUE",
//   dataPrivacy: { // DataPrivacy
//     childDirected: true || false, // required
//   },
//   idleSessionTTLInSeconds: Number("int"),
//   botStatus: "Creating" || "Available" || "Inactive" || "Deleting" || "Failed" || "Versioning" || "Importing" || "Updating",
//   creationDateTime: new Date("TIMESTAMP"),
//   botTags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
//   testBotAliasTags: {
//     "<keys>": "STRING_VALUE",
//   },
//   botType: "Bot" || "BotNetwork",
//   botMembers: [ // BotMembers
//     { // BotMember
//       botMemberId: "STRING_VALUE", // required
//       botMemberName: "STRING_VALUE", // required
//       botMemberAliasId: "STRING_VALUE", // required
//       botMemberAliasName: "STRING_VALUE", // required
//       botMemberVersion: "STRING_VALUE", // required
//     },
//   ],
//   errorLogSettings: { // ErrorLogSettings
//     enabled: true || false, // required
//   },
// };

CreateBotCommand Input

See CreateBotCommandInput for more details

Parameter
Type
Description
botName
Required
string | undefined

The name of the bot. The bot name must be unique in the account that creates the bot.

dataPrivacy
Required
DataPrivacy | undefined

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

idleSessionTTLInSeconds
Required
number | undefined

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

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

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

roleArn
Required
string | undefined

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

botMembers
BotMember[] | undefined

The list of bot members in a network to be created.

botTags
Record<string, string> | undefined

A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

botType
BotType | undefined

The type of a bot to create.

description
string | undefined

A description of the bot. It appears in lists to help you identify a particular bot.

errorLogSettings
ErrorLogSettings | undefined

Specifies the configuration for error logging during bot creation.

testBotAliasTags
Record<string, string> | undefined

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

CreateBotCommand Output

See CreateBotCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
botId
string | undefined

A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

botMembers
BotMember[] | undefined

The list of bots in a network that was created.

botName
string | undefined

The name specified for the bot.

botStatus
BotStatus | undefined

Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.

botTags
Record<string, string> | undefined

A list of tags associated with the bot.

botType
BotType | undefined

The type of a bot that was created.

creationDateTime
Date | undefined

A timestamp indicating the date and time that the bot was created.

dataPrivacy
DataPrivacy | undefined

The data privacy settings specified for the bot.

description
string | undefined

The description specified for the bot.

errorLogSettings
ErrorLogSettings | undefined

Specifies configuration settings for delivering error logs to Cloudwatch Logs in an Amazon Lex bot response.

idleSessionTTLInSeconds
number | undefined

The session idle time specified for the bot.

roleArn
string | undefined

The IAM role specified for the bot.

testBotAliasTags
Record<string, string> | undefined

A list of tags associated with the test alias for the bot.

Throws

Name
Fault
Details
ConflictException
client

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

InternalServerException
server

The service encountered an unexpected condition. Try your request again.

PreconditionFailedException
client

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

ServiceQuotaExceededException
client

You have reached a quota for your bot.

ThrottlingException
client

Your request rate is too high. Reduce the frequency of requests.

ValidationException
client

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

LexModelsV2ServiceException
Base exception class for all service exceptions from LexModelsV2 service.