bot_resource_generations

Creates, updates, deletes, gets or lists a bot_resource_generations resource.

Overview

Name	bot_resource_generations
Type	Resource
Id	aws.lexv2_models.bot_resource_generations

Fields

The following fields are returned by SELECT queries:

describe_bot_resource_generation

Name	Datatype	Description
bot_id	string	The unique identifier of the bot for which the generation request was made. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_version	string	The version of the bot for which the generation request was made. (pattern: <code>^(DRAFT|[0-9]+)$</code>)
creation_date_time	string (date-time)	The date and time at which the item was generated.
failure_reasons	array	A list of reasons why the generation of bot resources through natural language description failed.
generated_bot_locale_url	string	The Amazon S3 location of the generated bot locale configuration.
generation_id	string	The generation ID for which to return the generation details. (pattern: <code>^[0-9a-zA-Z]+$</code>)
generation_input_prompt	string	The prompt used in the generation request.
generation_status	string	The status of the generation request. (Failed, Complete, InProgress)
last_updated_date_time	string (date-time)	The date and time at which the generated item was updated.
locale_id	string	The locale of the bot for which the generation request was made.
model_arn	string	The ARN of the model used to generate the bot resources. (pattern: <code>^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}$</code>)

list_bot_resource_generations

Name	Datatype	Description
bot_id	string	The unique identifier of the bot for which the generation requests were made. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_version	string	The version of the bot for which the generation requests were made. (pattern: <code>^(DRAFT|[0-9]+)$</code>)
generation_summaries	array	A list of objects, each containing information about a generation request for the bot locale.
locale_id	string	The locale of the bot for which the generation requests were made.
next_token	string	If the total number of results is greater than the number specified in the maxResults, the response returns a token in the nextToken field. Use this token when making a request to return the next batch of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_bot_resource_generation	select	bot_id, bot_version, locale_id, generation_id, region		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.
list_bot_resource_generations	select	bot_id, bot_version, locale_id, region		Lists the generation requests made for a bot locale.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bot_id	string	The unique identifier of the bot whose generation requests you want to view.
bot_version	string	The version of the bot whose generation requests you want to view.
generation_id	string	The unique identifier of the generation request for which to return the generation details.
locale_id	string	The locale of the bot whose generation requests you want to view.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_bot_resource_generation

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.

SELECT
bot_id,
bot_version,
creation_date_time,
failure_reasons,
generated_bot_locale_url,
generation_id,
generation_input_prompt,
generation_status,
last_updated_date_time,
locale_id,
model_arn
FROM aws.lexv2_models.bot_resource_generations
WHERE bot_id = '{{ bot_id }}' -- required
AND bot_version = '{{ bot_version }}' -- required
AND locale_id = '{{ locale_id }}' -- required
AND generation_id = '{{ generation_id }}' -- required
AND region = '{{ region }}' -- required
;

list_bot_resource_generations

Lists the generation requests made for a bot locale.

SELECT
bot_id,
bot_version,
generation_summaries,
locale_id,
next_token
FROM aws.lexv2_models.bot_resource_generations
WHERE bot_id = '{{ bot_id }}' -- required
AND bot_version = '{{ bot_version }}' -- required
AND locale_id = '{{ locale_id }}' -- required
AND region = '{{ region }}' -- required
;