LexModelsV2 / Client / list_bot_analyzer_history

list_bot_analyzer_history¶

LexModelsV2.Client.list_bot_analyzer_history(**kwargs)¶

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

response = client.list_bot_analyzer_history(
    botId='string',
    localeId='string',
    botVersion='string',
    nextToken='string',
    maxResults=123
)

Parameters:

botId (string) –
[REQUIRED]

The unique identifier of the bot.
localeId (string) – The locale identifier to filter the history. If not specified, returns history for all locales.
botVersion (string) – The bot version to filter the history. If not specified, defaults to DRAFT.
nextToken (string) – If the response from a previous request was truncated, the nextToken value is used to retrieve the next page of history entries.
maxResults (integer) – The maximum number of history entries to return in the response. The default is 10.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'localeId': 'string',
    'botVersion': 'string',
    'botAnalyzerHistoryList': [
        {
            'botAnalyzerStatus': 'Processing'|'Available'|'Failed'|'Stopping'|'Stopped',
            'creationDateTime': datetime(2015, 1, 1),
            'botAnalyzerRequestId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- botId (string) –
  
  The unique identifier of the bot.
- localeId (string) –
  
  The locale identifier used to filter the history.
- botVersion (string) –
  
  The bot version used to filter the history.
- botAnalyzerHistoryList (list) –
  
  A list of historical analysis executions, ordered by creation date with the most recent first.
  - (dict) –
    
    Contains summary information about a historical bot analysis execution.
    - botAnalyzerStatus (string) –
      
      The status of the historical analysis execution.
      
      Valid Values: Processing | Available | Failed | Stopping | Stopped
    - creationDateTime (datetime) –
      
      The date and time when the analysis was initiated.
    - botAnalyzerRequestId (string) –
      
      The unique identifier for the analysis request.
- nextToken (string) –
  
  If the response is truncated, this token can be used in a subsequent request to retrieve the next page of history entries.

Exceptions

LexModelsV2.Client.exceptions.ThrottlingException
LexModelsV2.Client.exceptions.ValidationException
LexModelsV2.Client.exceptions.ResourceNotFoundException
LexModelsV2.Client.exceptions.InternalServerException