Expand description
Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in 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 the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (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, as well as give users the ability to grant access on a selective basis using the IAM model.
If you’re using the service, you’re probably looking for WorkmailClient and Workmail.
Structs§
- Access
Control Rule A rule that controls access to an Amazon WorkMail organization.
- Associate
Delegate ToResource Request - Associate
Delegate ToResource Response - Associate
Member ToGroup Request - Associate
Member ToGroup Response - Booking
Options At least one delegate must be associated to the resource to disable automatic replies from the resource.
- Cancel
Mailbox Export JobRequest - Cancel
Mailbox Export JobResponse - Create
Alias Request - Create
Alias Response - Create
Group Request - Create
Group Response - Create
Mobile Device Access Rule Request - Create
Mobile Device Access Rule Response - Create
Organization Request - Create
Organization Response - Create
Resource Request - Create
Resource Response - Create
User Request - Create
User Response - Delegate
The name of the attribute, which is one of the values defined in the UserAttribute enumeration.
- Delete
Access Control Rule Request - Delete
Access Control Rule Response - Delete
Alias Request - Delete
Alias Response - Delete
Group Request - Delete
Group Response - Delete
Mailbox Permissions Request - Delete
Mailbox Permissions Response - Delete
Mobile Device Access Rule Request - Delete
Mobile Device Access Rule Response - Delete
Organization Request - Delete
Organization Response - Delete
Resource Request - Delete
Resource Response - Delete
Retention Policy Request - Delete
Retention Policy Response - Delete
User Request - Delete
User Response - Deregister
From Work Mail Request - Deregister
From Work Mail Response - Describe
Group Request - Describe
Group Response - Describe
Mailbox Export JobRequest - Describe
Mailbox Export JobResponse - Describe
Organization Request - Describe
Organization Response - Describe
Resource Request - Describe
Resource Response - Describe
User Request - Describe
User Response - Disassociate
Delegate From Resource Request - Disassociate
Delegate From Resource Response - Disassociate
Member From Group Request - Disassociate
Member From Group Response - Domain
The domain to associate with an Amazon WorkMail organization.
When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the Amazon WorkMail Administrator Guide.
- Folder
Configuration The configuration applied to an organization's folders by its retention policy.
- GetAccess
Control Effect Request - GetAccess
Control Effect Response - GetDefault
Retention Policy Request - GetDefault
Retention Policy Response - GetMailbox
Details Request - GetMailbox
Details Response - GetMobile
Device Access Effect Request - GetMobile
Device Access Effect Response - Group
The representation of an Amazon WorkMail group.
- List
Access Control Rules Request - List
Access Control Rules Response - List
Aliases Request - List
Aliases Response - List
Group Members Request - List
Group Members Response - List
Groups Request - List
Groups Response - List
Mailbox Export Jobs Request - List
Mailbox Export Jobs Response - List
Mailbox Permissions Request - List
Mailbox Permissions Response - List
Mobile Device Access Rules Request - List
Mobile Device Access Rules Response - List
Organizations Request - List
Organizations Response - List
Resource Delegates Request - List
Resource Delegates Response - List
Resources Request - List
Resources Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Users Request - List
Users Response - Mailbox
Export Job The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.
- Member
The representation of a user or group.
- Mobile
Device Access Matched Rule The rule that a simulated user matches.
- Mobile
Device Access Rule A rule that controls access to mobile devices for an Amazon WorkMail group.
- Organization
Summary The representation of an organization.
- Permission
Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.
- PutAccess
Control Rule Request - PutAccess
Control Rule Response - PutMailbox
Permissions Request - PutMailbox
Permissions Response - PutRetention
Policy Request - PutRetention
Policy Response - Register
ToWork Mail Request - Register
ToWork Mail Response - Reset
Password Request - Reset
Password Response - Resource
The representation of a resource.
- Start
Mailbox Export JobRequest - Start
Mailbox Export JobResponse - Tag
Describes a tag applied to a resource.
- TagResource
Request - TagResource
Response - Untag
Resource Request - Untag
Resource Response - Update
Mailbox Quota Request - Update
Mailbox Quota Response - Update
Mobile Device Access Rule Request - Update
Mobile Device Access Rule Response - Update
Primary Email Address Request - Update
Primary Email Address Response - Update
Resource Request - Update
Resource Response - User
The representation of an Amazon WorkMail user.
- Workmail
Client - A client for the Amazon WorkMail API.
Enums§
- Associate
Delegate ToResource Error - Errors returned by AssociateDelegateToResource
- Associate
Member ToGroup Error - Errors returned by AssociateMemberToGroup
- Cancel
Mailbox Export JobError - Errors returned by CancelMailboxExportJob
- Create
Alias Error - Errors returned by CreateAlias
- Create
Group Error - Errors returned by CreateGroup
- Create
Mobile Device Access Rule Error - Errors returned by CreateMobileDeviceAccessRule
- Create
Organization Error - Errors returned by CreateOrganization
- Create
Resource Error - Errors returned by CreateResource
- Create
User Error - Errors returned by CreateUser
- Delete
Access Control Rule Error - Errors returned by DeleteAccessControlRule
- Delete
Alias Error - Errors returned by DeleteAlias
- Delete
Group Error - Errors returned by DeleteGroup
- Delete
Mailbox Permissions Error - Errors returned by DeleteMailboxPermissions
- Delete
Mobile Device Access Rule Error - Errors returned by DeleteMobileDeviceAccessRule
- Delete
Organization Error - Errors returned by DeleteOrganization
- Delete
Resource Error - Errors returned by DeleteResource
- Delete
Retention Policy Error - Errors returned by DeleteRetentionPolicy
- Delete
User Error - Errors returned by DeleteUser
- Deregister
From Work Mail Error - Errors returned by DeregisterFromWorkMail
- Describe
Group Error - Errors returned by DescribeGroup
- Describe
Mailbox Export JobError - Errors returned by DescribeMailboxExportJob
- Describe
Organization Error - Errors returned by DescribeOrganization
- Describe
Resource Error - Errors returned by DescribeResource
- Describe
User Error - Errors returned by DescribeUser
- Disassociate
Delegate From Resource Error - Errors returned by DisassociateDelegateFromResource
- Disassociate
Member From Group Error - Errors returned by DisassociateMemberFromGroup
- GetAccess
Control Effect Error - Errors returned by GetAccessControlEffect
- GetDefault
Retention Policy Error - Errors returned by GetDefaultRetentionPolicy
- GetMailbox
Details Error - Errors returned by GetMailboxDetails
- GetMobile
Device Access Effect Error - Errors returned by GetMobileDeviceAccessEffect
- List
Access Control Rules Error - Errors returned by ListAccessControlRules
- List
Aliases Error - Errors returned by ListAliases
- List
Group Members Error - Errors returned by ListGroupMembers
- List
Groups Error - Errors returned by ListGroups
- List
Mailbox Export Jobs Error - Errors returned by ListMailboxExportJobs
- List
Mailbox Permissions Error - Errors returned by ListMailboxPermissions
- List
Mobile Device Access Rules Error - Errors returned by ListMobileDeviceAccessRules
- List
Organizations Error - Errors returned by ListOrganizations
- List
Resource Delegates Error - Errors returned by ListResourceDelegates
- List
Resources Error - Errors returned by ListResources
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Users Error - Errors returned by ListUsers
- PutAccess
Control Rule Error - Errors returned by PutAccessControlRule
- PutMailbox
Permissions Error - Errors returned by PutMailboxPermissions
- PutRetention
Policy Error - Errors returned by PutRetentionPolicy
- Register
ToWork Mail Error - Errors returned by RegisterToWorkMail
- Reset
Password Error - Errors returned by ResetPassword
- Start
Mailbox Export JobError - Errors returned by StartMailboxExportJob
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Mailbox Quota Error - Errors returned by UpdateMailboxQuota
- Update
Mobile Device Access Rule Error - Errors returned by UpdateMobileDeviceAccessRule
- Update
Primary Email Address Error - Errors returned by UpdatePrimaryEmailAddress
- Update
Resource Error - Errors returned by UpdateResource
Traits§
- Workmail
- Trait representing the capabilities of the Amazon WorkMail API. Amazon WorkMail clients implement this trait.