AmazonWorkMailClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.workmail.AmazonWorkMailClient

All Implemented Interfaces:

AmazonWorkMail

Direct Known Subclasses:

AmazonWorkMailAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonWorkMailClient
extends AmazonWebServiceClient
implements AmazonWorkMail
```
Client for accessing Amazon WorkMail. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.workmail.AmazonWorkMail
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateDelegateToResourceResult`	`associateDelegateToResource(AssociateDelegateToResourceRequest request)` Adds a member to the resource's set of delegates.
`AssociateMemberToGroupResult`	`associateMemberToGroup(AssociateMemberToGroupRequest request)` Adds a member to the group's set.
`static AmazonWorkMailClientBuilder`	`builder()`
`CreateAliasResult`	`createAlias(CreateAliasRequest request)` Adds an alias to the set of a given member 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.
`DeleteAliasResult`	`deleteAlias(DeleteAliasRequest request)` Remove the alias from a set of aliases for a given user.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest request)` Deletes a group from Amazon WorkMail.
`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.
`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 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.
`ListOrganizationsResult`	`listOrganizations(ListOrganizationsRequest request)` Returns summaries of the customer's non-deleted organizations.
`ListResourceDelegatesResult`	`listResourceDelegates(ListResourceDelegatesRequest request)` Lists the delegates associated with a resource.
`ListResourcesResult`	`listResources(ListResourcesRequest request)` Returns summaries of the organization's resources.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Returns summaries of the organization's users.
`RegisterToWorkMailResult`	`registerToWorkMail(RegisterToWorkMailRequest request)` Registers an existing and disabled user, group, or resource/entity 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.
`UpdatePrimaryEmailAddressResult`	`updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)` Updates the primary email for an entity.
`UpdateResourceResult`	`updateResource(UpdateResourceRequest request)` Updates data for the resource.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.workmail.AmazonWorkMail
shutdown

- Method Detail
  - builder
```
public static AmazonWorkMailClientBuilder builder()
```
  - associateDelegateToResource
```
public AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest request)
```
    Adds a member to the resource's set of delegates.
    
    Specified by:
    
    associateDelegateToResource in interface AmazonWorkMail
    
    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
```
public AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest request)
```
    Adds a member to the group's set.
    
    Specified by:
    
    associateMemberToGroup in interface AmazonWorkMail
    
    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
```
public CreateAliasResult createAlias(CreateAliasRequest request)
```
    Adds an alias to the set of a given member of Amazon WorkMail.
    
    Specified by:
    
    createAlias in interface AmazonWorkMail
    
    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
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Specified by:
    
    createGroup in interface AmazonWorkMail
    
    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
```
public CreateResourceResult createResource(CreateResourceRequest request)
```
    Creates a new Amazon WorkMail resource. The available types are equipment and room.
    
    Specified by:
    
    createResource in interface AmazonWorkMail
    
    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
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Specified by:
    
    createUser in interface AmazonWorkMail
    
    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
```
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
```
    Remove the alias from a set of aliases for a given user.
    
    Specified by:
    
    deleteAlias in interface AmazonWorkMail
    
    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
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Deletes a group from Amazon WorkMail.
    
    Specified by:
    
    deleteGroup in interface AmazonWorkMail
    
    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
  - deleteResource
```
public DeleteResourceResult deleteResource(DeleteResourceRequest request)
```
    Deletes the specified resource.
    
    Specified by:
    
    deleteResource in interface AmazonWorkMail
    
    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
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    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.
    
    Specified by:
    
    deleteUser in interface AmazonWorkMail
    
    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
```
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. Amazon WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
    
    Specified by:
    
    deregisterFromWorkMail in interface AmazonWorkMail
    
    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
```
public DescribeGroupResult describeGroup(DescribeGroupRequest request)
```
    Returns the data available for the group.
    
    Specified by:
    
    describeGroup in interface AmazonWorkMail
    
    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
```
public DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
```
    Provides more information regarding a given organization based on its identifier.
    
    Specified by:
    
    describeOrganization in interface AmazonWorkMail
    
    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
```
public DescribeResourceResult describeResource(DescribeResourceRequest request)
```
    Returns the data available for the resource.
    
    Specified by:
    
    describeResource in interface AmazonWorkMail
    
    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
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Provides information regarding the user.
    
    Specified by:
    
    describeUser in interface AmazonWorkMail
    
    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
```
public DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
```
    Removes a member from the resource's set of delegates.
    
    Specified by:
    
    disassociateDelegateFromResource in interface AmazonWorkMail
    
    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
```
public DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
```
    Removes a member from a group.
    
    Specified by:
    
    disassociateMemberFromGroup in interface AmazonWorkMail
    
    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
```
public ListAliasesResult listAliases(ListAliasesRequest request)
```
    Creates a paginated call to list the aliases associated with a given entity.
    
    Specified by:
    
    listAliases in interface AmazonWorkMail
    
    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
```
public ListGroupMembersResult listGroupMembers(ListGroupMembersRequest request)
```
    Returns an overview of the members of a group.
    
    Specified by:
    
    listGroupMembers in interface AmazonWorkMail
    
    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
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Returns summaries of the organization's groups.
    
    Specified by:
    
    listGroups in interface AmazonWorkMail
    
    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
  - listOrganizations
```
public ListOrganizationsResult listOrganizations(ListOrganizationsRequest request)
```
    Returns summaries of the customer's non-deleted organizations.
    
    Specified by:
    
    listOrganizations in interface AmazonWorkMail
    
    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
```
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.
    
    Specified by:
    
    listResourceDelegates in interface AmazonWorkMail
    
    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
```
public ListResourcesResult listResources(ListResourcesRequest request)
```
    Returns summaries of the organization's resources.
    
    Specified by:
    
    listResources in interface AmazonWorkMail
    
    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
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Returns summaries of the organization's users.
    
    Specified by:
    
    listUsers in interface AmazonWorkMail
    
    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
  - registerToWorkMail
```
public RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest request)
```
    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.
    
    Specified by:
    
    registerToWorkMail in interface AmazonWorkMail
    
    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
```
public ResetPasswordResult resetPassword(ResetPasswordRequest request)
```
    Allows the administrator to reset the password for a user.
    
    Specified by:
    
    resetPassword in interface AmazonWorkMail
    
    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
```
public UpdatePrimaryEmailAddressResult updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
```
    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.
    
    Specified by:
    
    updatePrimaryEmailAddress in interface AmazonWorkMail
    
    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
```
public UpdateResourceResult updateResource(UpdateResourceRequest request)
```
    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.
    
    Specified by:
    
    updateResource in interface AmazonWorkMail
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonWorkMail
    
    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?

Class AmazonWorkMailClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.workmail.AmazonWorkMail

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.workmail.AmazonWorkMail

Method Detail

builder

associateDelegateToResource

associateMemberToGroup

createAlias

createGroup

createResource

createUser

deleteAlias

deleteGroup

deleteResource

deleteUser

deregisterFromWorkMail

describeGroup

describeOrganization

describeResource

describeUser

disassociateDelegateFromResource

disassociateMemberFromGroup

listAliases

listGroupMembers

listGroups

listOrganizations

listResourceDelegates

listResources

listUsers

registerToWorkMail

resetPassword

updatePrimaryEmailAddress

updateResource

getCachedResponseMetadata