builtin_intents

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

Overview

Name	builtin_intents
Type	Resource
Id	aws.lex_models.builtin_intents

Fields

The following fields are returned by SELECT queries:

get_builtin_intent

Name	Datatype	Description
signature	string	The unique identifier for a built-in intent.
slots	array	An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.
supported_locales	array	A list of locales that the intent supports.

get_builtin_intents

Name	Datatype	Description
signature	string	A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
supported_locales	array	A list of identifiers for the locales that the intent supports.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_builtin_intent	select	signature, region		Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action.
get_builtin_intents	select	region	locale, signatureContains, nextToken, maxResults	Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action.

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
region	string	AWS region (default: us-east-1)
signature	string	The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
locale	string	A list of locales that the intent supports.
maxResults	integer	The maximum number of intents to return in the response. The default is 10.
nextToken	string	A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.
signatureContains	string	Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

SELECT examples

get_builtin_intent

Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action.

SELECT
signature,
slots,
supported_locales
FROM aws.lex_models.builtin_intents
WHERE signature = '{{ signature }}' -- required
AND region = '{{ region }}' -- required
;

get_builtin_intents

Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action.

SELECT
signature,
supported_locales
FROM aws.lex_models.builtin_intents
WHERE region = '{{ region }}' -- required
AND locale = '{{ locale }}'
AND signatureContains = '{{ signatureContains }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;