AmazonWorkMailClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.workmail.AmazonWorkMailClient

All Implemented Interfaces:

AmazonWorkMail

Direct Known Subclasses:

AmazonWorkMailAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonWorkMailClient
extends AmazonWebServiceClient
implements AmazonWorkMail
```
Client for accessing Amazon WorkMail. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.

The WorkMail API is designed for the following scenarios:
- Listing and describing organizations
- Managing users
- Managing groups
- Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

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

Method Summary

All Methods Static 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.
`static AmazonWorkMailClientBuilder`	`builder()`
`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).
`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.
`DescribeGroupResult`	`describeGroup(DescribeGroupRequest request)` Returns the data available for the group.
`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.
`GetMobileDeviceAccessEffectResult`	`getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest request)` Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
`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.
`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.
`PutMailboxPermissionsResult`	`putMailboxPermissions(PutMailboxPermissionsRequest request)` Sets permissions for a user, group, or resource.
`PutRetentionPolicyResult`	`putRetentionPolicy(PutRetentionPolicyRequest request)` Puts a retention policy to the specified organization.
`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.
`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
  - builder
```
public static AmazonWorkMailClientBuilder builder()
```
  - associateDelegateToResource
```
public AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest request)
```
    Adds a member (user or group) to the resource's set of delegates.
    
    Specified by:
    
    associateDelegateToResource in interface AmazonWorkMail
    
    Parameters:
    
    associateDelegateToResourceRequest -
    
    Returns:
    
    Result of the AssociateDelegateToResource operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - associateMemberToGroup
```
public AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest request)
```
    Adds a member (user or group) to the group's set.
    
    Specified by:
    
    associateMemberToGroup in interface AmazonWorkMail
    
    Parameters:
    
    associateMemberToGroupRequest -
    
    Returns:
    
    Result of the AssociateMemberToGroup operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    UnsupportedOperationException - You can't perform a write operation against a read-only directory.
    
    See Also:
    
    AWS API Documentation
  - cancelMailboxExportJob
```
public CancelMailboxExportJobResult cancelMailboxExportJob(CancelMailboxExportJobRequest request)
```
    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
    
    Parameters:
    
    cancelMailboxExportJobRequest -
    
    Returns:
    
    Result of the CancelMailboxExportJob operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    See Also:
    
    AWS API Documentation
  - createAlias
```
public CreateAliasResult createAlias(CreateAliasRequest request)
```
    Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
    
    Specified by:
    
    createAlias in interface AmazonWorkMail
    
    Parameters:
    
    createAliasRequest -
    
    Returns:
    
    Result of the CreateAlias operation returned by the service.
    
    Throws:
    
    EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or resource.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.
    
    MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    LimitExceededException - The request exceeds the limit of the resource.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Specified by:
    
    createGroup in interface AmazonWorkMail
    
    Parameters:
    
    createGroupRequest -
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    NameAvailabilityException - The user, group, or resource name isn't unique in Amazon WorkMail.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    ReservedNameException - This user, group, or resource name is not allowed in Amazon WorkMail.
    
    UnsupportedOperationException - You can't perform a write operation against a read-only directory.
    
    See Also:
    
    AWS API Documentation
  - createMobileDeviceAccessRule
```
public CreateMobileDeviceAccessRuleResult createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest request)
```
    Creates a new mobile device access rule for the specified Amazon WorkMail organization.
    
    Specified by:
    
    createMobileDeviceAccessRule in interface AmazonWorkMail
    
    Parameters:
    
    createMobileDeviceAccessRuleRequest -
    
    Returns:
    
    Result of the CreateMobileDeviceAccessRule operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    LimitExceededException - The request exceeds the limit of the resource.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - createOrganization
```
public CreateOrganizationResult createOrganization(CreateOrganizationRequest request)
```
    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
    
    Parameters:
    
    createOrganizationRequest -
    
    Returns:
    
    Result of the CreateOrganization operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    DirectoryInUseException - The directory is already in use by another WorkMail organization in the same account and Region.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    LimitExceededException - The request exceeds the limit of the resource.
    
    NameAvailabilityException - The user, group, or resource name isn't unique in Amazon WorkMail.
    
    See Also:
    
    AWS API Documentation
  - createResource
```
public CreateResourceResult createResource(CreateResourceRequest request)
```
    Creates a new Amazon WorkMail resource.
    
    Specified by:
    
    createResource in interface AmazonWorkMail
    
    Parameters:
    
    createResourceRequest -
    
    Returns:
    
    Result of the CreateResource operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    NameAvailabilityException - The user, group, or resource name isn't unique in Amazon WorkMail.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    ReservedNameException - This user, group, or resource name is not allowed in Amazon WorkMail.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Specified by:
    
    createUser in interface AmazonWorkMail
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
    
    NameAvailabilityException - The user, group, or resource name isn't unique in Amazon WorkMail.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    ReservedNameException - This user, group, or resource name is not allowed in Amazon WorkMail.
    
    UnsupportedOperationException - You can't perform a write operation against a read-only directory.
    
    See Also:
    
    AWS API Documentation
  - deleteAccessControlRule
```
public DeleteAccessControlRuleResult deleteAccessControlRule(DeleteAccessControlRuleRequest request)
```
    Deletes an access control rule for the specified WorkMail organization.
    
    Specified by:
    
    deleteAccessControlRule in interface AmazonWorkMail
    
    Parameters:
    
    deleteAccessControlRuleRequest -
    
    Returns:
    
    Result of the DeleteAccessControlRule operation returned by the service.
    
    Throws:
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - deleteAlias
```
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
```
    Remove one or more specified aliases from a set of aliases for a given user.
    
    Specified by:
    
    deleteAlias in interface AmazonWorkMail
    
    Parameters:
    
    deleteAliasRequest -
    
    Returns:
    
    Result of the DeleteAlias operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Deletes a group from Amazon WorkMail.
    
    Specified by:
    
    deleteGroup in interface AmazonWorkMail
    
    Parameters:
    
    deleteGroupRequest -
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    UnsupportedOperationException - You can't perform a write operation against a read-only directory.
    
    See Also:
    
    AWS API Documentation
  - deleteMailboxPermissions
```
public DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
```
    Deletes permissions granted to a member (user or group).
    
    Specified by:
    
    deleteMailboxPermissions in interface AmazonWorkMail
    
    Parameters:
    
    deleteMailboxPermissionsRequest -
    
    Returns:
    
    Result of the DeleteMailboxPermissions operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - deleteMobileDeviceAccessRule
```
public DeleteMobileDeviceAccessRuleResult deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest request)
```
    Deletes a mobile device access rule for the specified Amazon WorkMail organization.
    
    Specified by:
    
    deleteMobileDeviceAccessRule in interface AmazonWorkMail
    
    Parameters:
    
    deleteMobileDeviceAccessRuleRequest -
    
    Returns:
    
    Result of the DeleteMobileDeviceAccessRule operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - deleteOrganization
```
public DeleteOrganizationResult deleteOrganization(DeleteOrganizationRequest request)
```
    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
    
    Parameters:
    
    deleteOrganizationRequest -
    
    Returns:
    
    Result of the DeleteOrganization operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - deleteResource
```
public DeleteResourceResult deleteResource(DeleteResourceRequest request)
```
    Deletes the specified resource.
    
    Specified by:
    
    deleteResource in interface AmazonWorkMail
    
    Parameters:
    
    deleteResourceRequest -
    
    Returns:
    
    Result of the DeleteResource operation returned by the service.
    
    Throws:
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - deleteRetentionPolicy
```
public DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
```
    Deletes the specified retention policy from the specified organization.
    
    Specified by:
    
    deleteRetentionPolicy in interface AmazonWorkMail
    
    Parameters:
    
    deleteRetentionPolicyRequest -
    
    Returns:
    
    Result of the DeleteRetentionPolicy operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    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
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    UnsupportedOperationException - You can't perform a write operation against a read-only directory.
    
    See Also:
    
    AWS API Documentation
  - deregisterFromWorkMail
```
public DeregisterFromWorkMailResult deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
```
    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
    
    Parameters:
    
    deregisterFromWorkMailRequest -
    
    Returns:
    
    Result of the DeregisterFromWorkMail operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - describeGroup
```
public DescribeGroupResult describeGroup(DescribeGroupRequest request)
```
    Returns the data available for the group.
    
    Specified by:
    
    describeGroup in interface AmazonWorkMail
    
    Parameters:
    
    describeGroupRequest -
    
    Returns:
    
    Result of the DescribeGroup operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - describeMailboxExportJob
```
public DescribeMailboxExportJobResult describeMailboxExportJob(DescribeMailboxExportJobRequest request)
```
    Describes the current status of a mailbox export job.
    
    Specified by:
    
    describeMailboxExportJob in interface AmazonWorkMail
    
    Parameters:
    
    describeMailboxExportJobRequest -
    
    Returns:
    
    Result of the DescribeMailboxExportJob operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    See Also:
    
    AWS API Documentation
  - describeOrganization
```
public DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
```
    Provides more information regarding a given organization based on its identifier.
    
    Specified by:
    
    describeOrganization in interface AmazonWorkMail
    
    Parameters:
    
    describeOrganizationRequest -
    
    Returns:
    
    Result of the DescribeOrganization operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    See Also:
    
    AWS API Documentation
  - describeResource
```
public DescribeResourceResult describeResource(DescribeResourceRequest request)
```
    Returns the data available for the resource.
    
    Specified by:
    
    describeResource in interface AmazonWorkMail
    
    Parameters:
    
    describeResourceRequest -
    
    Returns:
    
    Result of the DescribeResource operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Provides information regarding the user.
    
    Specified by:
    
    describeUser in interface AmazonWorkMail
    
    Parameters:
    
    describeUserRequest -
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - disassociateDelegateFromResource
```
public DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
```
    Removes a member from the resource's set of delegates.
    
    Specified by:
    
    disassociateDelegateFromResource in interface AmazonWorkMail
    
    Parameters:
    
    disassociateDelegateFromResourceRequest -
    
    Returns:
    
    Result of the DisassociateDelegateFromResource operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - disassociateMemberFromGroup
```
public DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
```
    Removes a member from a group.
    
    Specified by:
    
    disassociateMemberFromGroup in interface AmazonWorkMail
    
    Parameters:
    
    disassociateMemberFromGroupRequest -
    
    Returns:
    
    Result of the DisassociateMemberFromGroup operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    UnsupportedOperationException - You can't perform a write operation against a read-only directory.
    
    See Also:
    
    AWS API Documentation
  - getAccessControlEffect
```
public 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.
    
    Specified by:
    
    getAccessControlEffect in interface AmazonWorkMail
    
    Parameters:
    
    getAccessControlEffectRequest -
    
    Returns:
    
    Result of the GetAccessControlEffect operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - getDefaultRetentionPolicy
```
public GetDefaultRetentionPolicyResult getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest request)
```
    Gets the default retention policy details for the specified organization.
    
    Specified by:
    
    getDefaultRetentionPolicy in interface AmazonWorkMail
    
    Parameters:
    
    getDefaultRetentionPolicyRequest -
    
    Returns:
    
    Result of the GetDefaultRetentionPolicy operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    See Also:
    
    AWS API Documentation
  - getMailboxDetails
```
public GetMailboxDetailsResult getMailboxDetails(GetMailboxDetailsRequest request)
```
    Requests a user's mailbox details for a specified organization and user.
    
    Specified by:
    
    getMailboxDetails in interface AmazonWorkMail
    
    Parameters:
    
    getMailboxDetailsRequest -
    
    Returns:
    
    Result of the GetMailboxDetails operation returned by the service.
    
    Throws:
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    See Also:
    
    AWS API Documentation
  - getMobileDeviceAccessEffect
```
public GetMobileDeviceAccessEffectResult getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest request)
```
    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
    
    Parameters:
    
    getMobileDeviceAccessEffectRequest -
    
    Returns:
    
    Result of the GetMobileDeviceAccessEffect operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listAccessControlRules
```
public ListAccessControlRulesResult listAccessControlRules(ListAccessControlRulesRequest request)
```
    Lists the access control rules for the specified organization.
    
    Specified by:
    
    listAccessControlRules in interface AmazonWorkMail
    
    Parameters:
    
    listAccessControlRulesRequest -
    
    Returns:
    
    Result of the ListAccessControlRules operation returned by the service.
    
    Throws:
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listAliases
```
public ListAliasesResult listAliases(ListAliasesRequest request)
```
    Creates a paginated call to list the aliases associated with a given entity.
    
    Specified by:
    
    listAliases in interface AmazonWorkMail
    
    Parameters:
    
    listAliasesRequest -
    
    Returns:
    
    Result of the ListAliases operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listGroupMembers
```
public ListGroupMembersResult listGroupMembers(ListGroupMembersRequest request)
```
    Returns an overview of the members of a group. Users and groups can be members of a group.
    
    Specified by:
    
    listGroupMembers in interface AmazonWorkMail
    
    Parameters:
    
    listGroupMembersRequest -
    
    Returns:
    
    Result of the ListGroupMembers operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Returns summaries of the organization's groups.
    
    Specified by:
    
    listGroups in interface AmazonWorkMail
    
    Parameters:
    
    listGroupsRequest -
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listMailboxExportJobs
```
public ListMailboxExportJobsResult listMailboxExportJobs(ListMailboxExportJobsRequest request)
```
    Lists the mailbox export jobs started for the specified organization within the last seven days.
    
    Specified by:
    
    listMailboxExportJobs in interface AmazonWorkMail
    
    Parameters:
    
    listMailboxExportJobsRequest -
    
    Returns:
    
    Result of the ListMailboxExportJobs operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listMailboxPermissions
```
public ListMailboxPermissionsResult listMailboxPermissions(ListMailboxPermissionsRequest request)
```
    Lists the mailbox permissions associated with a user, group, or resource mailbox.
    
    Specified by:
    
    listMailboxPermissions in interface AmazonWorkMail
    
    Parameters:
    
    listMailboxPermissionsRequest -
    
    Returns:
    
    Result of the ListMailboxPermissions operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listMobileDeviceAccessRules
```
public ListMobileDeviceAccessRulesResult listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest request)
```
    Lists the mobile device access rules for the specified Amazon WorkMail organization.
    
    Specified by:
    
    listMobileDeviceAccessRules in interface AmazonWorkMail
    
    Parameters:
    
    listMobileDeviceAccessRulesRequest -
    
    Returns:
    
    Result of the ListMobileDeviceAccessRules operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listOrganizations
```
public ListOrganizationsResult listOrganizations(ListOrganizationsRequest request)
```
    Returns summaries of the customer's organizations.
    
    Specified by:
    
    listOrganizations in interface AmazonWorkMail
    
    Parameters:
    
    listOrganizationsRequest -
    
    Returns:
    
    Result of the ListOrganizations operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    See Also:
    
    AWS API Documentation
  - listResourceDelegates
```
public ListResourceDelegatesResult listResourceDelegates(ListResourceDelegatesRequest request)
```
    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
    
    Parameters:
    
    listResourceDelegatesRequest -
    
    Returns:
    
    Result of the ListResourceDelegates operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listResources
```
public ListResourcesResult listResources(ListResourcesRequest request)
```
    Returns summaries of the organization's resources.
    
    Specified by:
    
    listResources in interface AmazonWorkMail
    
    Parameters:
    
    listResourcesRequest -
    
    Returns:
    
    Result of the ListResources operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists the tags applied to an Amazon WorkMail organization resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonWorkMail
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource cannot be found.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Returns summaries of the organization's users.
    
    Specified by:
    
    listUsers in interface AmazonWorkMail
    
    Parameters:
    
    listUsersRequest -
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - putAccessControlRule
```
public PutAccessControlRuleResult putAccessControlRule(PutAccessControlRuleRequest request)
```
    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
    
    Parameters:
    
    putAccessControlRuleRequest -
    
    Returns:
    
    Result of the PutAccessControlRule operation returned by the service.
    
    Throws:
    
    LimitExceededException - The request exceeds the limit of the resource.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - putMailboxPermissions
```
public PutMailboxPermissionsResult putMailboxPermissions(PutMailboxPermissionsRequest request)
```
    Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
    
    Specified by:
    
    putMailboxPermissions in interface AmazonWorkMail
    
    Parameters:
    
    putMailboxPermissionsRequest -
    
    Returns:
    
    Result of the PutMailboxPermissions operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - putRetentionPolicy
```
public PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
```
    Puts a retention policy to the specified organization.
    
    Specified by:
    
    putRetentionPolicy in interface AmazonWorkMail
    
    Parameters:
    
    putRetentionPolicyRequest -
    
    Returns:
    
    Result of the PutRetentionPolicy operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    LimitExceededException - The request exceeds the limit of the resource.
    
    See Also:
    
    AWS API Documentation
  - registerToWorkMail
```
public RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest request)
```
    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
    
    Parameters:
    
    registerToWorkMailRequest -
    
    Returns:
    
    Result of the RegisterToWorkMail operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or resource.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    EntityAlreadyRegisteredException - The user, group, or resource that you're trying to register is already registered.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.
    
    MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - resetPassword
```
public ResetPasswordResult resetPassword(ResetPasswordRequest request)
```
    Allows the administrator to reset the password for a user.
    
    Specified by:
    
    resetPassword in interface AmazonWorkMail
    
    Parameters:
    
    resetPasswordRequest -
    
    Returns:
    
    Result of the ResetPassword operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    UnsupportedOperationException - You can't perform a write operation against a read-only directory.
    
    See Also:
    
    AWS API Documentation
  - startMailboxExportJob
```
public 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. For more information, see Exporting mailbox content in the Amazon WorkMail Administrator Guide.
    
    Specified by:
    
    startMailboxExportJob in interface AmazonWorkMail
    
    Parameters:
    
    startMailboxExportJobRequest -
    
    Returns:
    
    Result of the StartMailboxExportJob operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    LimitExceededException - The request exceeds the limit of the resource.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Applies the specified tags to the specified Amazon WorkMail organization resource.
    
    Specified by:
    
    tagResource in interface AmazonWorkMail
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource cannot be found.
    
    TooManyTagsException - The resource can have up to 50 user-applied tags.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Untags the specified tags from the specified Amazon WorkMail organization resource.
    
    Specified by:
    
    untagResource in interface AmazonWorkMail
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource cannot be found.
    
    See Also:
    
    AWS API Documentation
  - updateMailboxQuota
```
public UpdateMailboxQuotaResult updateMailboxQuota(UpdateMailboxQuotaRequest request)
```
    Updates a user's current mailbox quota for a specified organization and user.
    
    Specified by:
    
    updateMailboxQuota in interface AmazonWorkMail
    
    Parameters:
    
    updateMailboxQuotaRequest -
    
    Returns:
    
    Result of the UpdateMailboxQuota operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    See Also:
    
    AWS API Documentation
  - updateMobileDeviceAccessRule
```
public UpdateMobileDeviceAccessRuleResult updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest request)
```
    Updates a mobile device access rule for the specified Amazon WorkMail organization.
    
    Specified by:
    
    updateMobileDeviceAccessRule in interface AmazonWorkMail
    
    Parameters:
    
    updateMobileDeviceAccessRuleRequest -
    
    Returns:
    
    Result of the UpdateMobileDeviceAccessRule operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - updatePrimaryEmailAddress
```
public UpdatePrimaryEmailAddressResult updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
```
    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
    
    Parameters:
    
    updatePrimaryEmailAddressRequest -
    
    Returns:
    
    Result of the UpdatePrimaryEmailAddress operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or resource.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.
    
    MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    UnsupportedOperationException - You can't perform a write operation against a read-only directory.
    
    See Also:
    
    AWS API Documentation
  - updateResource
```
public UpdateResourceResult updateResource(UpdateResourceRequest request)
```
    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
    
    Parameters:
    
    updateResourceRequest -
    
    Returns:
    
    Result of the UpdateResource operation returned by the service.
    
    Throws:
    
    DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.
    
    EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.
    
    EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
    
    InvalidConfigurationException - The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.
    
    EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or resource.
    
    MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.
    
    MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.
    
    NameAvailabilityException - The user, group, or resource name isn't unique in Amazon WorkMail.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its members.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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. 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 the 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.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonWorkMail
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonWorkMailClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

associateDelegateToResource

associateMemberToGroup

cancelMailboxExportJob

createAlias

createGroup

createMobileDeviceAccessRule

createOrganization

createResource

createUser

deleteAccessControlRule

deleteAlias

deleteGroup

deleteMailboxPermissions

deleteMobileDeviceAccessRule

deleteOrganization

deleteResource

deleteRetentionPolicy

deleteUser

deregisterFromWorkMail

describeGroup

describeMailboxExportJob

describeOrganization

describeResource

describeUser

disassociateDelegateFromResource

disassociateMemberFromGroup

getAccessControlEffect

getDefaultRetentionPolicy

getMailboxDetails

getMobileDeviceAccessEffect

listAccessControlRules

listAliases

listGroupMembers

listGroups

listMailboxExportJobs

listMailboxPermissions

listMobileDeviceAccessRules

listOrganizations

listResourceDelegates

listResources

listTagsForResource

listUsers

putAccessControlRule

putMailboxPermissions

putRetentionPolicy

registerToWorkMail

resetPassword

startMailboxExportJob

tagResource

untagResource

updateMailboxQuota

updateMobileDeviceAccessRule

updatePrimaryEmailAddress

updateResource

getCachedResponseMetadata

shutdown