@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonWorkMail
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonWorkMail
instead.
Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or their native iOS and Android email applications. You can integrate Amazon 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 Amazon WorkMail API is designed for the following scenarios:
Listing and describing organizations
Managing users
Managing groups
Managing resources
All Amazon WorkMail API actions are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkMail site, the IAM user gains full administrative visibility into the entire Amazon 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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociateDelegateToResourceResult |
associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member to the resource's set of delegates.
|
AssociateMemberToGroupResult |
associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member to the group's set.
|
CreateAliasResult |
createAlias(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member of Amazon WorkMail.
|
CreateGroupResult |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
CreateResourceResult |
createResource(CreateResourceRequest createResourceRequest)
Creates a new Amazon WorkMail resource.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Remove the alias from a set of aliases for a given user.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group from Amazon WorkMail.
|
DeleteMailboxPermissionsResult |
deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest)
Deletes permissions granted to a user or group.
|
DeleteResourceResult |
deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from Amazon WorkMail and all subsequent systems.
|
DeregisterFromWorkMailResult |
deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
|
DescribeOrganizationResult |
describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
|
DescribeResourceResult |
describeResource(DescribeResourceRequest describeResourceRequest)
Returns the data available for the resource.
|
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Provides information regarding the user.
|
DisassociateDelegateFromResourceResult |
disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
|
DisassociateMemberFromGroupResult |
disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
Removes a member from a group.
|
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.
|
ListAliasesResult |
listAliases(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
ListGroupMembersResult |
listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
|
ListMailboxPermissionsResult |
listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a mailbox.
|
ListOrganizationsResult |
listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
|
ListResourceDelegatesResult |
listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
ListResourcesResult |
listResources(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
|
PutMailboxPermissionsResult |
putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest)
Sets permissions for a user or group.
|
RegisterToWorkMailResult |
registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a
mailbox and calendaring capabilities.
|
ResetPasswordResult |
resetPassword(ResetPasswordRequest resetPasswordRequest)
Allows the administrator to reset the password for a user.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdatePrimaryEmailAddressResult |
updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
Updates the primary email for an entity.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest updateResourceRequest)
Updates data for the resource.
|
static final String ENDPOINT_PREFIX
AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member to the resource's set of delegates.
associateDelegateToResourceRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member to the group's set.
associateMemberToGroupRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on isn't available.EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member of Amazon WorkMail.
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 entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createGroupRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on isn't available.InvalidParameterException
- One or more of the input parameters don't match the service's restrictions.NameAvailabilityException
- The entity (user, group, or user) 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 entities.ReservedNameException
- This entity name is not allowed in Amazon WorkMail.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.CreateResourceResult createResource(CreateResourceRequest createResourceRequest)
Creates a new Amazon WorkMail resource. The available types are equipment and room.
createResourceRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on isn't available.InvalidParameterException
- One or more of the input parameters don't match the service's restrictions.NameAvailabilityException
- The entity (user, group, or user) 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 entities.ReservedNameException
- This entity name is not allowed in Amazon WorkMail.CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createUserRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on 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 entity (user, group, or user) 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 entities.ReservedNameException
- This entity name is not allowed in Amazon WorkMail.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.DeleteAliasResult deleteAlias(DeleteAliasRequest deleteAliasRequest)
Remove the alias from a set of aliases for a given user.
deleteAliasRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group from Amazon WorkMail.
deleteGroupRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on isn't available.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest)
Deletes permissions granted to a user or group.
deleteMailboxPermissionsRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
deleteResourceRequest
- EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.
deleteUserRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on isn't available.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.DeregisterFromWorkMailResult deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. Amazon WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
deregisterFromWorkMailRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.DescribeGroupResult describeGroup(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
describeGroupRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it 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 entities.DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
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.DescribeResourceResult describeResource(DescribeResourceRequest describeResourceRequest)
Returns the data available for the resource.
describeResourceRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it 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 entities.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
Provides information regarding the user.
describeUserRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it 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 entities.DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
disassociateDelegateFromResourceRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
Removes a member from a group.
disassociateMemberFromGroupRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on isn't available.EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
listAliasesRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.ListGroupMembersResult listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
listGroupMembersRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
listGroupsRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it 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 entities.ListMailboxPermissionsResult listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a mailbox.
listMailboxPermissionsRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it 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 entities.ListOrganizationsResult listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
listOrganizationsRequest
- InvalidParameterException
- One or more of the input parameters don't match the service's restrictions.ListResourceDelegatesResult listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegatesRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
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 entities.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
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 entities.PutMailboxPermissionsResult putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest)
Sets permissions for a user or group. This replaces any pre-existing permissions set for the entity.
putMailboxPermissionsRequest
- EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity 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 or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
registerToWorkMailRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on 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 entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.ResetPasswordResult resetPassword(ResetPasswordRequest resetPasswordRequest)
Allows the administrator to reset the password for a user.
resetPasswordRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on isn't available.EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.UpdatePrimaryEmailAddressResult updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
Updates the primary email for an entity. 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.
updatePrimaryEmailAddressRequest
- DirectoryServiceAuthenticationFailedException
- The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException
- The directory that you are trying to perform operations on 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 entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 entities.UnsupportedOperationException
- You can't perform a write operation against a read-only directory.UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.
updateResourceRequest
- DirectoryUnavailableException
- The directory that you are trying to perform operations on isn't available.EntityNotFoundException
- The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException
- You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted 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 it 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 entity (user, group, or user) 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 entities.void shutdown()
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 a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.