@Generated(value="software.amazon.awssdk:codegen") public interface WorkMailAsyncClient extends SdkClient
builder()
method.
Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or their native iOS and Android email applications. You can integrate Amazon WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The Amazon WorkMail API is designed for the following scenarios:
Listing and describing organizations
Managing users
Managing groups
Managing resources
All Amazon WorkMail API actions are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkMail site, the IAM user gains full administrative visibility into the entire Amazon WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AssociateDelegateToResourceResponse> |
associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member to the resource's set of delegates.
|
default CompletableFuture<AssociateDelegateToResourceResponse> |
associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest)
Adds a member to the resource's set of delegates.
|
default CompletableFuture<AssociateMemberToGroupResponse> |
associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member to the group's set.
|
default CompletableFuture<AssociateMemberToGroupResponse> |
associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest)
Adds a member to the group's set.
|
static WorkMailAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
WorkMailAsyncClient . |
static WorkMailAsyncClient |
create()
Create a
WorkMailAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateAliasResponse> |
createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Adds an alias to the set of a given member of Amazon WorkMail.
|
default CompletableFuture<CreateAliasResponse> |
createAlias(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member of Amazon WorkMail.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CompletableFuture<CreateResourceResponse> |
createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
Creates a new Amazon WorkMail resource.
|
default CompletableFuture<CreateResourceResponse> |
createResource(CreateResourceRequest createResourceRequest)
Creates a new Amazon WorkMail resource.
|
default CompletableFuture<CreateUserResponse> |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CompletableFuture<CreateUserResponse> |
createUser(CreateUserRequest createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CompletableFuture<DeleteAliasResponse> |
deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Remove the alias from a set of aliases for a given user.
|
default CompletableFuture<DeleteAliasResponse> |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Remove the alias from a set of aliases for a given user.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group from Amazon WorkMail.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group from Amazon WorkMail.
|
default CompletableFuture<DeleteResourceResponse> |
deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)
Deletes the specified resource.
|
default CompletableFuture<DeleteResourceResponse> |
deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user from Amazon WorkMail and all subsequent systems.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from Amazon WorkMail and all subsequent systems.
|
default CompletableFuture<DeregisterFromWorkMailResponse> |
deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
default CompletableFuture<DeregisterFromWorkMailResponse> |
deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
default CompletableFuture<DescribeGroupResponse> |
describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
Returns the data available for the group.
|
default CompletableFuture<DescribeGroupResponse> |
describeGroup(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
|
default CompletableFuture<DescribeOrganizationResponse> |
describeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
|
default CompletableFuture<DescribeOrganizationResponse> |
describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
|
default CompletableFuture<DescribeResourceResponse> |
describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Returns the data available for the resource.
|
default CompletableFuture<DescribeResourceResponse> |
describeResource(DescribeResourceRequest describeResourceRequest)
Returns the data available for the resource.
|
default CompletableFuture<DescribeUserResponse> |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Provides information regarding the user.
|
default CompletableFuture<DescribeUserResponse> |
describeUser(DescribeUserRequest describeUserRequest)
Provides information regarding the user.
|
default CompletableFuture<DisassociateDelegateFromResourceResponse> |
disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
|
default CompletableFuture<DisassociateDelegateFromResourceResponse> |
disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
|
default CompletableFuture<DisassociateMemberFromGroupResponse> |
disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest)
Removes a member from a group.
|
default CompletableFuture<DisassociateMemberFromGroupResponse> |
disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
Removes a member from a group.
|
default CompletableFuture<ListAliasesResponse> |
listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default CompletableFuture<ListAliasesResponse> |
listAliases(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListAliasesPublisher |
listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListAliasesPublisher |
listAliasesPaginator(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default CompletableFuture<ListGroupMembersResponse> |
listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group.
|
default CompletableFuture<ListGroupMembersResponse> |
listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
|
default ListGroupMembersPublisher |
listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group.
|
default ListGroupMembersPublisher |
listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
|
default ListGroupsPublisher |
listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
|
default ListGroupsPublisher |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
|
default CompletableFuture<ListOrganizationsResponse> |
listOrganizations()
Returns summaries of the customer's non-deleted organizations.
|
default CompletableFuture<ListOrganizationsResponse> |
listOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
|
default CompletableFuture<ListOrganizationsResponse> |
listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
|
default ListOrganizationsPublisher |
listOrganizationsPaginator()
Returns summaries of the customer's non-deleted organizations.
|
default ListOrganizationsPublisher |
listOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
|
default ListOrganizationsPublisher |
listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
|
default CompletableFuture<ListResourceDelegatesResponse> |
listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
default CompletableFuture<ListResourceDelegatesResponse> |
listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
default CompletableFuture<ListResourcesResponse> |
listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns summaries of the organization's resources.
|
default CompletableFuture<ListResourcesResponse> |
listResources(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
|
default ListResourcesPublisher |
listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns summaries of the organization's resources.
|
default ListResourcesPublisher |
listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
|
default CompletableFuture<ListUsersResponse> |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns summaries of the organization's users.
|
default CompletableFuture<ListUsersResponse> |
listUsers(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
|
default ListUsersPublisher |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns summaries of the organization's users.
|
default ListUsersPublisher |
listUsersPaginator(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
|
default CompletableFuture<RegisterToWorkMailResponse> |
registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a
mailbox and calendaring capabilities.
|
default CompletableFuture<RegisterToWorkMailResponse> |
registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a
mailbox and calendaring capabilities.
|
default CompletableFuture<ResetPasswordResponse> |
resetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest)
Allows the administrator to reset the password for a user.
|
default CompletableFuture<ResetPasswordResponse> |
resetPassword(ResetPasswordRequest resetPasswordRequest)
Allows the administrator to reset the password for a user.
|
default CompletableFuture<UpdatePrimaryEmailAddressResponse> |
updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest)
Updates the primary email for an entity.
|
default CompletableFuture<UpdatePrimaryEmailAddressResponse> |
updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
Updates the primary email for an entity.
|
default CompletableFuture<UpdateResourceResponse> |
updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Updates data for the resource.
|
default CompletableFuture<UpdateResourceResponse> |
updateResource(UpdateResourceRequest updateResourceRequest)
Updates data for the resource.
|
serviceName
close
static final String SERVICE_NAME
static WorkMailAsyncClient create()
WorkMailAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static WorkMailAsyncClientBuilder builder()
WorkMailAsyncClient
.default CompletableFuture<AssociateDelegateToResourceResponse> associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member to the resource's set of delegates.
associateDelegateToResourceRequest
- default CompletableFuture<AssociateDelegateToResourceResponse> associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest)
Adds a member to the resource's set of delegates.
This is a convenience which creates an instance of the AssociateDelegateToResourceRequest.Builder
avoiding the need to create one manually via AssociateDelegateToResourceRequest.builder()
associateDelegateToResourceRequest
- A Consumer
that will call methods on AssociateDelegateToResourceRequest.Builder
to create
a request.default CompletableFuture<AssociateMemberToGroupResponse> associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member to the group's set.
associateMemberToGroupRequest
- default CompletableFuture<AssociateMemberToGroupResponse> associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest)
Adds a member to the group's set.
This is a convenience which creates an instance of the AssociateMemberToGroupRequest.Builder
avoiding the
need to create one manually via AssociateMemberToGroupRequest.builder()
associateMemberToGroupRequest
- A Consumer
that will call methods on AssociateMemberToGroupRequest.Builder
to create a
request.default CompletableFuture<CreateAliasResponse> createAlias(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member of Amazon WorkMail.
createAliasRequest
- default CompletableFuture<CreateAliasResponse> createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Adds an alias to the set of a given member of Amazon WorkMail.
This is a convenience which creates an instance of the CreateAliasRequest.Builder
avoiding the need to
create one manually via CreateAliasRequest.builder()
createAliasRequest
- A Consumer
that will call methods on CreateAliasRequest.Builder
to create a request.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createGroupRequest
- default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the CreateGroupRequest.Builder
avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest
- A Consumer
that will call methods on CreateGroupRequest.Builder
to create a request.default CompletableFuture<CreateResourceResponse> createResource(CreateResourceRequest createResourceRequest)
Creates a new Amazon WorkMail resource. The available types are equipment and room.
createResourceRequest
- default CompletableFuture<CreateResourceResponse> createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
Creates a new Amazon WorkMail resource. The available types are equipment and room.
This is a convenience which creates an instance of the CreateResourceRequest.Builder
avoiding the need to
create one manually via CreateResourceRequest.builder()
createResourceRequest
- A Consumer
that will call methods on CreateResourceRequest.Builder
to create a request.default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createUserRequest
- default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the CreateUserRequest.Builder
avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest
- A Consumer
that will call methods on CreateUserRequest.Builder
to create a request.default CompletableFuture<DeleteAliasResponse> deleteAlias(DeleteAliasRequest deleteAliasRequest)
Remove the alias from a set of aliases for a given user.
deleteAliasRequest
- default CompletableFuture<DeleteAliasResponse> deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Remove the alias from a set of aliases for a given user.
This is a convenience which creates an instance of the DeleteAliasRequest.Builder
avoiding the need to
create one manually via DeleteAliasRequest.builder()
deleteAliasRequest
- A Consumer
that will call methods on DeleteAliasRequest.Builder
to create a request.default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group from Amazon WorkMail.
deleteGroupRequest
- default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group from Amazon WorkMail.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder
avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest
- A Consumer
that will call methods on DeleteGroupRequest.Builder
to create a request.default CompletableFuture<DeleteResourceResponse> deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
deleteResourceRequest
- default CompletableFuture<DeleteResourceResponse> deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)
Deletes the specified resource.
This is a convenience which creates an instance of the DeleteResourceRequest.Builder
avoiding the need to
create one manually via DeleteResourceRequest.builder()
deleteResourceRequest
- A Consumer
that will call methods on DeleteResourceRequest.Builder
to create a request.default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.
deleteUserRequest
- default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteUserRequest.Builder
avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest
- A Consumer
that will call methods on DeleteUserRequest.Builder
to create a request.default CompletableFuture<DeregisterFromWorkMailResponse> deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. Amazon WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
deregisterFromWorkMailRequest
- default CompletableFuture<DeregisterFromWorkMailResponse> deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> 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.
This is a convenience which creates an instance of the DeregisterFromWorkMailRequest.Builder
avoiding the
need to create one manually via DeregisterFromWorkMailRequest.builder()
deregisterFromWorkMailRequest
- A Consumer
that will call methods on DeregisterFromWorkMailRequest.Builder
to create a
request.default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
describeGroupRequest
- default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
Returns the data available for the group.
This is a convenience which creates an instance of the DescribeGroupRequest.Builder
avoiding the need to
create one manually via DescribeGroupRequest.builder()
describeGroupRequest
- A Consumer
that will call methods on DescribeGroupRequest.Builder
to create a request.default CompletableFuture<DescribeOrganizationResponse> describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
describeOrganizationRequest
- default CompletableFuture<DescribeOrganizationResponse> describeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
This is a convenience which creates an instance of the DescribeOrganizationRequest.Builder
avoiding the
need to create one manually via DescribeOrganizationRequest.builder()
describeOrganizationRequest
- A Consumer
that will call methods on DescribeOrganizationRequest.Builder
to create a
request.default CompletableFuture<DescribeResourceResponse> describeResource(DescribeResourceRequest describeResourceRequest)
Returns the data available for the resource.
describeResourceRequest
- default CompletableFuture<DescribeResourceResponse> describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Returns the data available for the resource.
This is a convenience which creates an instance of the DescribeResourceRequest.Builder
avoiding the need
to create one manually via DescribeResourceRequest.builder()
describeResourceRequest
- A Consumer
that will call methods on DescribeResourceRequest.Builder
to create a request.default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)
Provides information regarding the user.
describeUserRequest
- default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Provides information regarding the user.
This is a convenience which creates an instance of the DescribeUserRequest.Builder
avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest
- A Consumer
that will call methods on DescribeUserRequest.Builder
to create a request.default CompletableFuture<DisassociateDelegateFromResourceResponse> disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
disassociateDelegateFromResourceRequest
- default CompletableFuture<DisassociateDelegateFromResourceResponse> disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
This is a convenience which creates an instance of the DisassociateDelegateFromResourceRequest.Builder
avoiding the need to create one manually via DisassociateDelegateFromResourceRequest.builder()
disassociateDelegateFromResourceRequest
- A Consumer
that will call methods on DisassociateDelegateFromResourceRequest.Builder
to
create a request.default CompletableFuture<DisassociateMemberFromGroupResponse> disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
Removes a member from a group.
disassociateMemberFromGroupRequest
- default CompletableFuture<DisassociateMemberFromGroupResponse> disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest)
Removes a member from a group.
This is a convenience which creates an instance of the DisassociateMemberFromGroupRequest.Builder
avoiding the need to create one manually via DisassociateMemberFromGroupRequest.builder()
disassociateMemberFromGroupRequest
- A Consumer
that will call methods on DisassociateMemberFromGroupRequest.Builder
to create
a request.default CompletableFuture<ListAliasesResponse> listAliases(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
listAliasesRequest
- default CompletableFuture<ListAliasesResponse> listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
This is a convenience which creates an instance of the ListAliasesRequest.Builder
avoiding the need to
create one manually via ListAliasesRequest.builder()
listAliasesRequest
- A Consumer
that will call methods on ListAliasesRequest.Builder
to create a request.default ListAliasesPublisher listAliasesPaginator(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
This is a variant of listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation.
listAliasesRequest
- default ListAliasesPublisher listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
This is a variant of listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation.
This is a convenience which creates an instance of the ListAliasesRequest.Builder
avoiding the need to
create one manually via ListAliasesRequest.builder()
listAliasesRequest
- A Consumer
that will call methods on ListAliasesRequest.Builder
to create a request.default CompletableFuture<ListGroupMembersResponse> listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
listGroupMembersRequest
- default CompletableFuture<ListGroupMembersResponse> listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group.
This is a convenience which creates an instance of the ListGroupMembersRequest.Builder
avoiding the need
to create one manually via ListGroupMembersRequest.builder()
listGroupMembersRequest
- A Consumer
that will call methods on ListGroupMembersRequest.Builder
to create a request.default ListGroupMembersPublisher listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation.
listGroupMembersRequest
- default ListGroupMembersPublisher listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group.
This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation.
This is a convenience which creates an instance of the ListGroupMembersRequest.Builder
avoiding the need
to create one manually via ListGroupMembersRequest.builder()
listGroupMembersRequest
- A Consumer
that will call methods on ListGroupMembersRequest.Builder
to create a request.default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
listGroupsRequest
- default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
This is a convenience which creates an instance of the ListGroupsRequest.Builder
avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest
- A Consumer
that will call methods on ListGroupsRequest.Builder
to create a request.default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
This is a variant of listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation.
listGroupsRequest
- default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
This is a variant of listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation.
This is a convenience which creates an instance of the ListGroupsRequest.Builder
avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest
- A Consumer
that will call methods on ListGroupsRequest.Builder
to create a request.default CompletableFuture<ListOrganizationsResponse> listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
listOrganizationsRequest
- default CompletableFuture<ListOrganizationsResponse> listOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
This is a convenience which creates an instance of the ListOrganizationsRequest.Builder
avoiding the need
to create one manually via ListOrganizationsRequest.builder()
listOrganizationsRequest
- A Consumer
that will call methods on ListOrganizationsRequest.Builder
to create a request.default CompletableFuture<ListOrganizationsResponse> listOrganizations()
Returns summaries of the customer's non-deleted organizations.
default ListOrganizationsPublisher listOrganizationsPaginator()
Returns summaries of the customer's non-deleted organizations.
This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
default ListOrganizationsPublisher listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
listOrganizationsRequest
- default ListOrganizationsPublisher listOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
This is a convenience which creates an instance of the ListOrganizationsRequest.Builder
avoiding the need
to create one manually via ListOrganizationsRequest.builder()
listOrganizationsRequest
- A Consumer
that will call methods on ListOrganizationsRequest.Builder
to create a request.default CompletableFuture<ListResourceDelegatesResponse> listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegatesRequest
- default CompletableFuture<ListResourceDelegatesResponse> listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
This is a convenience which creates an instance of the ListResourceDelegatesRequest.Builder
avoiding the
need to create one manually via ListResourceDelegatesRequest.builder()
listResourceDelegatesRequest
- A Consumer
that will call methods on ListResourceDelegatesRequest.Builder
to create a
request.default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
listResourcesRequest
- default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns summaries of the organization's resources.
This is a convenience which creates an instance of the ListResourcesRequest.Builder
avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest
- A Consumer
that will call methods on ListResourcesRequest.Builder
to create a request.default ListResourcesPublisher listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
This is a variant of listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation.
listResourcesRequest
- default ListResourcesPublisher listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns summaries of the organization's resources.
This is a variant of listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation.
This is a convenience which creates an instance of the ListResourcesRequest.Builder
avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest
- A Consumer
that will call methods on ListResourcesRequest.Builder
to create a request.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
listUsersRequest
- default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns summaries of the organization's users.
This is a convenience which creates an instance of the ListUsersRequest.Builder
avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest
- A Consumer
that will call methods on ListUsersRequest.Builder
to create a request.default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
This is a variant of listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation.
listUsersRequest
- default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns summaries of the organization's users.
This is a variant of listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation.
This is a convenience which creates an instance of the ListUsersRequest.Builder
avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest
- A Consumer
that will call methods on ListUsersRequest.Builder
to create a request.default CompletableFuture<RegisterToWorkMailResponse> registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
registerToWorkMailRequest
- default CompletableFuture<RegisterToWorkMailResponse> registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> 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.
This is a convenience which creates an instance of the RegisterToWorkMailRequest.Builder
avoiding the
need to create one manually via RegisterToWorkMailRequest.builder()
registerToWorkMailRequest
- A Consumer
that will call methods on RegisterToWorkMailRequest.Builder
to create a
request.default CompletableFuture<ResetPasswordResponse> resetPassword(ResetPasswordRequest resetPasswordRequest)
Allows the administrator to reset the password for a user.
resetPasswordRequest
- default CompletableFuture<ResetPasswordResponse> resetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest)
Allows the administrator to reset the password for a user.
This is a convenience which creates an instance of the ResetPasswordRequest.Builder
avoiding the need to
create one manually via ResetPasswordRequest.builder()
resetPasswordRequest
- A Consumer
that will call methods on ResetPasswordRequest.Builder
to create a request.default CompletableFuture<UpdatePrimaryEmailAddressResponse> updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
Updates the primary email for an entity. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email) and the email provided in the input is promoted as the primary.
updatePrimaryEmailAddressRequest
- default CompletableFuture<UpdatePrimaryEmailAddressResponse> updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> 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.
This is a convenience which creates an instance of the UpdatePrimaryEmailAddressRequest.Builder
avoiding
the need to create one manually via UpdatePrimaryEmailAddressRequest.builder()
updatePrimaryEmailAddressRequest
- A Consumer
that will call methods on UpdatePrimaryEmailAddressRequest.Builder
to create a
request.default CompletableFuture<UpdateResourceResponse> updateResource(UpdateResourceRequest updateResourceRequest)
Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.
updateResourceRequest
- default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateResourceRequest.Builder
avoiding the need to
create one manually via UpdateResourceRequest.builder()
updateResourceRequest
- A Consumer
that will call methods on UpdateResourceRequest.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.