Chatbot / Client / get_account_preferences

get_account_preferences#

Chatbot.Client.get_account_preferences()#

Returns AWS Chatbot account preferences.

See also: AWS API Documentation

Request Syntax

response = client.get_account_preferences()
Return type:

dict

Returns:

Response Syntax

{
    'AccountPreferences': {
        'UserAuthorizationRequired': True|False,
        'TrainingDataCollectionEnabled': True|False
    }
}

Response Structure

  • (dict) –

    • AccountPreferences (dict) –

      The preferences related to AWS Chatbot usage in the calling AWS account.

      • UserAuthorizationRequired (boolean) –

        Enables use of a user role requirement in your chat configuration.

      • TrainingDataCollectionEnabled (boolean) –

        Turns 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.

Exceptions

  • Chatbot.Client.exceptions.InvalidRequestException

  • Chatbot.Client.exceptions.GetAccountPreferencesException