@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonWorkMailAsync extends AmazonWorkMail
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonWorkMailAsync instead.
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.
ENDPOINT_PREFIXassociateDelegateToResource, associateMemberToGroup, assumeImpersonationRole, cancelMailboxExportJob, createAlias, createAvailabilityConfiguration, createGroup, createImpersonationRole, createMobileDeviceAccessRule, createOrganization, createResource, createUser, deleteAccessControlRule, deleteAlias, deleteAvailabilityConfiguration, deleteEmailMonitoringConfiguration, deleteGroup, deleteImpersonationRole, deleteMailboxPermissions, deleteMobileDeviceAccessOverride, deleteMobileDeviceAccessRule, deleteOrganization, deleteResource, deleteRetentionPolicy, deleteUser, deregisterFromWorkMail, deregisterMailDomain, describeEmailMonitoringConfiguration, describeEntity, describeGroup, describeInboundDmarcSettings, describeMailboxExportJob, describeOrganization, describeResource, describeUser, disassociateDelegateFromResource, disassociateMemberFromGroup, getAccessControlEffect, getCachedResponseMetadata, getDefaultRetentionPolicy, getImpersonationRole, getImpersonationRoleEffect, getMailboxDetails, getMailDomain, getMobileDeviceAccessEffect, getMobileDeviceAccessOverride, listAccessControlRules, listAliases, listAvailabilityConfigurations, listGroupMembers, listGroups, listGroupsForEntity, listImpersonationRoles, listMailboxExportJobs, listMailboxPermissions, listMailDomains, listMobileDeviceAccessOverrides, listMobileDeviceAccessRules, listOrganizations, listResourceDelegates, listResources, listTagsForResource, listUsers, putAccessControlRule, putEmailMonitoringConfiguration, putInboundDmarcSettings, putMailboxPermissions, putMobileDeviceAccessOverride, putRetentionPolicy, registerMailDomain, registerToWorkMail, resetPassword, shutdown, startMailboxExportJob, tagResource, testAvailabilityConfiguration, untagResource, updateAvailabilityConfiguration, updateDefaultMailDomain, updateGroup, updateImpersonationRole, updateMailboxQuota, updateMobileDeviceAccessRule, updatePrimaryEmailAddress, updateResource, updateUserFuture<AssociateDelegateToResourceResult> associateDelegateToResourceAsync(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member (user or group) to the resource's set of delegates.
associateDelegateToResourceRequest - Future<AssociateDelegateToResourceResult> associateDelegateToResourceAsync(AssociateDelegateToResourceRequest associateDelegateToResourceRequest, AsyncHandler<AssociateDelegateToResourceRequest,AssociateDelegateToResourceResult> asyncHandler)
Adds a member (user or group) to the resource's set of delegates.
associateDelegateToResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AssociateMemberToGroupResult> associateMemberToGroupAsync(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member (user or group) to the group's set.
associateMemberToGroupRequest - Future<AssociateMemberToGroupResult> associateMemberToGroupAsync(AssociateMemberToGroupRequest associateMemberToGroupRequest, AsyncHandler<AssociateMemberToGroupRequest,AssociateMemberToGroupResult> asyncHandler)
Adds a member (user or group) to the group's set.
associateMemberToGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AssumeImpersonationRoleResult> assumeImpersonationRoleAsync(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest)
Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
assumeImpersonationRoleRequest - Future<AssumeImpersonationRoleResult> assumeImpersonationRoleAsync(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest, AsyncHandler<AssumeImpersonationRoleRequest,AssumeImpersonationRoleResult> asyncHandler)
Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
assumeImpersonationRoleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CancelMailboxExportJobResult> cancelMailboxExportJobAsync(CancelMailboxExportJobRequest cancelMailboxExportJobRequest)
Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
cancelMailboxExportJobRequest - Future<CancelMailboxExportJobResult> cancelMailboxExportJobAsync(CancelMailboxExportJobRequest cancelMailboxExportJobRequest, AsyncHandler<CancelMailboxExportJobRequest,CancelMailboxExportJobResult> asyncHandler)
Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
cancelMailboxExportJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAliasResult> createAliasAsync(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member (user or group) of WorkMail.
createAliasRequest - Future<CreateAliasResult> createAliasAsync(CreateAliasRequest createAliasRequest, AsyncHandler<CreateAliasRequest,CreateAliasResult> asyncHandler)
Adds an alias to the set of a given member (user or group) of WorkMail.
createAliasRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAvailabilityConfigurationResult> createAvailabilityConfigurationAsync(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest)
Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
createAvailabilityConfigurationRequest - Future<CreateAvailabilityConfigurationResult> createAvailabilityConfigurationAsync(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest, AsyncHandler<CreateAvailabilityConfigurationRequest,CreateAvailabilityConfigurationResult> asyncHandler)
Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
createAvailabilityConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest)
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
createGroupRequest - Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
createGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateImpersonationRoleResult> createImpersonationRoleAsync(CreateImpersonationRoleRequest createImpersonationRoleRequest)
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.
createImpersonationRoleRequest - Future<CreateImpersonationRoleResult> createImpersonationRoleAsync(CreateImpersonationRoleRequest createImpersonationRoleRequest, AsyncHandler<CreateImpersonationRoleRequest,CreateImpersonationRoleResult> asyncHandler)
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.
createImpersonationRoleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateMobileDeviceAccessRuleResult> createMobileDeviceAccessRuleAsync(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest)
Creates a new mobile device access rule for the specified WorkMail organization.
createMobileDeviceAccessRuleRequest - Future<CreateMobileDeviceAccessRuleResult> createMobileDeviceAccessRuleAsync(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest, AsyncHandler<CreateMobileDeviceAccessRuleRequest,CreateMobileDeviceAccessRuleResult> asyncHandler)
Creates a new mobile device access rule for the specified WorkMail organization.
createMobileDeviceAccessRuleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateOrganizationResult> createOrganizationAsync(CreateOrganizationRequest createOrganizationRequest)
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 Adding an organization 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 Adding a domain and Choosing the default domain 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.
createOrganizationRequest - Future<CreateOrganizationResult> createOrganizationAsync(CreateOrganizationRequest createOrganizationRequest, AsyncHandler<CreateOrganizationRequest,CreateOrganizationResult> asyncHandler)
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 Adding an organization 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 Adding a domain and Choosing the default domain 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.
createOrganizationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateResourceResult> createResourceAsync(CreateResourceRequest createResourceRequest)
Creates a new WorkMail resource.
createResourceRequest - Future<CreateResourceResult> createResourceAsync(CreateResourceRequest createResourceRequest, AsyncHandler<CreateResourceRequest,CreateResourceResult> asyncHandler)
Creates a new WorkMail resource.
createResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest)
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
createUserRequest - Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
createUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAccessControlRuleResult> deleteAccessControlRuleAsync(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest)
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.
deleteAccessControlRuleRequest - Future<DeleteAccessControlRuleResult> deleteAccessControlRuleAsync(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest, AsyncHandler<DeleteAccessControlRuleRequest,DeleteAccessControlRuleResult> asyncHandler)
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.
deleteAccessControlRuleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest deleteAliasRequest)
Remove one or more specified aliases from a set of aliases for a given user.
deleteAliasRequest - Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest deleteAliasRequest, AsyncHandler<DeleteAliasRequest,DeleteAliasResult> asyncHandler)
Remove one or more specified aliases from a set of aliases for a given user.
deleteAliasRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAvailabilityConfigurationResult> deleteAvailabilityConfigurationAsync(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest)
Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
deleteAvailabilityConfigurationRequest - Future<DeleteAvailabilityConfigurationResult> deleteAvailabilityConfigurationAsync(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest, AsyncHandler<DeleteAvailabilityConfigurationRequest,DeleteAvailabilityConfigurationResult> asyncHandler)
Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
deleteAvailabilityConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteEmailMonitoringConfigurationResult> deleteEmailMonitoringConfigurationAsync(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest)
Deletes the email monitoring configuration for a specified organization.
deleteEmailMonitoringConfigurationRequest - Future<DeleteEmailMonitoringConfigurationResult> deleteEmailMonitoringConfigurationAsync(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest, AsyncHandler<DeleteEmailMonitoringConfigurationRequest,DeleteEmailMonitoringConfigurationResult> asyncHandler)
Deletes the email monitoring configuration for a specified organization.
deleteEmailMonitoringConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest)
Deletes a group from WorkMail.
deleteGroupRequest - Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
Deletes a group from WorkMail.
deleteGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteImpersonationRoleResult> deleteImpersonationRoleAsync(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest)
Deletes an impersonation role for the given WorkMail organization.
deleteImpersonationRoleRequest - Future<DeleteImpersonationRoleResult> deleteImpersonationRoleAsync(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest, AsyncHandler<DeleteImpersonationRoleRequest,DeleteImpersonationRoleResult> asyncHandler)
Deletes an impersonation role for the given WorkMail organization.
deleteImpersonationRoleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMailboxPermissionsResult> deleteMailboxPermissionsAsync(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest)
Deletes permissions granted to a member (user or group).
deleteMailboxPermissionsRequest - Future<DeleteMailboxPermissionsResult> deleteMailboxPermissionsAsync(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest, AsyncHandler<DeleteMailboxPermissionsRequest,DeleteMailboxPermissionsResult> asyncHandler)
Deletes permissions granted to a member (user or group).
deleteMailboxPermissionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMobileDeviceAccessOverrideResult> deleteMobileDeviceAccessOverrideAsync(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest)
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.
deleteMobileDeviceAccessOverrideRequest - Future<DeleteMobileDeviceAccessOverrideResult> deleteMobileDeviceAccessOverrideAsync(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest, AsyncHandler<DeleteMobileDeviceAccessOverrideRequest,DeleteMobileDeviceAccessOverrideResult> asyncHandler)
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.
deleteMobileDeviceAccessOverrideRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMobileDeviceAccessRuleResult> deleteMobileDeviceAccessRuleAsync(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest)
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.
deleteMobileDeviceAccessRuleRequest - Future<DeleteMobileDeviceAccessRuleResult> deleteMobileDeviceAccessRuleAsync(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest, AsyncHandler<DeleteMobileDeviceAccessRuleRequest,DeleteMobileDeviceAccessRuleResult> asyncHandler)
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.
deleteMobileDeviceAccessRuleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteOrganizationResult> deleteOrganizationAsync(DeleteOrganizationRequest deleteOrganizationRequest)
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 Removing an organization in the WorkMail Administrator Guide.
deleteOrganizationRequest - Future<DeleteOrganizationResult> deleteOrganizationAsync(DeleteOrganizationRequest deleteOrganizationRequest, AsyncHandler<DeleteOrganizationRequest,DeleteOrganizationResult> asyncHandler)
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 Removing an organization in the WorkMail Administrator Guide.
deleteOrganizationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteResourceResult> deleteResourceAsync(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
deleteResourceRequest - Future<DeleteResourceResult> deleteResourceAsync(DeleteResourceRequest deleteResourceRequest, AsyncHandler<DeleteResourceRequest,DeleteResourceResult> asyncHandler)
Deletes the specified resource.
deleteResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRetentionPolicyResult> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
Deletes the specified retention policy from the specified organization.
deleteRetentionPolicyRequest - Future<DeleteRetentionPolicyResult> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest, AsyncHandler<DeleteRetentionPolicyRequest,DeleteRetentionPolicyResult> asyncHandler)
Deletes the specified retention policy from the specified organization.
deleteRetentionPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
Deletes a user from 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.
deleteUserRequest - Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes a user from 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.
deleteUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeregisterFromWorkMailResult> deregisterFromWorkMailAsync(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
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.
deregisterFromWorkMailRequest - Future<DeregisterFromWorkMailResult> deregisterFromWorkMailAsync(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest, AsyncHandler<DeregisterFromWorkMailRequest,DeregisterFromWorkMailResult> asyncHandler)
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.
deregisterFromWorkMailRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeregisterMailDomainResult> deregisterMailDomainAsync(DeregisterMailDomainRequest deregisterMailDomainRequest)
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.
deregisterMailDomainRequest - Future<DeregisterMailDomainResult> deregisterMailDomainAsync(DeregisterMailDomainRequest deregisterMailDomainRequest, AsyncHandler<DeregisterMailDomainRequest,DeregisterMailDomainResult> asyncHandler)
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.
deregisterMailDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEmailMonitoringConfigurationResult> describeEmailMonitoringConfigurationAsync(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest)
Describes the current email monitoring configuration for a specified organization.
describeEmailMonitoringConfigurationRequest - Future<DescribeEmailMonitoringConfigurationResult> describeEmailMonitoringConfigurationAsync(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest, AsyncHandler<DescribeEmailMonitoringConfigurationRequest,DescribeEmailMonitoringConfigurationResult> asyncHandler)
Describes the current email monitoring configuration for a specified organization.
describeEmailMonitoringConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEntityResult> describeEntityAsync(DescribeEntityRequest describeEntityRequest)
Returns basic details about an entity in WorkMail.
describeEntityRequest - Future<DescribeEntityResult> describeEntityAsync(DescribeEntityRequest describeEntityRequest, AsyncHandler<DescribeEntityRequest,DescribeEntityResult> asyncHandler)
Returns basic details about an entity in WorkMail.
describeEntityRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
describeGroupRequest - Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest describeGroupRequest, AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)
Returns the data available for the group.
describeGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeInboundDmarcSettingsResult> describeInboundDmarcSettingsAsync(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest)
Lists the settings in a DMARC policy for a specified organization.
describeInboundDmarcSettingsRequest - Future<DescribeInboundDmarcSettingsResult> describeInboundDmarcSettingsAsync(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest, AsyncHandler<DescribeInboundDmarcSettingsRequest,DescribeInboundDmarcSettingsResult> asyncHandler)
Lists the settings in a DMARC policy for a specified organization.
describeInboundDmarcSettingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeMailboxExportJobResult> describeMailboxExportJobAsync(DescribeMailboxExportJobRequest describeMailboxExportJobRequest)
Describes the current status of a mailbox export job.
describeMailboxExportJobRequest - Future<DescribeMailboxExportJobResult> describeMailboxExportJobAsync(DescribeMailboxExportJobRequest describeMailboxExportJobRequest, AsyncHandler<DescribeMailboxExportJobRequest,DescribeMailboxExportJobResult> asyncHandler)
Describes the current status of a mailbox export job.
describeMailboxExportJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeOrganizationResult> describeOrganizationAsync(DescribeOrganizationRequest describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
describeOrganizationRequest - Future<DescribeOrganizationResult> describeOrganizationAsync(DescribeOrganizationRequest describeOrganizationRequest, AsyncHandler<DescribeOrganizationRequest,DescribeOrganizationResult> asyncHandler)
Provides more information regarding a given organization based on its identifier.
describeOrganizationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeResourceResult> describeResourceAsync(DescribeResourceRequest describeResourceRequest)
Returns the data available for the resource.
describeResourceRequest - Future<DescribeResourceResult> describeResourceAsync(DescribeResourceRequest describeResourceRequest, AsyncHandler<DescribeResourceRequest,DescribeResourceResult> asyncHandler)
Returns the data available for the resource.
describeResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest)
Provides information regarding the user.
describeUserRequest - Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Provides information regarding the user.
describeUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateDelegateFromResourceResult> disassociateDelegateFromResourceAsync(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
disassociateDelegateFromResourceRequest - Future<DisassociateDelegateFromResourceResult> disassociateDelegateFromResourceAsync(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest, AsyncHandler<DisassociateDelegateFromResourceRequest,DisassociateDelegateFromResourceResult> asyncHandler)
Removes a member from the resource's set of delegates.
disassociateDelegateFromResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateMemberFromGroupResult> disassociateMemberFromGroupAsync(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
Removes a member from a group.
disassociateMemberFromGroupRequest - Future<DisassociateMemberFromGroupResult> disassociateMemberFromGroupAsync(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest, AsyncHandler<DisassociateMemberFromGroupRequest,DisassociateMemberFromGroupResult> asyncHandler)
Removes a member from a group.
disassociateMemberFromGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAccessControlEffectResult> getAccessControlEffectAsync(GetAccessControlEffectRequest getAccessControlEffectRequest)
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.
getAccessControlEffectRequest - Future<GetAccessControlEffectResult> getAccessControlEffectAsync(GetAccessControlEffectRequest getAccessControlEffectRequest, AsyncHandler<GetAccessControlEffectRequest,GetAccessControlEffectResult> asyncHandler)
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.
getAccessControlEffectRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDefaultRetentionPolicyResult> getDefaultRetentionPolicyAsync(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest)
Gets the default retention policy details for the specified organization.
getDefaultRetentionPolicyRequest - Future<GetDefaultRetentionPolicyResult> getDefaultRetentionPolicyAsync(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest, AsyncHandler<GetDefaultRetentionPolicyRequest,GetDefaultRetentionPolicyResult> asyncHandler)
Gets the default retention policy details for the specified organization.
getDefaultRetentionPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetImpersonationRoleResult> getImpersonationRoleAsync(GetImpersonationRoleRequest getImpersonationRoleRequest)
Gets the impersonation role details for the given WorkMail organization.
getImpersonationRoleRequest - Future<GetImpersonationRoleResult> getImpersonationRoleAsync(GetImpersonationRoleRequest getImpersonationRoleRequest, AsyncHandler<GetImpersonationRoleRequest,GetImpersonationRoleResult> asyncHandler)
Gets the impersonation role details for the given WorkMail organization.
getImpersonationRoleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetImpersonationRoleEffectResult> getImpersonationRoleEffectAsync(GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest)
Tests whether the given impersonation role can impersonate a target user.
getImpersonationRoleEffectRequest - Future<GetImpersonationRoleEffectResult> getImpersonationRoleEffectAsync(GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest, AsyncHandler<GetImpersonationRoleEffectRequest,GetImpersonationRoleEffectResult> asyncHandler)
Tests whether the given impersonation role can impersonate a target user.
getImpersonationRoleEffectRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMailDomainResult> getMailDomainAsync(GetMailDomainRequest getMailDomainRequest)
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
getMailDomainRequest - Future<GetMailDomainResult> getMailDomainAsync(GetMailDomainRequest getMailDomainRequest, AsyncHandler<GetMailDomainRequest,GetMailDomainResult> asyncHandler)
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
getMailDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMailboxDetailsResult> getMailboxDetailsAsync(GetMailboxDetailsRequest getMailboxDetailsRequest)
Requests a user's mailbox details for a specified organization and user.
getMailboxDetailsRequest - Future<GetMailboxDetailsResult> getMailboxDetailsAsync(GetMailboxDetailsRequest getMailboxDetailsRequest, AsyncHandler<GetMailboxDetailsRequest,GetMailboxDetailsResult> asyncHandler)
Requests a user's mailbox details for a specified organization and user.
getMailboxDetailsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMobileDeviceAccessEffectResult> getMobileDeviceAccessEffectAsync(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest)
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.
getMobileDeviceAccessEffectRequest - Future<GetMobileDeviceAccessEffectResult> getMobileDeviceAccessEffectAsync(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest, AsyncHandler<GetMobileDeviceAccessEffectRequest,GetMobileDeviceAccessEffectResult> asyncHandler)
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.
getMobileDeviceAccessEffectRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMobileDeviceAccessOverrideResult> getMobileDeviceAccessOverrideAsync(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest)
Gets the mobile device access override for the given WorkMail organization, user, and device.
getMobileDeviceAccessOverrideRequest - Future<GetMobileDeviceAccessOverrideResult> getMobileDeviceAccessOverrideAsync(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest, AsyncHandler<GetMobileDeviceAccessOverrideRequest,GetMobileDeviceAccessOverrideResult> asyncHandler)
Gets the mobile device access override for the given WorkMail organization, user, and device.
getMobileDeviceAccessOverrideRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAccessControlRulesResult> listAccessControlRulesAsync(ListAccessControlRulesRequest listAccessControlRulesRequest)
Lists the access control rules for the specified organization.
listAccessControlRulesRequest - Future<ListAccessControlRulesResult> listAccessControlRulesAsync(ListAccessControlRulesRequest listAccessControlRulesRequest, AsyncHandler<ListAccessControlRulesRequest,ListAccessControlRulesResult> asyncHandler)
Lists the access control rules for the specified organization.
listAccessControlRulesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
listAliasesRequest - Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest listAliasesRequest, AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
Creates a paginated call to list the aliases associated with a given entity.
listAliasesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAvailabilityConfigurationsResult> listAvailabilityConfigurationsAsync(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)
List all the AvailabilityConfiguration's for the given WorkMail organization.
listAvailabilityConfigurationsRequest - Future<ListAvailabilityConfigurationsResult> listAvailabilityConfigurationsAsync(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest, AsyncHandler<ListAvailabilityConfigurationsRequest,ListAvailabilityConfigurationsResult> asyncHandler)
List all the AvailabilityConfiguration's for the given WorkMail organization.
listAvailabilityConfigurationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGroupMembersResult> listGroupMembersAsync(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group. Users and groups can be members of a group.
listGroupMembersRequest - Future<ListGroupMembersResult> listGroupMembersAsync(ListGroupMembersRequest listGroupMembersRequest, AsyncHandler<ListGroupMembersRequest,ListGroupMembersResult> asyncHandler)
Returns an overview of the members of a group. Users and groups can be members of a group.
listGroupMembersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
listGroupsRequest - Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Returns summaries of the organization's groups.
listGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGroupsForEntityResult> listGroupsForEntityAsync(ListGroupsForEntityRequest listGroupsForEntityRequest)
Returns all the groups to which an entity belongs.
listGroupsForEntityRequest - Future<ListGroupsForEntityResult> listGroupsForEntityAsync(ListGroupsForEntityRequest listGroupsForEntityRequest, AsyncHandler<ListGroupsForEntityRequest,ListGroupsForEntityResult> asyncHandler)
Returns all the groups to which an entity belongs.
listGroupsForEntityRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListImpersonationRolesResult> listImpersonationRolesAsync(ListImpersonationRolesRequest listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
listImpersonationRolesRequest - Future<ListImpersonationRolesResult> listImpersonationRolesAsync(ListImpersonationRolesRequest listImpersonationRolesRequest, AsyncHandler<ListImpersonationRolesRequest,ListImpersonationRolesResult> asyncHandler)
Lists all the impersonation roles for the given WorkMail organization.
listImpersonationRolesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMailDomainsResult> listMailDomainsAsync(ListMailDomainsRequest listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
listMailDomainsRequest - Future<ListMailDomainsResult> listMailDomainsAsync(ListMailDomainsRequest listMailDomainsRequest, AsyncHandler<ListMailDomainsRequest,ListMailDomainsResult> asyncHandler)
Lists the mail domains in a given WorkMail organization.
listMailDomainsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMailboxExportJobsResult> listMailboxExportJobsAsync(ListMailboxExportJobsRequest listMailboxExportJobsRequest)
Lists the mailbox export jobs started for the specified organization within the last seven days.
listMailboxExportJobsRequest - Future<ListMailboxExportJobsResult> listMailboxExportJobsAsync(ListMailboxExportJobsRequest listMailboxExportJobsRequest, AsyncHandler<ListMailboxExportJobsRequest,ListMailboxExportJobsResult> asyncHandler)
Lists the mailbox export jobs started for the specified organization within the last seven days.
listMailboxExportJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMailboxPermissionsResult> listMailboxPermissionsAsync(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
listMailboxPermissionsRequest - Future<ListMailboxPermissionsResult> listMailboxPermissionsAsync(ListMailboxPermissionsRequest listMailboxPermissionsRequest, AsyncHandler<ListMailboxPermissionsRequest,ListMailboxPermissionsResult> asyncHandler)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
listMailboxPermissionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMobileDeviceAccessOverridesResult> listMobileDeviceAccessOverridesAsync(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
listMobileDeviceAccessOverridesRequest - Future<ListMobileDeviceAccessOverridesResult> listMobileDeviceAccessOverridesAsync(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest, AsyncHandler<ListMobileDeviceAccessOverridesRequest,ListMobileDeviceAccessOverridesResult> asyncHandler)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
listMobileDeviceAccessOverridesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMobileDeviceAccessRulesResult> listMobileDeviceAccessRulesAsync(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest)
Lists the mobile device access rules for the specified WorkMail organization.
listMobileDeviceAccessRulesRequest - Future<ListMobileDeviceAccessRulesResult> listMobileDeviceAccessRulesAsync(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest, AsyncHandler<ListMobileDeviceAccessRulesRequest,ListMobileDeviceAccessRulesResult> asyncHandler)
Lists the mobile device access rules for the specified WorkMail organization.
listMobileDeviceAccessRulesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListOrganizationsResult> listOrganizationsAsync(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's organizations.
listOrganizationsRequest - Future<ListOrganizationsResult> listOrganizationsAsync(ListOrganizationsRequest listOrganizationsRequest, AsyncHandler<ListOrganizationsRequest,ListOrganizationsResult> asyncHandler)
Returns summaries of the customer's organizations.
listOrganizationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourceDelegatesResult> listResourceDelegatesAsync(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegatesRequest - Future<ListResourceDelegatesResult> listResourceDelegatesAsync(ListResourceDelegatesRequest listResourceDelegatesRequest, AsyncHandler<ListResourceDelegatesRequest,ListResourceDelegatesResult> asyncHandler)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
listResourcesRequest - Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest listResourcesRequest, AsyncHandler<ListResourcesRequest,ListResourcesResult> asyncHandler)
Returns summaries of the organization's resources.
listResourcesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to an WorkMail organization resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags applied to an WorkMail organization resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
listUsersRequest - Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Returns summaries of the organization's users.
listUsersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutAccessControlRuleResult> putAccessControlRuleAsync(PutAccessControlRuleRequest putAccessControlRuleRequest)
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.
putAccessControlRuleRequest - Future<PutAccessControlRuleResult> putAccessControlRuleAsync(PutAccessControlRuleRequest putAccessControlRuleRequest, AsyncHandler<PutAccessControlRuleRequest,PutAccessControlRuleResult> asyncHandler)
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.
putAccessControlRuleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutEmailMonitoringConfigurationResult> putEmailMonitoringConfigurationAsync(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest)
Creates or updates the email monitoring configuration for a specified organization.
putEmailMonitoringConfigurationRequest - Future<PutEmailMonitoringConfigurationResult> putEmailMonitoringConfigurationAsync(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest, AsyncHandler<PutEmailMonitoringConfigurationRequest,PutEmailMonitoringConfigurationResult> asyncHandler)
Creates or updates the email monitoring configuration for a specified organization.
putEmailMonitoringConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutInboundDmarcSettingsResult> putInboundDmarcSettingsAsync(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest)
Enables or disables a DMARC policy for a given organization.
putInboundDmarcSettingsRequest - Future<PutInboundDmarcSettingsResult> putInboundDmarcSettingsAsync(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest, AsyncHandler<PutInboundDmarcSettingsRequest,PutInboundDmarcSettingsResult> asyncHandler)
Enables or disables a DMARC policy for a given organization.
putInboundDmarcSettingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutMailboxPermissionsResult> putMailboxPermissionsAsync(PutMailboxPermissionsRequest putMailboxPermissionsRequest)
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
putMailboxPermissionsRequest - Future<PutMailboxPermissionsResult> putMailboxPermissionsAsync(PutMailboxPermissionsRequest putMailboxPermissionsRequest, AsyncHandler<PutMailboxPermissionsRequest,PutMailboxPermissionsResult> asyncHandler)
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
putMailboxPermissionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutMobileDeviceAccessOverrideResult> putMobileDeviceAccessOverrideAsync(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
putMobileDeviceAccessOverrideRequest - Future<PutMobileDeviceAccessOverrideResult> putMobileDeviceAccessOverrideAsync(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest, AsyncHandler<PutMobileDeviceAccessOverrideRequest,PutMobileDeviceAccessOverrideResult> asyncHandler)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
putMobileDeviceAccessOverrideRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutRetentionPolicyResult> putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest)
Puts a retention policy to the specified organization.
putRetentionPolicyRequest - Future<PutRetentionPolicyResult> putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest, AsyncHandler<PutRetentionPolicyRequest,PutRetentionPolicyResult> asyncHandler)
Puts a retention policy to the specified organization.
putRetentionPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RegisterMailDomainResult> registerMailDomainAsync(RegisterMailDomainRequest registerMailDomainRequest)
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.
registerMailDomainRequest - Future<RegisterMailDomainResult> registerMailDomainAsync(RegisterMailDomainRequest registerMailDomainRequest, AsyncHandler<RegisterMailDomainRequest,RegisterMailDomainResult> asyncHandler)
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.
registerMailDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RegisterToWorkMailResult> registerToWorkMailAsync(RegisterToWorkMailRequest registerToWorkMailRequest)
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 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.
registerToWorkMailRequest - Future<RegisterToWorkMailResult> registerToWorkMailAsync(RegisterToWorkMailRequest registerToWorkMailRequest, AsyncHandler<RegisterToWorkMailRequest,RegisterToWorkMailResult> asyncHandler)
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 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.
registerToWorkMailRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResetPasswordResult> resetPasswordAsync(ResetPasswordRequest resetPasswordRequest)
Allows the administrator to reset the password for a user.
resetPasswordRequest - Future<ResetPasswordResult> resetPasswordAsync(ResetPasswordRequest resetPasswordRequest, AsyncHandler<ResetPasswordRequest,ResetPasswordResult> asyncHandler)
Allows the administrator to reset the password for a user.
resetPasswordRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartMailboxExportJobResult> startMailboxExportJobAsync(StartMailboxExportJobRequest startMailboxExportJobRequest)
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 WorkMail Administrator Guide.
startMailboxExportJobRequest - Future<StartMailboxExportJobResult> startMailboxExportJobAsync(StartMailboxExportJobRequest startMailboxExportJobRequest, AsyncHandler<StartMailboxExportJobRequest,StartMailboxExportJobResult> asyncHandler)
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 WorkMail Administrator Guide.
startMailboxExportJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Applies the specified tags to the specified WorkMailorganization resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Applies the specified tags to the specified WorkMailorganization resource.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TestAvailabilityConfigurationResult> testAvailabilityConfigurationAsync(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest)
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.
testAvailabilityConfigurationRequest - Future<TestAvailabilityConfigurationResult> testAvailabilityConfigurationAsync(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest, AsyncHandler<TestAvailabilityConfigurationRequest,TestAvailabilityConfigurationResult> asyncHandler)
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.
testAvailabilityConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Untags the specified tags from the specified WorkMail organization resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Untags the specified tags from the specified WorkMail organization resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAvailabilityConfigurationResult> updateAvailabilityConfigurationAsync(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest)
Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
updateAvailabilityConfigurationRequest - Future<UpdateAvailabilityConfigurationResult> updateAvailabilityConfigurationAsync(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest, AsyncHandler<UpdateAvailabilityConfigurationRequest,UpdateAvailabilityConfigurationResult> asyncHandler)
Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
updateAvailabilityConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDefaultMailDomainResult> updateDefaultMailDomainAsync(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest)
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.
updateDefaultMailDomainRequest - Future<UpdateDefaultMailDomainResult> updateDefaultMailDomainAsync(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest, AsyncHandler<UpdateDefaultMailDomainRequest,UpdateDefaultMailDomainResult> asyncHandler)
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.
updateDefaultMailDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest)
Updates attibutes in a group.
updateGroupRequest - Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
Updates attibutes in a group.
updateGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateImpersonationRoleResult> updateImpersonationRoleAsync(UpdateImpersonationRoleRequest updateImpersonationRoleRequest)
Updates an impersonation role for the given WorkMail organization.
updateImpersonationRoleRequest - Future<UpdateImpersonationRoleResult> updateImpersonationRoleAsync(UpdateImpersonationRoleRequest updateImpersonationRoleRequest, AsyncHandler<UpdateImpersonationRoleRequest,UpdateImpersonationRoleResult> asyncHandler)
Updates an impersonation role for the given WorkMail organization.
updateImpersonationRoleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateMailboxQuotaResult> updateMailboxQuotaAsync(UpdateMailboxQuotaRequest updateMailboxQuotaRequest)
Updates a user's current mailbox quota for a specified organization and user.
updateMailboxQuotaRequest - Future<UpdateMailboxQuotaResult> updateMailboxQuotaAsync(UpdateMailboxQuotaRequest updateMailboxQuotaRequest, AsyncHandler<UpdateMailboxQuotaRequest,UpdateMailboxQuotaResult> asyncHandler)
Updates a user's current mailbox quota for a specified organization and user.
updateMailboxQuotaRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateMobileDeviceAccessRuleResult> updateMobileDeviceAccessRuleAsync(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest)
Updates a mobile device access rule for the specified WorkMail organization.
updateMobileDeviceAccessRuleRequest - Future<UpdateMobileDeviceAccessRuleResult> updateMobileDeviceAccessRuleAsync(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest, AsyncHandler<UpdateMobileDeviceAccessRuleRequest,UpdateMobileDeviceAccessRuleResult> asyncHandler)
Updates a mobile device access rule for the specified WorkMail organization.
updateMobileDeviceAccessRuleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdatePrimaryEmailAddressResult> updatePrimaryEmailAddressAsync(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
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.
updatePrimaryEmailAddressRequest - Future<UpdatePrimaryEmailAddressResult> updatePrimaryEmailAddressAsync(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest, AsyncHandler<UpdatePrimaryEmailAddressRequest,UpdatePrimaryEmailAddressResult> asyncHandler)
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.
updatePrimaryEmailAddressRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest updateResourceRequest)
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.
updateResourceRequest - Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest updateResourceRequest, AsyncHandler<UpdateResourceRequest,UpdateResourceResult> asyncHandler)
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.
updateResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest)
Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The
dataset in the request should be the one expected when performing another DescribeUser call.
updateUserRequest - Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The
dataset in the request should be the one expected when performing another DescribeUser call.
updateUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.