bot_aliases

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

Overview

Name	bot_aliases
Type	Resource
Id	aws.lex_models.bot_aliases

Fields

The following fields are returned by SELECT queries:

get_bot_aliases

Name	Datatype	Description
name	string	The name of the bot alias. (pattern: <code>^([A-Za-z]_?)+$</code>)
bot_name	string	The name of the bot to which the alias points. (pattern: <code>^([A-Za-z]_?)+$</code>)
bot_version	string	The version of the Amazon Lex bot to which the alias points. (pattern: <code>$LATEST|[0-9]+</code>)
checksum	string	Checksum of the bot alias.
conversation_logs	object	Settings that determine how Amazon Lex uses conversation logs for the alias.
created_date	string (date-time)	The date that the bot alias was created.
description	string	A description of the bot alias.
last_updated_date	string (date-time)	The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bot_aliases	select	bot_name, region	nextToken, maxResults, nameContains	Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases 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
bot_name	string	The name of the bot.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of aliases to return in the response. The default is 50. .
nameContains	string	Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
nextToken	string	A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

SELECT examples

get_bot_aliases

Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action.

SELECT
name,
bot_name,
bot_version,
checksum,
conversation_logs,
created_date,
description,
last_updated_date
FROM aws.lex_models.bot_aliases
WHERE bot_name = '{{ bot_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND nameContains = '{{ nameContains }}'
;