List Bot Locales

lexmodelsv2_list_bot_locales

R Documentation

Gets a list of locales for the specified bot¶

Description¶

Gets a list of locales for the specified bot.

Usage¶

lexmodelsv2_list_bot_locales(botId, botVersion, sortBy, filters,
  maxResults, nextToken)

Arguments¶

botId: [required] The identifier of the bot to list locales for.
botVersion: [required] The version of the bot to list locales for.
sortBy: Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.
filters: Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.
maxResults: The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken: If the response from the list_bot_locales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

Value¶

A list with the following syntax:

list(
  botId = "string",
  botVersion = "string",
  nextToken = "string",
  botLocaleSummaries = list(
    list(
      localeId = "string",
      localeName = "string",
      description = "string",
      botLocaleStatus = "Creating"|"Building"|"Built"|"ReadyExpressTesting"|"Failed"|"Deleting"|"NotBuilt"|"Importing"|"Processing",
      lastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      lastBuildSubmittedDateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$list_bot_locales(
  botId = "string",
  botVersion = "string",
  sortBy = list(
    attribute = "BotLocaleName",
    order = "Ascending"|"Descending"
  ),
  filters = list(
    list(
      name = "BotLocaleName",
      values = list(
        "string"
      ),
      operator = "CO"|"EQ"
    )
  ),
  maxResults = 123,
  nextToken = "string"
)