Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . quicksight ]

update-user

Description

Updates an Amazon QuickSight user.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-user
--user-name <value>
--aws-account-id <value>
--namespace <value>
--email <value>
--role <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-name (string)

The Amazon QuickSight user name that you want to update.

--aws-account-id (string)

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 (string)

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

--email (string)

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

--role (string)

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, datasets, analyses, and dashboards.
  • ADMIN : A user who is an author, who can also manage Amazon QuickSight settings.

Possible values:

  • ADMIN
  • AUTHOR
  • READER
  • RESTRICTED_AUTHOR
  • RESTRICTED_READER

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

User -> (structure)

The Amazon QuickSight user.

Arn -> (string)

The Amazon Resource Name (ARN) for the user.

UserName -> (string)

The user's user name.

Email -> (string)

The user's email address.

Role -> (string)

The Amazon QuickSight role for 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, datasets, analyses, and dashboards.
  • ADMIN : A user who is an author, who can also manage Amazon QuickSight settings.
  • RESTRICTED_READER : This role isn't currently available for use.
  • RESTRICTED_AUTHOR : This role isn't currently available for use.

IdentityType -> (string)

The type of identity authentication used by the user.

Active -> (boolean)

The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

PrincipalId -> (string)

The principal ID of the user.

RequestId -> (string)

The AWS request ID for this operation.

Status -> (integer)

The HTTP status of the request.