Get Bot Aliases

lexmodelbuildingservice_get_bot_aliases

R Documentation

Returns a list of aliases for a specified Amazon Lex bot

Description

Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the lex:GetBotAliases action.

Usage

lexmodelbuildingservice_get_bot_aliases(botName, nextToken, maxResults,
  nameContains)

Arguments

botName

[required] The name of the bot.

nextToken

A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

maxResults

The maximum number of aliases to return in the response. The default is 50. .

nameContains

Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

Value

A list with the following syntax:

list(
  BotAliases = list(
    list(
      name = "string",
      description = "string",
      botVersion = "string",
      botName = "string",
      lastUpdatedDate = as.POSIXct(
        "2015-01-01"
      ),
      createdDate = as.POSIXct(
        "2015-01-01"
      ),
      checksum = "string",
      conversationLogs = list(
        logSettings = list(
          list(
            logType = "AUDIO"|"TEXT",
            destination = "CLOUDWATCH_LOGS"|"S3",
            kmsKeyArn = "string",
            resourceArn = "string",
            resourcePrefix = "string"
          )
        ),
        iamRoleArn = "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$get_bot_aliases(
  botName = "string",
  nextToken = "string",
  maxResults = 123,
  nameContains = "string"
)