Try it now and let us know what you think. Switch to the new look >>
You can return to the original look by selecting English in the language selector above.
User
A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.
Contents
Note
In the following list, the required parameters are described first.
- Active
-
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
Type: Boolean
Required: No
- Arn
-
The Amazon Resource Name (ARN) for the user.
Type: String
Required: No
-
The user's email address.
Type: String
Required: No
- IdentityType
-
The type of identity authentication used by the user.
Type: String
Valid Values:
IAM | QUICKSIGHTRequired: No
- PrincipalId
-
The principal ID of the user.
Type: String
Required: No
- Role
-
The Amazon QuickSight role for the user.
Type: String
Valid Values:
ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READERRequired: No
- UserName
-
The user's user name.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\u0020-\u00FF]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
