Skip to content

Update Bot

lexmodelsv2_update_bot R Documentation

Updates the configuration of an existing bot

Description

Updates the configuration of an existing bot.

Usage

lexmodelsv2_update_bot(botId, botName, description, roleArn,
  dataPrivacy, idleSessionTTLInSeconds, botType, botMembers)

Arguments

botId

[required] The unique identifier of the bot to update. This identifier is returned by the create_bot operation.

botName

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

description

A description of the bot.

roleArn

[required] The Amazon Resource Name (ARN) of an IAM role that has permissions 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.

botType

The type of the bot to be updated.

botMembers

The list of bot members in the network associated with the update action.

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"
    )
  )
)

Request syntax

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