User - Amazon WorkMail
ContentsSee Also

User

Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

The representation of an WorkMail user.

Contents

DisabledDate

The date indicating when the user was disabled from 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 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

IdentityProviderIdentityStoreId

Identity store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Type: String

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

Pattern: ^d-[0-9a-f]{10}$|^[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}$

Required: No

IdentityProviderUserId

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

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

Required: No

See Also

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