Skip to content

Gets a list of available bots

Description

Gets a list of available bots.

Usage

lexmodelsv2_list_bots(sortBy, filters, maxResults, nextToken)

Arguments

  • sortBy

    Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.

  • filters

    Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

  • maxResults

    The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

  • nextToken

    If the response from the list_bots operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a list_bots request to return the next page of results. For a complete set of results, call the list_bots operation until the nextToken returned in the response is null.

Value

A list with the following syntax:

list(
  botSummaries = list(
    list(
      botId = "string",
      botName = "string",
      description = "string",
      botStatus = "Creating"|"Available"|"Inactive"|"Deleting"|"Failed"|"Versioning"|"Importing"|"Updating",
      latestBotVersion = "string",
      lastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      botType = "Bot"|"BotNetwork"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_bots(
  sortBy = list(
    attribute = "BotName",
    order = "Ascending"|"Descending"
  ),
  filters = list(
    list(
      name = "BotName"|"BotType",
      values = list(
        "string"
      ),
      operator = "CO"|"EQ"|"NE"
    )
  ),
  maxResults = 123,
  nextToken = "string"
)