Skip to main content

recommended_intents

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

Overview

Namerecommended_intents
TypeResource
Idaws.lexv2_models.recommended_intents

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
bot_idstringThe unique identifier of the bot associated with the recommended intent. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_recommendation_idstringThe identifier of the bot recommendation that contains the recommended intent. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_versionstringThe version of the bot that contains the intent. (pattern: <code>^DRAFT$</code>)
locale_idstringThe identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
next_tokenstringA token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
summary_listarraySummary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_recommended_intentsselectbot_id, bot_version, locale_id, bot_recommendation_id, regionGets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

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.

NameDatatypeDescription
bot_idstringThe unique identifier of the bot associated with the recommended intents.
bot_recommendation_idstringThe identifier of the bot recommendation that contains the recommended intents.
bot_versionstringThe version of the bot that contains the recommended intents.
locale_idstringThe identifier of the language and locale of the recommended intents.
regionstringAWS region (default: us-east-1)

SELECT examples

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

SELECT
bot_id,
bot_recommendation_id,
bot_version,
locale_id,
next_token,
summary_list
FROM aws.lexv2_models.recommended_intents
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
;