@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonWorkMailClient extends AmazonWebServiceClient implements AmazonWorkMail
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_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.
|
static AmazonWorkMailClientBuilder |
builder() |
CreateAliasResult |
createAlias(CreateAliasRequest request)
Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
|
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
CreateResourceResult |
createResource(CreateResourceRequest request)
Creates a new Amazon WorkMail resource.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
DeleteAccessControlRuleResult |
deleteAccessControlRule(DeleteAccessControlRuleRequest request)
Deletes an access control rule for the specified WorkMail organization.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest request)
Remove one or more specified aliases from a set of aliases for a given user.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Deletes a group from Amazon WorkMail.
|
DeleteMailboxPermissionsResult |
deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
Deletes permissions granted to a member (user or group).
|
DeleteResourceResult |
deleteResource(DeleteResourceRequest request)
Deletes the specified resource.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user from Amazon WorkMail and all subsequent systems.
|
DeregisterFromWorkMailResult |
deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest request)
Returns the data available for the group.
|
DescribeOrganizationResult |
describeOrganization(DescribeOrganizationRequest request)
Provides more information regarding a given organization based on its identifier.
|
DescribeResourceResult |
describeResource(DescribeResourceRequest request)
Returns the data available for the resource.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Provides information regarding the user.
|
DisassociateDelegateFromResourceResult |
disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
Removes a member from the resource's set of delegates.
|
DisassociateMemberFromGroupResult |
disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
Removes a member from a group.
|
GetAccessControlEffectResult |
getAccessControlEffect(GetAccessControlEffectRequest request)
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access
protocol action, or user ID.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetMailboxDetailsResult |
getMailboxDetails(GetMailboxDetailsRequest request)
Requests a user's mailbox details for a specified organization and user.
|
ListAccessControlRulesResult |
listAccessControlRules(ListAccessControlRulesRequest request)
Lists the access control rules for the specified organization.
|
ListAliasesResult |
listAliases(ListAliasesRequest request)
Creates a paginated call to list the aliases associated with a given entity.
|
ListGroupMembersResult |
listGroupMembers(ListGroupMembersRequest request)
Returns an overview of the members of a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Returns summaries of the organization's groups.
|
ListMailboxPermissionsResult |
listMailboxPermissions(ListMailboxPermissionsRequest request)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
ListOrganizationsResult |
listOrganizations(ListOrganizationsRequest request)
Returns summaries of the customer's organizations.
|
ListResourceDelegatesResult |
listResourceDelegates(ListResourceDelegatesRequest request)
Lists the delegates associated with a resource.
|
ListResourcesResult |
listResources(ListResourcesRequest request)
Returns summaries of the organization's resources.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags applied to an Amazon WorkMail organization resource.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Returns summaries of the organization's users.
|
PutAccessControlRuleResult |
putAccessControlRule(PutAccessControlRuleRequest request)
Adds a new access control rule for the specified organization.
|
PutMailboxPermissionsResult |
putMailboxPermissions(PutMailboxPermissionsRequest request)
Sets permissions for a user, group, or resource.
|
RegisterToWorkMailResult |
registerToWorkMail(RegisterToWorkMailRequest request)
Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and
calendaring capabilities.
|
ResetPasswordResult |
resetPassword(ResetPasswordRequest request)
Allows the administrator to reset the password for a user.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Applies the specified tags to the specified Amazon WorkMail organization resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Untags the specified tags from the specified Amazon WorkMail organization resource.
|
UpdateMailboxQuotaResult |
updateMailboxQuota(UpdateMailboxQuotaRequest request)
Updates a user's current mailbox quota for a specified organization and user.
|
UpdatePrimaryEmailAddressResult |
updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
Updates the primary email for a user, group, or resource.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest request)
Updates data for the resource.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonWorkMailClientBuilder builder()
public AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest request)
Adds a member (user or group) to the resource's set of delegates.
associateDelegateToResource
in interface AmazonWorkMail
associateDelegateToResourceRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest request)
Adds a member (user or group) to the group's set.
associateMemberToGroup
in interface AmazonWorkMail
associateMemberToGroupRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.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 (Active or Synchronizing) to perform certain operations on the
organization or its members.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.public CreateAliasResult createAlias(CreateAliasRequest request)
Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
createAlias
in interface AmazonWorkMail
createAliasRequest
- EmailAddressInUseException
- The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException
- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException
- You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException
- One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException
- For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException
- After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException
- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException
- The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its members.LimitExceededException
- The request exceeds the limit of the resource.public CreateGroupResult createGroup(CreateGroupRequest request)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createGroup
in interface AmazonWorkMail
createGroupRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.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 (Active or Synchronizing) 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.public CreateResourceResult createResource(CreateResourceRequest request)
Creates a new Amazon WorkMail resource.
createResource
in interface AmazonWorkMail
createResourceRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.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 (Active or Synchronizing) to perform certain operations on the
organization or its members.ReservedNameException
- This user, group, or resource name is not allowed in Amazon WorkMail.public CreateUserResult createUser(CreateUserRequest request)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createUser
in interface AmazonWorkMail
createUserRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.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 (Active or Synchronizing) 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.public DeleteAccessControlRuleResult deleteAccessControlRule(DeleteAccessControlRuleRequest request)
Deletes an access control rule for the specified WorkMail organization.
deleteAccessControlRule
in interface AmazonWorkMail
deleteAccessControlRuleRequest
- 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 (Active or Synchronizing) 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 AmazonWorkMail
deleteAliasRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
Deletes a group from Amazon WorkMail.
deleteGroup
in interface AmazonWorkMail
deleteGroupRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.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 (Active or Synchronizing) to perform certain operations on the
organization or its members.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.public DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
Deletes permissions granted to a member (user or group).
deleteMailboxPermissions
in interface AmazonWorkMail
deleteMailboxPermissionsRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public DeleteResourceResult deleteResource(DeleteResourceRequest request)
Deletes the specified resource.
deleteResource
in interface AmazonWorkMail
deleteResourceRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must
be DISABLED
. Use the DescribeUser action to confirm the user state.
Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
deleteUser
in interface AmazonWorkMail
deleteUserRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.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 (Active or Synchronizing) 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 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.
deregisterFromWorkMail
in interface AmazonWorkMail
deregisterFromWorkMailRequest
- 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 (Active or Synchronizing) 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 AmazonWorkMail
describeGroupRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
Provides more information regarding a given organization based on its identifier.
describeOrganization
in interface AmazonWorkMail
describeOrganizationRequest
- 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 AmazonWorkMail
describeResourceRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public DescribeUserResult describeUser(DescribeUserRequest request)
Provides information regarding the user.
describeUser
in interface AmazonWorkMail
describeUserRequest
- 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 (Active or Synchronizing) 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 AmazonWorkMail
disassociateDelegateFromResourceRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
Removes a member from a group.
disassociateMemberFromGroup
in interface AmazonWorkMail
disassociateMemberFromGroupRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.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 (Active or Synchronizing) 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, or user ID.
getAccessControlEffect
in interface AmazonWorkMail
getAccessControlEffectRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public GetMailboxDetailsResult getMailboxDetails(GetMailboxDetailsRequest request)
Requests a user's mailbox details for a specified organization and user.
getMailboxDetails
in interface AmazonWorkMail
getMailboxDetailsRequest
- 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 (Active or Synchronizing) 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 ListAccessControlRulesResult listAccessControlRules(ListAccessControlRulesRequest request)
Lists the access control rules for the specified organization.
listAccessControlRules
in interface AmazonWorkMail
listAccessControlRulesRequest
- 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 (Active or Synchronizing) 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 AmazonWorkMail
listAliasesRequest
- 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 (Active or Synchronizing) 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 AmazonWorkMail
listGroupMembersRequest
- 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 (Active or Synchronizing) 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 AmazonWorkMail
listGroupsRequest
- 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 (Active or Synchronizing) 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 AmazonWorkMail
listMailboxPermissionsRequest
- 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 (Active or Synchronizing) 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 AmazonWorkMail
listOrganizationsRequest
- 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 AmazonWorkMail
listResourceDelegatesRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public ListResourcesResult listResources(ListResourcesRequest request)
Returns summaries of the organization's resources.
listResources
in interface AmazonWorkMail
listResourcesRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags applied to an Amazon WorkMail organization resource.
listTagsForResource
in interface AmazonWorkMail
listTagsForResourceRequest
- ResourceNotFoundException
- The resource cannot be found.public ListUsersResult listUsers(ListUsersRequest request)
Returns summaries of the organization's users.
listUsers
in interface AmazonWorkMail
listUsersRequest
- 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 (Active or Synchronizing) 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, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
putAccessControlRule
in interface AmazonWorkMail
putAccessControlRuleRequest
- 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 (Active or Synchronizing) 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 AmazonWorkMail
putMailboxPermissionsRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest request)
Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
registerToWorkMail
in interface AmazonWorkMail
registerToWorkMailRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.EmailAddressInUseException
- The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException
- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException
- You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.EntityAlreadyRegisteredException
- The user, group, or resource that you're trying to register is already registered.InvalidParameterException
- One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException
- For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException
- After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException
- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException
- The organization must have a valid state (Active or Synchronizing) 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 AmazonWorkMail
resetPasswordRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.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 (Active or Synchronizing) to perform certain operations on the
organization or its members.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.public TagResourceResult tagResource(TagResourceRequest request)
Applies the specified tags to the specified Amazon WorkMail organization resource.
tagResource
in interface AmazonWorkMail
tagResourceRequest
- 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 (Active or Synchronizing) to perform certain operations on the
organization or its members.public UntagResourceResult untagResource(UntagResourceRequest request)
Untags the specified tags from the specified Amazon WorkMail organization resource.
untagResource
in interface AmazonWorkMail
untagResourceRequest
- ResourceNotFoundException
- The resource cannot be found.public UpdateMailboxQuotaResult updateMailboxQuota(UpdateMailboxQuotaRequest request)
Updates a user's current mailbox quota for a specified organization and user.
updateMailboxQuota
in interface AmazonWorkMail
updateMailboxQuotaRequest
- 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 (Active or Synchronizing) 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 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 AmazonWorkMail
updatePrimaryEmailAddressRequest
- DirectoryServiceAuthenticationFailedException
- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.EmailAddressInUseException
- The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException
- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException
- You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException
- One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException
- For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException
- After a domain has been added to the organization, it must be verified. The domain is not yet verified.InvalidParameterException
- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException
- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException
- The organization must have a valid state (Active or Synchronizing) 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 AmazonWorkMail
updateResourceRequest
- DirectoryUnavailableException
- The directory on which you are trying to perform operations isn't available.EntityNotFoundException
- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException
- You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidConfigurationException
- The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests
or have at least one delegate associated that can do so on its behalf.EmailAddressInUseException
- The email address that you're trying to assign is already created for a different user, group, or
resource.MailDomainNotFoundException
- For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException
- After a domain has been added to the organization, it must be verified. The domain is not yet verified.NameAvailabilityException
- The user, group, or resource name isn't unique in Amazon WorkMail.OrganizationNotFoundException
- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException
- The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its members.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 AmazonWorkMail
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.