User
Important
Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs.
Learn about migration steps here:
How to migrate data from Amazon WorkDocs
Describes a user.
Contents
- CreatedTimestamp
-
The time when the user was created.
Type: Timestamp
Required: No
- EmailAddress
-
The email address of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}Required: No
- GivenName
-
The given name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- Id
-
The ID of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[&\w+-.@]+Required: No
- Locale
-
The locale of the user.
Type: String
Valid Values:
en | fr | ko | de | es | ja | ru | zh_CN | zh_TW | pt_BR | defaultRequired: No
- ModifiedTimestamp
-
The time when the user was modified.
Type: Timestamp
Required: No
- OrganizationId
-
The ID of the organization.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[&\w+-.@]+Required: No
- RecycleBinFolderId
-
The ID of the recycle bin folder.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+-.@]+Required: No
- RootFolderId
-
The ID of the root folder.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+-.@]+Required: No
- Status
-
The status of the user.
Type: String
Valid Values:
ACTIVE | INACTIVE | PENDINGRequired: No
- Storage
-
The storage for the user.
Type: UserStorageMetadata object
Required: No
- Surname
-
The surname of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- TimeZoneId
-
The time zone ID of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Type
-
The type of user.
Type: String
Valid Values:
USER | ADMIN | POWERUSER | MINIMALUSER | WORKSPACESUSERRequired: No
- Username
-
The login name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\w\-+.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z]+)?Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
