AbstractAmazonWorkMail (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workmail.AbstractAmazonWorkMail

All Implemented Interfaces:

AmazonWorkMail

Direct Known Subclasses:

AbstractAmazonWorkMailAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonWorkMail
extends Object
implements AmazonWorkMail
```
Abstract implementation of AmazonWorkMail. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.workmail.AmazonWorkMail
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateDelegateToResourceResult`	`associateDelegateToResource(AssociateDelegateToResourceRequest request)` Adds a member (user or group) to the resource's set of delegates.
`AssociateMemberToGroupResult`	`associateMemberToGroup(AssociateMemberToGroupRequest request)` Adds a member (user or group) to the group's set.
`CancelMailboxExportJobResult`	`cancelMailboxExportJob(CancelMailboxExportJobRequest request)` Cancels a mailbox export job.
`CreateAliasResult`	`createAlias(CreateAliasRequest request)` Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
`CreateGroupResult`	`createGroup(CreateGroupRequest request)` Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
`CreateMobileDeviceAccessRuleResult`	`createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest request)` Creates a new mobile device access rule for the specified Amazon WorkMail organization.
`CreateOrganizationResult`	`createOrganization(CreateOrganizationRequest request)` Creates a new Amazon WorkMail organization.
`CreateResourceResult`	`createResource(CreateResourceRequest request)` Creates a new Amazon WorkMail resource.
`CreateUserResult`	`createUser(CreateUserRequest request)` Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
`DeleteAccessControlRuleResult`	`deleteAccessControlRule(DeleteAccessControlRuleRequest request)` Deletes an access control rule for the specified WorkMail organization.
`DeleteAliasResult`	`deleteAlias(DeleteAliasRequest request)` Remove one or more specified aliases from a set of aliases for a given user.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest request)` Deletes a group from Amazon WorkMail.
`DeleteMailboxPermissionsResult`	`deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)` Deletes permissions granted to a member (user or group).
`DeleteMobileDeviceAccessOverrideResult`	`deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest request)` Deletes the mobile device access override for the given WorkMail organization, user, and device.
`DeleteMobileDeviceAccessRuleResult`	`deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest request)` Deletes a mobile device access rule for the specified Amazon WorkMail organization.
`DeleteOrganizationResult`	`deleteOrganization(DeleteOrganizationRequest request)` Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization.
`DeleteResourceResult`	`deleteResource(DeleteResourceRequest request)` Deletes the specified resource.
`DeleteRetentionPolicyResult`	`deleteRetentionPolicy(DeleteRetentionPolicyRequest request)` Deletes the specified retention policy from the specified organization.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Deletes a user from Amazon WorkMail and all subsequent systems.
`DeregisterFromWorkMailResult`	`deregisterFromWorkMail(DeregisterFromWorkMailRequest request)` Mark a user, group, or resource as no longer used in Amazon WorkMail.
`DeregisterMailDomainResult`	`deregisterMailDomain(DeregisterMailDomainRequest request)` Removes a domain from Amazon WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.
`DescribeGroupResult`	`describeGroup(DescribeGroupRequest request)` Returns the data available for the group.
`DescribeInboundDmarcSettingsResult`	`describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest request)` Lists the settings in a DMARC policy for a specified organization.
`DescribeMailboxExportJobResult`	`describeMailboxExportJob(DescribeMailboxExportJobRequest request)` Describes the current status of a mailbox export job.
`DescribeOrganizationResult`	`describeOrganization(DescribeOrganizationRequest request)` Provides more information regarding a given organization based on its identifier.
`DescribeResourceResult`	`describeResource(DescribeResourceRequest request)` Returns the data available for the resource.
`DescribeUserResult`	`describeUser(DescribeUserRequest request)` Provides information regarding the user.
`DisassociateDelegateFromResourceResult`	`disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)` Removes a member from the resource's set of delegates.
`DisassociateMemberFromGroupResult`	`disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)` Removes a member from a group.
`GetAccessControlEffectResult`	`getAccessControlEffect(GetAccessControlEffectRequest request)` Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDefaultRetentionPolicyResult`	`getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest request)` Gets the default retention policy details for the specified organization.
`GetMailboxDetailsResult`	`getMailboxDetails(GetMailboxDetailsRequest request)` Requests a user's mailbox details for a specified organization and user.
`GetMailDomainResult`	`getMailDomain(GetMailDomainRequest request)` Gets details for a mail domain, including domain records required to configure your domain with recommended security.
`GetMobileDeviceAccessEffectResult`	`getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest request)` Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
`GetMobileDeviceAccessOverrideResult`	`getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest request)` Gets the mobile device access override for the given WorkMail organization, user, and device.
`ListAccessControlRulesResult`	`listAccessControlRules(ListAccessControlRulesRequest request)` Lists the access control rules for the specified organization.
`ListAliasesResult`	`listAliases(ListAliasesRequest request)` Creates a paginated call to list the aliases associated with a given entity.
`ListGroupMembersResult`	`listGroupMembers(ListGroupMembersRequest request)` Returns an overview of the members of a group.
`ListGroupsResult`	`listGroups(ListGroupsRequest request)` Returns summaries of the organization's groups.
`ListMailboxExportJobsResult`	`listMailboxExportJobs(ListMailboxExportJobsRequest request)` Lists the mailbox export jobs started for the specified organization within the last seven days.
`ListMailboxPermissionsResult`	`listMailboxPermissions(ListMailboxPermissionsRequest request)` Lists the mailbox permissions associated with a user, group, or resource mailbox.
`ListMailDomainsResult`	`listMailDomains(ListMailDomainsRequest request)` Lists the mail domains in a given Amazon WorkMail organization.
`ListMobileDeviceAccessOverridesResult`	`listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest request)` Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
`ListMobileDeviceAccessRulesResult`	`listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest request)` Lists the mobile device access rules for the specified Amazon WorkMail organization.
`ListOrganizationsResult`	`listOrganizations(ListOrganizationsRequest request)` Returns summaries of the customer's organizations.
`ListResourceDelegatesResult`	`listResourceDelegates(ListResourceDelegatesRequest request)` Lists the delegates associated with a resource.
`ListResourcesResult`	`listResources(ListResourcesRequest request)` Returns summaries of the organization's resources.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags applied to an Amazon WorkMail organization resource.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Returns summaries of the organization's users.
`PutAccessControlRuleResult`	`putAccessControlRule(PutAccessControlRuleRequest request)` Adds a new access control rule for the specified organization.
`PutInboundDmarcSettingsResult`	`putInboundDmarcSettings(PutInboundDmarcSettingsRequest request)` Enables or disables a DMARC policy for a given organization.
`PutMailboxPermissionsResult`	`putMailboxPermissions(PutMailboxPermissionsRequest request)` Sets permissions for a user, group, or resource.
`PutMobileDeviceAccessOverrideResult`	`putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest request)` Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
`PutRetentionPolicyResult`	`putRetentionPolicy(PutRetentionPolicyRequest request)` Puts a retention policy to the specified organization.
`RegisterMailDomainResult`	`registerMailDomain(RegisterMailDomainRequest request)` Registers a new domain in Amazon WorkMail and SES, and configures it for use by WorkMail.
`RegisterToWorkMailResult`	`registerToWorkMail(RegisterToWorkMailRequest request)` Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities.
`ResetPasswordResult`	`resetPassword(ResetPasswordRequest request)` Allows the administrator to reset the password for a user.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartMailboxExportJobResult`	`startMailboxExportJob(StartMailboxExportJobRequest request)` 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.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Applies the specified tags to the specified Amazon WorkMail organization resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Untags the specified tags from the specified Amazon WorkMail organization resource.
`UpdateDefaultMailDomainResult`	`updateDefaultMailDomain(UpdateDefaultMailDomainRequest request)` Updates the default mail domain for an organization.
`UpdateMailboxQuotaResult`	`updateMailboxQuota(UpdateMailboxQuotaRequest request)` Updates a user's current mailbox quota for a specified organization and user.
`UpdateMobileDeviceAccessRuleResult`	`updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest request)` Updates a mobile device access rule for the specified Amazon WorkMail organization.
`UpdatePrimaryEmailAddressResult`	`updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)` Updates the primary email for a user, group, or resource.
`UpdateResourceResult`	`updateResource(UpdateResourceRequest request)` Updates data for the resource.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - associateDelegateToResource
```
public AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Adds a member (user or group) to the resource's set of delegates.
    
    Specified by:
    
    associateDelegateToResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the AssociateDelegateToResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - associateMemberToGroup
```
public AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Adds a member (user or group) to the group's set.
    
    Specified by:
    
    associateMemberToGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the AssociateMemberToGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelMailboxExportJob
```
public CancelMailboxExportJobResult cancelMailboxExportJob(CancelMailboxExportJobRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Cancels a mailbox export job.
    
    If the mailbox export job is near completion, it might not be possible to cancel it.
    
    Specified by:
    
    cancelMailboxExportJob in interface AmazonWorkMail
    
    Returns:
    
    Result of the CancelMailboxExportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAlias
```
public CreateAliasResult createAlias(CreateAliasRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
    
    Specified by:
    
    createAlias in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Specified by:
    
    createGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createMobileDeviceAccessRule
```
public CreateMobileDeviceAccessRuleResult createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a new mobile device access rule for the specified Amazon WorkMail organization.
    
    Specified by:
    
    createMobileDeviceAccessRule in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateMobileDeviceAccessRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createOrganization
```
public CreateOrganizationResult createOrganization(CreateOrganizationRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a new Amazon WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide.
    
    You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the Amazon WorkMail Administrator Guide.
    
    Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.
    
    Specified by:
    
    createOrganization in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateOrganization operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createResource
```
public CreateResourceResult createResource(CreateResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a new Amazon WorkMail resource.
    
    Specified by:
    
    createResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Specified by:
    
    createUser in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAccessControlRule
```
public DeleteAccessControlRuleResult deleteAccessControlRule(DeleteAccessControlRuleRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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.
    
    Specified by:
    
    deleteAccessControlRule in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteAccessControlRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAlias
```
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Remove one or more specified aliases from a set of aliases for a given user.
    
    Specified by:
    
    deleteAlias in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Deletes a group from Amazon WorkMail.
    
    Specified by:
    
    deleteGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteMailboxPermissions
```
public DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Deletes permissions granted to a member (user or group).
    
    Specified by:
    
    deleteMailboxPermissions in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteMailboxPermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteMobileDeviceAccessOverride
```
public DeleteMobileDeviceAccessOverrideResult deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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.
    
    Specified by:
    
    deleteMobileDeviceAccessOverride in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteMobileDeviceAccessOverride operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteMobileDeviceAccessRule
```
public DeleteMobileDeviceAccessRuleResult deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Deletes a mobile device access rule for the specified Amazon 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.
    
    Specified by:
    
    deleteMobileDeviceAccessRule in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteMobileDeviceAccessRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteOrganization
```
public DeleteOrganizationResult deleteOrganization(DeleteOrganizationRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the Amazon WorkMail Administrator Guide.
    
    Specified by:
    
    deleteOrganization in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteOrganization operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteResource
```
public DeleteResourceResult deleteResource(DeleteResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Deletes the specified resource.
    
    Specified by:
    
    deleteResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRetentionPolicy
```
public DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Deletes the specified retention policy from the specified organization.
    
    Specified by:
    
    deleteRetentionPolicy in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteRetentionPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.
    
    Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
    
    Specified by:
    
    deleteUser in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deregisterFromWorkMail
```
public DeregisterFromWorkMailResult deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
    
    Specified by:
    
    deregisterFromWorkMail in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeregisterFromWorkMail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deregisterMailDomain
```
public DeregisterMailDomainResult deregisterMailDomain(DeregisterMailDomainRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Removes a domain from Amazon 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.
    
    Specified by:
    
    deregisterMailDomain in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeregisterMailDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeGroup
```
public DescribeGroupResult describeGroup(DescribeGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns the data available for the group.
    
    Specified by:
    
    describeGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeInboundDmarcSettings
```
public DescribeInboundDmarcSettingsResult describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Lists the settings in a DMARC policy for a specified organization.
    
    Specified by:
    
    describeInboundDmarcSettings in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeInboundDmarcSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeMailboxExportJob
```
public DescribeMailboxExportJobResult describeMailboxExportJob(DescribeMailboxExportJobRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Describes the current status of a mailbox export job.
    
    Specified by:
    
    describeMailboxExportJob in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeMailboxExportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeOrganization
```
public DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Provides more information regarding a given organization based on its identifier.
    
    Specified by:
    
    describeOrganization in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeOrganization operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeResource
```
public DescribeResourceResult describeResource(DescribeResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns the data available for the resource.
    
    Specified by:
    
    describeResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Provides information regarding the user.
    
    Specified by:
    
    describeUser in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateDelegateFromResource
```
public DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Removes a member from the resource's set of delegates.
    
    Specified by:
    
    disassociateDelegateFromResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the DisassociateDelegateFromResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateMemberFromGroup
```
public DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Removes a member from a group.
    
    Specified by:
    
    disassociateMemberFromGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the DisassociateMemberFromGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAccessControlEffect
```
public GetAccessControlEffectResult getAccessControlEffect(GetAccessControlEffectRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.
    
    Specified by:
    
    getAccessControlEffect in interface AmazonWorkMail
    
    Returns:
    
    Result of the GetAccessControlEffect operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDefaultRetentionPolicy
```
public GetDefaultRetentionPolicyResult getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Gets the default retention policy details for the specified organization.
    
    Specified by:
    
    getDefaultRetentionPolicy in interface AmazonWorkMail
    
    Returns:
    
    Result of the GetDefaultRetentionPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getMailDomain
```
public GetMailDomainResult getMailDomain(GetMailDomainRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Gets details for a mail domain, including domain records required to configure your domain with recommended security.
    
    Specified by:
    
    getMailDomain in interface AmazonWorkMail
    
    Returns:
    
    Result of the GetMailDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getMailboxDetails
```
public GetMailboxDetailsResult getMailboxDetails(GetMailboxDetailsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Requests a user's mailbox details for a specified organization and user.
    
    Specified by:
    
    getMailboxDetails in interface AmazonWorkMail
    
    Returns:
    
    Result of the GetMailboxDetails operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getMobileDeviceAccessEffect
```
public GetMobileDeviceAccessEffectResult getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the Amazon WorkMail organization for a particular user's attributes.
    
    Specified by:
    
    getMobileDeviceAccessEffect in interface AmazonWorkMail
    
    Returns:
    
    Result of the GetMobileDeviceAccessEffect operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getMobileDeviceAccessOverride
```
public GetMobileDeviceAccessOverrideResult getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Gets the mobile device access override for the given WorkMail organization, user, and device.
    
    Specified by:
    
    getMobileDeviceAccessOverride in interface AmazonWorkMail
    
    Returns:
    
    Result of the GetMobileDeviceAccessOverride operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAccessControlRules
```
public ListAccessControlRulesResult listAccessControlRules(ListAccessControlRulesRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Lists the access control rules for the specified organization.
    
    Specified by:
    
    listAccessControlRules in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListAccessControlRules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAliases
```
public ListAliasesResult listAliases(ListAliasesRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a paginated call to list the aliases associated with a given entity.
    
    Specified by:
    
    listAliases in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroupMembers
```
public ListGroupMembersResult listGroupMembers(ListGroupMembersRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns an overview of the members of a group. Users and groups can be members of a group.
    
    Specified by:
    
    listGroupMembers in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListGroupMembers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns summaries of the organization's groups.
    
    Specified by:
    
    listGroups in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMailDomains
```
public ListMailDomainsResult listMailDomains(ListMailDomainsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Lists the mail domains in a given Amazon WorkMail organization.
    
    Specified by:
    
    listMailDomains in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListMailDomains operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMailboxExportJobs
```
public ListMailboxExportJobsResult listMailboxExportJobs(ListMailboxExportJobsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Lists the mailbox export jobs started for the specified organization within the last seven days.
    
    Specified by:
    
    listMailboxExportJobs in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListMailboxExportJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMailboxPermissions
```
public ListMailboxPermissionsResult listMailboxPermissions(ListMailboxPermissionsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Lists the mailbox permissions associated with a user, group, or resource mailbox.
    
    Specified by:
    
    listMailboxPermissions in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListMailboxPermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMobileDeviceAccessOverrides
```
public ListMobileDeviceAccessOverridesResult listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
    
    Specified by:
    
    listMobileDeviceAccessOverrides in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListMobileDeviceAccessOverrides operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMobileDeviceAccessRules
```
public ListMobileDeviceAccessRulesResult listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Lists the mobile device access rules for the specified Amazon WorkMail organization.
    
    Specified by:
    
    listMobileDeviceAccessRules in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListMobileDeviceAccessRules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listOrganizations
```
public ListOrganizationsResult listOrganizations(ListOrganizationsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns summaries of the customer's organizations.
    
    Specified by:
    
    listOrganizations in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListOrganizations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listResourceDelegates
```
public ListResourceDelegatesResult listResourceDelegates(ListResourceDelegatesRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
    
    Specified by:
    
    listResourceDelegates in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListResourceDelegates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listResources
```
public ListResourcesResult listResources(ListResourcesRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns summaries of the organization's resources.
    
    Specified by:
    
    listResources in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Lists the tags applied to an Amazon WorkMail organization resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns summaries of the organization's users.
    
    Specified by:
    
    listUsers in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putAccessControlRule
```
public PutAccessControlRuleResult putAccessControlRule(PutAccessControlRuleRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
    
    Specified by:
    
    putAccessControlRule in interface AmazonWorkMail
    
    Returns:
    
    Result of the PutAccessControlRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putInboundDmarcSettings
```
public PutInboundDmarcSettingsResult putInboundDmarcSettings(PutInboundDmarcSettingsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Enables or disables a DMARC policy for a given organization.
    
    Specified by:
    
    putInboundDmarcSettings in interface AmazonWorkMail
    
    Returns:
    
    Result of the PutInboundDmarcSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putMailboxPermissions
```
public PutMailboxPermissionsResult putMailboxPermissions(PutMailboxPermissionsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
    
    Specified by:
    
    putMailboxPermissions in interface AmazonWorkMail
    
    Returns:
    
    Result of the PutMailboxPermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putMobileDeviceAccessOverride
```
public PutMobileDeviceAccessOverrideResult putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
    
    Specified by:
    
    putMobileDeviceAccessOverride in interface AmazonWorkMail
    
    Returns:
    
    Result of the PutMobileDeviceAccessOverride operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putRetentionPolicy
```
public PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Puts a retention policy to the specified organization.
    
    Specified by:
    
    putRetentionPolicy in interface AmazonWorkMail
    
    Returns:
    
    Result of the PutRetentionPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerMailDomain
```
public RegisterMailDomainResult registerMailDomain(RegisterMailDomainRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Registers a new domain in Amazon 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.
    
    Specified by:
    
    registerMailDomain in interface AmazonWorkMail
    
    Returns:
    
    Result of the RegisterMailDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerToWorkMail
```
public RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
    
    Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
    
    Specified by:
    
    registerToWorkMail in interface AmazonWorkMail
    
    Returns:
    
    Result of the RegisterToWorkMail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resetPassword
```
public ResetPasswordResult resetPassword(ResetPasswordRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Allows the administrator to reset the password for a user.
    
    Specified by:
    
    resetPassword in interface AmazonWorkMail
    
    Returns:
    
    Result of the ResetPassword operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startMailboxExportJob
```
public StartMailboxExportJobResult startMailboxExportJob(StartMailboxExportJobRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the Amazon WorkMail Administrator Guide.
    
    Specified by:
    
    startMailboxExportJob in interface AmazonWorkMail
    
    Returns:
    
    Result of the StartMailboxExportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Applies the specified tags to the specified Amazon WorkMail organization resource.
    
    Specified by:
    
    tagResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Untags the specified tags from the specified Amazon WorkMail organization resource.
    
    Specified by:
    
    untagResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDefaultMailDomain
```
public UpdateDefaultMailDomainResult updateDefaultMailDomain(UpdateDefaultMailDomainRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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.
    
    Specified by:
    
    updateDefaultMailDomain in interface AmazonWorkMail
    
    Returns:
    
    Result of the UpdateDefaultMailDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateMailboxQuota
```
public UpdateMailboxQuotaResult updateMailboxQuota(UpdateMailboxQuotaRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Updates a user's current mailbox quota for a specified organization and user.
    
    Specified by:
    
    updateMailboxQuota in interface AmazonWorkMail
    
    Returns:
    
    Result of the UpdateMailboxQuota operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateMobileDeviceAccessRule
```
public UpdateMobileDeviceAccessRuleResult updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Updates a mobile device access rule for the specified Amazon WorkMail organization.
    
    Specified by:
    
    updateMobileDeviceAccessRule in interface AmazonWorkMail
    
    Returns:
    
    Result of the UpdateMobileDeviceAccessRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePrimaryEmailAddress
```
public UpdatePrimaryEmailAddressResult updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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.
    
    Specified by:
    
    updatePrimaryEmailAddress in interface AmazonWorkMail
    
    Returns:
    
    Result of the UpdatePrimaryEmailAddress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateResource
```
public UpdateResourceResult updateResource(UpdateResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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.
    
    Specified by:
    
    updateResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the UpdateResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonWorkMail
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonWorkMail
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonWorkMail
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonWorkMail

Field Summary

Fields inherited from interface com.amazonaws.services.workmail.AmazonWorkMail

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateDelegateToResource

associateMemberToGroup

cancelMailboxExportJob

createAlias

createGroup

createMobileDeviceAccessRule

createOrganization

createResource

createUser

deleteAccessControlRule

deleteAlias

deleteGroup

deleteMailboxPermissions

deleteMobileDeviceAccessOverride

deleteMobileDeviceAccessRule

deleteOrganization

deleteResource

deleteRetentionPolicy

deleteUser

deregisterFromWorkMail

deregisterMailDomain

describeGroup

describeInboundDmarcSettings

describeMailboxExportJob

describeOrganization

describeResource

describeUser

disassociateDelegateFromResource

disassociateMemberFromGroup

getAccessControlEffect

getDefaultRetentionPolicy

getMailDomain

getMailboxDetails

getMobileDeviceAccessEffect

getMobileDeviceAccessOverride

listAccessControlRules

listAliases

listGroupMembers

listGroups

listMailDomains

listMailboxExportJobs

listMailboxPermissions

listMobileDeviceAccessOverrides

listMobileDeviceAccessRules

listOrganizations

listResourceDelegates

listResources

listTagsForResource

listUsers

putAccessControlRule

putInboundDmarcSettings

putMailboxPermissions

putMobileDeviceAccessOverride

putRetentionPolicy

registerMailDomain

registerToWorkMail

resetPassword

startMailboxExportJob

tagResource

untagResource

updateDefaultMailDomain

updateMailboxQuota

updateMobileDeviceAccessRule

updatePrimaryEmailAddress

updateResource

shutdown

getCachedResponseMetadata