AmazonWorkMail (AWS Java SDK for Amazon WorkMail 1.12.276 API)

All Known Subinterfaces:

AmazonWorkMailAsync

All Known Implementing Classes:

AbstractAmazonWorkMail, AbstractAmazonWorkMailAsync, AmazonWorkMailAsyncClient, AmazonWorkMailClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonWorkMail
```
Interface for accessing Amazon WorkMail.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonWorkMail instead.

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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociateDelegateToResourceResult`	`associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)` Adds a member (user or group) to the resource's set of delegates.
`AssociateMemberToGroupResult`	`associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)` Adds a member (user or group) to the group's set.
`CancelMailboxExportJobResult`	`cancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest)` Cancels a mailbox export job.
`CreateAliasResult`	`createAlias(CreateAliasRequest createAliasRequest)` Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
`CreateAvailabilityConfigurationResult`	`createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest)` Creates an `AvailabilityConfiguration` for the given WorkMail organization and domain.
`CreateGroupResult`	`createGroup(CreateGroupRequest createGroupRequest)` Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
`CreateMobileDeviceAccessRuleResult`	`createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest)` Creates a new mobile device access rule for the specified Amazon WorkMail organization.
`CreateOrganizationResult`	`createOrganization(CreateOrganizationRequest createOrganizationRequest)` Creates a new Amazon WorkMail organization.
`CreateResourceResult`	`createResource(CreateResourceRequest createResourceRequest)` Creates a new Amazon WorkMail resource.
`CreateUserResult`	`createUser(CreateUserRequest createUserRequest)` Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
`DeleteAccessControlRuleResult`	`deleteAccessControlRule(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest)` Deletes an access control rule for the specified WorkMail organization.
`DeleteAliasResult`	`deleteAlias(DeleteAliasRequest deleteAliasRequest)` Remove one or more specified aliases from a set of aliases for a given user.
`DeleteAvailabilityConfigurationResult`	`deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest)` Deletes the `AvailabilityConfiguration` for the given WorkMail organization and domain.
`DeleteEmailMonitoringConfigurationResult`	`deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest)` Deletes the email monitoring configuration for a specified organization.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest deleteGroupRequest)` Deletes a group from Amazon WorkMail.
`DeleteMailboxPermissionsResult`	`deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest)` Deletes permissions granted to a member (user or group).
`DeleteMobileDeviceAccessOverrideResult`	`deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest)` Deletes the mobile device access override for the given WorkMail organization, user, and device.
`DeleteMobileDeviceAccessRuleResult`	`deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest)` Deletes a mobile device access rule for the specified Amazon WorkMail organization.
`DeleteOrganizationResult`	`deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest)` Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization.
`DeleteResourceResult`	`deleteResource(DeleteResourceRequest deleteResourceRequest)` Deletes the specified resource.
`DeleteRetentionPolicyResult`	`deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)` Deletes the specified retention policy from the specified organization.
`DeleteUserResult`	`deleteUser(DeleteUserRequest deleteUserRequest)` Deletes a user from Amazon WorkMail and all subsequent systems.
`DeregisterFromWorkMailResult`	`deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)` Mark a user, group, or resource as no longer used in Amazon WorkMail.
`DeregisterMailDomainResult`	`deregisterMailDomain(DeregisterMailDomainRequest deregisterMailDomainRequest)` Removes a domain from Amazon WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.
`DescribeEmailMonitoringConfigurationResult`	`describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest)` Describes the current email monitoring configuration for a specified organization.
`DescribeGroupResult`	`describeGroup(DescribeGroupRequest describeGroupRequest)` Returns the data available for the group.
`DescribeInboundDmarcSettingsResult`	`describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest)` Lists the settings in a DMARC policy for a specified organization.
`DescribeMailboxExportJobResult`	`describeMailboxExportJob(DescribeMailboxExportJobRequest describeMailboxExportJobRequest)` Describes the current status of a mailbox export job.
`DescribeOrganizationResult`	`describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)` Provides more information regarding a given organization based on its identifier.
`DescribeResourceResult`	`describeResource(DescribeResourceRequest describeResourceRequest)` Returns the data available for the resource.
`DescribeUserResult`	`describeUser(DescribeUserRequest describeUserRequest)` Provides information regarding the user.
`DisassociateDelegateFromResourceResult`	`disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)` Removes a member from the resource's set of delegates.
`DisassociateMemberFromGroupResult`	`disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)` Removes a member from a group.
`GetAccessControlEffectResult`	`getAccessControlEffect(GetAccessControlEffectRequest getAccessControlEffectRequest)` 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 getDefaultRetentionPolicyRequest)` Gets the default retention policy details for the specified organization.
`GetMailboxDetailsResult`	`getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest)` Requests a user's mailbox details for a specified organization and user.
`GetMailDomainResult`	`getMailDomain(GetMailDomainRequest getMailDomainRequest)` Gets details for a mail domain, including domain records required to configure your domain with recommended security.
`GetMobileDeviceAccessEffectResult`	`getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest)` Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
`GetMobileDeviceAccessOverrideResult`	`getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest)` Gets the mobile device access override for the given WorkMail organization, user, and device.
`ListAccessControlRulesResult`	`listAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest)` Lists the access control rules for the specified organization.
`ListAliasesResult`	`listAliases(ListAliasesRequest listAliasesRequest)` Creates a paginated call to list the aliases associated with a given entity.
`ListAvailabilityConfigurationsResult`	`listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)` List all the `AvailabilityConfiguration`'s for the given WorkMail organization.
`ListGroupMembersResult`	`listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)` Returns an overview of the members of a group.
`ListGroupsResult`	`listGroups(ListGroupsRequest listGroupsRequest)` Returns summaries of the organization's groups.
`ListMailboxExportJobsResult`	`listMailboxExportJobs(ListMailboxExportJobsRequest listMailboxExportJobsRequest)` Lists the mailbox export jobs started for the specified organization within the last seven days.
`ListMailboxPermissionsResult`	`listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest)` Lists the mailbox permissions associated with a user, group, or resource mailbox.
`ListMailDomainsResult`	`listMailDomains(ListMailDomainsRequest listMailDomainsRequest)` Lists the mail domains in a given Amazon WorkMail organization.
`ListMobileDeviceAccessOverridesResult`	`listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)` Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
`ListMobileDeviceAccessRulesResult`	`listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest)` Lists the mobile device access rules for the specified Amazon WorkMail organization.
`ListOrganizationsResult`	`listOrganizations(ListOrganizationsRequest listOrganizationsRequest)` Returns summaries of the customer's organizations.
`ListResourceDelegatesResult`	`listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)` Lists the delegates associated with a resource.
`ListResourcesResult`	`listResources(ListResourcesRequest listResourcesRequest)` Returns summaries of the organization's resources.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists the tags applied to an Amazon WorkMail organization resource.
`ListUsersResult`	`listUsers(ListUsersRequest listUsersRequest)` Returns summaries of the organization's users.
`PutAccessControlRuleResult`	`putAccessControlRule(PutAccessControlRuleRequest putAccessControlRuleRequest)` Adds a new access control rule for the specified organization.
`PutEmailMonitoringConfigurationResult`	`putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest)` Creates or updates the email monitoring configuration for a specified organization.
`PutInboundDmarcSettingsResult`	`putInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest)` Enables or disables a DMARC policy for a given organization.
`PutMailboxPermissionsResult`	`putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest)` Sets permissions for a user, group, or resource.
`PutMobileDeviceAccessOverrideResult`	`putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest)` Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
`PutRetentionPolicyResult`	`putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)` Puts a retention policy to the specified organization.
`RegisterMailDomainResult`	`registerMailDomain(RegisterMailDomainRequest registerMailDomainRequest)` Registers a new domain in Amazon WorkMail and SES, and configures it for use by WorkMail.
`RegisterToWorkMailResult`	`registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)` Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities.
`ResetPasswordResult`	`resetPassword(ResetPasswordRequest resetPasswordRequest)` 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 startMailboxExportJobRequest)` Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Applies the specified tags to the specified Amazon WorkMail organization resource.
`TestAvailabilityConfigurationResult`	`testAvailabilityConfiguration(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest)` Performs a test on an availability provider to ensure that access is allowed.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Untags the specified tags from the specified Amazon WorkMail organization resource.
`UpdateAvailabilityConfigurationResult`	`updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest)` Updates an existing `AvailabilityConfiguration` for the given WorkMail organization and domain.
`UpdateDefaultMailDomainResult`	`updateDefaultMailDomain(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest)` Updates the default mail domain for an organization.
`UpdateMailboxQuotaResult`	`updateMailboxQuota(UpdateMailboxQuotaRequest updateMailboxQuotaRequest)` Updates a user's current mailbox quota for a specified organization and user.
`UpdateMobileDeviceAccessRuleResult`	`updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest)` Updates a mobile device access rule for the specified Amazon WorkMail organization.
`UpdatePrimaryEmailAddressResult`	`updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)` Updates the primary email for a user, group, or resource.
`UpdateResourceResult`	`updateResource(UpdateResourceRequest updateResourceRequest)` Updates data for the resource.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - associateDelegateToResource
```
AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
```
    Adds a member (user or group) to the resource's set of delegates.
    
    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
```
AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
```
    Adds a member (user or group) to the group's set.
    
    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
```
CancelMailboxExportJobResult cancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest)
```
    Cancels a mailbox export job.
    
    If the mailbox export job is near completion, it might not be possible to cancel it.
    
    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
```
CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)
```
    Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
    
    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 - The domain specified is not found in your 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
  - createAvailabilityConfiguration
```
CreateAvailabilityConfigurationResult createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest)
```
    Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
    
    Parameters:
    
    createAvailabilityConfigurationRequest -
    
    Returns:
    
    Result of the CreateAvailabilityConfiguration 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.
    
    NameAvailabilityException - The user, group, or resource name isn't unique in Amazon WorkMail.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    LimitExceededException - The request exceeds the limit of the resource.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
```
    Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    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
```
CreateMobileDeviceAccessRuleResult createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest)
```
    Creates a new mobile device access rule for the specified Amazon WorkMail organization.
    
    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
```
CreateOrganizationResult createOrganization(CreateOrganizationRequest createOrganizationRequest)
```
    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.
    
    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
```
CreateResourceResult createResource(CreateResourceRequest createResourceRequest)
```
    Creates a new Amazon WorkMail resource.
    
    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
```
CreateUserResult createUser(CreateUserRequest createUserRequest)
```
    Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    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
```
DeleteAccessControlRuleResult deleteAccessControlRule(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest)
```
    Deletes an access control rule for the specified WorkMail organization.
    
    Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
    
    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
```
DeleteAliasResult deleteAlias(DeleteAliasRequest deleteAliasRequest)
```
    Remove one or more specified aliases from a set of aliases for a given user.
    
    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
  - deleteAvailabilityConfiguration
```
DeleteAvailabilityConfigurationResult deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest)
```
    Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
    
    Parameters:
    
    deleteAvailabilityConfigurationRequest -
    
    Returns:
    
    Result of the DeleteAvailabilityConfiguration 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
  - deleteEmailMonitoringConfiguration
```
DeleteEmailMonitoringConfigurationResult deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest)
```
    Deletes the email monitoring configuration for a specified organization.
    
    Parameters:
    
    deleteEmailMonitoringConfigurationRequest -
    
    Returns:
    
    Result of the DeleteEmailMonitoringConfiguration 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
  - deleteGroup
```
DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
```
    Deletes a group from Amazon WorkMail.
    
    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
```
DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest)
```
    Deletes permissions granted to a member (user or group).
    
    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
  - deleteMobileDeviceAccessOverride
```
DeleteMobileDeviceAccessOverrideResult deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest)
```
    Deletes the mobile device access override for the given WorkMail organization, user, and device.
    
    Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
    
    Parameters:
    
    deleteMobileDeviceAccessOverrideRequest -
    
    Returns:
    
    Result of the DeleteMobileDeviceAccessOverride 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
  - deleteMobileDeviceAccessRule
```
DeleteMobileDeviceAccessRuleResult deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest)
```
    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.
    
    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
```
DeleteOrganizationResult deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest)
```
    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.
    
    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
```
DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)
```
    Deletes the specified resource.
    
    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
```
DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
```
    Deletes the specified retention policy from the specified organization.
    
    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
```
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    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.
    
    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
```
DeregisterFromWorkMailResult deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
```
    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.
    
    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
  - deregisterMailDomain
```
DeregisterMailDomainResult deregisterMailDomain(DeregisterMailDomainRequest deregisterMailDomainRequest)
```
    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.
    
    Parameters:
    
    deregisterMailDomainRequest -
    
    Returns:
    
    Result of the DeregisterMailDomain operation returned by the service.
    
    Throws:
    
    MailDomainInUseException - The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
    
    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.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    InvalidCustomSesConfigurationException - You SES configuration has customizations that Amazon WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
    
    See Also:
    
    AWS API Documentation
  - describeEmailMonitoringConfiguration
```
DescribeEmailMonitoringConfigurationResult describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest)
```
    Describes the current email monitoring configuration for a specified organization.
    
    Parameters:
    
    describeEmailMonitoringConfigurationRequest -
    
    Returns:
    
    Result of the DescribeEmailMonitoringConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource cannot be found.
    
    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
```
DescribeGroupResult describeGroup(DescribeGroupRequest describeGroupRequest)
```
    Returns the data available for the group.
    
    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
  - describeInboundDmarcSettings
```
DescribeInboundDmarcSettingsResult describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest)
```
    Lists the settings in a DMARC policy for a specified organization.
    
    Parameters:
    
    describeInboundDmarcSettingsRequest -
    
    Returns:
    
    Result of the DescribeInboundDmarcSettings 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
  - describeMailboxExportJob
```
DescribeMailboxExportJobResult describeMailboxExportJob(DescribeMailboxExportJobRequest describeMailboxExportJobRequest)
```
    Describes the current status of a mailbox export job.
    
    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
```
DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
```
    Provides more information regarding a given organization based on its identifier.
    
    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
```
DescribeResourceResult describeResource(DescribeResourceRequest describeResourceRequest)
```
    Returns the data available for the resource.
    
    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
```
DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
```
    Provides information regarding the user.
    
    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
```
DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
```
    Removes a member from the resource's set of delegates.
    
    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
```
DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
```
    Removes a member from a group.
    
    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
```
GetAccessControlEffectResult getAccessControlEffect(GetAccessControlEffectRequest getAccessControlEffectRequest)
```
    Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.
    
    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
```
GetDefaultRetentionPolicyResult getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest)
```
    Gets the default retention policy details for the specified organization.
    
    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
  - getMailDomain
```
GetMailDomainResult getMailDomain(GetMailDomainRequest getMailDomainRequest)
```
    Gets details for a mail domain, including domain records required to configure your domain with recommended security.
    
    Parameters:
    
    getMailDomainRequest -
    
    Returns:
    
    Result of the GetMailDomain operation returned by the service.
    
    Throws:
    
    MailDomainNotFoundException - The domain specified is not found 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.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    See Also:
    
    AWS API Documentation
  - getMailboxDetails
```
GetMailboxDetailsResult getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest)
```
    Requests a user's mailbox details for a specified organization and user.
    
    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
```
GetMobileDeviceAccessEffectResult getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest)
```
    Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the Amazon WorkMail organization for a particular user's attributes.
    
    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
  - getMobileDeviceAccessOverride
```
GetMobileDeviceAccessOverrideResult getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest)
```
    Gets the mobile device access override for the given WorkMail organization, user, and device.
    
    Parameters:
    
    getMobileDeviceAccessOverrideRequest -
    
    Returns:
    
    Result of the GetMobileDeviceAccessOverride 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.
    
    ResourceNotFoundException - The resource cannot be found.
    
    See Also:
    
    AWS API Documentation
  - listAccessControlRules
```
ListAccessControlRulesResult listAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest)
```
    Lists the access control rules for the specified organization.
    
    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
```
ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest)
```
    Creates a paginated call to list the aliases associated with a given entity.
    
    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
  - listAvailabilityConfigurations
```
ListAvailabilityConfigurationsResult listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)
```
    List all the AvailabilityConfiguration's for the given WorkMail organization.
    
    Parameters:
    
    listAvailabilityConfigurationsRequest -
    
    Returns:
    
    Result of the ListAvailabilityConfigurations 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
  - listGroupMembers
```
ListGroupMembersResult listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
```
    Returns an overview of the members of a group. Users and groups can be members of a group.
    
    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
```
ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
```
    Returns summaries of the organization's groups.
    
    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
  - listMailDomains
```
ListMailDomainsResult listMailDomains(ListMailDomainsRequest listMailDomainsRequest)
```
    Lists the mail domains in a given Amazon WorkMail organization.
    
    Parameters:
    
    listMailDomainsRequest -
    
    Returns:
    
    Result of the ListMailDomains 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
  - listMailboxExportJobs
```
ListMailboxExportJobsResult listMailboxExportJobs(ListMailboxExportJobsRequest listMailboxExportJobsRequest)
```
    Lists the mailbox export jobs started for the specified organization within the last seven days.
    
    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
```
ListMailboxPermissionsResult listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
```
    Lists the mailbox permissions associated with a user, group, or resource mailbox.
    
    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
  - listMobileDeviceAccessOverrides
```
ListMobileDeviceAccessOverridesResult listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)
```
    Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
    
    Parameters:
    
    listMobileDeviceAccessOverridesRequest -
    
    Returns:
    
    Result of the ListMobileDeviceAccessOverrides 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
  - listMobileDeviceAccessRules
```
ListMobileDeviceAccessRulesResult listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest)
```
    Lists the mobile device access rules for the specified Amazon WorkMail organization.
    
    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
```
ListOrganizationsResult listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
```
    Returns summaries of the customer's organizations.
    
    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
```
ListResourceDelegatesResult listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
```
    Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
    
    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
```
ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)
```
    Returns summaries of the organization's resources.
    
    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
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists the tags applied to an Amazon WorkMail organization resource.
    
    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
```
ListUsersResult listUsers(ListUsersRequest listUsersRequest)
```
    Returns summaries of the organization's users.
    
    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
```
PutAccessControlRuleResult putAccessControlRule(PutAccessControlRuleRequest putAccessControlRuleRequest)
```
    Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
    
    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
  - putEmailMonitoringConfiguration
```
PutEmailMonitoringConfigurationResult putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest)
```
    Creates or updates the email monitoring configuration for a specified organization.
    
    Parameters:
    
    putEmailMonitoringConfigurationRequest -
    
    Returns:
    
    Result of the PutEmailMonitoringConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource cannot be found.
    
    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
  - putInboundDmarcSettings
```
PutInboundDmarcSettingsResult putInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest)
```
    Enables or disables a DMARC policy for a given organization.
    
    Parameters:
    
    putInboundDmarcSettingsRequest -
    
    Returns:
    
    Result of the PutInboundDmarcSettings 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
  - putMailboxPermissions
```
PutMailboxPermissionsResult putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest)
```
    Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
    
    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
  - putMobileDeviceAccessOverride
```
PutMobileDeviceAccessOverrideResult putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest)
```
    Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
    
    Parameters:
    
    putMobileDeviceAccessOverrideRequest -
    
    Returns:
    
    Result of the PutMobileDeviceAccessOverride 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
  - putRetentionPolicy
```
PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)
```
    Puts a retention policy to the specified organization.
    
    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
  - registerMailDomain
```
RegisterMailDomainResult registerMailDomain(RegisterMailDomainRequest registerMailDomainRequest)
```
    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.
    
    Parameters:
    
    registerMailDomainRequest -
    
    Returns:
    
    Result of the RegisterMailDomain operation returned by the service.
    
    Throws:
    
    MailDomainInUseException - The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
    
    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.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    See Also:
    
    AWS API Documentation
  - registerToWorkMail
```
RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
```
    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.
    
    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 - The domain specified is not found in your 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
```
ResetPasswordResult resetPassword(ResetPasswordRequest resetPasswordRequest)
```
    Allows the administrator to reset the password for a user.
    
    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
```
StartMailboxExportJobResult startMailboxExportJob(StartMailboxExportJobRequest startMailboxExportJobRequest)
```
    Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the Amazon WorkMail Administrator Guide.
    
    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
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Applies the specified tags to the specified Amazon WorkMail organization resource.
    
    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
  - testAvailabilityConfiguration
```
TestAvailabilityConfigurationResult testAvailabilityConfiguration(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest)
```
    Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.
    
    The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.
    
    Parameters:
    
    testAvailabilityConfigurationRequest -
    
    Returns:
    
    Result of the TestAvailabilityConfiguration 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.
    
    ResourceNotFoundException - The resource cannot be found.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Untags the specified tags from the specified Amazon WorkMail organization resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource cannot be found.
    
    See Also:
    
    AWS API Documentation
  - updateAvailabilityConfiguration
```
UpdateAvailabilityConfigurationResult updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest)
```
    Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
    
    Parameters:
    
    updateAvailabilityConfigurationRequest -
    
    Returns:
    
    Result of the UpdateAvailabilityConfiguration 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.
    
    ResourceNotFoundException - The resource cannot be found.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    See Also:
    
    AWS API Documentation
  - updateDefaultMailDomain
```
UpdateDefaultMailDomainResult updateDefaultMailDomain(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest)
```
    Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
    
    Parameters:
    
    updateDefaultMailDomainRequest -
    
    Returns:
    
    Result of the UpdateDefaultMailDomain operation returned by the service.
    
    Throws:
    
    MailDomainNotFoundException - The domain specified is not found in your 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.
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    See Also:
    
    AWS API Documentation
  - updateMailboxQuota
```
UpdateMailboxQuotaResult updateMailboxQuota(UpdateMailboxQuotaRequest updateMailboxQuotaRequest)
```
    Updates a user's current mailbox quota for a specified organization and user.
    
    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
```
UpdateMobileDeviceAccessRuleResult updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest)
```
    Updates a mobile device access rule for the specified Amazon WorkMail organization.
    
    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
```
UpdatePrimaryEmailAddressResult updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
```
    Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
    
    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 - The domain specified is not found in your 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
```
UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
```
    Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.
    
    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 - The domain specified is not found in your 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
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AmazonWorkMail

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

associateDelegateToResource

associateMemberToGroup

cancelMailboxExportJob

createAlias

createAvailabilityConfiguration

createGroup

createMobileDeviceAccessRule

createOrganization

createResource

createUser

deleteAccessControlRule

deleteAlias

deleteAvailabilityConfiguration

deleteEmailMonitoringConfiguration

deleteGroup

deleteMailboxPermissions

deleteMobileDeviceAccessOverride

deleteMobileDeviceAccessRule

deleteOrganization

deleteResource

deleteRetentionPolicy

deleteUser

deregisterFromWorkMail

deregisterMailDomain

describeEmailMonitoringConfiguration

describeGroup

describeInboundDmarcSettings

describeMailboxExportJob

describeOrganization

describeResource

describeUser

disassociateDelegateFromResource

disassociateMemberFromGroup

getAccessControlEffect

getDefaultRetentionPolicy

getMailDomain

getMailboxDetails

getMobileDeviceAccessEffect

getMobileDeviceAccessOverride

listAccessControlRules

listAliases

listAvailabilityConfigurations

listGroupMembers

listGroups

listMailDomains

listMailboxExportJobs

listMailboxPermissions

listMobileDeviceAccessOverrides

listMobileDeviceAccessRules

listOrganizations

listResourceDelegates

listResources

listTagsForResource

listUsers

putAccessControlRule

putEmailMonitoringConfiguration

putInboundDmarcSettings

putMailboxPermissions

putMobileDeviceAccessOverride

putRetentionPolicy

registerMailDomain

registerToWorkMail

resetPassword

startMailboxExportJob

tagResource

testAvailabilityConfiguration

untagResource

updateAvailabilityConfiguration

updateDefaultMailDomain

updateMailboxQuota

updateMobileDeviceAccessRule

updatePrimaryEmailAddress

updateResource

shutdown