User
Describes a user in the user pool.
Contents
- AuthenticationType
-
The authentication type for the user.
Type: String
Valid Values:
API | SAML | USERPOOL | AWS_ADRequired: Yes
- Arn
-
The ARN of the user.
Type: String
Pattern:
^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$Required: No
- CreatedTime
-
The date and time the user was created in the user pool.
Type: Timestamp
Required: No
- Enabled
-
Specifies whether the user in the user pool is enabled.
Type: Boolean
Required: No
- FirstName
-
The first name, or given name, of the user.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^[A-Za-z0-9_\-\s]+$Required: No
- LastName
-
The last name, or surname, of the user.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^[A-Za-z0-9_\-\s]+$Required: No
- Status
-
The status of the user in the user pool. The status can be one of the following:
-
UNCONFIRMED – The user is created but not confirmed.
-
CONFIRMED – The user is confirmed.
-
ARCHIVED – The user is no longer active.
-
COMPROMISED – The user is disabled because of a potential security threat.
-
UNKNOWN – The user status is not known.
Type: String
Length Constraints: Minimum length of 1.
Required: No
-
- UserName
-
The email address of the user.
Note
Users' email addresses are case-sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
