Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

User - Amazon WorkDocs

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 | default

Required: 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 | PENDING

Required: 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 | WORKSPACESUSER

Required: 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:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.