Put botsbotidbotversionsbotversionbotlocaleslocaleidbotrecommendationsbotrecommendationidstopbotrecommendation

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1471501483.8 KB

Stop an already running Bot Recommendation request.

put/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/stopbotrecommendation

Path parameters

botIdstring required

The unique identifier of the bot containing the bot recommendation to be stopped.

botVersionstring required

The version of the bot containing the bot recommendation.

localeIdstring required

The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>

botRecommendationIdstring required

The unique identifier of the bot recommendation to be stopped.

Response

Success

botIdstring

The unique identifier of the bot containing the bot recommendation that is being stopped.

botVersionstring

The version of the bot containing the recommendation that is being stopped.

localeIdstring

The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>

The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

botRecommendationIdstring

The unique identifier of the bot recommendation that is being stopped.