AWS.WorkMail (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

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

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

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

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

Creates a new mobile device access rule for the specified Amazon WorkMail organization.

Creates a new Amazon WorkMail organization.

Creates a new Amazon WorkMail resource.

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

Deletes an access control rule for the specified WorkMail organization.

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

Deletes a group from Amazon WorkMail.

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

Deletes a mobile device access rule for the specified Amazon WorkMail organization.

Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization.

Deletes the specified resource.

Deletes the specified retention policy from the specified 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 the data available for the group.

Describes the current status of a mailbox export job.

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

Returns the data available for the resource.

Provides information regarding the user.

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

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

Gets the default retention policy details for the specified organization.

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

Simulates the effect of the mobile device access rules for the given attributes of a sample access event.

Lists the access control rules for the specified organization.

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

Returns an overview of the members of a group.

Returns summaries of the organization's groups.

Lists the mailbox export jobs started for the specified organization within the last seven days.

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

Lists the mobile device access rules for the specified Amazon WorkMail organization.

Returns summaries of the customer's organizations.

Lists the delegates associated with a resource.

Returns summaries of the organization's resources.

Lists the tags applied to an Amazon WorkMail organization resource.

Returns summaries of the organization's users.

Adds a new access control rule for the specified organization.

Sets permissions for a user, group, or resource.

Puts a retention policy to the specified organization.

Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities.

Allows the administrator to reset the password for a user.

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.

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

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

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

Updates a mobile device access rule for the specified Amazon WorkMail organization.

Updates the primary email for a user, group, or resource.

Updates data for the resource.

Link to this section Functions

Link to this function

associate_delegate_to_resource(client, input, options \\ [])

View Source

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

Link to this function

associate_member_to_group(client, input, options \\ [])

View Source

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

Link to this function

cancel_mailbox_export_job(client, input, options \\ [])

View Source

Cancels a mailbox export job.

If the mailbox export job is near completion, it might not be possible to cancel it.

Link to this function

create_alias(client, input, options \\ [])

View Source

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

Link to this function

create_group(client, input, options \\ [])

View Source

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

Link to this function

create_mobile_device_access_rule(client, input, options \\ [])

View Source

Creates a new mobile device access rule for the specified Amazon WorkMail organization.

Link to this function

create_organization(client, input, options \\ [])

View Source

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.

Link to this function

create_resource(client, input, options \\ [])

View Source

Creates a new Amazon WorkMail resource.

Link to this function

create_user(client, input, options \\ [])

View Source

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

Link to this function

delete_access_control_rule(client, input, options \\ [])

View Source

Deletes an access control rule for the specified WorkMail organization.

Link to this function

delete_alias(client, input, options \\ [])

View Source

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

Link to this function

delete_group(client, input, options \\ [])

View Source

Deletes a group from Amazon WorkMail.

Link to this function

delete_mailbox_permissions(client, input, options \\ [])

View Source

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

Link to this function

delete_mobile_device_access_rule(client, input, options \\ [])

View Source

Deletes a mobile device access rule for the specified Amazon WorkMail organization.

Link to this function

delete_organization(client, input, options \\ [])

View Source

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.

Link to this function

delete_resource(client, input, options \\ [])

View Source

Deletes the specified resource.

Link to this function

delete_retention_policy(client, input, options \\ [])

View Source

Deletes the specified retention policy from the specified organization.

Link to this function

delete_user(client, input, options \\ [])

View Source

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.

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

Link to this function

deregister_from_work_mail(client, input, options \\ [])

View Source

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.

Link to this function

describe_group(client, input, options \\ [])

View Source

Returns the data available for the group.

Link to this function

describe_mailbox_export_job(client, input, options \\ [])

View Source

Describes the current status of a mailbox export job.

Link to this function

describe_organization(client, input, options \\ [])

View Source

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

Link to this function

describe_resource(client, input, options \\ [])

View Source

Returns the data available for the resource.

Link to this function

describe_user(client, input, options \\ [])

View Source

Provides information regarding the user.

Link to this function

disassociate_delegate_from_resource(client, input, options \\ [])

View Source

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

Link to this function

disassociate_member_from_group(client, input, options \\ [])

View Source

Removes a member from a group.

Link to this function

get_access_control_effect(client, input, options \\ [])

View Source

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

Link to this function

get_default_retention_policy(client, input, options \\ [])

View Source

Gets the default retention policy details for the specified organization.

Link to this function

get_mailbox_details(client, input, options \\ [])

View Source

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

Link to this function

get_mobile_device_access_effect(client, input, options \\ [])

View Source

Simulates the effect of the mobile device access rules for the given attributes of a sample access event.

Use this method to test the effects of the current set of mobile device access rules for the Amazon WorkMail organization for a particular user's attributes.

Link to this function

list_access_control_rules(client, input, options \\ [])

View Source

Lists the access control rules for the specified organization.

Link to this function

list_aliases(client, input, options \\ [])

View Source

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

Link to this function

list_group_members(client, input, options \\ [])

View Source

Returns an overview of the members of a group.

Users and groups can be members of a group.

Link to this function

list_groups(client, input, options \\ [])

View Source

Returns summaries of the organization's groups.

Link to this function

list_mailbox_export_jobs(client, input, options \\ [])

View Source

Lists the mailbox export jobs started for the specified organization within the last seven days.

Link to this function

list_mailbox_permissions(client, input, options \\ [])

View Source

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

Link to this function

list_mobile_device_access_rules(client, input, options \\ [])

View Source

Lists the mobile device access rules for the specified Amazon WorkMail organization.

Link to this function

list_organizations(client, input, options \\ [])

View Source

Returns summaries of the customer's organizations.

Link to this function

list_resource_delegates(client, input, options \\ [])

View Source

Lists the delegates associated with a resource.

Users and groups can be resource delegates and answer requests on behalf of the resource.

Link to this function

list_resources(client, input, options \\ [])

View Source

Returns summaries of the organization's resources.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists the tags applied to an Amazon WorkMail organization resource.

Link to this function

list_users(client, input, options \\ [])

View Source

Returns summaries of the organization's users.

Link to this function

put_access_control_rule(client, input, options \\ [])

View Source

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.

Link to this function

put_mailbox_permissions(client, input, options \\ [])

View Source

Sets permissions for a user, group, or resource.

This replaces any pre-existing permissions.

Link to this function

put_retention_policy(client, input, options \\ [])

View Source

Puts a retention policy to the specified organization.

Link to this function

register_to_work_mail(client, input, options \\ [])

View Source

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 the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

Link to this function

reset_password(client, input, options \\ [])

View Source

Allows the administrator to reset the password for a user.

Link to this function

start_mailbox_export_job(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

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

Link to this function

untag_resource(client, input, options \\ [])

View Source

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

Link to this function

update_mailbox_quota(client, input, options \\ [])

View Source

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

Link to this function

update_mobile_device_access_rule(client, input, options \\ [])

View Source

Updates a mobile device access rule for the specified Amazon WorkMail organization.

Link to this function

update_primary_email_address(client, input, options \\ [])

View Source

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.

Link to this function

update_resource(client, input, options \\ [])

View Source

Updates data for the resource.

To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.