Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

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.

post/bots/{botId}/botanalyzer/

Path parameters

botIdstring required

The unique identifier of the bot to analyze.

Request body

analysisScope'BotLocale' required
<p>The scope of analysis to perform on the bot.</p> <p>Valid values include:</p> <ul> <li> <p> <code>BotLocale</code> </p> </li> </ul>
localeIdstring

The locale identifier for the bot locale to analyze. Required when <code>analysisScope</code> is <code>BotLocale</code>.

botVersionstring

The version of the bot to analyze. Defaults to <code>DRAFT</code> if not specified.

Response

Success

botIdstring

The unique identifier of the bot being analyzed.

botVersionstring

The version of the bot being analyzed.

localeIdstring

The locale identifier of the bot locale being analyzed.

botAnalyzerStatus'Processing' | 'Available' | 'Failed' | 'Stopping' | 'Stopped'
<p>The current status of the analysis. The initial status is <code>Processing</code>.</p> <p>Valid Values: <code>Processing | Available | Failed | Stopping | Stopped</code> </p>
botAnalyzerRequestIdstring

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

creationDateTimestring date-time

The date and time when the analysis was initiated.