lex_bots

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

Overview

Name	lex_bots
Type	Resource
Id	aws.connect.lex_bots

Fields

The following fields are returned by SELECT queries:

list_lex_bots

Name	Datatype	Description
lex_region	string	The Amazon Web Services Region where the Amazon Lex bot was created.
name	string	The name of the Amazon Lex bot.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_lex_bots	select	instance_id, region	nextToken, maxResults	This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
disassociate_lex_bot	update	instance_id, botName, lexRegion, region	clientToken	This API is in preview release for Connect Customer and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot.
associate_lex_bot	update	instance_id, region, LexBot		This API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.

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
botName	string	The name of the Amazon Lex bot. Maximum character limit of 50.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
lexRegion	string	The Amazon Web Services Region in which the Amazon Lex bot has been created.
region	string	AWS region (default: us-east-1)
clientToken	string	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
maxResults	integer	The maximum number of results to return per page. If no value is specified, the default is 10.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

list_lex_bots

This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

SELECT
lex_region,
name
FROM aws.connect.lex_bots
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

disassociate_lex_bot

This API is in preview release for Connect Customer and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot.

UPDATE aws.connect.lex_bots
SET 
-- No updatable properties
WHERE 
instance_id = '{{ instance_id }}' --required
AND botName = '{{ botName }}' --required
AND lexRegion = '{{ lexRegion }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken}}';

associate_lex_bot

This API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.

UPDATE aws.connect.lex_bots
SET 
LexBot = '{{ LexBot }}',
ClientToken = '{{ ClientToken }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND LexBot = '{{ LexBot }}' --required;