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

ListBotAnalyzerHistory

Retrieves a list of historical bot analysis executions for a specific bot. You can filter the results by locale and bot version.

The history includes all analysis executions regardless of their status, allowing you to track past analyses and their outcomes.

Request Syntax


POST /bots/botId/botanalyzer/history/ HTTP/1.1
Content-type: application/json

{
   "botVersion": "string",
   "localeId": "string",
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

botId

The unique identifier of the bot.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

botVersion

The bot version to filter the history. If not specified, defaults to DRAFT.

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

Required: No

localeId

The locale identifier to filter the history. If not specified, returns history for all locales.

Type: String

Required: No

maxResults

The maximum number of history entries to return in the response. The default is 10.

Type: Integer

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

Required: No

nextToken

If the response from a previous request was truncated, the nextToken value is used to retrieve the next page of history entries.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "botAnalyzerHistoryList": [ 
      { 
         "botAnalyzerRequestId": "string",
         "botAnalyzerStatus": "string",
         "creationDateTime": number
      }
   ],
   "botId": "string",
   "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.

botAnalyzerHistoryList

A list of historical analysis executions, ordered by creation date with the most recent first.

Type: Array of BotAnalyzerHistorySummary objects

botId

The unique identifier of the bot.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botVersion

The bot version used to filter the history.

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

localeId

The locale identifier used to filter the history.

Type: String

nextToken

If the response is truncated, this token can be used in a subsequent request to retrieve the next page of history entries.

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.

retryAfterSeconds: The number of seconds after which the user can invoke the API again.

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

Examples

Example request

This example illustrates one usage of ListBotAnalyzerHistory.


POST https://models-v2-lex.us-east-1.amazonaws.com/bots/<BotId>/botanalyzer/history/

Payload:
{
    "localeId": "en_US",
    "botVersion": "DRAFT"
}

Example response

This example illustrates one usage of ListBotAnalyzerHistory.


{
    "botId": "<BotId>",
    "localeId": "en_US",
    "botVersion": "DRAFT",
    "botAnalyzerHistoryList": [
        {
            "botAnalyzerStatus": "Available",
            "creationDateTime": 1729570423.948,
            "botAnalyzerRequestId": "<RequestId1>"
        },
        {
            "botAnalyzerStatus": "Failed",
            "creationDateTime": 1729484530.123,
            "botAnalyzerRequestId": "<RequestId2>"
        }
    ],
    "nextToken": "<NextToken>"
}