events_configurations

Creates, updates, deletes, gets or lists an events_configurations resource.

Overview

Name	events_configurations
Type	Resource
Id	aws.chime.events_configurations

Fields

The following fields are returned by SELECT queries:

get_events_configuration

Name	Datatype	Description
bot_id	string	The bot ID.
lambda_function_arn	string	Lambda function ARN that allows a bot to receive outgoing events.
outbound_events_https_endpoint	string	HTTPS endpoint that allows a bot to receive outgoing events.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_events_configuration	select	account_id, bot_id, region		Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
put_events_configuration	replace	account_id, bot_id, region		Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
delete_events_configuration	delete	account_id, bot_id, region		Deletes the events configuration that allows a bot to receive outgoing events.

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)

SELECT examples

get_events_configuration

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

SELECT
bot_id,
lambda_function_arn,
outbound_events_https_endpoint
FROM aws.chime.events_configurations
WHERE account_id = '{{ account_id }}' -- required
AND bot_id = '{{ bot_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_events_configuration

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

REPLACE aws.chime.events_configurations
SET 
OutboundEventsHTTPSEndpoint = '{{ OutboundEventsHTTPSEndpoint }}',
LambdaFunctionArn = '{{ LambdaFunctionArn }}'
WHERE 
account_id = '{{ account_id }}' --required
AND bot_id = '{{ bot_id }}' --required
AND region = '{{ region }}' --required
RETURNING
events_configuration;

DELETE examples

delete_events_configuration

Deletes the events configuration that allows a bot to receive outgoing events.

DELETE FROM aws.chime.events_configurations
WHERE account_id = '{{ account_id }}' --required
AND bot_id = '{{ bot_id }}' --required
AND region = '{{ region }}' --required
;