Skip to content

Create Bot Alias

lexmodelsv2_create_bot_alias R Documentation

Creates an alias for the specified version of a bot

Description

Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.

For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.

Usage

lexmodelsv2_create_bot_alias(botAliasName, description, botVersion,
  botAliasLocaleSettings, conversationLogSettings,
  sentimentAnalysisSettings, botId, tags)

Arguments

botAliasName

[required] The alias to create. The name must be unique for the bot.

description

A description of the alias. Use this description to help identify the alias.

botVersion

The version of the bot that this alias points to. You can use the update_bot_alias operation to change the bot version associated with the alias.

botAliasLocaleSettings

Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.

conversationLogSettings

Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.

sentimentAnalysisSettings
botId

[required] The unique identifier of the bot that the alias applies to.

tags

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

Value

A list with the following syntax: 

list(
  botAliasId = "string",
  botAliasName = "string",
  description = "string",
  botVersion = "string",
  botAliasLocaleSettings = list(
    list(
      enabled = TRUE|FALSE,
      codeHookSpecification = list(
        lambdaCodeHook = list(
          lambdaARN = "string",
          codeHookInterfaceVersion = "string"
        )
      )
    )
  ),
  conversationLogSettings = list(
    textLogSettings = list(
      list(
        enabled = TRUE|FALSE,
        destination = list(
          cloudWatch = list(
            cloudWatchLogGroupArn = "string",
            logPrefix = "string"
          )
        ),
        selectiveLoggingEnabled = TRUE|FALSE
      )
    ),
    audioLogSettings = list(
      list(
        enabled = TRUE|FALSE,
        destination = list(
          s3Bucket = list(
            kmsKeyArn = "string",
            s3BucketArn = "string",
            logPrefix = "string"
          )
        ),
        selectiveLoggingEnabled = TRUE|FALSE
      )
    )
  ),
  sentimentAnalysisSettings = list(
    detectSentiment = TRUE|FALSE
  ),
  botAliasStatus = "Creating"|"Available"|"Deleting"|"Failed",
  botId = "string",
  creationDateTime = as.POSIXct(
    "2015-01-01"
  ),
  tags = list(
    "string"
  )
)

Request syntax

svc$create_bot_alias(
  botAliasName = "string",
  description = "string",
  botVersion = "string",
  botAliasLocaleSettings = list(
    list(
      enabled = TRUE|FALSE,
      codeHookSpecification = list(
        lambdaCodeHook = list(
          lambdaARN = "string",
          codeHookInterfaceVersion = "string"
        )
      )
    )
  ),
  conversationLogSettings = list(
    textLogSettings = list(
      list(
        enabled = TRUE|FALSE,
        destination = list(
          cloudWatch = list(
            cloudWatchLogGroupArn = "string",
            logPrefix = "string"
          )
        ),
        selectiveLoggingEnabled = TRUE|FALSE
      )
    ),
    audioLogSettings = list(
      list(
        enabled = TRUE|FALSE,
        destination = list(
          s3Bucket = list(
            kmsKeyArn = "string",
            s3BucketArn = "string",
            logPrefix = "string"
          )
        ),
        selectiveLoggingEnabled = TRUE|FALSE
      )
    )
  ),
  sentimentAnalysisSettings = list(
    detectSentiment = TRUE|FALSE
  ),
  botId = "string",
  tags = list(
    "string"
  )
)