Skip to content

Create Bot

lexmodelsv2_create_bot R Documentation

Creates an Amazon Lex conversational bot

Description

Creates an Amazon Lex conversational bot.

Usage

lexmodelsv2_create_bot(botName, description, roleArn, dataPrivacy,
  idleSessionTTLInSeconds, botTags, testBotAliasTags, botType, botMembers)

Arguments

botName

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

description

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

roleArn

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

dataPrivacy

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

idleSessionTTLInSeconds

[required] 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.

botTags

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

testBotAliasTags

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 tag_resource operation.

botType

The type of a bot to create.

botMembers

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

Value

A list with the following syntax: 

list(
  botId = "string",
  botName = "string",
  description = "string",
  roleArn = "string",
  dataPrivacy = list(
    childDirected = TRUE|FALSE
  ),
  idleSessionTTLInSeconds = 123,
  botStatus = "Creating"|"Available"|"Inactive"|"Deleting"|"Failed"|"Versioning"|"Importing"|"Updating",
  creationDateTime = as.POSIXct(
    "2015-01-01"
  ),
  botTags = list(
    "string"
  ),
  testBotAliasTags = list(
    "string"
  ),
  botType = "Bot"|"BotNetwork",
  botMembers = list(
    list(
      botMemberId = "string",
      botMemberName = "string",
      botMemberAliasId = "string",
      botMemberAliasName = "string",
      botMemberVersion = "string"
    )
  )
)

Request syntax

svc$create_bot(
  botName = "string",
  description = "string",
  roleArn = "string",
  dataPrivacy = list(
    childDirected = TRUE|FALSE
  ),
  idleSessionTTLInSeconds = 123,
  botTags = list(
    "string"
  ),
  testBotAliasTags = list(
    "string"
  ),
  botType = "Bot"|"BotNetwork",
  botMembers = list(
    list(
      botMemberId = "string",
      botMemberName = "string",
      botMemberAliasId = "string",
      botMemberAliasName = "string",
      botMemberVersion = "string"
    )
  )
)