DescribeBotResourceGeneration
Returns information about a request to generate a bot through natural language description, made through
the StartBotResource API. Use the generatedBotLocaleUrl
to retrieve the Amazon S3 object containing the bot locale configuration. You can
then modify and import this configuration.
Request Syntax
GET /bots/botId/botversions/botVersion/botlocales/localeId/generations/generationId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- botId
-
The unique identifier of the bot for which to return the generation details.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- botVersion
-
The version of the bot for which to return the generation details.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]+)$Required: Yes
- generationId
-
The unique identifier of the generation request for which to return the generation details.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- localeId
-
The locale of the bot for which to return the generation details.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"failureReasons": [ "string" ],
"generatedBotLocaleUrl": "string",
"generationId": "string",
"generationInputPrompt": "string",
"generationStatus": "string",
"lastUpdatedDateTime": number,
"localeId": "string",
"modelArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- botId
-
The unique identifier of the bot for which the generation request was made.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botVersion
-
The version of the bot for which the generation request was made.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]+)$ - creationDateTime
-
The date and time at which the item was generated.
Type: Timestamp
- failureReasons
-
A list of reasons why the generation of bot resources through natural language description failed.
Type: Array of strings
- generatedBotLocaleUrl
-
The Amazon S3 location of the generated bot locale configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- generationId
-
The generation ID for which to return the generation details.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - generationInputPrompt
-
The prompt used in the generation request.
Type: String
Length Constraints: Minimum length of 100. Maximum length of 2000.
- generationStatus
-
The status of the generation request.
Type: String
Valid Values:
Failed | Complete | InProgress - lastUpdatedDateTime
-
The date and time at which the generated item was updated.
Type: Timestamp
- localeId
-
The locale of the bot for which the generation request was made.
Type: String
- modelArn
-
The ARN of the model used to generate the bot resources.
Type: String
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
- ResourceNotFoundException
-
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
- ThrottlingException
-
Your request rate is too high. Reduce the frequency of requests.
HTTP Status Code: 429
- ValidationException
-
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
Examples
Example request
This example illustrates one usage of DescribeBotResourceGeneration.
GET https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/botversions/DRAFT/botlocales/en_GB/generations/GEN1234567Example response
This example illustrates one usage of DescribeBotResourceGeneration.
{
"botId": "BOT1234567",
"botVersion": "DRAFT",
"creationDateTime": 1.699570064977E9,
"failureReasons": null,
"generatedBotLocaleUrl": "https://lex-botresourcegenerations-us-east-1-prod.s3.amazonaws.com/901559830335/BOT1234567/DRAFT/en_GB/GEN1234567/generated-LexJson-54481014-ef11-42a5-a3e6-eac6062044b9.zip",
"generationId": "GEN1234567",
"generationInputPrompt": "We want a bot to help customers order food (using item id, quantity, size), check order status, and cancel an order. Use Order ID for indexing order.",
"generationStatus": "Complete",
"lastUpdatedDateTime": 1.699570064977E9,
"localeId": "en_GB",
"modelArn ": null
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
