ListBotRecommendations
Get a list of bot recommendations that meet the specified criteria.
Request Syntax
POST /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}URI Request Parameters
The request uses the following URI parameters.
- botId
-
The unique identifier of the bot that contains the bot recommendation list.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- botVersion
-
The version of the bot that contains the bot recommendation list.
Length Constraints: Fixed length of 5.
Pattern:
^DRAFT$Required: Yes
- localeId
-
The identifier of the language and locale of the bot recommendation list.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- maxResults
-
The maximum number of bot recommendations 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- nextToken
-
If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botRecommendationSummaries": [
{
"botRecommendationId": "string",
"botRecommendationStatus": "string",
"creationDateTime": number,
"lastUpdatedDateTime": number
}
],
"botVersion": "string",
"localeId": "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.
- botId
-
The unique identifier of the bot that contains the bot recommendation list.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botRecommendationSummaries
-
Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.
Type: Array of BotRecommendationSummary objects
- botVersion
-
The version of the bot that contains the bot recommendation list.
Type: String
Length Constraints: Fixed length of 5.
Pattern:
^DRAFT$ - localeId
-
The identifier of the language and locale of the bot recommendation list.
Type: String
- nextToken
-
A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations 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
- ResourceNotFoundException
-
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
