Skip to content

Describe Bot Version

lexmodelsv2_describe_bot_version R Documentation

Provides metadata about a version of a bot

Description

Provides metadata about a version of a bot.

Usage

lexmodelsv2_describe_bot_version(botId, botVersion)

Arguments

botId

[required] The identifier of the bot containing the version to return metadata for.

botVersion

[required] The version of the bot to return metadata for.

Value

A list with the following syntax:

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

Request syntax

svc$describe_bot_version(
  botId = "string",
  botVersion = "string"
)