Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1471501483.8 KB

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

get/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/

Path parameters

botIdstring required

The unique identifier of the bot associated with the bot recommendation.

botVersionstring required

The version of the bot associated with the bot recommendation.

localeIdstring required

The identifier of the language and locale of the bot recommendation to describe. 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 identifier of the bot recommendation to describe.

Response

Success

botIdstring

The identifier of the bot associated with the bot recommendation.

botVersionstring

The version of the bot associated with the bot recommendation.

localeIdstring

The identifier of the language and locale of the bot recommendation to describe.

botRecommendationStatus'Processing' | 'Deleting' | 'Deleted' | 'Downloading' | 'Updating' | 'Available' | 'Failed' | 'Stopping' | 'Stopped'

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 identifier of the bot recommendation being described.

failureReasonsFailureReason[]

If botRecommendationStatus is Failed, Amazon Lex explains why.

creationDateTimestring date-time

The date and time that the bot recommendation was created.

lastUpdatedDateTimestring date-time

The date and time that the bot recommendation was last updated.