Describe Bot

lexmodelsv2_describe_bot

R Documentation

Provides metadata information about a bot¶

Description¶

Provides metadata information about a bot.

Usage¶

lexmodelsv2_describe_bot(botId)

Arguments¶

botId: [required] The unique identifier of the bot to describe.

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"
  ),
  lastUpdatedDateTime = as.POSIXct(
    "2015-01-01"
  ),
  botType = "Bot"|"BotNetwork",
  botMembers = list(
    list(
      botMemberId = "string",
      botMemberName = "string",
      botMemberAliasId = "string",
      botMemberAliasName = "string",
      botMemberVersion = "string"
    )
  ),
  failureReasons = list(
    "string"
  )
)

Request syntax¶

svc$describe_bot(
  botId = "string"
)