AmazonWorkMail (AWS SDK for Java

All Known Subinterfaces:

AmazonWorkMailAsync

All Known Implementing Classes:

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

Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or 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.

Field Summary

Fields
Modifier and Type Field and Description

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

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociateDelegateToResourceResult`	`associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)` Adds a member 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.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - associateDelegateToResource
```
AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
```
    Adds a member to the resource's set of delegates.
    
    Parameters:
    
    associateDelegateToResourceRequest -
    
    Returns:
    
    Result of the AssociateDelegateToResource operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - associateMemberToGroup
```
AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
```
    Adds a member to the group's set.
    
    Parameters:
    
    associateMemberToGroupRequest -
    
    Returns:
    
    Result of the AssociateMemberToGroup operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by 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.
    
    See Also:
    
    AWS API Documentation
  - createAlias
```
CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)
```
    Adds an alias to the set of a given member of Amazon WorkMail.
    
    Parameters:
    
    createAliasRequest -
    
    Returns:
    
    Result of the CreateAlias operation returned by the service.
    
    Throws:
    
    EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or resource.
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
```
    Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Parameters:
    
    createGroupRequest -
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by 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.
    
    See Also:
    
    AWS API Documentation
  - createResource
```
CreateResourceResult createResource(CreateResourceRequest createResourceRequest)
```
    Creates a new Amazon WorkMail resource. The available types are equipment and room.
    
    Parameters:
    
    createResourceRequest -
    
    Returns:
    
    Result of the CreateResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
CreateUserResult createUser(CreateUserRequest createUserRequest)
```
    Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by 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.
    
    See Also:
    
    AWS API Documentation
  - deleteAlias
```
DeleteAliasResult deleteAlias(DeleteAliasRequest deleteAliasRequest)
```
    Remove the alias from a set of aliases for a given user.
    
    Parameters:
    
    deleteAliasRequest -
    
    Returns:
    
    Result of the DeleteAlias operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
```
    Deletes a group from Amazon WorkMail.
    
    Parameters:
    
    deleteGroupRequest -
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by 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.
    
    See Also:
    
    AWS API Documentation
  - deleteMailboxPermissions
```
DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest)
```
    Deletes permissions granted to a user or group.
    
    Parameters:
    
    deleteMailboxPermissionsRequest -
    
    Returns:
    
    Result of the DeleteMailboxPermissions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteResource
```
DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)
```
    Deletes the specified resource.
    
    Parameters:
    
    deleteResourceRequest -
    
    Returns:
    
    Result of the DeleteResource operation returned by the service.
    
    Throws:
    
    EntityStateException - You are performing an operation on 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.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
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.
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deregisterFromWorkMail
```
DeregisterFromWorkMailResult deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
```
    Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. Amazon WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
    
    Parameters:
    
    deregisterFromWorkMailRequest -
    
    Returns:
    
    Result of the DeregisterFromWorkMail operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - describeGroup
```
DescribeGroupResult describeGroup(DescribeGroupRequest describeGroupRequest)
```
    Returns the data available for the group.
    
    Parameters:
    
    describeGroupRequest -
    
    Returns:
    
    Result of the DescribeGroup operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - describeOrganization
```
DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
```
    Provides more information regarding a given organization based on its identifier.
    
    Parameters:
    
    describeOrganizationRequest -
    
    Returns:
    
    Result of the DescribeOrganization operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    See Also:
    
    AWS API Documentation
  - describeResource
```
DescribeResourceResult describeResource(DescribeResourceRequest describeResourceRequest)
```
    Returns the data available for the resource.
    
    Parameters:
    
    describeResourceRequest -
    
    Returns:
    
    Result of the DescribeResource operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
```
    Provides information regarding the user.
    
    Parameters:
    
    describeUserRequest -
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - disassociateDelegateFromResource
```
DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
```
    Removes a member from the resource's set of delegates.
    
    Parameters:
    
    disassociateDelegateFromResourceRequest -
    
    Returns:
    
    Result of the DisassociateDelegateFromResource operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - disassociateMemberFromGroup
```
DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
```
    Removes a member from a group.
    
    Parameters:
    
    disassociateMemberFromGroupRequest -
    
    Returns:
    
    Result of the DisassociateMemberFromGroup operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by 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.
    
    See Also:
    
    AWS API Documentation
  - listAliases
```
ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest)
```
    Creates a paginated call to list the aliases associated with a given entity.
    
    Parameters:
    
    listAliasesRequest -
    
    Returns:
    
    Result of the ListAliases operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - listGroupMembers
```
ListGroupMembersResult listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
```
    Returns an overview of the members of a group.
    
    Parameters:
    
    listGroupMembersRequest -
    
    Returns:
    
    Result of the ListGroupMembers operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
```
    Returns summaries of the organization's groups.
    
    Parameters:
    
    listGroupsRequest -
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - listMailboxPermissions
```
ListMailboxPermissionsResult listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
```
    Lists the mailbox permissions associated with a mailbox.
    
    Parameters:
    
    listMailboxPermissionsRequest -
    
    Returns:
    
    Result of the ListMailboxPermissions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listOrganizations
```
ListOrganizationsResult listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
```
    Returns summaries of the customer's non-deleted organizations.
    
    Parameters:
    
    listOrganizationsRequest -
    
    Returns:
    
    Result of the ListOrganizations operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    See Also:
    
    AWS API Documentation
  - listResourceDelegates
```
ListResourceDelegatesResult listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
```
    Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
    
    Parameters:
    
    listResourceDelegatesRequest -
    
    Returns:
    
    Result of the ListResourceDelegates operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - The identifier supplied for the 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.
    
    See Also:
    
    AWS API Documentation
  - listResources
```
ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)
```
    Returns summaries of the organization's resources.
    
    Parameters:
    
    listResourcesRequest -
    
    Returns:
    
    Result of the ListResources operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its entities.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
ListUsersResult listUsers(ListUsersRequest listUsersRequest)
```
    Returns summaries of the organization's users.
    
    Parameters:
    
    listUsersRequest -
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more of the input parameters don't match the service's restrictions.
    
    OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.
    
    OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its entities.
    
    See Also:
    
    AWS API Documentation
  - putMailboxPermissions
```
PutMailboxPermissionsResult putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest)
```
    Sets permissions for a user or group. This replaces any pre-existing permissions set for the entity.
    
    Parameters:
    
    putMailboxPermissionsRequest -
    
    Returns:
    
    Result of the PutMailboxPermissions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - registerToWorkMail
```
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.
    
    Parameters:
    
    registerToWorkMailRequest -
    
    Returns:
    
    Result of the RegisterToWorkMail operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - resetPassword
```
ResetPasswordResult resetPassword(ResetPasswordRequest resetPasswordRequest)
```
    Allows the administrator to reset the password for a user.
    
    Parameters:
    
    resetPasswordRequest -
    
    Returns:
    
    Result of the ResetPassword operation returned by the service.
    
    Throws:
    
    DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by 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.
    
    See Also:
    
    AWS API Documentation
  - updatePrimaryEmailAddress
```
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.
    
    Parameters:
    
    updatePrimaryEmailAddressRequest -
    
    Returns:
    
    Result of the UpdatePrimaryEmailAddress operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateResource
```
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.
    
    Parameters:
    
    updateResourceRequest -
    
    Returns:
    
    Result of the UpdateResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonWorkMail

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

associateDelegateToResource

associateMemberToGroup

createAlias

createGroup

createResource

createUser

deleteAlias

deleteGroup

deleteMailboxPermissions

deleteResource

deleteUser

deregisterFromWorkMail

describeGroup

describeOrganization

describeResource

describeUser

disassociateDelegateFromResource

disassociateMemberFromGroup

listAliases

listGroupMembers

listGroups

listMailboxPermissions

listOrganizations

listResourceDelegates

listResources

listUsers

putMailboxPermissions

registerToWorkMail

resetPassword

updatePrimaryEmailAddress

updateResource

shutdown

getCachedResponseMetadata