Amazon QuickSight

2018/12/17 - Amazon QuickSight - 1 updated api methods

Changes  Amazon QuickSight's RegisterUser API now generates a user invitation URL when registering a user with the QuickSight identity type. This URL can then be used by the registered QuickSight user to complete the user registration process. This release also corrects some HTTP return status codes.

RegisterUser (updated) Link ¶
Changes (response)
{'UserInvitationUrl': 'string'}

Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.

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

The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.

The condition keys are quicksight:IamArn and quicksight:SessionName .

CLI Sample:

aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\ -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat

See also: AWS API Documentation

Request Syntax

type IdentityType


param IdentityType


Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM : A user whose identity maps to an existing IAM user or role.

  • QUICKSIGHT : A user whose identity is owned and managed internally by Amazon QuickSight.

type Email


param Email


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

type UserRole


param UserRole


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 IamArn


param IamArn

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

type SessionName


param SessionName

The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see ` assume-role`__ in the AWS CLI Reference.

type AwsAccountId


param 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.

type Namespace


param Namespace


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

type UserName


param UserName

The Amazon QuickSight user name that you want to create for the user you are registering.




Response Syntax

    'User': {
        'Arn': 'string',
        'UserName': 'string',
        'Email': 'string',
        'IdentityType': 'IAM'|'QUICKSIGHT',
        'Active': True|False
    'UserInvitationUrl': 'string',
    'RequestId': 'string',
    'Status': 123

Response Structure

  • (dict) --

    • User (dict) --

      The user name.

      • 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.

      • IdentityType (string) --

        The type of identity authentication used by the user.

      • Active (boolean) --

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

    • UserInvitationUrl (string) --

      The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT .

    • RequestId (string) --

      The AWS request ID for this operation.

    • Status (integer) --

      The http status of the request.