View Source aws_workmail (aws v0.3.1)
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
Link to this section Summary
Functions
Cancels a mailbox export job.
RegisterToWorkMail operation.Creates a new Amazon WorkMail organization.
RegisterToWorkMail operation.Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization.
Deletes a user from Amazon WorkMail and all subsequent systems.
Mark a user, group, or resource as no longer used in Amazon WorkMail.
Returns an overview of the members of a group.
Lists the delegates associated with a resource.
Adds a new access control rule for the specified organization.
Sets permissions for a user, group, or resource.
Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities.
Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket.
Updates the primary email for a user, group, or resource.
Updates data for the resource.
Link to this section Functions
Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.RegisterToWorkMail operation.
Creates a new Amazon WorkMail organization.
Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the Amazon WorkMail Administrator Guide.
Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.RegisterToWorkMail operation.
Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization.
You can choose whether to delete the associated directory. For more information, see Removing an organization in the Amazon WorkMail Administrator Guide.Deletes a user from Amazon WorkMail and all subsequent systems.
Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.
Mark a user, group, or resource as no longer used in Amazon WorkMail.
This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.Returns an overview of the members of a group.
Users and groups can be members of a group.Lists the delegates associated with a resource.
Users and groups can be resource delegates and answer requests on behalf of the resource.Adds a new access control rule for the specified organization.
The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.Sets permissions for a user, group, or resource.
This replaces any pre-existing permissions.Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities.
It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
Users can either be created by calling theCreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket.
For more information, see Exporting mailbox content in the Amazon WorkMail Administrator Guide.Updates the primary email for a user, group, or resource.
The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.Updates data for the resource.
To have the latest information, it must be preceded by aDescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.