User
A registered user of Amazon QuickSight.
Contents
In the following list, the required parameters are described first.
- Active
-
The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory 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
- CustomPermissionsName
-
The custom permissions profile associated with this user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9+=,.@_-]+$
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 | QUICKSIGHT
Required: No
- PrincipalId
-
The principal ID of the user.
Type: String
Required: No
- Role
-
The Amazon QuickSight role for 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, datasets, analyses, and dashboards. -
ADMIN
: A user who is an author, who can also manage Amazon QuickSight settings. -
RESTRICTED_READER
: This role isn't currently available for use. -
RESTRICTED_AUTHOR
: This role isn't currently available for use.
Type: String
Valid Values:
ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER
Required: 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: