Amazon QuickSight

{'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 -\-email=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat

See also: AWS API Documentation

Request Syntax

client.register_user(
    IdentityType='IAM'|'QUICKSIGHT',
    Email='string',
    UserRole='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
    IamArn='string',
    SessionName='string',
    AwsAccountId='string',
    Namespace='string',
    UserName='string'
)

type IdentityType:

string

param IdentityType:

[REQUIRED]

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:

string

param Email:

[REQUIRED]

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

type UserRole:

string

param UserRole:

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

type IamArn:

string

param IamArn:

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

type SessionName:

string

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:

string

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

type Namespace:

string

param Namespace:

[REQUIRED]

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

type UserName:

string

param UserName:

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

rtype:

dict

returns:

Response Syntax

{
    'User': {
        'Arn': 'string',
        'UserName': 'string',
        'Email': 'string',
        'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
        '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.