Skip to main content

account_preferences

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

Overview

Nameaccount_preferences
TypeResource
Idaws.chatbot.account_preferences

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
training_data_collection_enabledbooleanTurns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AI technologies for AWS Chatbot.
user_authorization_requiredbooleanEnables use of a user role requirement in your chat configuration.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_account_preferencesselectregionReturns AWS Chatbot account preferences.
update_account_preferencesupdateregionUpdates AWS Chatbot account preferences.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Returns AWS Chatbot account preferences.

SELECT
training_data_collection_enabled,
user_authorization_required
FROM aws.chatbot.account_preferences
WHERE region = '{{ region }}' -- required
;

UPDATE examples

Updates AWS Chatbot account preferences.

UPDATE aws.chatbot.account_preferences
SET
UserAuthorizationRequired = {{ UserAuthorizationRequired }},
TrainingDataCollectionEnabled = {{ TrainingDataCollectionEnabled }}
WHERE
region = '{{ region }}' --required
RETURNING
account_preferences;