@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonWorkMailClient extends AmazonWebServiceClient implements AmazonWorkMail
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AssociateDelegateToResourceResult |
associateDelegateToResource(AssociateDelegateToResourceRequest request)
Adds a member (user or group) to the resource's set of delegates.
|
AssociateMemberToGroupResult |
associateMemberToGroup(AssociateMemberToGroupRequest request)
Adds a member (user or group) to the group's set.
|
AssumeImpersonationRoleResult |
assumeImpersonationRole(AssumeImpersonationRoleRequest request)
Assumes an impersonation role for the given WorkMail organization.
|
static AmazonWorkMailClientBuilder |
builder() |
CancelMailboxExportJobResult |
cancelMailboxExportJob(CancelMailboxExportJobRequest request)
Cancels a mailbox export job.
|
CreateAliasResult |
createAlias(CreateAliasRequest request)
Adds an alias to the set of a given member (user or group) of WorkMail.
|
CreateAvailabilityConfigurationResult |
createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest request)
Creates an
AvailabilityConfiguration for the given WorkMail organization and domain. |
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
|
CreateImpersonationRoleResult |
createImpersonationRole(CreateImpersonationRoleRequest request)
Creates an impersonation role for the given WorkMail organization.
|
CreateMobileDeviceAccessRuleResult |
createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest request)
Creates a new mobile device access rule for the specified WorkMail organization.
|
CreateOrganizationResult |
createOrganization(CreateOrganizationRequest request)
Creates a new WorkMail organization.
|
CreateResourceResult |
createResource(CreateResourceRequest request)
Creates a new WorkMail resource.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
|
DeleteAccessControlRuleResult |
deleteAccessControlRule(DeleteAccessControlRuleRequest request)
Deletes an access control rule for the specified WorkMail organization.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest request)
Remove one or more specified aliases from a set of aliases for a given user.
|
DeleteAvailabilityConfigurationResult |
deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest request)
Deletes the
AvailabilityConfiguration for the given WorkMail organization and domain. |
DeleteEmailMonitoringConfigurationResult |
deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest request)
Deletes the email monitoring configuration for a specified organization.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Deletes a group from WorkMail.
|
DeleteImpersonationRoleResult |
deleteImpersonationRole(DeleteImpersonationRoleRequest request)
Deletes an impersonation role for the given WorkMail organization.
|
DeleteMailboxPermissionsResult |
deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
Deletes permissions granted to a member (user or group).
|
DeleteMobileDeviceAccessOverrideResult |
deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest request)
Deletes the mobile device access override for the given WorkMail organization, user, and device.
|
DeleteMobileDeviceAccessRuleResult |
deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest request)
Deletes a mobile device access rule for the specified WorkMail organization.
|
DeleteOrganizationResult |
deleteOrganization(DeleteOrganizationRequest request)
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the
organization.
|
DeleteResourceResult |
deleteResource(DeleteResourceRequest request)
Deletes the specified resource.
|
DeleteRetentionPolicyResult |
deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
Deletes the specified retention policy from the specified organization.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user from WorkMail and all subsequent systems.
|
DeregisterFromWorkMailResult |
deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
Mark a user, group, or resource as no longer used in WorkMail.
|
DeregisterMailDomainResult |
deregisterMailDomain(DeregisterMailDomainRequest request)
Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail
use.
|
DescribeEmailMonitoringConfigurationResult |
describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest request)
Describes the current email monitoring configuration for a specified organization.
|
DescribeEntityResult |
describeEntity(DescribeEntityRequest request)
Returns basic details about an entity in WorkMail.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest request)
Returns the data available for the group.
|
DescribeInboundDmarcSettingsResult |
describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest request)
Lists the settings in a DMARC policy for a specified organization.
|
DescribeMailboxExportJobResult |
describeMailboxExportJob(DescribeMailboxExportJobRequest request)
Describes the current status of a mailbox export job.
|
DescribeOrganizationResult |
describeOrganization(DescribeOrganizationRequest request)
Provides more information regarding a given organization based on its identifier.
|
DescribeResourceResult |
describeResource(DescribeResourceRequest request)
Returns the data available for the resource.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Provides information regarding the user.
|
DisassociateDelegateFromResourceResult |
disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
Removes a member from the resource's set of delegates.
|
DisassociateMemberFromGroupResult |
disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
Removes a member from a group.
|
GetAccessControlEffectResult |
getAccessControlEffect(GetAccessControlEffectRequest request)
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access
protocol action, and user ID or impersonation role ID.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDefaultRetentionPolicyResult |
getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest request)
Gets the default retention policy details for the specified organization.
|
GetImpersonationRoleResult |
getImpersonationRole(GetImpersonationRoleRequest request)
Gets the impersonation role details for the given WorkMail organization.
|
GetImpersonationRoleEffectResult |
getImpersonationRoleEffect(GetImpersonationRoleEffectRequest request)
Tests whether the given impersonation role can impersonate a target user.
|
GetMailboxDetailsResult |
getMailboxDetails(GetMailboxDetailsRequest request)
Requests a user's mailbox details for a specified organization and user.
|
GetMailDomainResult |
getMailDomain(GetMailDomainRequest request)
Gets details for a mail domain, including domain records required to configure your domain with recommended
security.
|
GetMobileDeviceAccessEffectResult |
getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest request)
Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
|
GetMobileDeviceAccessOverrideResult |
getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest request)
Gets the mobile device access override for the given WorkMail organization, user, and device.
|
ListAccessControlRulesResult |
listAccessControlRules(ListAccessControlRulesRequest request)
Lists the access control rules for the specified organization.
|
ListAliasesResult |
listAliases(ListAliasesRequest request)
Creates a paginated call to list the aliases associated with a given entity.
|
ListAvailabilityConfigurationsResult |
listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest request)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
ListGroupMembersResult |
listGroupMembers(ListGroupMembersRequest request)
Returns an overview of the members of a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Returns summaries of the organization's groups.
|
ListGroupsForEntityResult |
listGroupsForEntity(ListGroupsForEntityRequest request)
Returns all the groups to which an entity belongs.
|
ListImpersonationRolesResult |
listImpersonationRoles(ListImpersonationRolesRequest request)
Lists all the impersonation roles for the given WorkMail organization.
|
ListMailboxExportJobsResult |
listMailboxExportJobs(ListMailboxExportJobsRequest request)
Lists the mailbox export jobs started for the specified organization within the last seven days.
|
ListMailboxPermissionsResult |
listMailboxPermissions(ListMailboxPermissionsRequest request)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
ListMailDomainsResult |
listMailDomains(ListMailDomainsRequest request)
Lists the mail domains in a given WorkMail organization.
|
ListMobileDeviceAccessOverridesResult |
listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest request)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
ListMobileDeviceAccessRulesResult |
listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest request)
Lists the mobile device access rules for the specified WorkMail organization.
|
ListOrganizationsResult |
listOrganizations(ListOrganizationsRequest request)
Returns summaries of the customer's organizations.
|
ListResourceDelegatesResult |
listResourceDelegates(ListResourceDelegatesRequest request)
Lists the delegates associated with a resource.
|
ListResourcesResult |
listResources(ListResourcesRequest request)
Returns summaries of the organization's resources.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags applied to an WorkMail organization resource.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Returns summaries of the organization's users.
|
PutAccessControlRuleResult |
putAccessControlRule(PutAccessControlRuleRequest request)
Adds a new access control rule for the specified organization.
|
PutEmailMonitoringConfigurationResult |
putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest request)
Creates or updates the email monitoring configuration for a specified organization.
|
PutInboundDmarcSettingsResult |
putInboundDmarcSettings(PutInboundDmarcSettingsRequest request)
Enables or disables a DMARC policy for a given organization.
|
PutMailboxPermissionsResult |
putMailboxPermissions(PutMailboxPermissionsRequest request)
Sets permissions for a user, group, or resource.
|
PutMobileDeviceAccessOverrideResult |
putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest request)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
|
PutRetentionPolicyResult |
putRetentionPolicy(PutRetentionPolicyRequest request)
Puts a retention policy to the specified organization.
|
RegisterMailDomainResult |
registerMailDomain(RegisterMailDomainRequest request)
Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.
|
RegisterToWorkMailResult |
registerToWorkMail(RegisterToWorkMailRequest request)
Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and
calendaring capabilities.
|
ResetPasswordResult |
resetPassword(ResetPasswordRequest request)
Allows the administrator to reset the password for a user.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartMailboxExportJobResult |
startMailboxExportJob(StartMailboxExportJobRequest request)
Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to
the specified Amazon Simple Storage Service (Amazon S3) bucket.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Applies the specified tags to the specified WorkMailorganization resource.
|
TestAvailabilityConfigurationResult |
testAvailabilityConfiguration(TestAvailabilityConfigurationRequest request)
Performs a test on an availability provider to ensure that access is allowed.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Untags the specified tags from the specified WorkMail organization resource.
|
UpdateAvailabilityConfigurationResult |
updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest request)
Updates an existing
AvailabilityConfiguration for the given WorkMail organization and domain. |
UpdateDefaultMailDomainResult |
updateDefaultMailDomain(UpdateDefaultMailDomainRequest request)
Updates the default mail domain for an organization.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest request)
Updates attibutes in a group.
|
UpdateImpersonationRoleResult |
updateImpersonationRole(UpdateImpersonationRoleRequest request)
Updates an impersonation role for the given WorkMail organization.
|
UpdateMailboxQuotaResult |
updateMailboxQuota(UpdateMailboxQuotaRequest request)
Updates a user's current mailbox quota for a specified organization and user.
|
UpdateMobileDeviceAccessRuleResult |
updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest request)
Updates a mobile device access rule for the specified WorkMail organization.
|
UpdatePrimaryEmailAddressResult |
updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
Updates the primary email for a user, group, or resource.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest request)
Updates data for the resource.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Updates data for the user.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonWorkMailClientBuilder builder()
public AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest request)
Adds a member (user or group) to the resource's set of delegates.
associateDelegateToResource in interface AmazonWorkMailassociateDelegateToResourceRequest - 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.public AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest request)
Adds a member (user or group) to the group's set.
associateMemberToGroup in interface AmazonWorkMailassociateMemberToGroupRequest - 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.public AssumeImpersonationRoleResult assumeImpersonationRole(AssumeImpersonationRoleRequest request)
Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
assumeImpersonationRole in interface AmazonWorkMailassumeImpersonationRoleRequest - 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.ResourceNotFoundException - The resource cannot be found.public CancelMailboxExportJobResult cancelMailboxExportJob(CancelMailboxExportJobRequest request)
Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
cancelMailboxExportJob in interface AmazonWorkMailcancelMailboxExportJobRequest - 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.public CreateAliasResult createAlias(CreateAliasRequest request)
Adds an alias to the set of a given member (user or group) of WorkMail.
createAlias in interface AmazonWorkMailcreateAliasRequest - 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.public CreateAvailabilityConfigurationResult createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest request)
Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
createAvailabilityConfiguration in interface AmazonWorkMailcreateAvailabilityConfigurationRequest - 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 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.public CreateGroupResult createGroup(CreateGroupRequest request)
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
createGroup in interface AmazonWorkMailcreateGroupRequest - 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 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 WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.public CreateImpersonationRoleResult createImpersonationRole(CreateImpersonationRoleRequest request)
Creates an impersonation role for the given WorkMail organization.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.
createImpersonationRole in interface AmazonWorkMailcreateImpersonationRoleRequest - 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.LimitExceededException - The request exceeds the limit of the resource.public CreateMobileDeviceAccessRuleResult createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest request)
Creates a new mobile device access rule for the specified WorkMail organization.
createMobileDeviceAccessRule in interface AmazonWorkMailcreateMobileDeviceAccessRuleRequest - 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.public CreateOrganizationResult createOrganization(CreateOrganizationRequest request)
Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide.
Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
createOrganization in interface AmazonWorkMailcreateOrganizationRequest - 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 WorkMail.public CreateResourceResult createResource(CreateResourceRequest request)
Creates a new WorkMail resource.
createResource in interface AmazonWorkMailcreateResourceRequest - 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 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 WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.public CreateUserResult createUser(CreateUserRequest request)
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
createUser in interface AmazonWorkMailcreateUserRequest - 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 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 WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.public DeleteAccessControlRuleResult deleteAccessControlRule(DeleteAccessControlRuleRequest request)
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.
deleteAccessControlRule in interface AmazonWorkMaildeleteAccessControlRuleRequest - 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.public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
Remove one or more specified aliases from a set of aliases for a given user.
deleteAlias in interface AmazonWorkMaildeleteAliasRequest - 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.public DeleteAvailabilityConfigurationResult deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest request)
Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
deleteAvailabilityConfiguration in interface AmazonWorkMaildeleteAvailabilityConfigurationRequest - 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.public DeleteEmailMonitoringConfigurationResult deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest request)
Deletes the email monitoring configuration for a specified organization.
deleteEmailMonitoringConfiguration in interface AmazonWorkMaildeleteEmailMonitoringConfigurationRequest - 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.public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
Deletes a group from WorkMail.
deleteGroup in interface AmazonWorkMaildeleteGroupRequest - 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.public DeleteImpersonationRoleResult deleteImpersonationRole(DeleteImpersonationRoleRequest request)
Deletes an impersonation role for the given WorkMail organization.
deleteImpersonationRole in interface AmazonWorkMaildeleteImpersonationRoleRequest - 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.public DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
Deletes permissions granted to a member (user or group).
deleteMailboxPermissions in interface AmazonWorkMaildeleteMailboxPermissionsRequest - 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.public DeleteMobileDeviceAccessOverrideResult deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest request)
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.
deleteMobileDeviceAccessOverride in interface AmazonWorkMaildeleteMobileDeviceAccessOverrideRequest - 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.public DeleteMobileDeviceAccessRuleResult deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest request)
Deletes a mobile device access rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
deleteMobileDeviceAccessRule in interface AmazonWorkMaildeleteMobileDeviceAccessRuleRequest - 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.public DeleteOrganizationResult deleteOrganization(DeleteOrganizationRequest request)
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.
deleteOrganization in interface AmazonWorkMaildeleteOrganizationRequest - 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.public DeleteResourceResult deleteResource(DeleteResourceRequest request)
Deletes the specified resource.
deleteResource in interface AmazonWorkMaildeleteResourceRequest - 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.public DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
Deletes the specified retention policy from the specified organization.
deleteRetentionPolicy in interface AmazonWorkMaildeleteRetentionPolicyRequest - 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.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be
DISABLED. Use the DescribeUser action to confirm the user state.
Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
deleteUser in interface AmazonWorkMaildeleteUserRequest - 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.public DeregisterFromWorkMailResult deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
deregisterFromWorkMail in interface AmazonWorkMailderegisterFromWorkMailRequest - 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.public DeregisterMailDomainResult deregisterMailDomain(DeregisterMailDomainRequest request)
Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
deregisterMailDomain in interface AmazonWorkMailderegisterMailDomainRequest - 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 WorkMail cannot save. The error message lists the invalid
setting. For examples of invalid settings, refer to CreateReceiptRule.public DescribeEmailMonitoringConfigurationResult describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest request)
Describes the current email monitoring configuration for a specified organization.
describeEmailMonitoringConfiguration in interface AmazonWorkMaildescribeEmailMonitoringConfigurationRequest - 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.public DescribeEntityResult describeEntity(DescribeEntityRequest request)
Returns basic details about an entity in WorkMail.
describeEntity in interface AmazonWorkMaildescribeEntityRequest - 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.public DescribeGroupResult describeGroup(DescribeGroupRequest request)
Returns the data available for the group.
describeGroup in interface AmazonWorkMaildescribeGroupRequest - 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.public DescribeInboundDmarcSettingsResult describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest request)
Lists the settings in a DMARC policy for a specified organization.
describeInboundDmarcSettings in interface AmazonWorkMaildescribeInboundDmarcSettingsRequest - 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.public DescribeMailboxExportJobResult describeMailboxExportJob(DescribeMailboxExportJobRequest request)
Describes the current status of a mailbox export job.
describeMailboxExportJob in interface AmazonWorkMaildescribeMailboxExportJobRequest - 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.public DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
Provides more information regarding a given organization based on its identifier.
describeOrganization in interface AmazonWorkMaildescribeOrganizationRequest - 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.public DescribeResourceResult describeResource(DescribeResourceRequest request)
Returns the data available for the resource.
describeResource in interface AmazonWorkMaildescribeResourceRequest - 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.UnsupportedOperationException - You can't perform a write operation against a read-only directory.public DescribeUserResult describeUser(DescribeUserRequest request)
Provides information regarding the user.
describeUser in interface AmazonWorkMaildescribeUserRequest - 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.public DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
Removes a member from the resource's set of delegates.
disassociateDelegateFromResource in interface AmazonWorkMaildisassociateDelegateFromResourceRequest - 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.public DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
Removes a member from a group.
disassociateMemberFromGroup in interface AmazonWorkMaildisassociateMemberFromGroupRequest - 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.public GetAccessControlEffectResult getAccessControlEffect(GetAccessControlEffectRequest request)
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
getAccessControlEffect in interface AmazonWorkMailgetAccessControlEffectRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.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.public GetDefaultRetentionPolicyResult getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest request)
Gets the default retention policy details for the specified organization.
getDefaultRetentionPolicy in interface AmazonWorkMailgetDefaultRetentionPolicyRequest - 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.public GetImpersonationRoleResult getImpersonationRole(GetImpersonationRoleRequest request)
Gets the impersonation role details for the given WorkMail organization.
getImpersonationRole in interface AmazonWorkMailgetImpersonationRoleRequest - 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.ResourceNotFoundException - The resource cannot be found.public GetImpersonationRoleEffectResult getImpersonationRoleEffect(GetImpersonationRoleEffectRequest request)
Tests whether the given impersonation role can impersonate a target user.
getImpersonationRoleEffect in interface AmazonWorkMailgetImpersonationRoleEffectRequest - 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.ResourceNotFoundException - The resource cannot be found.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.public GetMailDomainResult getMailDomain(GetMailDomainRequest request)
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
getMailDomain in interface AmazonWorkMailgetMailDomainRequest - 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.public GetMailboxDetailsResult getMailboxDetails(GetMailboxDetailsRequest request)
Requests a user's mailbox details for a specified organization and user.
getMailboxDetails in interface AmazonWorkMailgetMailboxDetailsRequest - 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.public GetMobileDeviceAccessEffectResult getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest request)
Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
getMobileDeviceAccessEffect in interface AmazonWorkMailgetMobileDeviceAccessEffectRequest - 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.public GetMobileDeviceAccessOverrideResult getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest request)
Gets the mobile device access override for the given WorkMail organization, user, and device.
getMobileDeviceAccessOverride in interface AmazonWorkMailgetMobileDeviceAccessOverrideRequest - 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.public ListAccessControlRulesResult listAccessControlRules(ListAccessControlRulesRequest request)
Lists the access control rules for the specified organization.
listAccessControlRules in interface AmazonWorkMaillistAccessControlRulesRequest - 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.public ListAliasesResult listAliases(ListAliasesRequest request)
Creates a paginated call to list the aliases associated with a given entity.
listAliases in interface AmazonWorkMaillistAliasesRequest - 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.public ListAvailabilityConfigurationsResult listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest request)
List all the AvailabilityConfiguration's for the given WorkMail organization.
listAvailabilityConfigurations in interface AmazonWorkMaillistAvailabilityConfigurationsRequest - 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.public ListGroupMembersResult listGroupMembers(ListGroupMembersRequest request)
Returns an overview of the members of a group. Users and groups can be members of a group.
listGroupMembers in interface AmazonWorkMaillistGroupMembersRequest - 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.public ListGroupsResult listGroups(ListGroupsRequest request)
Returns summaries of the organization's groups.
listGroups in interface AmazonWorkMaillistGroupsRequest - 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.public ListGroupsForEntityResult listGroupsForEntity(ListGroupsForEntityRequest request)
Returns all the groups to which an entity belongs.
listGroupsForEntity in interface AmazonWorkMaillistGroupsForEntityRequest - 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.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.public ListImpersonationRolesResult listImpersonationRoles(ListImpersonationRolesRequest request)
Lists all the impersonation roles for the given WorkMail organization.
listImpersonationRoles in interface AmazonWorkMaillistImpersonationRolesRequest - 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.public ListMailDomainsResult listMailDomains(ListMailDomainsRequest request)
Lists the mail domains in a given WorkMail organization.
listMailDomains in interface AmazonWorkMaillistMailDomainsRequest - 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.public ListMailboxExportJobsResult listMailboxExportJobs(ListMailboxExportJobsRequest request)
Lists the mailbox export jobs started for the specified organization within the last seven days.
listMailboxExportJobs in interface AmazonWorkMaillistMailboxExportJobsRequest - 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.public ListMailboxPermissionsResult listMailboxPermissions(ListMailboxPermissionsRequest request)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
listMailboxPermissions in interface AmazonWorkMaillistMailboxPermissionsRequest - 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.public ListMobileDeviceAccessOverridesResult listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest request)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
listMobileDeviceAccessOverrides in interface AmazonWorkMaillistMobileDeviceAccessOverridesRequest - 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.public ListMobileDeviceAccessRulesResult listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest request)
Lists the mobile device access rules for the specified WorkMail organization.
listMobileDeviceAccessRules in interface AmazonWorkMaillistMobileDeviceAccessRulesRequest - 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.public ListOrganizationsResult listOrganizations(ListOrganizationsRequest request)
Returns summaries of the customer's organizations.
listOrganizations in interface AmazonWorkMaillistOrganizationsRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.public ListResourceDelegatesResult listResourceDelegates(ListResourceDelegatesRequest request)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegates in interface AmazonWorkMaillistResourceDelegatesRequest - 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.public ListResourcesResult listResources(ListResourcesRequest request)
Returns summaries of the organization's resources.
listResources in interface AmazonWorkMaillistResourcesRequest - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags applied to an WorkMail organization resource.
listTagsForResource in interface AmazonWorkMaillistTagsForResourceRequest - ResourceNotFoundException - The resource cannot be found.public ListUsersResult listUsers(ListUsersRequest request)
Returns summaries of the organization's users.
listUsers in interface AmazonWorkMaillistUsersRequest - 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.public PutAccessControlRuleResult putAccessControlRule(PutAccessControlRuleRequest request)
Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
putAccessControlRule in interface AmazonWorkMailputAccessControlRuleRequest - 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.ResourceNotFoundException - The resource cannot be found.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.public PutEmailMonitoringConfigurationResult putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest request)
Creates or updates the email monitoring configuration for a specified organization.
putEmailMonitoringConfiguration in interface AmazonWorkMailputEmailMonitoringConfigurationRequest - 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.public PutInboundDmarcSettingsResult putInboundDmarcSettings(PutInboundDmarcSettingsRequest request)
Enables or disables a DMARC policy for a given organization.
putInboundDmarcSettings in interface AmazonWorkMailputInboundDmarcSettingsRequest - 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.public PutMailboxPermissionsResult putMailboxPermissions(PutMailboxPermissionsRequest request)
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
putMailboxPermissions in interface AmazonWorkMailputMailboxPermissionsRequest - 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.public PutMobileDeviceAccessOverrideResult putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest request)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
putMobileDeviceAccessOverride in interface AmazonWorkMailputMobileDeviceAccessOverrideRequest - 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.public PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
Puts a retention policy to the specified organization.
putRetentionPolicy in interface AmazonWorkMailputRetentionPolicyRequest - 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.public RegisterMailDomainResult registerMailDomain(RegisterMailDomainRequest request)
Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
registerMailDomain in interface AmazonWorkMailregisterMailDomainRequest - 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.public RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest request)
Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
registerToWorkMail in interface AmazonWorkMailregisterToWorkMailRequest - 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.public ResetPasswordResult resetPassword(ResetPasswordRequest request)
Allows the administrator to reset the password for a user.
resetPassword in interface AmazonWorkMailresetPasswordRequest - 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.public StartMailboxExportJobResult startMailboxExportJob(StartMailboxExportJobRequest request)
Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
startMailboxExportJob in interface AmazonWorkMailstartMailboxExportJobRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
Applies the specified tags to the specified WorkMailorganization resource.
tagResource in interface AmazonWorkMailtagResourceRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.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.public TestAvailabilityConfigurationResult testAvailabilityConfiguration(TestAvailabilityConfigurationRequest request)
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.
testAvailabilityConfiguration in interface AmazonWorkMailtestAvailabilityConfigurationRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Untags the specified tags from the specified WorkMail organization resource.
untagResource in interface AmazonWorkMailuntagResourceRequest - ResourceNotFoundException - The resource cannot be found.public UpdateAvailabilityConfigurationResult updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest request)
Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
updateAvailabilityConfiguration in interface AmazonWorkMailupdateAvailabilityConfigurationRequest - 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.public UpdateDefaultMailDomainResult updateDefaultMailDomain(UpdateDefaultMailDomainRequest request)
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.
updateDefaultMailDomain in interface AmazonWorkMailupdateDefaultMailDomainRequest - 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.public UpdateGroupResult updateGroup(UpdateGroupRequest request)
Updates attibutes in a group.
updateGroup in interface AmazonWorkMailupdateGroupRequest - 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.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.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.public UpdateImpersonationRoleResult updateImpersonationRole(UpdateImpersonationRoleRequest request)
Updates an impersonation role for the given WorkMail organization.
updateImpersonationRole in interface AmazonWorkMailupdateImpersonationRoleRequest - 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.ResourceNotFoundException - The resource cannot be found.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.LimitExceededException - The request exceeds the limit of the resource.public UpdateMailboxQuotaResult updateMailboxQuota(UpdateMailboxQuotaRequest request)
Updates a user's current mailbox quota for a specified organization and user.
updateMailboxQuota in interface AmazonWorkMailupdateMailboxQuotaRequest - 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.public UpdateMobileDeviceAccessRuleResult updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest request)
Updates a mobile device access rule for the specified WorkMail organization.
updateMobileDeviceAccessRule in interface AmazonWorkMailupdateMobileDeviceAccessRuleRequest - 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.public UpdatePrimaryEmailAddressResult updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
updatePrimaryEmailAddress in interface AmazonWorkMailupdatePrimaryEmailAddressRequest - 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.public UpdateResourceResult updateResource(UpdateResourceRequest request)
Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource
call. The dataset in the request should be the one expected when performing another DescribeResource
call.
updateResource in interface AmazonWorkMailupdateResourceRequest - 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 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.UnsupportedOperationException - You can't perform a write operation against a read-only directory.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.public UpdateUserResult updateUser(UpdateUserRequest request)
Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The
dataset in the request should be the one expected when performing another DescribeUser call.
updateUser in interface AmazonWorkMailupdateUserRequest - 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.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.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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonWorkMailrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonWorkMailshutdown in class AmazonWebServiceClient