bots

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

Overview

Name	bots
Type	Resource
Id	aws.chime.bots

Fields

The following fields are returned by SELECT queries:

get_bot

Name	Datatype	Description
bot_email	string	The bot email address.
bot_id	string	The bot ID.
bot_type	string	The bot type. (ChatBot)
created_timestamp	string (date-time)	The bot creation timestamp, in ISO 8601 format.
disabled	boolean	When true, the bot is stopped from running in your account.
display_name	string	The bot display name.
security_token	string	The security token used to authenticate Amazon Chime with the outgoing event endpoint.
updated_timestamp	string (date-time)	The updated bot timestamp, in ISO 8601 format.
user_id	string	The unique ID for the bot user.

list_bots

Name	Datatype	Description
bots	array	List of bots and bot details.
next_token	string	The token to use to retrieve the next page of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bot	select	account_id, bot_id, region		Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
list_bots	select	account_id, region	max-results, next-token	Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
create_bot	insert	account_id, region, DisplayName		Creates a bot for an Amazon Chime Enterprise account.
update_bot	update	account_id, bot_id, region		Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

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
account_id	string	The Amazon Chime account ID.
bot_id	string	The bot ID.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return in a single call. The default is 10.
next-token	string	The token to use to retrieve the next page of results.

SELECT examples

get_bot

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

SELECT
bot_email,
bot_id,
bot_type,
created_timestamp,
disabled,
display_name,
security_token,
updated_timestamp,
user_id
FROM aws.chime.bots
WHERE account_id = '{{ account_id }}' -- required
AND bot_id = '{{ bot_id }}' -- required
AND region = '{{ region }}' -- required
;

list_bots

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

SELECT
bots,
next_token
FROM aws.chime.bots
WHERE account_id = '{{ account_id }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_bot

Creates a bot for an Amazon Chime Enterprise account.

INSERT INTO aws.chime.bots (
DisplayName,
Domain,
account_id,
region
)
SELECT 
'{{ DisplayName }}' /* required */,
'{{ Domain }}',
'{{ account_id }}',
'{{ region }}'
RETURNING
bot
;

Manifest

# Description fields are for documentation purposes
- name: bots
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the bots resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the bots resource.
  - name: DisplayName
    value: "{{ DisplayName }}"
  - name: Domain
    value: "{{ Domain }}"

UPDATE examples

update_bot

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

UPDATE aws.chime.bots
SET 
Disabled = {{ Disabled }}
WHERE 
account_id = '{{ account_id }}' --required
AND bot_id = '{{ bot_id }}' --required
AND region = '{{ region }}' --required
RETURNING
bot;