Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateAccountPreferences

Updates AWS Chatbot account preferences.

Request Syntax


POST /update-account-preferences HTTP/1.1
Content-type: application/json

{
   "TrainingDataCollectionEnabled": boolean,
   "UserAuthorizationRequired": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

TrainingDataCollectionEnabled

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.

Type: Boolean

Required: No

UserAuthorizationRequired

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

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AccountPreferences": { 
      "TrainingDataCollectionEnabled": boolean,
      "UserAuthorizationRequired": boolean
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccountPreferences

Preferences related to AWS Chatbot usage in the calling AWS account.

Type: AccountPreferences object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

Your request input doesn't meet the constraints required by AWS Chatbot.

HTTP Status Code: 400

InvalidRequestException

Your request input doesn't meet the constraints required by AWS Chatbot.

HTTP Status Code: 400

UpdateAccountPreferencesException

We can’t process your request right now because of a server issue. Try again later.

HTTP Status Code: 500