AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon QuickSight RegisterUser API operation.

Syntax

Register-QSUser
-Email <String>
-AwsAccountId <String>
-IamArn <String>
-IdentityType <IdentityType>
-Namespace <String>
-SessionName <String>
-UserName <String>
-UserRole <UserRole>
-Force <SwitchParameter>

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

Parameters

-AwsAccountId <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Email <String>
The email address of the user that you want to register.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-IamArn <String>
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
Required?False
Position?Named
Accept pipeline input?False
-IdentityType <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.
Required?False
Position?Named
Accept pipeline input?False
-Namespace <String>
The namespace. Currently, you should set this to default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SessionName <String>
You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.
Required?False
Position?Named
Accept pipeline input?False
-UserName <String>
The Amazon QuickSight user name that you want to create for the user you are registering.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserRole <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.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the Email parameter.

Outputs

This cmdlet returns a Amazon.QuickSight.Model.RegisterUserResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z