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

Description

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

Usage

quicksight_register_user(IdentityType, Email, UserRole, IamArn,
  SessionName, AwsAccountId, Namespace, UserName)

Arguments

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.

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

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.

IamArn

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

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.

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.

UserName

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

Request syntax

svc$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"
)

Details

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

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