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

UpdateQPersonalizationConfiguration

Updates a personalization configuration.

Request Syntax


PUT /accounts/AwsAccountId/q-personalization-configuration HTTP/1.1
Content-type: application/json

{
   "PersonalizationMode": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account account that contains the personalization configuration that the user wants to update.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

PersonalizationMode

An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "PersonalizationMode": "string",
   "RequestId": "string"
}

Response Elements

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

Status: The HTTP status of the request.

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

PersonalizationMode

The personalization mode that is used for the personalization configuration.

Type: String

Valid Values: ENABLED | DISABLED

RequestId

The AWS request ID for this operation.

Type: String

Errors

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

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

HTTP Status Code: 429