Menu
Amazon WorkMail
API Reference (API Version 2017-10-01)

User

The representation of an Amazon WorkMail user.

Contents

DisabledDate

The date indicating when the user was disabled from Amazon WorkMail use.

Type: Timestamp

Required: No

DisplayName

The display name of the user.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Email

The email of the user.

Type: String

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

Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}

Required: No

EnabledDate

The date indicating when the user was enabled for Amazon WorkMail use.

Type: Timestamp

Required: No

Id

The identifier of the user.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: No

Name

The name of the user.

Type: String

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

Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9]{2,})?

Required: No

State

The state of the user, which can be ENABLED, DISABLED, or DELETED.

Type: String

Valid Values: ENABLED | DISABLED | DELETED

Required: No

UserRole

The role of the user.

Type: String

Valid Values: USER | RESOURCE | SYSTEM_USER

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: