AbstractAmazonWorkMail (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workmail.AbstractAmazonWorkMail

All Implemented Interfaces:

AmazonWorkMail

Direct Known Subclasses:

AbstractAmazonWorkMailAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonWorkMail
extends Object
implements AmazonWorkMail
```
Abstract implementation of AmazonWorkMail. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.workmail.AmazonWorkMail
  ENDPOINT_PREFIX

Method Summary

All 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.
`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.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`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

- Method Detail
  - associateDelegateToResource
```
public AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Adds a member to the resource's set of delegates.
    
    Specified by:
    
    associateDelegateToResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the AssociateDelegateToResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - associateMemberToGroup
```
public AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Adds a member to the group's set.
    
    Specified by:
    
    associateMemberToGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the AssociateMemberToGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAlias
```
public CreateAliasResult createAlias(CreateAliasRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Adds an alias to the set of a given member of Amazon WorkMail.
    
    Specified by:
    
    createAlias in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Specified by:
    
    createGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createResource
```
public CreateResourceResult createResource(CreateResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a new Amazon WorkMail resource. The available types are equipment and room.
    
    Specified by:
    
    createResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
    
    Specified by:
    
    createUser in interface AmazonWorkMail
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAlias
```
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Remove the alias from a set of aliases for a given user.
    
    Specified by:
    
    deleteAlias in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Deletes a group from Amazon WorkMail.
    
    Specified by:
    
    deleteGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteResource
```
public DeleteResourceResult deleteResource(DeleteResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Deletes the specified resource.
    
    Specified by:
    
    deleteResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the DeleteResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deregisterFromWorkMail
```
public DeregisterFromWorkMailResult deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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
    
    Returns:
    
    Result of the DeregisterFromWorkMail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeGroup
```
public DescribeGroupResult describeGroup(DescribeGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns the data available for the group.
    
    Specified by:
    
    describeGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeOrganization
```
public DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Provides more information regarding a given organization based on its identifier.
    
    Specified by:
    
    describeOrganization in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeOrganization operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeResource
```
public DescribeResourceResult describeResource(DescribeResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns the data available for the resource.
    
    Specified by:
    
    describeResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Provides information regarding the user.
    
    Specified by:
    
    describeUser in interface AmazonWorkMail
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateDelegateFromResource
```
public DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Removes a member from the resource's set of delegates.
    
    Specified by:
    
    disassociateDelegateFromResource in interface AmazonWorkMail
    
    Returns:
    
    Result of the DisassociateDelegateFromResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateMemberFromGroup
```
public DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Removes a member from a group.
    
    Specified by:
    
    disassociateMemberFromGroup in interface AmazonWorkMail
    
    Returns:
    
    Result of the DisassociateMemberFromGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAliases
```
public ListAliasesResult listAliases(ListAliasesRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Creates a paginated call to list the aliases associated with a given entity.
    
    Specified by:
    
    listAliases in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroupMembers
```
public ListGroupMembersResult listGroupMembers(ListGroupMembersRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns an overview of the members of a group.
    
    Specified by:
    
    listGroupMembers in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListGroupMembers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns summaries of the organization's groups.
    
    Specified by:
    
    listGroups in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listOrganizations
```
public ListOrganizationsResult listOrganizations(ListOrganizationsRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns summaries of the customer's non-deleted organizations.
    
    Specified by:
    
    listOrganizations in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListOrganizations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listResourceDelegates
```
public ListResourceDelegatesResult listResourceDelegates(ListResourceDelegatesRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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
    
    Returns:
    
    Result of the ListResourceDelegates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listResources
```
public ListResourcesResult listResources(ListResourcesRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns summaries of the organization's resources.
    
    Specified by:
    
    listResources in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Returns summaries of the organization's users.
    
    Specified by:
    
    listUsers in interface AmazonWorkMail
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerToWorkMail
```
public RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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
    
    Returns:
    
    Result of the RegisterToWorkMail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resetPassword
```
public ResetPasswordResult resetPassword(ResetPasswordRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    Allows the administrator to reset the password for a user.
    
    Specified by:
    
    resetPassword in interface AmazonWorkMail
    
    Returns:
    
    Result of the ResetPassword operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePrimaryEmailAddress
```
public UpdatePrimaryEmailAddressResult updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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
    
    Returns:
    
    Result of the UpdatePrimaryEmailAddress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateResource
```
public UpdateResourceResult updateResource(UpdateResourceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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
    
    Returns:
    
    Result of the UpdateResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonWorkMail
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonWorkMail
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonWorkMail
    
    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.
    
    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 AbstractAmazonWorkMail

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

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

shutdown

getCachedResponseMetadata