Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListBots

Gets a list of available bots.

Request Syntax


POST /bots/ HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "operator": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "sortBy": { 
      "attribute": "string",
      "order": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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.

Type: Array of BotFilter objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

If the response from the ListBots 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 ListBots request to return the next page of results. For a complete set of results, call the ListBots operation until the nextToken returned in the response is null.

Type: String

Required: No

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.

Type: BotSortBy object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "botSummaries": [ 
      { 
         "botId": "string",
         "botName": "string",
         "botStatus": "string",
         "botType": "string",
         "description": "string",
         "lastUpdatedDateTime": number,
         "latestBotVersion": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

botSummaries

Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more bots available, the nextToken field contains a token to the next page of results.

Type: Array of BotSummary objects

nextToken

A token that indicates whether there are more results to return in a response to the ListBots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBots operation request to get the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

HTTP Status Code: 400