User
A user object that contains a specified user’s metadata and attributes.
Contents
- Addresses
-
A list of
Address
objects containing addresses associated with the user.Type: Array of Address objects
Array Members: Fixed number of 1 item.
Required: No
- DisplayName
-
A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
- Emails
-
A list of
Email
objects containing email addresses associated with the user.Type: Array of Email objects
Array Members: Fixed number of 1 item.
Required: No
- ExternalIds
-
A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.Type: Array of ExternalId objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- IdentityStoreId
-
The globally unique identifier for the identity store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Required: Yes
- Locale
-
A string containing the user's geographical region or location.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
- Name
-
An object containing the user's name.
Type: Name object
Required: No
- NickName
-
A string containing an alternate name for the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
- PhoneNumbers
-
A list of
PhoneNumber
objects containing phone numbers associated with the user.Type: Array of PhoneNumber objects
Array Members: Fixed number of 1 item.
Required: No
- PreferredLanguage
-
A string containing the preferred language of the user. For example, "American English" or "en-us."
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
- ProfileUrl
-
A string containing a URL that may be associated with the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
- Timezone
-
A string containing the user's time zone.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
- Title
-
A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
- UserId
-
The identifier for a user in the identity store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern:
([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}
Required: Yes
- UserName
-
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
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
- UserType
-
A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: