LexModelsV2 / Client / start_bot_analyzer

start_bot_analyzer

LexModelsV2.Client.start_bot_analyzer(**kwargs)

Initiates an asynchronous analysis of your bot configuration using AI-powered analysis to identify potential issues and recommend improvements based on AWS best practices.

The analysis examines your bot’s configuration, including intents, utterances, slots, and conversation flows, to provide actionable recommendations for optimization.

See also: AWS API Documentation

Request Syntax

response = client.start_bot_analyzer(
    botId='string',
    analysisScope='BotLocale',
    localeId='string',
    botVersion='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

    The unique identifier of the bot to analyze.

  • analysisScope (string) –

    [REQUIRED]

    The scope of analysis to perform. Currently only BotLocale scope is supported.

    Valid Values: BotLocale

  • localeId (string) – The locale identifier for the bot locale to analyze. Required when analysisScope is BotLocale.

  • botVersion (string) – The version of the bot to analyze. Defaults to DRAFT if not specified.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • botId (string) –

      The unique identifier of the bot being analyzed.

    • botVersion (string) –

      The version of the bot being analyzed.

    • localeId (string) –

      The locale identifier of the bot locale being analyzed.

    • botAnalyzerStatus (string) –

      The current status of the analysis. The initial status is Processing.

      Valid Values: Processing | Available | Failed | Stopping | Stopped

    • botAnalyzerRequestId (string) –

      A unique identifier for this analysis request. Use this identifier to check the status and retrieve results.

    • creationDateTime (datetime) –

      The date and time when the analysis was initiated.

Exceptions

  • LexModelsV2.Client.exceptions.ThrottlingException

  • LexModelsV2.Client.exceptions.ValidationException

  • LexModelsV2.Client.exceptions.ResourceNotFoundException

  • LexModelsV2.Client.exceptions.ConflictException

  • LexModelsV2.Client.exceptions.InternalServerException