paws.analytics (version 0.1.0)

quicksight_update_user: Updates an Amazon QuickSight user

Description

Updates an Amazon QuickSight user.

Usage

quicksight_update_user(UserName, AwsAccountId, Namespace, Email, Role)

Arguments

UserName

[required] The Amazon QuickSight user name that you want to update.

AwsAccountId

[required] 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.

Namespace

[required] The namespace. Currently, you should set this to default.

Email

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

Role

[required] 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.

Request syntax

svc$update_user(
  UserName = "string",
  AwsAccountId = "string",
  Namespace = "string",
  Email = "string",
  Role = "ADMIN"|"AUTHOR"|"READER"|"RESTRICTED_AUTHOR"|"RESTRICTED_READER"
)

Details

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

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