@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonWorkMailAsync extends AmazonWorkMail
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonWorkMailAsync 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.
ENDPOINT_PREFIXassociateDelegateToResource, associateMemberToGroup, createAlias, createGroup, createResource, createUser, deleteAlias, deleteGroup, deleteResource, deleteUser, deregisterFromWorkMail, describeGroup, describeOrganization, describeResource, describeUser, disassociateDelegateFromResource, disassociateMemberFromGroup, getCachedResponseMetadata, listAliases, listGroupMembers, listGroups, listOrganizations, listResourceDelegates, listResources, listUsers, registerToWorkMail, resetPassword, shutdown, updatePrimaryEmailAddress, updateResourceFuture<AssociateDelegateToResourceResult> associateDelegateToResourceAsync(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member to the resource's set of delegates.
associateDelegateToResourceRequest - Future<AssociateDelegateToResourceResult> associateDelegateToResourceAsync(AssociateDelegateToResourceRequest associateDelegateToResourceRequest, AsyncHandler<AssociateDelegateToResourceRequest,AssociateDelegateToResourceResult> asyncHandler)
Adds a member to the resource's set of delegates.
associateDelegateToResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AssociateMemberToGroupResult> associateMemberToGroupAsync(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member to the group's set.
associateMemberToGroupRequest - Future<AssociateMemberToGroupResult> associateMemberToGroupAsync(AssociateMemberToGroupRequest associateMemberToGroupRequest, AsyncHandler<AssociateMemberToGroupRequest,AssociateMemberToGroupResult> asyncHandler)
Adds a member to the group's set.
associateMemberToGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAliasResult> createAliasAsync(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member of Amazon WorkMail.
createAliasRequest - Future<CreateAliasResult> createAliasAsync(CreateAliasRequest createAliasRequest, AsyncHandler<CreateAliasRequest,CreateAliasResult> asyncHandler)
Adds an alias to the set of a given member of Amazon WorkMail.
createAliasRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createGroupRequest - Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateResourceResult> createResourceAsync(CreateResourceRequest createResourceRequest)
Creates a new Amazon WorkMail resource. The available types are equipment and room.
createResourceRequest - Future<CreateResourceResult> createResourceAsync(CreateResourceRequest createResourceRequest, AsyncHandler<CreateResourceRequest,CreateResourceResult> asyncHandler)
Creates a new Amazon WorkMail resource. The available types are equipment and room.
createResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createUserRequest - Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest deleteAliasRequest)
Remove the alias from a set of aliases for a given user.
deleteAliasRequest - Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest deleteAliasRequest, AsyncHandler<DeleteAliasRequest,DeleteAliasResult> asyncHandler)
Remove the alias from a set of aliases for a given user.
deleteAliasRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest)
Deletes a group from Amazon WorkMail.
deleteGroupRequest - Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
Deletes a group from Amazon WorkMail.
deleteGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteResourceResult> deleteResourceAsync(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
deleteResourceRequest - Future<DeleteResourceResult> deleteResourceAsync(DeleteResourceRequest deleteResourceRequest, AsyncHandler<DeleteResourceRequest,DeleteResourceResult> asyncHandler)
Deletes the specified resource.
deleteResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.
deleteUserRequest - Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.
deleteUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeregisterFromWorkMailResult> deregisterFromWorkMailAsync(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. Amazon WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
deregisterFromWorkMailRequest - Future<DeregisterFromWorkMailResult> deregisterFromWorkMailAsync(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest, AsyncHandler<DeregisterFromWorkMailRequest,DeregisterFromWorkMailResult> asyncHandler)
Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. Amazon WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
deregisterFromWorkMailRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
describeGroupRequest - Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest describeGroupRequest, AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)
Returns the data available for the group.
describeGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeOrganizationResult> describeOrganizationAsync(DescribeOrganizationRequest describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
describeOrganizationRequest - Future<DescribeOrganizationResult> describeOrganizationAsync(DescribeOrganizationRequest describeOrganizationRequest, AsyncHandler<DescribeOrganizationRequest,DescribeOrganizationResult> asyncHandler)
Provides more information regarding a given organization based on its identifier.
describeOrganizationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeResourceResult> describeResourceAsync(DescribeResourceRequest describeResourceRequest)
Returns the data available for the resource.
describeResourceRequest - Future<DescribeResourceResult> describeResourceAsync(DescribeResourceRequest describeResourceRequest, AsyncHandler<DescribeResourceRequest,DescribeResourceResult> asyncHandler)
Returns the data available for the resource.
describeResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest)
Provides information regarding the user.
describeUserRequest - Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Provides information regarding the user.
describeUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateDelegateFromResourceResult> disassociateDelegateFromResourceAsync(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
disassociateDelegateFromResourceRequest - Future<DisassociateDelegateFromResourceResult> disassociateDelegateFromResourceAsync(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest, AsyncHandler<DisassociateDelegateFromResourceRequest,DisassociateDelegateFromResourceResult> asyncHandler)
Removes a member from the resource's set of delegates.
disassociateDelegateFromResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateMemberFromGroupResult> disassociateMemberFromGroupAsync(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
Removes a member from a group.
disassociateMemberFromGroupRequest - Future<DisassociateMemberFromGroupResult> disassociateMemberFromGroupAsync(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest, AsyncHandler<DisassociateMemberFromGroupRequest,DisassociateMemberFromGroupResult> asyncHandler)
Removes a member from a group.
disassociateMemberFromGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
listAliasesRequest - Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest listAliasesRequest, AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
Creates a paginated call to list the aliases associated with a given entity.
listAliasesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGroupMembersResult> listGroupMembersAsync(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
listGroupMembersRequest - Future<ListGroupMembersResult> listGroupMembersAsync(ListGroupMembersRequest listGroupMembersRequest, AsyncHandler<ListGroupMembersRequest,ListGroupMembersResult> asyncHandler)
Returns an overview of the members of a group.
listGroupMembersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
listGroupsRequest - Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Returns summaries of the organization's groups.
listGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListOrganizationsResult> listOrganizationsAsync(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
listOrganizationsRequest - Future<ListOrganizationsResult> listOrganizationsAsync(ListOrganizationsRequest listOrganizationsRequest, AsyncHandler<ListOrganizationsRequest,ListOrganizationsResult> asyncHandler)
Returns summaries of the customer's non-deleted organizations.
listOrganizationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourceDelegatesResult> listResourceDelegatesAsync(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegatesRequest - Future<ListResourceDelegatesResult> listResourceDelegatesAsync(ListResourceDelegatesRequest listResourceDelegatesRequest, AsyncHandler<ListResourceDelegatesRequest,ListResourceDelegatesResult> asyncHandler)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
listResourcesRequest - Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest listResourcesRequest, AsyncHandler<ListResourcesRequest,ListResourcesResult> asyncHandler)
Returns summaries of the organization's resources.
listResourcesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
listUsersRequest - Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Returns summaries of the organization's users.
listUsersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RegisterToWorkMailResult> registerToWorkMailAsync(RegisterToWorkMailRequest registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
registerToWorkMailRequest - Future<RegisterToWorkMailResult> registerToWorkMailAsync(RegisterToWorkMailRequest registerToWorkMailRequest, AsyncHandler<RegisterToWorkMailRequest,RegisterToWorkMailResult> asyncHandler)
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
registerToWorkMailRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResetPasswordResult> resetPasswordAsync(ResetPasswordRequest resetPasswordRequest)
Allows the administrator to reset the password for a user.
resetPasswordRequest - Future<ResetPasswordResult> resetPasswordAsync(ResetPasswordRequest resetPasswordRequest, AsyncHandler<ResetPasswordRequest,ResetPasswordResult> asyncHandler)
Allows the administrator to reset the password for a user.
resetPasswordRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdatePrimaryEmailAddressResult> updatePrimaryEmailAddressAsync(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
Updates the primary email for an entity. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email) and the email provided in the input is promoted as the primary.
updatePrimaryEmailAddressRequest - Future<UpdatePrimaryEmailAddressResult> updatePrimaryEmailAddressAsync(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest, AsyncHandler<UpdatePrimaryEmailAddressRequest,UpdatePrimaryEmailAddressResult> asyncHandler)
Updates the primary email for an entity. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email) and the email provided in the input is promoted as the primary.
updatePrimaryEmailAddressRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest updateResourceRequest)
Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.
updateResourceRequest - Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest updateResourceRequest, AsyncHandler<UpdateResourceRequest,UpdateResourceResult> asyncHandler)
Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.
updateResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.