---
title: "POST /bots/{botId}/botanalyzer/describe/{botAnalyzerRequestId}/"
method: POST
path: "/bots/{botId}/botanalyzer/describe/{botAnalyzerRequestId}/"
---

# POST /bots/{botId}/botanalyzer/describe/{botAnalyzerRequestId}/

`POST /bots/{botId}/botanalyzer/describe/{botAnalyzerRequestId}/`

Retrieves the analysis results and recommendations for bot optimization. The analysis must be in `Available` status before recommendations can be retrieved.

Recommendations are returned with pagination support. Each recommendation includes the issue location, priority level, detailed description, and proposed fix.

## Path parameters

- `botId` string, required
- `botAnalyzerRequestId` string, required

## Request body

- object
  - `nextToken` string — If the response from a previous request was truncated, the <code>nextToken</code> value is used to retrieve the next page of recommendations.
  - `maxResults` integer — The maximum number of recommendations to return in the response. The default is 5.

## Response `200`

Success

- DescribeBotAnalyzerRecommendationResponse
  - `botId` string — The unique identifier of the bot.
  - `botVersion` string — The version of the bot that was analyzed.
  - `localeId` string — The locale identifier of the bot locale that was analyzed.
  - `botAnalyzerStatus` 'Processing' | 'Available' | 'Failed' | 'Stopping' | 'Stopped' — <p>The current status of the analysis.</p> <p>Valid Values: <code>Processing | Available | Failed | Stopping | Stopped</code> </p>
  - `creationDateTime` string, date-time — The date and time when the analysis was initiated.
  - `botAnalyzerRecommendationList` BotAnalyzerRecommendation[] — A list of recommendations for optimizing your bot configuration. Each recommendation includes the issue location, priority, description, and proposed fix.
    - `issueLocation` object, required — The location information for the identified issue within the bot configuration.
      - `botLocale` string — The locale identifier where the issue was found.
      - `intentId` string — The intent identifier where the issue was found, if applicable.
      - `slotId` string — The slot identifier where the issue was found, if applicable.
    - `priority` 'High' | 'Medium' | 'Low', required — <p>The priority level of the recommendation.</p> <p>Valid Values: <code>High | Medium | Low</code> </p>
    - `issueDescription` string, required — A detailed description of the identified configuration issue.
    - `proposedFix` string, required — The recommended solution to address the identified issue.
  - `nextToken` string — If the response is truncated, this token can be used in a subsequent request to retrieve the next page of recommendations.

## Other responses

- `480` — ThrottlingException
- `481` — ValidationException
- `482` — ResourceNotFoundException
- `483` — InternalServerException

---

[API](https://skmtc.net/aws/apis/lexv2-models.md) · [All operations](https://skmtc.net/aws/apis/lexv2-models/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/lexv2-models/versions/6997ba482d72/schema)