PrincipalSearchResult
A user or group matched by SearchPrincipals.
Contents
- displayName
-
The display name of the principal.
Type: String
Required: Yes
- principalId
-
The unique ID of the principal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9:/_+=,.@-]*Required: Yes
- principalType
-
Whether the principal is a user or a group.
Type: String
Valid Values:
USER | GROUPRequired: Yes
- description
-
An optional description of the principal.
Type: String
Required: No
- userName
-
The user name of the principal. Present for users only.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
