amazonaws.com – workmail

OpenAPI apis-guru cloud

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.

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:workmail/2017-10-01.json
Provider: amazonaws.com:workmail / workmail
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/openapi.yaml

Tools (82)

Extracted live via the executor SDK.

xAmzTargetWorkMailServiceAssociateDelegateToResource.associateDelegateToResource

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

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

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
xAmzTargetWorkMailServiceCancelMailboxExportJob.cancelMailboxExportJob

Cancels a mailbox export job.

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

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

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
xAmzTargetWorkMailServiceCreateGroup.createGroup

Creates a group that can be used in WorkMail by calling the RegisterToWorkMail [blocked] operation.
xAmzTargetWorkMailServiceCreateImpersonationRole.createImpersonationRole

Creates an impersonation role for the given WorkMail organization.

Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.
xAmzTargetWorkMailServiceCreateMobileDeviceAccessRule.createMobileDeviceAccessRule

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

Creates a new 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 WorkMail directory for you. For more information, see in the WorkMail Administrator Guide.

You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see and in the WorkMail Administrator Guide.

Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
xAmzTargetWorkMailServiceCreateResource.createResource

Creates a new WorkMail resource.
xAmzTargetWorkMailServiceCreateUser.createUser

Creates a user who can be used in WorkMail by calling the RegisterToWorkMail [blocked] operation.
xAmzTargetWorkMailServiceDeleteAccessControlRule.deleteAccessControlRule

Deletes an access control rule for the specified WorkMail organization.

Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
xAmzTargetWorkMailServiceDeleteAlias.deleteAlias

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

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
xAmzTargetWorkMailServiceDeleteEmailMonitoringConfiguration.deleteEmailMonitoringConfiguration

Deletes the email monitoring configuration for a specified organization.
xAmzTargetWorkMailServiceDeleteGroup.deleteGroup

Deletes a group from WorkMail.
xAmzTargetWorkMailServiceDeleteImpersonationRole.deleteImpersonationRole

Deletes an impersonation role for the given WorkMail organization.
xAmzTargetWorkMailServiceDeleteMailboxPermissions.deleteMailboxPermissions

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

Deletes the mobile device access override for the given WorkMail organization, user, and device.

Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
xAmzTargetWorkMailServiceDeleteMobileDeviceAccessRule.deleteMobileDeviceAccessRule

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

Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
xAmzTargetWorkMailServiceDeleteOrganization.deleteOrganization

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see in the WorkMail Administrator Guide.
xAmzTargetWorkMailServiceDeleteResource.deleteResource

Deletes the specified resource.
xAmzTargetWorkMailServiceDeleteRetentionPolicy.deleteRetentionPolicy

Deletes the specified retention policy from the specified organization.
xAmzTargetWorkMailServiceDeleteUser.deleteUser

Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser [blocked] 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.
xAmzTargetWorkMailServiceDeregisterFromWorkMail.deregisterFromWorkMail

Mark a user, group, or resource as no longer used in 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.
xAmzTargetWorkMailServiceDeregisterMailDomain.deregisterMailDomain

Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
xAmzTargetWorkMailServiceDescribeEmailMonitoringConfiguration.describeEmailMonitoringConfiguration

Describes the current email monitoring configuration for a specified organization.
xAmzTargetWorkMailServiceDescribeGroup.describeGroup

Returns the data available for the group.
xAmzTargetWorkMailServiceDescribeInboundDmarcSettings.describeInboundDmarcSettings

Lists the settings in a DMARC policy for a specified organization.
xAmzTargetWorkMailServiceDescribeMailboxExportJob.describeMailboxExportJob

Describes the current status of a mailbox export job.
xAmzTargetWorkMailServiceDescribeOrganization.describeOrganization

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

Returns the data available for the resource.
xAmzTargetWorkMailServiceDescribeUser.describeUser

Provides information regarding the user.
xAmzTargetWorkMailServiceDisassociateDelegateFromResource.disassociateDelegateFromResource

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

Removes a member from a group.
xAmzTargetWorkMailServiceGetAccessControlEffect.getAccessControlEffect

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
xAmzTargetWorkMailServiceGetDefaultRetentionPolicy.getDefaultRetentionPolicy

Gets the default retention policy details for the specified organization.
xAmzTargetWorkMailServiceGetImpersonationRole.getImpersonationRole

Gets the impersonation role details for the given WorkMail organization.
xAmzTargetWorkMailServiceGetImpersonationRoleEffect.getImpersonationRoleEffect

Tests whether the given impersonation role can impersonate a target user.
xAmzTargetWorkMailServiceGetMailboxDetails.getMailboxDetails

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

Gets details for a mail domain, including domain records required to configure your domain with recommended security.
xAmzTargetWorkMailServiceGetMobileDeviceAccessEffect.getMobileDeviceAccessEffect

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 WorkMail organization for a particular user's attributes.
xAmzTargetWorkMailServiceGetMobileDeviceAccessOverride.getMobileDeviceAccessOverride

Gets the mobile device access override for the given WorkMail organization, user, and device.
xAmzTargetWorkMailServiceListAccessControlRules.listAccessControlRules

Lists the access control rules for the specified organization.
xAmzTargetWorkMailServiceListAliases.listAliases

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

List all the AvailabilityConfiguration's for the given WorkMail organization.
xAmzTargetWorkMailServiceListGroupMembers.listGroupMembers

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

Returns summaries of the organization's groups.
xAmzTargetWorkMailServiceListImpersonationRoles.listImpersonationRoles

Lists all the impersonation roles for the given WorkMail organization.
xAmzTargetWorkMailServiceListMailboxExportJobs.listMailboxExportJobs

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

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

Lists the mail domains in a given WorkMail organization.
xAmzTargetWorkMailServiceListMobileDeviceAccessOverrides.listMobileDeviceAccessOverrides

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
xAmzTargetWorkMailServiceListMobileDeviceAccessRules.listMobileDeviceAccessRules

Lists the mobile device access rules for the specified WorkMail organization.
xAmzTargetWorkMailServiceListOrganizations.listOrganizations

Returns summaries of the customer's organizations.
xAmzTargetWorkMailServiceListResourceDelegates.listResourceDelegates

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

Returns summaries of the organization's resources.
xAmzTargetWorkMailServiceListTagsForResource.listTagsForResource

Lists the tags applied to an WorkMail organization resource.
xAmzTargetWorkMailServiceListUsers.listUsers

Returns summaries of the organization's users.
xAmzTargetWorkMailServicePutAccessControlRule.putAccessControlRule

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, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
xAmzTargetWorkMailServicePutEmailMonitoringConfiguration.putEmailMonitoringConfiguration

Creates or updates the email monitoring configuration for a specified organization.
xAmzTargetWorkMailServicePutInboundDmarcSettings.putInboundDmarcSettings

Enables or disables a DMARC policy for a given organization.
xAmzTargetWorkMailServicePutMailboxPermissions.putMailboxPermissions

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

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
xAmzTargetWorkMailServicePutRetentionPolicy.putRetentionPolicy

Puts a retention policy to the specified organization.
xAmzTargetWorkMailServiceRegisterMailDomain.registerMailDomain

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
xAmzTargetWorkMailServiceRegisterToWorkMail.registerToWorkMail

Registers an existing and disabled user, group, or resource for 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 . The equivalent console functionality for this operation is Enable.

Users can either be created by calling the CreateUser [blocked] API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail [blocked].
xAmzTargetWorkMailServiceResetPassword.resetPassword

Allows the administrator to reset the password for a user.
xAmzTargetWorkMailServiceStartMailboxExportJob.startMailboxExportJob

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 in the WorkMail Administrator Guide.
xAmzTargetWorkMailServiceTagResource.tagResource

Applies the specified tags to the specified WorkMailorganization resource.
xAmzTargetWorkMailServiceTestAvailabilityConfiguration.testAvailabilityConfiguration

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.

The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.
xAmzTargetWorkMailServiceUntagResource.untagResource

Untags the specified tags from the specified WorkMail organization resource.
xAmzTargetWorkMailServiceUpdateAvailabilityConfiguration.updateAvailabilityConfiguration

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
xAmzTargetWorkMailServiceUpdateDefaultMailDomain.updateDefaultMailDomain

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
xAmzTargetWorkMailServiceUpdateImpersonationRole.updateImpersonationRole

Updates an impersonation role for the given WorkMail organization.
xAmzTargetWorkMailServiceUpdateMailboxQuota.updateMailboxQuota

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

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

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.
xAmzTargetWorkMailServiceUpdateResource.updateResource

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource [blocked] call. The dataset in the request should be the one expected when performing another DescribeResource call.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools