bots

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

Overview

Name	bots
Type	Resource
Id	aws.connect.bots

Fields

The following fields are returned by SELECT queries:

list_bots

Name	Datatype	Description
lex_bot	object	Configuration information of an Amazon Lex bot.
lex_v2_bot	object	Configuration information of an Amazon Lex V2 bot.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_bots	select	instance_id, lexVersion, region	nextToken, maxResults	This API is in preview release for Connect Customer and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.
associate_bot	update	instance_id, region		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 or Amazon Lex V2 bot.
disassociate_bot	exec	instance_id, region		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 or Amazon Lex V2 bot.

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
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.
lexVersion	string	The version of Amazon Lex or Amazon Lex V2.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
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_bots

This API is in preview release for Connect Customer and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.

SELECT
lex_bot,
lex_v2_bot
FROM aws.connect.bots
WHERE instance_id = '{{ instance_id }}' -- required
AND lexVersion = '{{ lexVersion }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

associate_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 or Amazon Lex V2 bot.

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

Lifecycle Methods

disassociate_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 or Amazon Lex V2 bot.

EXEC aws.connect.bots.disassociate_bot 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"LexBot": "{{ LexBot }}", 
"LexV2Bot": "{{ LexV2Bot }}", 
"ClientToken": "{{ ClientToken }}"
}'
;