bot_recommendations

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

Overview

Name	bot_recommendations
Type	Resource
Id	aws.lexv2_models.bot_recommendations

Fields

The following fields are returned by SELECT queries:

describe_bot_recommendation

Name	Datatype	Description
bot_id	string	The identifier of the bot associated with the bot recommendation. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_recommendation_id	string	The identifier of the bot recommendation being described. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_recommendation_results	object	The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
bot_recommendation_status	string	The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field. (Processing, Deleting, Deleted, Downloading, Updating, Available, Failed, Stopping, Stopped)
bot_version	string	The version of the bot associated with the bot recommendation. (pattern: <code>^DRAFT$</code>)
creation_date_time	string (date-time)	The date and time that the bot recommendation was created.
encryption_setting	object	The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
failure_reasons	array	If botRecommendationStatus is Failed, Amazon Lex explains why.
last_updated_date_time	string (date-time)	The date and time that the bot recommendation was last updated.
locale_id	string	The identifier of the language and locale of the bot recommendation to describe.
transcript_source_setting	object	The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

list_bot_recommendations

Name	Datatype	Description
bot_id	string	The unique identifier of the bot that contains the bot recommendation list. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_recommendation_summaries	array	Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.
bot_version	string	The version of the bot that contains the bot recommendation list. (pattern: <code>^DRAFT$</code>)
locale_id	string	The identifier of the language and locale of the bot recommendation list.
next_token	string	A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_bot_recommendation	select	bot_id, bot_version, locale_id, bot_recommendation_id, region		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.
list_bot_recommendations	select	bot_id, bot_version, locale_id, region		Get a list of bot recommendations that meet the specified criteria.
update_bot_recommendation	update	bot_id, bot_version, locale_id, bot_recommendation_id, region, encryptionSetting		Updates an existing bot recommendation request.

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 containing the bot recommendation to be updated.
bot_recommendation_id	string	The unique identifier of the bot recommendation to be updated.
bot_version	string	The version of the bot containing the bot recommendation to be updated.
locale_id	string	The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
region	string	AWS region (default: us-east-1)

SELECT examples

describe_bot_recommendation

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.

SELECT
bot_id,
bot_recommendation_id,
bot_recommendation_results,
bot_recommendation_status,
bot_version,
creation_date_time,
encryption_setting,
failure_reasons,
last_updated_date_time,
locale_id,
transcript_source_setting
FROM aws.lexv2_models.bot_recommendations
WHERE bot_id = '{{ bot_id }}' -- required
AND bot_version = '{{ bot_version }}' -- required
AND locale_id = '{{ locale_id }}' -- required
AND bot_recommendation_id = '{{ bot_recommendation_id }}' -- required
AND region = '{{ region }}' -- required
;

list_bot_recommendations

Get a list of bot recommendations that meet the specified criteria.

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

UPDATE examples

update_bot_recommendation

Updates an existing bot recommendation request.

UPDATE aws.lexv2_models.bot_recommendations
SET 
encryptionSetting = '{{ encryptionSetting }}'
WHERE 
bot_id = '{{ bot_id }}' --required
AND bot_version = '{{ bot_version }}' --required
AND locale_id = '{{ locale_id }}' --required
AND bot_recommendation_id = '{{ bot_recommendation_id }}' --required
AND region = '{{ region }}' --required
AND encryptionSetting = '{{ encryptionSetting }}' --required
RETURNING
bot_id,
bot_recommendation_id,
bot_recommendation_status,
bot_version,
creation_date_time,
encryption_setting,
last_updated_date_time,
locale_id,
transcript_source_setting;