v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442228254.5 KB

Returns bot information as follows:

  • If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string.

  • If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots.

This operation requires permission for the lex:GetBots action.

get/bots/

Query parameters

nextTokenstring

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

maxResultsinteger

The maximum number of bots to return in the response that the request will return. The default is 10.

nameContainsstring

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

Response

Success

nextTokenstring

If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots.

Example response

{
  "bots": [
    {
      "version": "$LATEST",
      "name": "DocOrderPizzaBot",
      "createdDate": 1494360160.133,
      "description": "Orders a pizza from a local pizzeria.",
      "lastUpdatedDate": 1494360160.133,
      "status": "NOT_BUILT"
    }
  ]
}