flowground for Business Customers
Amazon WorkMail
Connector for

Amazon WorkMail

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 their native iOS and Android email applications. You can integrate Amazon 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 Amazon WorkMail API is designed for the following scenarios:

  • Listing and describing organizations

  • Managing users

  • Managing groups

  • Managing resources

All Amazon WorkMail API actions are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkMail site, the IAM user gains full administrative visibility into the entire Amazon 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.

Specifications
  • Category: Office
  • Provider: n/a
  • Used API: -
  • Managed: -
  • License: Apache License 2.0
  • Programmed with: javascript
Prices

For productive use you need a project room, which is subject to a fee.

Prices & Editions

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

AssociateDelegateToResource

Adds a member to the resource's set of delegates.

OnInit
./lib/actions/AssociateDelegateToResource.js
OnStartup
-
OnClose
-

Attributes

-

AssociateMemberToGroup

Adds a member to the group's set.

OnInit
./lib/actions/AssociateMemberToGroup.js
OnStartup
-
OnClose
-

Attributes

-

CreateAlias

Adds an alias to the set of a given member of Amazon WorkMail.

OnInit
./lib/actions/CreateAlias.js
OnStartup
-
OnClose
-

Attributes

-

CreateGroup

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

OnInit
./lib/actions/CreateGroup.js
OnStartup
-
OnClose
-

Attributes

-

CreateResource

Creates a new Amazon WorkMail resource. The available types are equipment and room.

OnInit
./lib/actions/CreateResource.js
OnStartup
-
OnClose
-

Attributes

-

CreateUser

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

OnInit
./lib/actions/CreateUser.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAlias

Remove the alias from a set of aliases for a given user.

OnInit
./lib/actions/DeleteAlias.js
OnStartup
-
OnClose
-

Attributes

-

DeleteGroup

Deletes a group from Amazon WorkMail.

OnInit
./lib/actions/DeleteGroup.js
OnStartup
-
OnClose
-

Attributes

-

DeleteMailboxPermissions

Deletes permissions granted to a user or group.

OnInit
./lib/actions/DeleteMailboxPermissions.js
OnStartup
-
OnClose
-

Attributes

-

DeleteResource

Deletes the specified resource.

OnInit
./lib/actions/DeleteResource.js
OnStartup
-
OnClose
-

Attributes

-

DeleteUser

Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.

OnInit
./lib/actions/DeleteUser.js
OnStartup
-
OnClose
-

Attributes

-

DeregisterFromWorkMail

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

OnInit
./lib/actions/DeregisterFromWorkMail.js
OnStartup
-
OnClose
-

Attributes

-

DescribeGroup

Returns the data available for the group.

OnInit
./lib/actions/DescribeGroup.js
OnStartup
-
OnClose
-

Attributes

-

DescribeOrganization

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

OnInit
./lib/actions/DescribeOrganization.js
OnStartup
-
OnClose
-

Attributes

-

DescribeResource

Returns the data available for the resource.

OnInit
./lib/actions/DescribeResource.js
OnStartup
-
OnClose
-

Attributes

-

DescribeUser

Provides information regarding the user.

OnInit
./lib/actions/DescribeUser.js
OnStartup
-
OnClose
-

Attributes

-

DisassociateDelegateFromResource

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

OnInit
./lib/actions/DisassociateDelegateFromResource.js
OnStartup
-
OnClose
-

Attributes

-

DisassociateMemberFromGroup

Removes a member from a group.

OnInit
./lib/actions/DisassociateMemberFromGroup.js
OnStartup
-
OnClose
-

Attributes

-

ListAliases

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

OnInit
./lib/actions/ListAliases.js
OnStartup
-
OnClose
-

Attributes

-

ListGroupMembers

Returns an overview of the members of a group.

OnInit
./lib/actions/ListGroupMembers.js
OnStartup
-
OnClose
-

Attributes

-

ListGroups

Returns summaries of the organization's groups.

OnInit
./lib/actions/ListGroups.js
OnStartup
-
OnClose
-

Attributes

-

ListMailboxPermissions

Lists the mailbox permissions associated with a mailbox.

OnInit
./lib/actions/ListMailboxPermissions.js
OnStartup
-
OnClose
-

Attributes

-

ListOrganizations

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

OnInit
./lib/actions/ListOrganizations.js
OnStartup
-
OnClose
-

Attributes

-

ListResourceDelegates

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

OnInit
./lib/actions/ListResourceDelegates.js
OnStartup
-
OnClose
-

Attributes

-

ListResources

Returns summaries of the organization's resources.

OnInit
./lib/actions/ListResources.js
OnStartup
-
OnClose
-

Attributes

-

ListUsers

Returns summaries of the organization's users.

OnInit
./lib/actions/ListUsers.js
OnStartup
-
OnClose
-

Attributes

-

PutMailboxPermissions

Sets permissions for a user or group. This replaces any pre-existing permissions set for the entity.

OnInit
./lib/actions/PutMailboxPermissions.js
OnStartup
-
OnClose
-

Attributes

-

RegisterToWorkMail

Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity 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 or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

OnInit
./lib/actions/RegisterToWorkMail.js
OnStartup
-
OnClose
-

Attributes

-

ResetPassword

Allows the administrator to reset the password for a user.

OnInit
./lib/actions/ResetPassword.js
OnStartup
-
OnClose
-

Attributes

-

UpdatePrimaryEmailAddress

Updates the primary email for an entity. 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.

OnInit
./lib/actions/UpdatePrimaryEmailAddress.js
OnStartup
-
OnClose
-

Attributes

-

UpdateResource

Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.

OnInit
./lib/actions/UpdateResource.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment

You have any technical questions about the platform?

Technical documentation of the platform, online tutorials and more can be found here.

We are happy to bring you together directly with the flowground experts:

To contact form