amazon workmail - api reference · 2020-02-13 · amazon workmail api reference amazon's...

Amazon WorkMailAPI Reference

Amazon WorkMail: API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon WorkMail API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Amazon WorkMail ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Amazon WorkMail Message Flow .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Amazon WorkMail ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

AssociateDelegateToResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5AssociateMemberToGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7CreateAlias ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10CreateGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13CreateResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16CreateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19DeleteAccessControlRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22DeleteAlias ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24DeleteGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26DeleteMailboxPermissions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28DeleteResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30DeleteUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32DeregisterFromWorkMail ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34DescribeGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36DescribeOrganization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39DescribeResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42DescribeUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45DisassociateDelegateFromResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48DisassociateMemberFromGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50GetAccessControlEffect .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53GetMailboxDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56ListAccessControlRules .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58ListAliases .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60ListGroupMembers .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63ListGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66ListMailboxPermissions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69ListOrganizations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72ListResourceDelegates .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74ListResources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80ListUsers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82PutAccessControlRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85PutMailboxPermissions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89RegisterToWorkMail ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92ResetPassword .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100UpdateMailboxQuota .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102UpdatePrimaryEmailAddress .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104UpdateResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Amazon WorkMail Message Flow .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109GetRawMessageContent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Amazon WorkMail ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

AccessControlRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114BookingOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Delegate .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Group .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Member .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

iii


OrganizationSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Permission .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Resource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128User .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

iv

Amazon WorkMail API ReferenceAmazon WorkMail

Welcome

Amazon WorkMailAmazon WorkMail is a secure, managed business email and calendaring service with support for existingdesktop and mobile email clients. You can access your email, contacts, and calendars using MicrosoftOutlook, your browser, or other native iOS and Android email applications. You can integrate WorkMailwith your existing corporate directory and control both the keys that encrypt your data and the locationin which your data is stored.

The WorkMail API is designed for the following scenarios:

• Listing and describing organizations

• Managing users

• Managing groups

• Managing resources

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require theuse of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management usersand roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAMuser to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMailorganization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update,and delete users, groups, and resources. This allows developers to perform the scenarios listed above, aswell as give users the ability to grant access on a selective basis using the IAM model.

Amazon WorkMail Message FlowThe WorkMail Message Flow API provides access to email messages as they are being sent and receivedby a WorkMail organization.

1


ActionsThe following actions are supported by Amazon WorkMail:

• AssociateDelegateToResource (p. 5)• AssociateMemberToGroup (p. 7)• CreateAlias (p. 10)• CreateGroup (p. 13)• CreateResource (p. 16)• CreateUser (p. 19)• DeleteAccessControlRule (p. 22)• DeleteAlias (p. 24)• DeleteGroup (p. 26)• DeleteMailboxPermissions (p. 28)• DeleteResource (p. 30)• DeleteUser (p. 32)• DeregisterFromWorkMail (p. 34)• DescribeGroup (p. 36)• DescribeOrganization (p. 39)• DescribeResource (p. 42)• DescribeUser (p. 45)• DisassociateDelegateFromResource (p. 48)• DisassociateMemberFromGroup (p. 50)• GetAccessControlEffect (p. 53)• GetMailboxDetails (p. 56)• ListAccessControlRules (p. 58)• ListAliases (p. 60)• ListGroupMembers (p. 63)• ListGroups (p. 66)• ListMailboxPermissions (p. 69)• ListOrganizations (p. 72)• ListResourceDelegates (p. 74)• ListResources (p. 77)• ListTagsForResource (p. 80)• ListUsers (p. 82)• PutAccessControlRule (p. 85)• PutMailboxPermissions (p. 89)• RegisterToWorkMail (p. 92)• ResetPassword (p. 95)• TagResource (p. 98)• UntagResource (p. 100)• UpdateMailboxQuota (p. 102)• UpdatePrimaryEmailAddress (p. 104)• UpdateResource (p. 107)

2


The following actions are supported by Amazon WorkMail Message Flow:

• GetRawMessageContent (p. 110)

Amazon WorkMailThe following actions are supported by Amazon WorkMail:

• AssociateDelegateToResource (p. 5)• AssociateMemberToGroup (p. 7)• CreateAlias (p. 10)• CreateGroup (p. 13)• CreateResource (p. 16)• CreateUser (p. 19)• DeleteAccessControlRule (p. 22)• DeleteAlias (p. 24)• DeleteGroup (p. 26)• DeleteMailboxPermissions (p. 28)• DeleteResource (p. 30)• DeleteUser (p. 32)• DeregisterFromWorkMail (p. 34)• DescribeGroup (p. 36)• DescribeOrganization (p. 39)• DescribeResource (p. 42)• DescribeUser (p. 45)• DisassociateDelegateFromResource (p. 48)• DisassociateMemberFromGroup (p. 50)• GetAccessControlEffect (p. 53)• GetMailboxDetails (p. 56)• ListAccessControlRules (p. 58)• ListAliases (p. 60)• ListGroupMembers (p. 63)• ListGroups (p. 66)• ListMailboxPermissions (p. 69)• ListOrganizations (p. 72)• ListResourceDelegates (p. 74)• ListResources (p. 77)• ListTagsForResource (p. 80)• ListUsers (p. 82)• PutAccessControlRule (p. 85)• PutMailboxPermissions (p. 89)• RegisterToWorkMail (p. 92)• ResetPassword (p. 95)• TagResource (p. 98)• UntagResource (p. 100)• UpdateMailboxQuota (p. 102)

3


• UpdatePrimaryEmailAddress (p. 104)• UpdateResource (p. 107)

4

Amazon WorkMail API ReferenceAssociateDelegateToResource

AssociateDelegateToResourceService: Amazon WorkMail

Adds a member (user or group) to the resource's set of delegates.

Request Syntax

{ "EntityId": "string", "OrganizationId": "string", "ResourceId": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 131).

The request accepts the following data in JSON format.

EntityId (p. 5)

The member (user or group) to associate to the resource.

Type: String

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

Required: YesOrganizationId (p. 5)

The organization under which the resource exists.

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: YesResourceId (p. 5)

The resource for which members (users or groups) are associated.

Type: String

Pattern: ^r-[0-9a-f]{32}$

Required: Yes

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 133).

5

Amazon WorkMail API ReferenceAssociateDelegateToResource

EntityNotFoundException

The identifier supplied for the user, group, or resource does not exist in your organization.

HTTP Status Code: 400EntityStateException

You are performing an operation on a user, group, or resource that isn't in the expected state, suchas trying to delete an active user.

HTTP Status Code: 400InvalidParameterException

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400OrganizationNotFoundException

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400OrganizationStateException

The organization must have a valid state (Active or Synchronizing) to perform certain operations onthe organization or its members.

HTTP Status Code: 400

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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

6

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/AssociateDelegateToResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/AssociateDelegateToResource

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/AssociateDelegateToResource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/AssociateDelegateToResource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/AssociateDelegateToResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/AssociateDelegateToResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/AssociateDelegateToResource

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/AssociateDelegateToResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/AssociateDelegateToResource

Amazon WorkMail API ReferenceAssociateMemberToGroup

AssociateMemberToGroupService: Amazon WorkMail

Adds a member (user or group) to the group's set.

Request Syntax

{ "GroupId": "string", "MemberId": "string", "OrganizationId": "string"}



GroupId (p. 7)

The group to which the member (user or group) is associated.

Type: String


Required: YesMemberId (p. 7)

The member (user or group) to associate to the group.

Type: String



The organization under which the group exists.

Type: String


Required: Yes



7


DirectoryServiceAuthenticationFailedException

The directory service doesn't recognize the credentials supplied by WorkMail.

HTTP Status Code: 400DirectoryUnavailableException

The directory on which you are trying to perform operations isn't available.

HTTP Status Code: 400EntityNotFoundException










HTTP Status Code: 400UnsupportedOperationException

You can't perform a write operation against a read-only directory.



• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python

8

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/AssociateMemberToGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/AssociateMemberToGroup

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/AssociateMemberToGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/AssociateMemberToGroup

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/AssociateMemberToGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/AssociateMemberToGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/AssociateMemberToGroup

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/AssociateMemberToGroup


• AWS SDK for Ruby V3

9

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/AssociateMemberToGroup

Amazon WorkMail API ReferenceCreateAlias

CreateAliasService: Amazon WorkMail

Adds an alias to the set of a given member (user or group) of Amazon WorkMail.

Request Syntax

{ "Alias": "string", "EntityId": "string", "OrganizationId": "string"}



Alias (p. 10)

The alias to add to the member set.

Type: String


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

Required: YesEntityId (p. 10)

The member (user or group) to which this alias is added.

Type: String



The organization under which the member (user or group) exists.

Type: String


Required: Yes



10


EmailAddressInUseException

The email address that you're trying to assign is already created for a different user, group, orresource.







HTTP Status Code: 400LimitExceededException

The request exceeds the limit of the resource.

HTTP Status Code: 400MailDomainNotFoundException

For an email or alias to be created in Amazon WorkMail, the included domain must be defined in theorganization.

HTTP Status Code: 400MailDomainStateException

After a domain has been added to the organization, it must be verified. The domain is not yetverified.







• AWS Command Line Interface• AWS SDK for .NET

11

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/CreateAlias

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/CreateAlias


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

12

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/CreateAlias

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/CreateAlias

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/CreateAlias

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/CreateAlias

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/CreateAlias

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/CreateAlias

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/CreateAlias

Amazon WorkMail API ReferenceCreateGroup

CreateGroupService: Amazon WorkMail

Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail (p. 92)operation.

Request Syntax

{ "Name": "string", "OrganizationId": "string"}



Name (p. 13)

The name of the group.

Type: String


Pattern: [\u0020-\u00FF]+


The organization under which the group is to be created.

Type: String


Required: Yes

Response Syntax

{ "GroupId": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GroupId (p. 13)

The identifier of the group.

13


Type: String









HTTP Status Code: 400NameAvailabilityException

The user, group, or resource name isn't unique in Amazon WorkMail.





HTTP Status Code: 400ReservedNameException

This user, group, or resource name is not allowed in Amazon WorkMail.






14

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/CreateGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/CreateGroup



15

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/CreateGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/CreateGroup

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/CreateGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/CreateGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/CreateGroup

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/CreateGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/CreateGroup

Amazon WorkMail API ReferenceCreateResource

CreateResourceService: Amazon WorkMail

Creates a new Amazon WorkMail resource.

Request Syntax

{ "Name": "string", "OrganizationId": "string", "Type": "string"}



Name (p. 16)

The name of the new resource.

Type: String


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


The identifier associated with the organization for which the resource is created.

Type: String


Required: YesType (p. 16)

The type of the new resource. The available types are equipment and room.

Type: String

Valid Values: ROOM | EQUIPMENT

Required: Yes

Response Syntax

{ "ResourceId": "string"}

16




ResourceId (p. 16)

The identifier of the new resource.

Type: String



















17



18

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/CreateResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/CreateResource

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/CreateResource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/CreateResource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/CreateResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/CreateResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/CreateResource

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/CreateResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/CreateResource

Amazon WorkMail API ReferenceCreateUser

CreateUserService: Amazon WorkMail

Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail (p. 92)operation.

Request Syntax

{ "DisplayName": "string", "Name": "string", "OrganizationId": "string", "Password": "string"}



DisplayName (p. 19)

The display name for the new user.

Type: String

Length Constraints: Maximum length of 256.

Required: YesName (p. 19)

The name for the new user. Simple AD or AD Connector user names have a maximum length of 20.All others have a maximum length of 64.

Type: String




The identifier of the organization for which the user is created.

Type: String


Required: YesPassword (p. 19)

The password for the new user.

Type: String

19




Required: Yes

Response Syntax

{ "UserId": "string"}



UserId (p. 20)

The identifier for the new user.

Type: String









HTTP Status Code: 400InvalidPasswordException

The supplied password doesn't match the minimum security constraints, such as length or use ofspecial characters.




20


OrganizationNotFoundException











21

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/CreateUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/CreateUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/CreateUser

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/CreateUser

Amazon WorkMail API ReferenceDeleteAccessControlRule

DeleteAccessControlRuleService: Amazon WorkMail

Deletes an access control rule for the specified WorkMail organization.

Request Syntax

{ "Name": "string", "OrganizationId": "string"}



Name (p. 22)

The name of the access control rule.

Type: String


Pattern: [a-zA-Z0-9_-]+


The identifier for the organization.

Type: String


Required: No







22

Amazon WorkMail API ReferenceDeleteAccessControlRule




23

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DeleteAccessControlRule

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DeleteAccessControlRule

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DeleteAccessControlRule

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DeleteAccessControlRule

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DeleteAccessControlRule

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DeleteAccessControlRule

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DeleteAccessControlRule

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DeleteAccessControlRule

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DeleteAccessControlRule

Amazon WorkMail API ReferenceDeleteAlias

DeleteAliasService: Amazon WorkMail

Remove one or more specified aliases from a set of aliases for a given user.

Request Syntax

{ "Alias": "string", "EntityId": "string", "OrganizationId": "string"}



Alias (p. 24)

The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsedinto single entries (the list is transformed into a set).

Type: String




The identifier for the member (user or group) from which to have the aliases removed.

Type: String



The identifier for the organization under which the user exists.

Type: String


Required: Yes



24

Amazon WorkMail API ReferenceDeleteAlias














25

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DeleteAlias

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DeleteAlias

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DeleteAlias

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DeleteAlias

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DeleteAlias

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DeleteAlias

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DeleteAlias

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DeleteAlias

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DeleteAlias

Amazon WorkMail API ReferenceDeleteGroup

DeleteGroupService: Amazon WorkMail

Deletes a group from Amazon WorkMail.

Request Syntax

{ "GroupId": "string", "OrganizationId": "string"}



GroupId (p. 26)

The identifier of the group to be deleted.

Type: String



The organization that contains the group.

Type: String


Required: Yes








26

Amazon WorkMail API ReferenceDeleteGroup

EntityStateException













27

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DeleteGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DeleteGroup

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DeleteGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DeleteGroup

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DeleteGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DeleteGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DeleteGroup

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DeleteGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DeleteGroup

Amazon WorkMail API ReferenceDeleteMailboxPermissions

DeleteMailboxPermissionsService: Amazon WorkMail

Deletes permissions granted to a member (user or group).

Request Syntax

{ "EntityId": "string", "GranteeId": "string", "OrganizationId": "string"}



EntityId (p. 28)

The identifier of the member (user or group)that owns the mailbox.

Type: String


Required: YesGranteeId (p. 28)

The identifier of the member (user or group) for which to delete granted permissions.

Type: String



The identifier of the organization under which the member (user or group) exists.

Type: String


Required: Yes



28

Amazon WorkMail API ReferenceDeleteMailboxPermissions














29

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DeleteMailboxPermissions

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DeleteMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DeleteMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DeleteMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DeleteMailboxPermissions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DeleteMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DeleteMailboxPermissions

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DeleteMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DeleteMailboxPermissions

Amazon WorkMail API ReferenceDeleteResource

DeleteResourceService: Amazon WorkMail

Deletes the specified resource.

Request Syntax

{ "OrganizationId": "string", "ResourceId": "string"}



OrganizationId (p. 30)

The identifier associated with the organization from which the resource is deleted.

Type: String



The identifier of the resource to be deleted.

Type: String


Required: Yes



EntityStateException




30

Amazon WorkMail API ReferenceDeleteResource








31

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DeleteResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DeleteResource

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DeleteResource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DeleteResource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DeleteResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DeleteResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DeleteResource

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DeleteResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DeleteResource

Amazon WorkMail API ReferenceDeleteUser

DeleteUserService: Amazon WorkMail

Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the userstate must be DISABLED. Use the DescribeUser (p. 45) action to confirm the user state.

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 daysbefore they are permanently removed.

Request Syntax

{ "OrganizationId": "string", "UserId": "string"}




The organization that contains the user to be deleted.

Type: String


Required: YesUserId (p. 32)

The identifier of the user to be deleted.

Type: String


Required: Yes






32

Amazon WorkMail API ReferenceDeleteUser

DirectoryUnavailableException















33

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DeleteUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DeleteUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DeleteUser

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DeleteUser

Amazon WorkMail API ReferenceDeregisterFromWorkMail

DeregisterFromWorkMailService: Amazon WorkMail

Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociatesthe mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they arepermanently removed. The functionality in the console is Disable.

Request Syntax

{ "EntityId": "string", "OrganizationId": "string"}



EntityId (p. 34)

The identifier for the member (user or group) to be updated.

Type: String



The identifier for the organization under which the Amazon WorkMail entity exists.

Type: String


Required: Yes







34

Amazon WorkMail API ReferenceDeregisterFromWorkMail










35

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DeregisterFromWorkMail

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DeregisterFromWorkMail

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DeregisterFromWorkMail

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DeregisterFromWorkMail

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DeregisterFromWorkMail

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DeregisterFromWorkMail

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DeregisterFromWorkMail

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DeregisterFromWorkMail

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DeregisterFromWorkMail

Amazon WorkMail API ReferenceDescribeGroup

DescribeGroupService: Amazon WorkMail

Returns the data available for the group.

Request Syntax

{ "GroupId": "string", "OrganizationId": "string"}



GroupId (p. 36)

The identifier for the group to be described.

Type: String


Required: Yes


The identifier for the organization under which the group exists.

Type: String


Required: Yes

Response Syntax

{ "DisabledDate": number, "Email": "string", "EnabledDate": number, "GroupId": "string", "Name": "string", "State": "string"}



36


DisabledDate (p. 36)

The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

Type: TimestampEmail (p. 36)

The email of the described group.

Type: String


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

The date and time when a user was registered to WorkMail, in UNIX epoch time format.

Type: TimestampGroupId (p. 36)

The identifier of the described group.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.Name (p. 36)

The name of the described group.

Type: String


Pattern: [\u0020-\u00FF]+State (p. 36)

The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or neverregistered to WorkMail).

Type: String

Valid Values: ENABLED | DISABLED | DELETED







37









38

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DescribeGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DescribeGroup

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DescribeGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DescribeGroup

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DescribeGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DescribeGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DescribeGroup

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DescribeGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DescribeGroup

Amazon WorkMail API ReferenceDescribeOrganization

DescribeOrganizationService: Amazon WorkMail

Provides more information regarding a given organization based on its identifier.

Request Syntax

{ "OrganizationId": "string"}




The identifier for the organization to be described.

Type: String


Required: Yes

Response Syntax

{ "Alias": "string", "ARN": "string", "CompletedDate": number, "DefaultMailDomain": "string", "DirectoryId": "string", "DirectoryType": "string", "ErrorMessage": "string", "OrganizationId": "string", "State": "string"}



Alias (p. 39)

The alias for an organization.

Type: String


Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*

39


ARN (p. 39)

The Amazon Resource Name (ARN) of the organization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.CompletedDate (p. 39)

The date at which the organization became usable in the WorkMail context, in UNIX epoch timeformat.

Type: TimestampDefaultMailDomain (p. 39)

The default mail domain associated with the organization.

Type: String

Length Constraints: Maximum length of 256.DirectoryId (p. 39)

The identifier for the directory associated with an Amazon WorkMail organization.

Type: String

Length Constraints: Maximum length of 256.DirectoryType (p. 39)

The type of directory associated with the WorkMail organization.

Type: String

Length Constraints: Maximum length of 256.ErrorMessage (p. 39)

(Optional) The error message indicating if unexpected behavior was encountered with regards to theorganization.

Type: String

Length Constraints: Maximum length of 256.OrganizationId (p. 39)

The identifier of an organization.

Type: String

Pattern: ^m-[0-9a-f]{32}$State (p. 39)

The state of an organization.

Type: String



40


InvalidParameterException







41

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DescribeOrganization

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DescribeOrganization

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DescribeOrganization

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DescribeOrganization

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DescribeOrganization

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DescribeOrganization

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DescribeOrganization

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DescribeOrganization

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DescribeOrganization

Amazon WorkMail API ReferenceDescribeResource

DescribeResourceService: Amazon WorkMail

Returns the data available for the resource.

Request Syntax

{ "OrganizationId": "string", "ResourceId": "string"}




The identifier associated with the organization for which the resource is described.

Type: String



The identifier of the resource to be described.

Type: String


Required: Yes

Response Syntax

{ "BookingOptions": { "AutoAcceptRequests": boolean, "AutoDeclineConflictingRequests": boolean, "AutoDeclineRecurringRequests": boolean }, "DisabledDate": number, "Email": "string", "EnabledDate": number, "Name": "string", "ResourceId": "string", "State": "string", "Type": "string"}


42



BookingOptions (p. 42)

The booking options for the described resource.

Type: BookingOptions (p. 117) object


The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

Type: Timestamp

Email (p. 42)

The email of the described resource.

Type: String



EnabledDate (p. 42)

The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

Type: Timestamp

Name (p. 42)

The name of the described resource.

Type: String



ResourceId (p. 42)

The identifier of the described resource.

Type: String


State (p. 42)

The state of the resource: enabled (registered to Amazon WorkMail), disabled (deregistered or neverregistered to WorkMail), or deleted.

Type: String


Type (p. 42)

The type of the described resource.

Type: String


43














44

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DescribeResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DescribeResource

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DescribeResource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DescribeResource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DescribeResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DescribeResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DescribeResource

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DescribeResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DescribeResource

Amazon WorkMail API ReferenceDescribeUser

DescribeUserService: Amazon WorkMail

Provides information regarding the user.

Request Syntax





The identifier for the organization under which the user exists.

Type: String



The identifier for the user to be described.

Type: String


Required: Yes

Response Syntax

{ "DisabledDate": number, "DisplayName": "string", "Email": "string", "EnabledDate": number, "Name": "string", "State": "string", "UserId": "string", "UserRole": "string"}



45



The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch timeformat.

Type: TimestampDisplayName (p. 45)

The display name of the user.

Type: String

Length Constraints: Maximum length of 256.Email (p. 45)

The email of the user.

Type: String


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

The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch timeformat.

Type: TimestampName (p. 45)

The name for the user.

Type: String


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

The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or neverregistered to WorkMail).

Type: String

Valid Values: ENABLED | DISABLED | DELETEDUserId (p. 45)

The identifier for the described user.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.UserRole (p. 45)

In certain cases, other entities are modeled as users. If interoperability is enabled, resources areimported into Amazon WorkMail as users. Because different WorkMail organizations rely ondifferent directory types, administrators can distinguish between an unregistered user (account isdisabled and has a user role) and the directory administrators. The values are USER, RESOURCE, andSYSTEM_USER.

46


Type: String

Valid Values: USER | RESOURCE | SYSTEM_USER













47

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DescribeUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DescribeUser

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DescribeUser

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DescribeUser

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DescribeUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DescribeUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DescribeUser

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DescribeUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DescribeUser

Amazon WorkMail API ReferenceDisassociateDelegateFromResource

DisassociateDelegateFromResourceService: Amazon WorkMail

Removes a member from the resource's set of delegates.

Request Syntax

{ "EntityId": "string", "OrganizationId": "string", "ResourceId": "string"}



EntityId (p. 48)

The identifier for the member (user, group) to be removed from the resource's delegates.

Type: String



The identifier for the organization under which the resource exists.

Type: String



The identifier of the resource from which delegates' set members are removed.

Type: String


Required: Yes



48

Amazon WorkMail API ReferenceDisassociateDelegateFromResource














49

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DisassociateDelegateFromResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DisassociateDelegateFromResource

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DisassociateDelegateFromResource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DisassociateDelegateFromResource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DisassociateDelegateFromResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DisassociateDelegateFromResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DisassociateDelegateFromResource

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DisassociateDelegateFromResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DisassociateDelegateFromResource

Amazon WorkMail API ReferenceDisassociateMemberFromGroup

DisassociateMemberFromGroupService: Amazon WorkMail

Removes a member from a group.

Request Syntax

{ "GroupId": "string", "MemberId": "string", "OrganizationId": "string"}



GroupId (p. 50)

The identifier for the group from which members are removed.

Type: String


Required: YesMemberId (p. 50)

The identifier for the member to be removed to the group.

Type: String




Type: String


Required: Yes



50




















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python

51

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/DisassociateMemberFromGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/DisassociateMemberFromGroup

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/DisassociateMemberFromGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/DisassociateMemberFromGroup

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/DisassociateMemberFromGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/DisassociateMemberFromGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/DisassociateMemberFromGroup

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/DisassociateMemberFromGroup


• AWS SDK for Ruby V3

52

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/DisassociateMemberFromGroup

Amazon WorkMail API ReferenceGetAccessControlEffect

GetAccessControlEffectService: Amazon WorkMail

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, accessprotocol action, or user ID.

Request Syntax

{ "Action": "string", "IpAddress": "string", "OrganizationId": "string", "UserId": "string"}



Action (p. 53)

The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP,WindowsOutlook, and WebMail.

Type: String


Pattern: [a-zA-Z]+

Required: YesIpAddress (p. 53)

The IPv4 address.

Type: String


Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$



Type: String



The user ID.

53


Type: String


Required: Yes

Response Syntax

{ "Effect": "string", "MatchedRules": [ "string" ]}



Effect (p. 54)

The rule effect.

Type: String

Valid Values: ALLOW | DENYMatchedRules (p. 54)

The rules that match the given parameters, resulting in an effect.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.











54


OrganizationStateException





55

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/GetAccessControlEffect

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/GetAccessControlEffect

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/GetAccessControlEffect

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/GetAccessControlEffect

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/GetAccessControlEffect

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/GetAccessControlEffect

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/GetAccessControlEffect

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/GetAccessControlEffect

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/GetAccessControlEffect

Amazon WorkMail API ReferenceGetMailboxDetails

GetMailboxDetailsService: Amazon WorkMail

Requests a user's mailbox details for a specified organization and user.

Request Syntax





The identifier for the organization that contains the user whose mailbox details are being requested.

Type: String



The identifier for the user whose mailbox details are being requested.

Type: String


Required: Yes

Response Syntax

{ "MailboxQuota": number, "MailboxSize": number}



MailboxQuota (p. 56)

The maximum allowed mailbox size, in MB, for the specified user.

Type: Integer

56

Amazon WorkMail API ReferenceGetMailboxDetails

Valid Range: Minimum value of 1.MailboxSize (p. 56)

The current mailbox size, in MB, for the specified user.

Type: Double

Valid Range: Minimum value of 0.











57

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/GetMailboxDetails

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/GetMailboxDetails

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/GetMailboxDetails

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/GetMailboxDetails

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/GetMailboxDetails

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/GetMailboxDetails

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/GetMailboxDetails

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/GetMailboxDetails

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/GetMailboxDetails

Amazon WorkMail API ReferenceListAccessControlRules

ListAccessControlRulesService: Amazon WorkMail

Lists the access control rules for the specified organization.

Request Syntax

{ "OrganizationId": "string"}





Type: String


Required: Yes

Response Syntax

{ "Rules": [ { "Actions": [ "string" ], "DateCreated": number, "DateModified": number, "Description": "string", "Effect": "string", "IpRanges": [ "string" ], "Name": "string", "NotActions": [ "string" ], "NotIpRanges": [ "string" ], "NotUserIds": [ "string" ], "UserIds": [ "string" ] } ]}



Rules (p. 58)

The access control rules.

58

Amazon WorkMail API ReferenceListAccessControlRules

Type: Array of AccessControlRule (p. 114) objects










59

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListAccessControlRules

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListAccessControlRules

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListAccessControlRules

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListAccessControlRules

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListAccessControlRules

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListAccessControlRules

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListAccessControlRules

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListAccessControlRules

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListAccessControlRules

Amazon WorkMail API ReferenceListAliases

ListAliasesService: Amazon WorkMail

Creates a paginated call to list the aliases associated with a given entity.

Request Syntax

{ "EntityId": "string", "MaxResults": number, "NextToken": "string", "OrganizationId": "string"}



EntityId (p. 60)

The identifier for the entity for which to list the aliases.

Type: String


Required: YesMaxResults (p. 60)

The maximum number of results to return in a single call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: NoNextToken (p. 60)

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Type: String


Required: NoOrganizationId (p. 60)

The identifier for the organization under which the entity exists.

Type: String


Required: Yes

60


Response Syntax

{ "Aliases": [ "string" ], "NextToken": "string"}



Aliases (p. 61)

The entity's paginated aliases.



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

The token to use to retrieve the next page of results. The value is "null" when there are no moreresults to return.

Type: String












61







62

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListAliases

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListAliases

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListAliases

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListAliases

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListAliases

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListAliases

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListAliases

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListAliases

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListAliases

Amazon WorkMail API ReferenceListGroupMembers

ListGroupMembersService: Amazon WorkMail

Returns an overview of the members of a group. Users and groups can be members of a group.

Request Syntax

{ "GroupId": "string", "MaxResults": number, "NextToken": "string", "OrganizationId": "string"}



GroupId (p. 63)

The identifier for the group to which the members (users or groups) are associated.

Type: String




Type: Integer




Type: String




Type: String


Required: Yes

63


Response Syntax

{ "Members": [ { "DisabledDate": number, "EnabledDate": number, "Id": "string", "Name": "string", "State": "string", "Type": "string" } ], "NextToken": "string"}



Members (p. 64)

The members associated to the group.

Type: Array of Member (p. 121) objectsNextToken (p. 64)


Type: String











64







65

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListGroupMembers

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListGroupMembers

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListGroupMembers

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListGroupMembers

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListGroupMembers

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListGroupMembers

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListGroupMembers

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListGroupMembers

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListGroupMembers

Amazon WorkMail API ReferenceListGroups

ListGroupsService: Amazon WorkMail

Returns summaries of the organization's groups.

Request Syntax

{ "MaxResults": number, "NextToken": "string", "OrganizationId": "string"}



MaxResults (p. 66)


Type: Integer




Type: String



The identifier for the organization under which the groups exist.

Type: String


Required: Yes

Response Syntax

{ "Groups": [ { "DisabledDate": number, "Email": "string", "EnabledDate": number,

66


"Id": "string", "Name": "string", "State": "string" } ], "NextToken": "string"}



Groups (p. 66)

The overview of groups for an organization.

Type: Array of Group (p. 119) objectsNextToken (p. 66)


Type: String













67



68

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListGroups

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListGroups

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListGroups

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListGroups

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListGroups

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListGroups

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListGroups

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListGroups

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListGroups

Amazon WorkMail API ReferenceListMailboxPermissions

ListMailboxPermissionsService: Amazon WorkMail

Lists the mailbox permissions associated with a user, group, or resource mailbox.

Request Syntax

{ "EntityId": "string", "MaxResults": number, "NextToken": "string", "OrganizationId": "string"}



EntityId (p. 69)

The identifier of the user, group, or resource for which to list mailbox permissions.

Type: String




Type: Integer




Type: String



The identifier of the organization under which the user, group, or resource exists.

Type: String


Required: Yes

69


Response Syntax

{ "NextToken": "string", "Permissions": [ { "GranteeId": "string", "GranteeType": "string", "PermissionValues": [ "string" ] } ]}



NextToken (p. 70)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.Permissions (p. 70)

One page of the user, group, or resource mailbox permissions.

Type: Array of Permission (p. 125) objects











70




71

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListMailboxPermissions

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListMailboxPermissions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListMailboxPermissions

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListMailboxPermissions

Amazon WorkMail API ReferenceListOrganizations

ListOrganizationsService: Amazon WorkMail

Returns summaries of the customer's non-deleted organizations.

Request Syntax

{ "MaxResults": number, "NextToken": "string"}



MaxResults (p. 72)


Type: Integer




Type: String


Required: No

Response Syntax

{ "NextToken": "string", "OrganizationSummaries": [ { "Alias": "string", "ErrorMessage": "string", "OrganizationId": "string", "State": "string" } ]}


72

Amazon WorkMail API ReferenceListOrganizations


NextToken (p. 72)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.OrganizationSummaries (p. 72)

The overview of owned organizations presented as a list of organization summaries.

Type: Array of OrganizationSummary (p. 123) objects







73

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListOrganizations

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListOrganizations

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListOrganizations

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListOrganizations

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListOrganizations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListOrganizations

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListOrganizations

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListOrganizations

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListOrganizations

Amazon WorkMail API ReferenceListResourceDelegates

ListResourceDelegatesService: Amazon WorkMail

Lists the delegates associated with a resource. Users and groups can be resource delegates and answerrequests on behalf of the resource.

Request Syntax

{ "MaxResults": number, "NextToken": "string", "OrganizationId": "string", "ResourceId": "string"}



MaxResults (p. 74)

The number of maximum results in a page.

Type: Integer



The token used to paginate through the delegates associated with a resource.

Type: String



The identifier for the organization that contains the resource for which delegates are listed.

Type: String



The identifier for the resource whose delegates are listed.

Type: String


Required: Yes

74


Response Syntax

{ "Delegates": [ { "Id": "string", "Type": "string" } ], "NextToken": "string"}



Delegates (p. 75)

One page of the resource's delegates.

Type: Array of Delegate (p. 118) objectsNextToken (p. 75)

The token used to paginate through the delegates associated with a resource. While results are stillavailable, it has an associated value. When the last page is reached, the token is empty.

Type: String












75







76

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListResourceDelegates

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListResourceDelegates

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListResourceDelegates

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListResourceDelegates

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListResourceDelegates

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListResourceDelegates

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListResourceDelegates

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListResourceDelegates

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListResourceDelegates

Amazon WorkMail API ReferenceListResources

ListResourcesService: Amazon WorkMail

Returns summaries of the organization's resources.

Request Syntax




MaxResults (p. 77)


Type: Integer




Type: String



The identifier for the organization under which the resources exist.

Type: String


Required: Yes

Response Syntax

{ "NextToken": "string", "Resources": [ { "DisabledDate": number, "Email": "string", "EnabledDate": number,

77


"Id": "string", "Name": "string", "State": "string", "Type": "string" } ]}



NextToken (p. 77)

The token used to paginate through all the organization's resources. While results are still available,it has an associated value. When the last page is reached, the token is empty.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.Resources (p. 77)

One page of the organization's resource representation.

Type: Array of Resource (p. 126) objects










• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++

78

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListResources

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListResources

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListResources


• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

79

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListResources

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListResources

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListResources

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListResources

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListResources

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListResources

Amazon WorkMail API ReferenceListTagsForResource

ListTagsForResourceService: Amazon WorkMail

Lists the tags applied to an Amazon WorkMail organization resource.

Request Syntax

{ "ResourceARN": "string"}



ResourceARN (p. 80)

The resource ARN.

Type: String


Required: Yes

Response Syntax

{ "Tags": [ { "Key": "string", "Value": "string" } ]}



Tags (p. 80)

A list of tag key-value pairs.

Type: Array of Tag (p. 128) objects



80

Amazon WorkMail API ReferenceListTagsForResource

ResourceNotFoundException

The resource cannot be found.




81

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListTagsForResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListTagsForResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListTagsForResource

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListTagsForResource

Amazon WorkMail API ReferenceListUsers

ListUsersService: Amazon WorkMail

Returns summaries of the organization's users.

Request Syntax




MaxResults (p. 82)


Type: Integer




Type: String



The identifier for the organization under which the users exist.

Type: String


Required: Yes

Response Syntax

{ "NextToken": "string", "Users": [ { "DisabledDate": number, "DisplayName": "string",

82


"Email": "string", "EnabledDate": number, "Id": "string", "Name": "string", "State": "string", "UserRole": "string" } ]}



NextToken (p. 82)

The token to use to retrieve the next page of results. This value is `null` when there are no moreresults to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.Users (p. 82)

The overview of users for an organization.

Type: Array of User (p. 129) objects











83

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ListUsers

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ListUsers



84

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ListUsers

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ListUsers

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ListUsers

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ListUsers

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ListUsers

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ListUsers

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ListUsers

Amazon WorkMail API ReferencePutAccessControlRule

PutAccessControlRuleService: Amazon WorkMail

Adds a new access control rule for the specified organization. The rule allows or denies access to theorganization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rulewith the same name as an existing rule replaces the older rule.

Request Syntax

{ "Actions": [ "string" ], "Description": "string", "Effect": "string", "IpRanges": [ "string" ], "Name": "string", "NotActions": [ "string" ], "NotIpRanges": [ "string" ], "NotUserIds": [ "string" ], "OrganizationId": "string", "UserIds": [ "string" ]}



Actions (p. 85)

Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover,EWS, IMAP, SMTP, WindowsOutlook, and WebMail.




Pattern: [a-zA-Z]+

Required: NoDescription (p. 85)

The rule description.

Type: String



Required: YesEffect (p. 85)

The rule effect.

Type: String

85


Valid Values: ALLOW | DENY

Required: YesIpRanges (p. 85)

IPv4 CIDR ranges to include in the rule.




Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$

Required: NoName (p. 85)

The rule name.

Type: String



Required: YesNotActions (p. 85)

Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover,EWS, IMAP, SMTP, WindowsOutlook, and WebMail.




Pattern: [a-zA-Z]+

Required: NoNotIpRanges (p. 85)

IPv4 CIDR ranges to exclude from the rule.




Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$

Required: NoNotUserIds (p. 85)

User IDs to exclude from the rule.


86





The identifier of the organization.

Type: String


Required: YesUserIds (p. 85)

User IDs to include in the rule.




Required: No







HTTP Status Code: 400LimitExceededException

The request exceeds the limit of the resource.





87





88

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/PutAccessControlRule

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/PutAccessControlRule

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/PutAccessControlRule

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/PutAccessControlRule

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/PutAccessControlRule

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/PutAccessControlRule

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/PutAccessControlRule

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/PutAccessControlRule

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/PutAccessControlRule

Amazon WorkMail API ReferencePutMailboxPermissions

PutMailboxPermissionsService: Amazon WorkMail

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

Request Syntax

{ "EntityId": "string", "GranteeId": "string", "OrganizationId": "string", "PermissionValues": [ "string" ]}



EntityId (p. 89)

The identifier of the user, group, or resource for which to update mailbox permissions.

Type: String


Required: YesGranteeId (p. 89)

The identifier of the user, group, or resource to which to grant the permissions.

Type: String



The identifier of the organization under which the user, group, or resource exists.

Type: String


Required: YesPermissionValues (p. 89)

The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner ofthe mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the granteeto send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physicalsender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective ofother folder-level permissions set on the mailbox.


89


Valid Values: FULL_ACCESS | SEND_AS | SEND_ON_BEHALF

Required: Yes
















90

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/PutMailboxPermissions

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/PutMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/PutMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/PutMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/PutMailboxPermissions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/PutMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/PutMailboxPermissions

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/PutMailboxPermissions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/PutMailboxPermissions


91

Amazon WorkMail API ReferenceRegisterToWorkMail

RegisterToWorkMailService: Amazon WorkMail

Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating amailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabledand fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. Formore information, see Pricing. The equivalent console functionality for this operation is Enable.

Users can either be created by calling the CreateUser (p. 19) API operation or they can be synchronizedfrom your directory. For more information, see DeregisterFromWorkMail (p. 34).

Request Syntax

{ "Email": "string", "EntityId": "string", "OrganizationId": "string"}



Email (p. 92)

The email for the user, group, or resource to be updated.

Type: String




The identifier for the user, group, or resource to be updated.

Type: String



The identifier for the organization under which the user, group, or resource exists.

Type: String


Required: Yes


92

https://aws.amazon.com/workmail/pricing







HTTP Status Code: 400EmailAddressInUseException


HTTP Status Code: 400EntityAlreadyRegisteredException

The user, group, or resource that you're trying to register is already registered.














93







94

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/RegisterToWorkMail

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/RegisterToWorkMail

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/RegisterToWorkMail

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/RegisterToWorkMail

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/RegisterToWorkMail

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/RegisterToWorkMail

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/RegisterToWorkMail

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/RegisterToWorkMail

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/RegisterToWorkMail

Amazon WorkMail API ReferenceResetPassword

ResetPasswordService: Amazon WorkMail

Allows the administrator to reset the password for a user.

Request Syntax

{ "OrganizationId": "string", "Password": "string", "UserId": "string"}




The identifier of the organization that contains the user for which the password is reset.

Type: String


Required: YesPassword (p. 95)

The new password for the user.

Type: String




The identifier of the user for whom the password is reset.

Type: String


Required: Yes



95












HTTP Status Code: 400InvalidPasswordException

The supplied password doesn't match the minimum security constraints, such as length or use ofspecial characters.









• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go

96

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/ResetPassword

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/ResetPassword

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/ResetPassword

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/ResetPassword


• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

97

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/ResetPassword

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/ResetPassword

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/ResetPassword

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/ResetPassword

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/ResetPassword

Amazon WorkMail API ReferenceTagResource

TagResourceService: Amazon WorkMail

Applies the specified tags to the specified Amazon WorkMail organization resource.

Request Syntax

{ "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}



ResourceARN (p. 98)

The resource ARN.

Type: String


Required: YesTags (p. 98)

The tag key-value pairs.

Type: Array of Tag (p. 128) objects


Required: Yes






98

Amazon WorkMail API ReferenceTagResource



HTTP Status Code: 400TooManyTagsException

The resource can have up to 50 user-applied tags.




99

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/TagResource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/TagResource

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/TagResource

Amazon WorkMail API ReferenceUntagResource

UntagResourceService: Amazon WorkMail

Untags the specified tags from the specified Amazon WorkMail organization resource.

Request Syntax

{ "ResourceARN": "string", "TagKeys": [ "string" ]}



ResourceARN (p. 100)

The resource ARN.

Type: String


Required: YesTagKeys (p. 100)

The tag keys.




Required: Yes







100

Amazon WorkMail API ReferenceUntagResource


101

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/UntagResource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/UntagResource

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/UntagResource

Amazon WorkMail API ReferenceUpdateMailboxQuota

UpdateMailboxQuotaService: Amazon WorkMail

Updates a user's current mailbox quota for a specified organization and user.

Request Syntax

{ "MailboxQuota": number, "OrganizationId": "string", "UserId": "string"}



MailboxQuota (p. 102)

The updated mailbox quota, in MB, for the specified user.

Type: Integer

Valid Range: Minimum value of 1.


The identifier for the organization that contains the user for whom to update the mailbox quota.

Type: String



The identifer for the user for whom to update the mailbox quota.

Type: String


Required: Yes



102

Amazon WorkMail API ReferenceUpdateMailboxQuota














103

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/UpdateMailboxQuota

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/UpdateMailboxQuota

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/UpdateMailboxQuota

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/UpdateMailboxQuota

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/UpdateMailboxQuota

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/UpdateMailboxQuota

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/UpdateMailboxQuota

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/UpdateMailboxQuota

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/UpdateMailboxQuota

Amazon WorkMail API ReferenceUpdatePrimaryEmailAddress

UpdatePrimaryEmailAddressService: Amazon WorkMail

Updates the primary email for a user, group, or resource. The current email is moved into the list ofaliases (or swapped between an existing alias and the current primary email), and the email provided inthe input is promoted as the primary.

Request Syntax

{ "Email": "string", "EntityId": "string", "OrganizationId": "string"}



Email (p. 104)

The value of the email to be updated as primary.

Type: String



Required: Yes

EntityId (p. 104)

The user, group, or resource to update.

Type: String


Required: Yes


The organization that contains the user, group, or resource to update.

Type: String


Required: Yes


104
























105









106

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/UpdatePrimaryEmailAddress

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/UpdatePrimaryEmailAddress

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/UpdatePrimaryEmailAddress

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/UpdatePrimaryEmailAddress

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/UpdatePrimaryEmailAddress

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/UpdatePrimaryEmailAddress

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/UpdatePrimaryEmailAddress

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/UpdatePrimaryEmailAddress

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/UpdatePrimaryEmailAddress

Amazon WorkMail API ReferenceUpdateResource

UpdateResourceService: Amazon WorkMail

Updates data for the resource. To have the latest information, it must be preceded by aDescribeResource (p. 42) call. The dataset in the request should be the one expected when performinganother DescribeResource call.

Request Syntax

{ "BookingOptions": { "AutoAcceptRequests": boolean, "AutoDeclineConflictingRequests": boolean, "AutoDeclineRecurringRequests": boolean }, "Name": "string", "OrganizationId": "string", "ResourceId": "string"}



BookingOptions (p. 107)

The resource's booking options to be updated.

Type: BookingOptions (p. 117) object

Required: NoName (p. 107)

The name of the resource to be updated.

Type: String




The identifier associated with the organization for which the resource is updated.

Type: String



The identifier of the resource to be updated.

Type: String

107

Amazon WorkMail API ReferenceUpdateResource


Required: Yes



DirectoryUnavailableException








HTTP Status Code: 400InvalidConfigurationException

The configuration for a resource isn't valid. A resource must either be able to auto-respond torequests or have at least one delegate associated that can do so on its behalf.








108

Amazon WorkMail API ReferenceAmazon WorkMail Message Flow








Amazon WorkMail Message FlowThe following actions are supported by Amazon WorkMail Message Flow:

• GetRawMessageContent (p. 110)

109

https://docs.aws.amazon.com/goto/aws-cli/workmail-2017-10-01/UpdateResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmail-2017-10-01/UpdateResource

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/UpdateResource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/UpdateResource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/UpdateResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmail-2017-10-01/UpdateResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmail-2017-10-01/UpdateResource

https://docs.aws.amazon.com/goto/boto3/workmail-2017-10-01/UpdateResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/UpdateResource

Amazon WorkMail API ReferenceGetRawMessageContent

GetRawMessageContentService: Amazon WorkMail Message Flow

Retrieves the raw content of an in-transit email message, in MIME format.

Request Syntax

GET /messages/messageId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

messageId (p. 110)

The identifier of the email message to retrieve.


Pattern: [a-z0-9\-]*

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

messageContent

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following as the HTTP body.

messageContent (p. 110)

The raw content of the email message, in MIME format.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 133).


The requested email message is not found.


110


ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example gets the raw content of an in-transit email message and sends it to a text file named "test".

Sample Request

GET /messages/a1b2cd34-ef5g-6h7j-kl8m-npq9012345rs HTTP/1.1Host: workmailmessageflow.us-east-1.amazonaws.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.273 Python/3.6.0 Windows/10 botocore/1.13.9X-Amz-Date: 20191107T195012ZAuthorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OKCache-Control: no-cacheContent-Type: application/jsonDate: Thu, 07 Nov 2019 19:50:12 GMTx-amzn-RequestId: ea71f214-79c5-4f89-9d4e-1ab4c43ae0dfContent-Length: 1344Connection: keep-alive

Subject: Hello WorldFrom: =?UTF-8?Q?marymajor_marymajor?= <[email protected]>To: =?UTF-8?Q?mateojackson=40example=2Enet?= <[email protected]>Date: Thu, 7 Nov 2019 19:22:46 +0000Mime-Version: 1.0Content-Type: multipart/alternative; boundary="=_EXAMPLE+"References: <[email protected]>X-Priority: 3 (Normal)X-Mailer: Amazon WorkMailThread-Index: EXAMPLEThread-Topic: Hello WorldMessage-Id: <[email protected]>

This is a multi-part message in MIME format. Your mail reader does notunderstand MIME message format.--=_EXAMPLE+Content-Type: text/plain; charset=UTF-8Content-Transfer-Encoding: 7bit

hello world

--=_EXAMPLE+Content-Type: text/html; charset=utf-8Content-Transfer-Encoding: quoted-printable

111

https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://aws.amazon.com/cli/

http://aws.amazon.com/tools/


<!DOCTYPE HTML><html><head><meta name=3D"Generator" content=3D"Amazon WorkMail v3.0-4510"><meta http-equiv=3D"Content-Type" content=3D"text/html; charset=3Dutf-8">=

<title>testing</title></head><body><p style=3D"margin: 0px; font-family: Arial, Tahoma, Helvetica, sans-seri=f; font-size: small;">hello world</p></body></html>--=_EXAMPLE+--



112

https://docs.aws.amazon.com/goto/aws-cli/workmailmessageflow-2019-05-01/GetRawMessageContent

https://docs.aws.amazon.com/goto/DotNetSDKV3/workmailmessageflow-2019-05-01/GetRawMessageContent

https://docs.aws.amazon.com/goto/SdkForCpp/workmailmessageflow-2019-05-01/GetRawMessageContent

https://docs.aws.amazon.com/goto/SdkForGoV1/workmailmessageflow-2019-05-01/GetRawMessageContent

https://docs.aws.amazon.com/goto/SdkForJava/workmailmessageflow-2019-05-01/GetRawMessageContent

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workmailmessageflow-2019-05-01/GetRawMessageContent

https://docs.aws.amazon.com/goto/SdkForPHPV3/workmailmessageflow-2019-05-01/GetRawMessageContent

https://docs.aws.amazon.com/goto/boto3/workmailmessageflow-2019-05-01/GetRawMessageContent

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmailmessageflow-2019-05-01/GetRawMessageContent


Data TypesThe following data types are supported by Amazon WorkMail:

• AccessControlRule (p. 114)• BookingOptions (p. 117)• Delegate (p. 118)• Group (p. 119)• Member (p. 121)• OrganizationSummary (p. 123)• Permission (p. 125)• Resource (p. 126)• Tag (p. 128)• User (p. 129)

Amazon WorkMailThe following data types are supported by Amazon WorkMail:

• AccessControlRule (p. 114)• BookingOptions (p. 117)• Delegate (p. 118)• Group (p. 119)• Member (p. 121)• OrganizationSummary (p. 123)• Permission (p. 125)• Resource (p. 126)• Tag (p. 128)• User (p. 129)

113

Amazon WorkMail API ReferenceAccessControlRule

AccessControlRuleService: Amazon WorkMail

A rule that controls access to an Amazon WorkMail organization.

ContentsActions

Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover,EWS, IMAP, SMTP, WindowsOutlook, and WebMail.




Pattern: [a-zA-Z]+

Required: NoDateCreated

The date that the rule was created.

Type: Timestamp

Required: NoDateModified

The date that the rule was modified.

Type: Timestamp

Required: NoDescription

The rule description.

Type: String



Required: NoEffect

The rule effect.

Type: String

Valid Values: ALLOW | DENY

Required: NoIpRanges

IPv4 CIDR ranges to include in the rule.

114





Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$

Required: NoName

The rule name.

Type: String



Required: NoNotActions

Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover,EWS, IMAP, SMTP, WindowsOutlook, and WebMail.




Pattern: [a-zA-Z]+

Required: NoNotIpRanges

IPv4 CIDR ranges to exclude from the rule.




Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$

Required: NoNotUserIds

User IDs to exclude from the rule.




Required: No

115


UserIds

User IDs to include in the rule.




Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

116

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/AccessControlRule

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/AccessControlRule

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/AccessControlRule

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/AccessControlRule

Amazon WorkMail API ReferenceBookingOptions

BookingOptionsService: Amazon WorkMail

At least one delegate must be associated to the resource to disable automatic replies from the resource.

ContentsAutoAcceptRequests

The resource's ability to automatically reply to requests. If disabled, delegates must be associated tothe resource.

Type: Boolean

Required: NoAutoDeclineConflictingRequests

The resource's ability to automatically decline any conflicting requests.

Type: Boolean

Required: NoAutoDeclineRecurringRequests

The resource's ability to automatically decline any recurring requests.

Type: Boolean

Required: No



117

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/BookingOptions

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/BookingOptions

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/BookingOptions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/BookingOptions

Amazon WorkMail API ReferenceDelegate

DelegateService: Amazon WorkMail

The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

ContentsId

The identifier for the user or group associated as the resource's delegate.

Type: String


Required: YesType

The type of the delegate: user or group.

Type: String

Valid Values: GROUP | USER

Required: Yes



118

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/Delegate

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/Delegate

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/Delegate

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/Delegate

Amazon WorkMail API ReferenceGroup

GroupService: Amazon WorkMail

The representation of an Amazon WorkMail group.

ContentsDisabledDate

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

Type: Timestamp

Required: NoEmail

The email of the group.

Type: String



Required: NoEnabledDate

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

Type: Timestamp

Required: NoId

The identifier of the group.

Type: String


Required: NoName

The name of the group.

Type: String



Required: NoState

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

Type: String


119

Amazon WorkMail API ReferenceGroup

Required: No



120

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/Group

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/Group

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/Group

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/Group

Amazon WorkMail API ReferenceMember

MemberService: Amazon WorkMail

The representation of a user or group.


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

Type: Timestamp

Required: No

EnabledDate

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

Type: Timestamp

Required: No

Id

The identifier of the member.

Type: String


Required: No

Name

The name of the member.

Type: String


Required: No

State

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

Type: String


Required: No

Type

A member can be a user or group.

Type: String


Required: No

121

Amazon WorkMail API ReferenceMember



122

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/Member

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/Member

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/Member

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/Member

Amazon WorkMail API ReferenceOrganizationSummary

OrganizationSummaryService: Amazon WorkMail

The representation of an organization.

ContentsAlias

The alias associated with the organization.

Type: String


Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*

Required: NoErrorMessage

The error message associated with the organization. It is only present if unexpected behavior hasoccurred with regards to the organization. It provides insight or solutions regarding unexpectedbehavior.

Type: String


Required: NoOrganizationId

The identifier associated with the organization.

Type: String


Required: NoState

The state associated with the organization.

Type: String


Required: No



123

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/OrganizationSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/OrganizationSummary

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/OrganizationSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/OrganizationSummary

Amazon WorkMail API ReferenceOrganizationSummary

124

Amazon WorkMail API ReferencePermission

PermissionService: Amazon WorkMail

Permission granted to a user, group, or resource to access a certain aspect of another user, group, orresource mailbox.

ContentsGranteeId

The identifier of the user, group, or resource to which the permissions are granted.

Type: String


Required: YesGranteeType

The type of user, group, or resource referred to in GranteeId.

Type: String


Required: YesPermissionValues

The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner ofthe mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the granteeto send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physicalsender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective ofother folder-level permissions set on the mailbox.


Valid Values: FULL_ACCESS | SEND_AS | SEND_ON_BEHALF

Required: Yes



125

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/Permission

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/Permission

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/Permission

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/Permission

Amazon WorkMail API ReferenceResource

ResourceService: Amazon WorkMail

The representation of a resource.


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

Type: Timestamp

Required: NoEmail

The email of the resource.

Type: String




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

Type: Timestamp

Required: NoId

The identifier of the resource.

Type: String


Required: NoName

The name of the resource.

Type: String



Required: NoState

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

Type: String


126

Amazon WorkMail API ReferenceResource

Required: NoType

The type of the resource: equipment or room.

Type: String


Required: No



127

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/Resource

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/Resource

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/Resource

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/Resource

Amazon WorkMail API ReferenceTag

TagService: Amazon WorkMail

Describes a tag applied to a resource.

ContentsKey

The key of the tag.

Type: String


Required: YesValue

The value of the tag.

Type: String


Required: Yes



128

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/Tag

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/Tag

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/Tag

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/Tag

Amazon WorkMail API ReferenceUser

UserService: Amazon WorkMail

The representation of an Amazon WorkMail user.


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

Type: Timestamp

Required: NoDisplayName

The display name of the user.

Type: String


Required: NoEmail

The email of the user.

Type: String




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

Type: Timestamp

Required: NoId

The identifier of the user.

Type: String


Required: NoName

The name of the user.

Type: String



129

Amazon WorkMail API ReferenceUser

Required: NoState

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

Type: String


Required: NoUserRole

The role of the user.

Type: String

Valid Values: USER | RESOURCE | SYSTEM_USER

Required: No



130

https://docs.aws.amazon.com/goto/SdkForCpp/workmail-2017-10-01/User

https://docs.aws.amazon.com/goto/SdkForGoV1/workmail-2017-10-01/User

https://docs.aws.amazon.com/goto/SdkForJava/workmail-2017-10-01/User

https://docs.aws.amazon.com/goto/SdkForRubyV3/workmail-2017-10-01/User


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is

131

http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional

132

http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.


133


MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.


134

amazon workmail - api reference · 2020-02-13 · amazon workmail api reference amazon's...

Documents