UserMetadata - Amazon WorkDocs

UserMetadata

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 the metadata of the user.

Contents

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 before a rename operation.

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

Surname

The surname of the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

Username

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