UpdateUser

Updates an Amazon QuickSight user.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).

CLI Sample:

aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1

Request Syntax

PUT /accounts/AwsAccountId/namespaces/Namespace/users/UserName HTTP/1.1 Content-type: application/json { "Email": "string", "Role": "string" }

URI Request Parameters

The request requires the following URI parameters.

AwsAccountId

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Length Constraints: Fixed length of 12.

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

Namespace

The namespace. Currently, you should set this to default.

Pattern: default

UserName

The Amazon QuickSight user name that you want to update.

Length Constraints: Minimum length of 1.

Pattern: [\u0020-\u00FF]+

Request Body

The request accepts the following data in JSON format.

Email

The email address of the user that you want to update.

Type: String

Required: Yes

Role

The Amazon QuickSight role of the user. The user role can be one of the following:

  • READER: A user who has read-only access to dashboards.

  • AUTHOR: A user who can create data sources, data sets, analyses, and dashboards.

  • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

Type: String

Valid Values: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER

Required: Yes

Response Syntax

HTTP/1.1 Status Content-type: application/json { "RequestId": "string", "User": { "Active": boolean, "Arn": "string", "Email": "string", "IdentityType": "string", "Role": "string", "UserName": "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.

RequestId

The AWS request ID for this operation.

Type: String

User

The Amazon QuickSight user.

Type: User object

Errors

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

AccessDeniedException

You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters don't have a valid value.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: