software.amazon.awssdk.services.workmail.WorkMailAsyncClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.workmail;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.workmail.model.AssociateDelegateToResourceRequest;
import software.amazon.awssdk.services.workmail.model.AssociateDelegateToResourceResponse;
import software.amazon.awssdk.services.workmail.model.AssociateMemberToGroupRequest;
import software.amazon.awssdk.services.workmail.model.AssociateMemberToGroupResponse;
import software.amazon.awssdk.services.workmail.model.AssumeImpersonationRoleRequest;
import software.amazon.awssdk.services.workmail.model.AssumeImpersonationRoleResponse;
import software.amazon.awssdk.services.workmail.model.CancelMailboxExportJobRequest;
import software.amazon.awssdk.services.workmail.model.CancelMailboxExportJobResponse;
import software.amazon.awssdk.services.workmail.model.CreateAliasRequest;
import software.amazon.awssdk.services.workmail.model.CreateAliasResponse;
import software.amazon.awssdk.services.workmail.model.CreateAvailabilityConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.CreateAvailabilityConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.CreateGroupRequest;
import software.amazon.awssdk.services.workmail.model.CreateGroupResponse;
import software.amazon.awssdk.services.workmail.model.CreateIdentityCenterApplicationRequest;
import software.amazon.awssdk.services.workmail.model.CreateIdentityCenterApplicationResponse;
import software.amazon.awssdk.services.workmail.model.CreateImpersonationRoleRequest;
import software.amazon.awssdk.services.workmail.model.CreateImpersonationRoleResponse;
import software.amazon.awssdk.services.workmail.model.CreateMobileDeviceAccessRuleRequest;
import software.amazon.awssdk.services.workmail.model.CreateMobileDeviceAccessRuleResponse;
import software.amazon.awssdk.services.workmail.model.CreateOrganizationRequest;
import software.amazon.awssdk.services.workmail.model.CreateOrganizationResponse;
import software.amazon.awssdk.services.workmail.model.CreateResourceRequest;
import software.amazon.awssdk.services.workmail.model.CreateResourceResponse;
import software.amazon.awssdk.services.workmail.model.CreateUserRequest;
import software.amazon.awssdk.services.workmail.model.CreateUserResponse;
import software.amazon.awssdk.services.workmail.model.DeleteAccessControlRuleRequest;
import software.amazon.awssdk.services.workmail.model.DeleteAccessControlRuleResponse;
import software.amazon.awssdk.services.workmail.model.DeleteAliasRequest;
import software.amazon.awssdk.services.workmail.model.DeleteAliasResponse;
import software.amazon.awssdk.services.workmail.model.DeleteAvailabilityConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.DeleteAvailabilityConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.DeleteEmailMonitoringConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.DeleteEmailMonitoringConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.DeleteGroupRequest;
import software.amazon.awssdk.services.workmail.model.DeleteGroupResponse;
import software.amazon.awssdk.services.workmail.model.DeleteIdentityCenterApplicationRequest;
import software.amazon.awssdk.services.workmail.model.DeleteIdentityCenterApplicationResponse;
import software.amazon.awssdk.services.workmail.model.DeleteIdentityProviderConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.DeleteIdentityProviderConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.DeleteImpersonationRoleRequest;
import software.amazon.awssdk.services.workmail.model.DeleteImpersonationRoleResponse;
import software.amazon.awssdk.services.workmail.model.DeleteMailboxPermissionsRequest;
import software.amazon.awssdk.services.workmail.model.DeleteMailboxPermissionsResponse;
import software.amazon.awssdk.services.workmail.model.DeleteMobileDeviceAccessOverrideRequest;
import software.amazon.awssdk.services.workmail.model.DeleteMobileDeviceAccessOverrideResponse;
import software.amazon.awssdk.services.workmail.model.DeleteMobileDeviceAccessRuleRequest;
import software.amazon.awssdk.services.workmail.model.DeleteMobileDeviceAccessRuleResponse;
import software.amazon.awssdk.services.workmail.model.DeleteOrganizationRequest;
import software.amazon.awssdk.services.workmail.model.DeleteOrganizationResponse;
import software.amazon.awssdk.services.workmail.model.DeletePersonalAccessTokenRequest;
import software.amazon.awssdk.services.workmail.model.DeletePersonalAccessTokenResponse;
import software.amazon.awssdk.services.workmail.model.DeleteResourceRequest;
import software.amazon.awssdk.services.workmail.model.DeleteResourceResponse;
import software.amazon.awssdk.services.workmail.model.DeleteRetentionPolicyRequest;
import software.amazon.awssdk.services.workmail.model.DeleteRetentionPolicyResponse;
import software.amazon.awssdk.services.workmail.model.DeleteUserRequest;
import software.amazon.awssdk.services.workmail.model.DeleteUserResponse;
import software.amazon.awssdk.services.workmail.model.DeregisterFromWorkMailRequest;
import software.amazon.awssdk.services.workmail.model.DeregisterFromWorkMailResponse;
import software.amazon.awssdk.services.workmail.model.DeregisterMailDomainRequest;
import software.amazon.awssdk.services.workmail.model.DeregisterMailDomainResponse;
import software.amazon.awssdk.services.workmail.model.DescribeEmailMonitoringConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.DescribeEmailMonitoringConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.DescribeEntityRequest;
import software.amazon.awssdk.services.workmail.model.DescribeEntityResponse;
import software.amazon.awssdk.services.workmail.model.DescribeGroupRequest;
import software.amazon.awssdk.services.workmail.model.DescribeGroupResponse;
import software.amazon.awssdk.services.workmail.model.DescribeIdentityProviderConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.DescribeIdentityProviderConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.DescribeInboundDmarcSettingsRequest;
import software.amazon.awssdk.services.workmail.model.DescribeInboundDmarcSettingsResponse;
import software.amazon.awssdk.services.workmail.model.DescribeMailboxExportJobRequest;
import software.amazon.awssdk.services.workmail.model.DescribeMailboxExportJobResponse;
import software.amazon.awssdk.services.workmail.model.DescribeOrganizationRequest;
import software.amazon.awssdk.services.workmail.model.DescribeOrganizationResponse;
import software.amazon.awssdk.services.workmail.model.DescribeResourceRequest;
import software.amazon.awssdk.services.workmail.model.DescribeResourceResponse;
import software.amazon.awssdk.services.workmail.model.DescribeUserRequest;
import software.amazon.awssdk.services.workmail.model.DescribeUserResponse;
import software.amazon.awssdk.services.workmail.model.DisassociateDelegateFromResourceRequest;
import software.amazon.awssdk.services.workmail.model.DisassociateDelegateFromResourceResponse;
import software.amazon.awssdk.services.workmail.model.DisassociateMemberFromGroupRequest;
import software.amazon.awssdk.services.workmail.model.DisassociateMemberFromGroupResponse;
import software.amazon.awssdk.services.workmail.model.GetAccessControlEffectRequest;
import software.amazon.awssdk.services.workmail.model.GetAccessControlEffectResponse;
import software.amazon.awssdk.services.workmail.model.GetDefaultRetentionPolicyRequest;
import software.amazon.awssdk.services.workmail.model.GetDefaultRetentionPolicyResponse;
import software.amazon.awssdk.services.workmail.model.GetImpersonationRoleEffectRequest;
import software.amazon.awssdk.services.workmail.model.GetImpersonationRoleEffectResponse;
import software.amazon.awssdk.services.workmail.model.GetImpersonationRoleRequest;
import software.amazon.awssdk.services.workmail.model.GetImpersonationRoleResponse;
import software.amazon.awssdk.services.workmail.model.GetMailDomainRequest;
import software.amazon.awssdk.services.workmail.model.GetMailDomainResponse;
import software.amazon.awssdk.services.workmail.model.GetMailboxDetailsRequest;
import software.amazon.awssdk.services.workmail.model.GetMailboxDetailsResponse;
import software.amazon.awssdk.services.workmail.model.GetMobileDeviceAccessEffectRequest;
import software.amazon.awssdk.services.workmail.model.GetMobileDeviceAccessEffectResponse;
import software.amazon.awssdk.services.workmail.model.GetMobileDeviceAccessOverrideRequest;
import software.amazon.awssdk.services.workmail.model.GetMobileDeviceAccessOverrideResponse;
import software.amazon.awssdk.services.workmail.model.GetPersonalAccessTokenMetadataRequest;
import software.amazon.awssdk.services.workmail.model.GetPersonalAccessTokenMetadataResponse;
import software.amazon.awssdk.services.workmail.model.ListAccessControlRulesRequest;
import software.amazon.awssdk.services.workmail.model.ListAccessControlRulesResponse;
import software.amazon.awssdk.services.workmail.model.ListAliasesRequest;
import software.amazon.awssdk.services.workmail.model.ListAliasesResponse;
import software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest;
import software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse;
import software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest;
import software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse;
import software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest;
import software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse;
import software.amazon.awssdk.services.workmail.model.ListGroupsRequest;
import software.amazon.awssdk.services.workmail.model.ListGroupsResponse;
import software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest;
import software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse;
import software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest;
import software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse;
import software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest;
import software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse;
import software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest;
import software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse;
import software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest;
import software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse;
import software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessRulesRequest;
import software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessRulesResponse;
import software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest;
import software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse;
import software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensRequest;
import software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensResponse;
import software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest;
import software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse;
import software.amazon.awssdk.services.workmail.model.ListResourcesRequest;
import software.amazon.awssdk.services.workmail.model.ListResourcesResponse;
import software.amazon.awssdk.services.workmail.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.workmail.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.workmail.model.ListUsersRequest;
import software.amazon.awssdk.services.workmail.model.ListUsersResponse;
import software.amazon.awssdk.services.workmail.model.PutAccessControlRuleRequest;
import software.amazon.awssdk.services.workmail.model.PutAccessControlRuleResponse;
import software.amazon.awssdk.services.workmail.model.PutEmailMonitoringConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.PutEmailMonitoringConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.PutIdentityProviderConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.PutIdentityProviderConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.PutInboundDmarcSettingsRequest;
import software.amazon.awssdk.services.workmail.model.PutInboundDmarcSettingsResponse;
import software.amazon.awssdk.services.workmail.model.PutMailboxPermissionsRequest;
import software.amazon.awssdk.services.workmail.model.PutMailboxPermissionsResponse;
import software.amazon.awssdk.services.workmail.model.PutMobileDeviceAccessOverrideRequest;
import software.amazon.awssdk.services.workmail.model.PutMobileDeviceAccessOverrideResponse;
import software.amazon.awssdk.services.workmail.model.PutRetentionPolicyRequest;
import software.amazon.awssdk.services.workmail.model.PutRetentionPolicyResponse;
import software.amazon.awssdk.services.workmail.model.RegisterMailDomainRequest;
import software.amazon.awssdk.services.workmail.model.RegisterMailDomainResponse;
import software.amazon.awssdk.services.workmail.model.RegisterToWorkMailRequest;
import software.amazon.awssdk.services.workmail.model.RegisterToWorkMailResponse;
import software.amazon.awssdk.services.workmail.model.ResetPasswordRequest;
import software.amazon.awssdk.services.workmail.model.ResetPasswordResponse;
import software.amazon.awssdk.services.workmail.model.StartMailboxExportJobRequest;
import software.amazon.awssdk.services.workmail.model.StartMailboxExportJobResponse;
import software.amazon.awssdk.services.workmail.model.TagResourceRequest;
import software.amazon.awssdk.services.workmail.model.TagResourceResponse;
import software.amazon.awssdk.services.workmail.model.TestAvailabilityConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.TestAvailabilityConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.UntagResourceRequest;
import software.amazon.awssdk.services.workmail.model.UntagResourceResponse;
import software.amazon.awssdk.services.workmail.model.UpdateAvailabilityConfigurationRequest;
import software.amazon.awssdk.services.workmail.model.UpdateAvailabilityConfigurationResponse;
import software.amazon.awssdk.services.workmail.model.UpdateDefaultMailDomainRequest;
import software.amazon.awssdk.services.workmail.model.UpdateDefaultMailDomainResponse;
import software.amazon.awssdk.services.workmail.model.UpdateGroupRequest;
import software.amazon.awssdk.services.workmail.model.UpdateGroupResponse;
import software.amazon.awssdk.services.workmail.model.UpdateImpersonationRoleRequest;
import software.amazon.awssdk.services.workmail.model.UpdateImpersonationRoleResponse;
import software.amazon.awssdk.services.workmail.model.UpdateMailboxQuotaRequest;
import software.amazon.awssdk.services.workmail.model.UpdateMailboxQuotaResponse;
import software.amazon.awssdk.services.workmail.model.UpdateMobileDeviceAccessRuleRequest;
import software.amazon.awssdk.services.workmail.model.UpdateMobileDeviceAccessRuleResponse;
import software.amazon.awssdk.services.workmail.model.UpdatePrimaryEmailAddressRequest;
import software.amazon.awssdk.services.workmail.model.UpdatePrimaryEmailAddressResponse;
import software.amazon.awssdk.services.workmail.model.UpdateResourceRequest;
import software.amazon.awssdk.services.workmail.model.UpdateResourceResponse;
import software.amazon.awssdk.services.workmail.model.UpdateUserRequest;
import software.amazon.awssdk.services.workmail.model.UpdateUserResponse;
import software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListPersonalAccessTokensPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher;
import software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher;
/**
* Service client for accessing Amazon WorkMail asynchronously. This can be created using the static {@link #builder()}
* method.The asynchronous client performs non-blocking I/O when configured with any {@code SdkAsyncHttpClient}
* supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
* some cases such as credentials retrieval and endpoint discovery as part of the async API call.
*
*
* 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 other
* native iOS and Android email applications. You can integrate 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 WorkMail API is designed for the following scenarios:
*
*
* -
*
* Listing and describing organizations
*
*
*
*
* -
*
* Managing users
*
*
*
*
* -
*
* Managing groups
*
*
*
*
* -
*
* Managing resources
*
*
*
*
* All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS
* SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate
* access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the
* IAM user gains full administrative visibility into the entire 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface WorkMailAsyncClient extends AwsClient {
String SERVICE_NAME = "workmail";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "workmail";
/**
*
* Adds a member (user or group) to the resource's set of delegates.
*
*
* @param associateDelegateToResourceRequest
* @return A Java Future containing the result of the AssociateDelegateToResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.AssociateDelegateToResource
* @see AWS API Documentation
*/
default CompletableFuture associateDelegateToResource(
AssociateDelegateToResourceRequest associateDelegateToResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds a member (user or group) to the resource's set of delegates.
*
*
*
* This is a convenience which creates an instance of the {@link AssociateDelegateToResourceRequest.Builder}
* avoiding the need to create one manually via {@link AssociateDelegateToResourceRequest#builder()}
*
*
* @param associateDelegateToResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.AssociateDelegateToResourceRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the AssociateDelegateToResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.AssociateDelegateToResource
* @see AWS API Documentation
*/
default CompletableFuture associateDelegateToResource(
Consumer associateDelegateToResourceRequest) {
return associateDelegateToResource(AssociateDelegateToResourceRequest.builder()
.applyMutation(associateDelegateToResourceRequest).build());
}
/**
*
* Adds a member (user or group) to the group's set.
*
*
* @param associateMemberToGroupRequest
* @return A Java Future containing the result of the AssociateMemberToGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.AssociateMemberToGroup
* @see AWS API Documentation
*/
default CompletableFuture associateMemberToGroup(
AssociateMemberToGroupRequest associateMemberToGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds a member (user or group) to the group's set.
*
*
*
* This is a convenience which creates an instance of the {@link AssociateMemberToGroupRequest.Builder} avoiding the
* need to create one manually via {@link AssociateMemberToGroupRequest#builder()}
*
*
* @param associateMemberToGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.AssociateMemberToGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the AssociateMemberToGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.AssociateMemberToGroup
* @see AWS API Documentation
*/
default CompletableFuture associateMemberToGroup(
Consumer associateMemberToGroupRequest) {
return associateMemberToGroup(AssociateMemberToGroupRequest.builder().applyMutation(associateMemberToGroupRequest)
.build());
}
/**
*
* Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token
* you can use to make impersonated calls.
*
*
* @param assumeImpersonationRoleRequest
* @return A Java Future containing the result of the AssumeImpersonationRole operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.AssumeImpersonationRole
* @see AWS API Documentation
*/
default CompletableFuture assumeImpersonationRole(
AssumeImpersonationRoleRequest assumeImpersonationRoleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token
* you can use to make impersonated calls.
*
*
*
* This is a convenience which creates an instance of the {@link AssumeImpersonationRoleRequest.Builder} avoiding
* the need to create one manually via {@link AssumeImpersonationRoleRequest#builder()}
*
*
* @param assumeImpersonationRoleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.AssumeImpersonationRoleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the AssumeImpersonationRole operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.AssumeImpersonationRole
* @see AWS API Documentation
*/
default CompletableFuture assumeImpersonationRole(
Consumer assumeImpersonationRoleRequest) {
return assumeImpersonationRole(AssumeImpersonationRoleRequest.builder().applyMutation(assumeImpersonationRoleRequest)
.build());
}
/**
*
* Cancels a mailbox export job.
*
*
*
* If the mailbox export job is near completion, it might not be possible to cancel it.
*
*
*
* @param cancelMailboxExportJobRequest
* @return A Java Future containing the result of the CancelMailboxExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CancelMailboxExportJob
* @see AWS API Documentation
*/
default CompletableFuture cancelMailboxExportJob(
CancelMailboxExportJobRequest cancelMailboxExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Cancels a mailbox export job.
*
*
*
* If the mailbox export job is near completion, it might not be possible to cancel it.
*
*
*
* This is a convenience which creates an instance of the {@link CancelMailboxExportJobRequest.Builder} avoiding the
* need to create one manually via {@link CancelMailboxExportJobRequest#builder()}
*
*
* @param cancelMailboxExportJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CancelMailboxExportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CancelMailboxExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CancelMailboxExportJob
* @see AWS API Documentation
*/
default CompletableFuture cancelMailboxExportJob(
Consumer cancelMailboxExportJobRequest) {
return cancelMailboxExportJob(CancelMailboxExportJobRequest.builder().applyMutation(cancelMailboxExportJobRequest)
.build());
}
/**
*
* Adds an alias to the set of a given member (user or group) of WorkMail.
*
*
* @param createAliasRequest
* @return A Java Future containing the result of the CreateAlias operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EmailAddressInUseException The email address that you're trying to assign is already created for a
* different user, group, or resource.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - MailDomainNotFoundException The domain specified is not found in your organization.
* - MailDomainStateException After a domain has been added to the organization, it must be verified. The
* domain is not yet verified.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - LimitExceededException The request exceeds the limit of the resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateAlias
* @see AWS API
* Documentation
*/
default CompletableFuture createAlias(CreateAliasRequest createAliasRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds an alias to the set of a given member (user or group) of WorkMail.
*
*
*
* This is a convenience which creates an instance of the {@link CreateAliasRequest.Builder} avoiding the need to
* create one manually via {@link CreateAliasRequest#builder()}
*
*
* @param createAliasRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CreateAliasRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateAlias operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EmailAddressInUseException The email address that you're trying to assign is already created for a
* different user, group, or resource.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - MailDomainNotFoundException The domain specified is not found in your organization.
* - MailDomainStateException After a domain has been added to the organization, it must be verified. The
* domain is not yet verified.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - LimitExceededException The request exceeds the limit of the resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateAlias
* @see AWS API
* Documentation
*/
default CompletableFuture createAlias(Consumer createAliasRequest) {
return createAlias(CreateAliasRequest.builder().applyMutation(createAliasRequest).build());
}
/**
*
* Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
*
*
* @param createAvailabilityConfigurationRequest
* @return A Java Future containing the result of the CreateAvailabilityConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - LimitExceededException The request exceeds the limit of the resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateAvailabilityConfiguration
* @see AWS API Documentation
*/
default CompletableFuture createAvailabilityConfiguration(
CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
*
*
*
* This is a convenience which creates an instance of the {@link CreateAvailabilityConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link CreateAvailabilityConfigurationRequest#builder()}
*
*
* @param createAvailabilityConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CreateAvailabilityConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the CreateAvailabilityConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - LimitExceededException The request exceeds the limit of the resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateAvailabilityConfiguration
* @see AWS API Documentation
*/
default CompletableFuture createAvailabilityConfiguration(
Consumer createAvailabilityConfigurationRequest) {
return createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest.builder()
.applyMutation(createAvailabilityConfigurationRequest).build());
}
/**
*
* Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
*
*
* @param createGroupRequest
* @return A Java Future containing the result of the CreateGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ReservedNameException This user, group, or resource name is not allowed in WorkMail.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createGroup(CreateGroupRequest createGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
*
*
*
* This is a convenience which creates an instance of the {@link CreateGroupRequest.Builder} avoiding the need to
* create one manually via {@link CreateGroupRequest#builder()}
*
*
* @param createGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CreateGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ReservedNameException This user, group, or resource name is not allowed in WorkMail.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createGroup(Consumer createGroupRequest) {
return createGroup(CreateGroupRequest.builder().applyMutation(createGroupRequest).build());
}
/**
*
* Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration.
* For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication
* settings for any WorkMail organizations.
*
*
* @param createIdentityCenterApplicationRequest
* @return A Java Future containing the result of the CreateIdentityCenterApplication operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateIdentityCenterApplication
* @see AWS API Documentation
*/
default CompletableFuture createIdentityCenterApplication(
CreateIdentityCenterApplicationRequest createIdentityCenterApplicationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration.
* For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication
* settings for any WorkMail organizations.
*
*
*
* This is a convenience which creates an instance of the {@link CreateIdentityCenterApplicationRequest.Builder}
* avoiding the need to create one manually via {@link CreateIdentityCenterApplicationRequest#builder()}
*
*
* @param createIdentityCenterApplicationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CreateIdentityCenterApplicationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the CreateIdentityCenterApplication operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateIdentityCenterApplication
* @see AWS API Documentation
*/
default CompletableFuture createIdentityCenterApplication(
Consumer createIdentityCenterApplicationRequest) {
return createIdentityCenterApplication(CreateIdentityCenterApplicationRequest.builder()
.applyMutation(createIdentityCenterApplicationRequest).build());
}
/**
*
* Creates an impersonation role for the given WorkMail organization.
*
*
* Idempotency ensures that an API request completes no more than one time. With an idempotent request, if
* the original request completes successfully, any subsequent retries also complete successfully without performing
* any further actions.
*
*
* @param createImpersonationRoleRequest
* @return A Java Future containing the result of the CreateImpersonationRole operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - LimitExceededException The request exceeds the limit of the resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateImpersonationRole
* @see AWS API Documentation
*/
default CompletableFuture createImpersonationRole(
CreateImpersonationRoleRequest createImpersonationRoleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an impersonation role for the given WorkMail organization.
*
*
* Idempotency ensures that an API request completes no more than one time. With an idempotent request, if
* the original request completes successfully, any subsequent retries also complete successfully without performing
* any further actions.
*
*
*
* This is a convenience which creates an instance of the {@link CreateImpersonationRoleRequest.Builder} avoiding
* the need to create one manually via {@link CreateImpersonationRoleRequest#builder()}
*
*
* @param createImpersonationRoleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CreateImpersonationRoleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateImpersonationRole operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - LimitExceededException The request exceeds the limit of the resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateImpersonationRole
* @see AWS API Documentation
*/
default CompletableFuture createImpersonationRole(
Consumer createImpersonationRoleRequest) {
return createImpersonationRole(CreateImpersonationRoleRequest.builder().applyMutation(createImpersonationRoleRequest)
.build());
}
/**
*
* Creates a new mobile device access rule for the specified WorkMail organization.
*
*
* @param createMobileDeviceAccessRuleRequest
* @return A Java Future containing the result of the CreateMobileDeviceAccessRule operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - LimitExceededException The request exceeds the limit of the resource.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateMobileDeviceAccessRule
* @see AWS API Documentation
*/
default CompletableFuture createMobileDeviceAccessRule(
CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new mobile device access rule for the specified WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link CreateMobileDeviceAccessRuleRequest.Builder}
* avoiding the need to create one manually via {@link CreateMobileDeviceAccessRuleRequest#builder()}
*
*
* @param createMobileDeviceAccessRuleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CreateMobileDeviceAccessRuleRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the CreateMobileDeviceAccessRule operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - LimitExceededException The request exceeds the limit of the resource.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateMobileDeviceAccessRule
* @see AWS API Documentation
*/
default CompletableFuture createMobileDeviceAccessRule(
Consumer createMobileDeviceAccessRuleRequest) {
return createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest.builder()
.applyMutation(createMobileDeviceAccessRuleRequest).build());
}
/**
*
* Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service
* directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias
* must match the directory alias. If you choose not to associate an existing directory with your organization, then
* we create a new WorkMail directory for you. For more information, see Adding an
* organization in the WorkMail Administrator Guide.
*
*
* You can associate multiple email domains with an organization, then choose your default email domain from the
* WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For
* more information, see Adding a
* domain and Choosing the
* default domain in the WorkMail Administrator Guide.
*
*
* Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for
* your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
*
*
* @param createOrganizationRequest
* @return A Java Future containing the result of the CreateOrganization operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - DirectoryInUseException The directory is already in use by another WorkMail organization in the same
* account and Region.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - LimitExceededException The request exceeds the limit of the resource.
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateOrganization
* @see AWS
* API Documentation
*/
default CompletableFuture createOrganization(CreateOrganizationRequest createOrganizationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service
* directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias
* must match the directory alias. If you choose not to associate an existing directory with your organization, then
* we create a new WorkMail directory for you. For more information, see Adding an
* organization in the WorkMail Administrator Guide.
*
*
* You can associate multiple email domains with an organization, then choose your default email domain from the
* WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For
* more information, see Adding a
* domain and Choosing the
* default domain in the WorkMail Administrator Guide.
*
*
* Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for
* your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
*
*
*
* This is a convenience which creates an instance of the {@link CreateOrganizationRequest.Builder} avoiding the
* need to create one manually via {@link CreateOrganizationRequest#builder()}
*
*
* @param createOrganizationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CreateOrganizationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateOrganization operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - DirectoryInUseException The directory is already in use by another WorkMail organization in the same
* account and Region.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - LimitExceededException The request exceeds the limit of the resource.
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateOrganization
* @see AWS
* API Documentation
*/
default CompletableFuture createOrganization(
Consumer createOrganizationRequest) {
return createOrganization(CreateOrganizationRequest.builder().applyMutation(createOrganizationRequest).build());
}
/**
*
* Creates a new WorkMail resource.
*
*
* @param createResourceRequest
* @return A Java Future containing the result of the CreateResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ReservedNameException This user, group, or resource name is not allowed in WorkMail.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateResource
* @see AWS API
* Documentation
*/
default CompletableFuture createResource(CreateResourceRequest createResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new WorkMail resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateResourceRequest.Builder} avoiding the need to
* create one manually via {@link CreateResourceRequest#builder()}
*
*
* @param createResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CreateResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ReservedNameException This user, group, or resource name is not allowed in WorkMail.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateResource
* @see AWS API
* Documentation
*/
default CompletableFuture createResource(Consumer createResourceRequest) {
return createResource(CreateResourceRequest.builder().applyMutation(createResourceRequest).build());
}
/**
*
* Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
*
*
* @param createUserRequest
* @return A Java Future containing the result of the CreateUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - InvalidPasswordException The supplied password doesn't match the minimum security constraints, such
* as length or use of special characters.
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ReservedNameException This user, group, or resource name is not allowed in WorkMail.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateUser
* @see AWS API
* Documentation
*/
default CompletableFuture createUser(CreateUserRequest createUserRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
*
*
*
* This is a convenience which creates an instance of the {@link CreateUserRequest.Builder} avoiding the need to
* create one manually via {@link CreateUserRequest#builder()}
*
*
* @param createUserRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.CreateUserRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - InvalidPasswordException The supplied password doesn't match the minimum security constraints, such
* as length or use of special characters.
* - NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ReservedNameException This user, group, or resource name is not allowed in WorkMail.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.CreateUser
* @see AWS API
* Documentation
*/
default CompletableFuture createUser(Consumer createUserRequest) {
return createUser(CreateUserRequest.builder().applyMutation(createUserRequest).build());
}
/**
*
* Deletes an access control rule for the specified WorkMail organization.
*
*
*
* Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back
* an HTTP 200 response with an empty HTTP body.
*
*
*
* @param deleteAccessControlRuleRequest
* @return A Java Future containing the result of the DeleteAccessControlRule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteAccessControlRule
* @see AWS API Documentation
*/
default CompletableFuture deleteAccessControlRule(
DeleteAccessControlRuleRequest deleteAccessControlRuleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an access control rule for the specified WorkMail organization.
*
*
*
* Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back
* an HTTP 200 response with an empty HTTP body.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAccessControlRuleRequest.Builder} avoiding
* the need to create one manually via {@link DeleteAccessControlRuleRequest#builder()}
*
*
* @param deleteAccessControlRuleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteAccessControlRuleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteAccessControlRule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteAccessControlRule
* @see AWS API Documentation
*/
default CompletableFuture deleteAccessControlRule(
Consumer deleteAccessControlRuleRequest) {
return deleteAccessControlRule(DeleteAccessControlRuleRequest.builder().applyMutation(deleteAccessControlRuleRequest)
.build());
}
/**
*
* Remove one or more specified aliases from a set of aliases for a given user.
*
*
* @param deleteAliasRequest
* @return A Java Future containing the result of the DeleteAlias operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteAlias
* @see AWS API
* Documentation
*/
default CompletableFuture deleteAlias(DeleteAliasRequest deleteAliasRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Remove one or more specified aliases from a set of aliases for a given user.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAliasRequest.Builder} avoiding the need to
* create one manually via {@link DeleteAliasRequest#builder()}
*
*
* @param deleteAliasRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteAliasRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteAlias operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteAlias
* @see AWS API
* Documentation
*/
default CompletableFuture deleteAlias(Consumer deleteAliasRequest) {
return deleteAlias(DeleteAliasRequest.builder().applyMutation(deleteAliasRequest).build());
}
/**
*
* Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
*
*
* @param deleteAvailabilityConfigurationRequest
* @return A Java Future containing the result of the DeleteAvailabilityConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteAvailabilityConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteAvailabilityConfiguration(
DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAvailabilityConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteAvailabilityConfigurationRequest#builder()}
*
*
* @param deleteAvailabilityConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteAvailabilityConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteAvailabilityConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteAvailabilityConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteAvailabilityConfiguration(
Consumer deleteAvailabilityConfigurationRequest) {
return deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest.builder()
.applyMutation(deleteAvailabilityConfigurationRequest).build());
}
/**
*
* Deletes the email monitoring configuration for a specified organization.
*
*
* @param deleteEmailMonitoringConfigurationRequest
* @return A Java Future containing the result of the DeleteEmailMonitoringConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteEmailMonitoringConfiguration(
DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the email monitoring configuration for a specified organization.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteEmailMonitoringConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteEmailMonitoringConfigurationRequest#builder()}
*
*
* @param deleteEmailMonitoringConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteEmailMonitoringConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DeleteEmailMonitoringConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteEmailMonitoringConfiguration(
Consumer deleteEmailMonitoringConfigurationRequest) {
return deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest.builder()
.applyMutation(deleteEmailMonitoringConfigurationRequest).build());
}
/**
*
* Deletes a group from WorkMail.
*
*
* @param deleteGroupRequest
* @return A Java Future containing the result of the DeleteGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteGroup(DeleteGroupRequest deleteGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a group from WorkMail.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteGroupRequest.Builder} avoiding the need to
* create one manually via {@link DeleteGroupRequest#builder()}
*
*
* @param deleteGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteGroup(Consumer deleteGroupRequest) {
return deleteGroup(DeleteGroupRequest.builder().applyMutation(deleteGroupRequest).build());
}
/**
*
* Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication
* settings for any WorkMail organizations.
*
*
* @param deleteIdentityCenterApplicationRequest
* @return A Java Future containing the result of the DeleteIdentityCenterApplication operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteIdentityCenterApplication
* @see AWS API Documentation
*/
default CompletableFuture deleteIdentityCenterApplication(
DeleteIdentityCenterApplicationRequest deleteIdentityCenterApplicationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication
* settings for any WorkMail organizations.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIdentityCenterApplicationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteIdentityCenterApplicationRequest#builder()}
*
*
* @param deleteIdentityCenterApplicationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteIdentityCenterApplicationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteIdentityCenterApplication operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteIdentityCenterApplication
* @see AWS API Documentation
*/
default CompletableFuture deleteIdentityCenterApplication(
Consumer deleteIdentityCenterApplicationRequest) {
return deleteIdentityCenterApplication(DeleteIdentityCenterApplicationRequest.builder()
.applyMutation(deleteIdentityCenterApplicationRequest).build());
}
/**
*
* Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was
* before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and
* mobile email clients.
*
*
* @param deleteIdentityProviderConfigurationRequest
* @return A Java Future containing the result of the DeleteIdentityProviderConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteIdentityProviderConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteIdentityProviderConfiguration(
DeleteIdentityProviderConfigurationRequest deleteIdentityProviderConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was
* before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and
* mobile email clients.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIdentityProviderConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteIdentityProviderConfigurationRequest#builder()}
*
*
* @param deleteIdentityProviderConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteIdentityProviderConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DeleteIdentityProviderConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteIdentityProviderConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteIdentityProviderConfiguration(
Consumer deleteIdentityProviderConfigurationRequest) {
return deleteIdentityProviderConfiguration(DeleteIdentityProviderConfigurationRequest.builder()
.applyMutation(deleteIdentityProviderConfigurationRequest).build());
}
/**
*
* Deletes an impersonation role for the given WorkMail organization.
*
*
* @param deleteImpersonationRoleRequest
* @return A Java Future containing the result of the DeleteImpersonationRole operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteImpersonationRole
* @see AWS API Documentation
*/
default CompletableFuture deleteImpersonationRole(
DeleteImpersonationRoleRequest deleteImpersonationRoleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an impersonation role for the given WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteImpersonationRoleRequest.Builder} avoiding
* the need to create one manually via {@link DeleteImpersonationRoleRequest#builder()}
*
*
* @param deleteImpersonationRoleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteImpersonationRoleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteImpersonationRole operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteImpersonationRole
* @see AWS API Documentation
*/
default CompletableFuture deleteImpersonationRole(
Consumer deleteImpersonationRoleRequest) {
return deleteImpersonationRole(DeleteImpersonationRoleRequest.builder().applyMutation(deleteImpersonationRoleRequest)
.build());
}
/**
*
* Deletes permissions granted to a member (user or group).
*
*
* @param deleteMailboxPermissionsRequest
* @return A Java Future containing the result of the DeleteMailboxPermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteMailboxPermissions
* @see AWS API Documentation
*/
default CompletableFuture deleteMailboxPermissions(
DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes permissions granted to a member (user or group).
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMailboxPermissionsRequest.Builder} avoiding
* the need to create one manually via {@link DeleteMailboxPermissionsRequest#builder()}
*
*
* @param deleteMailboxPermissionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteMailboxPermissionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteMailboxPermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteMailboxPermissions
* @see AWS API Documentation
*/
default CompletableFuture deleteMailboxPermissions(
Consumer deleteMailboxPermissionsRequest) {
return deleteMailboxPermissions(DeleteMailboxPermissionsRequest.builder().applyMutation(deleteMailboxPermissionsRequest)
.build());
}
/**
*
* Deletes the mobile device access override for the given WorkMail organization, user, and device.
*
*
*
* Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends
* back an HTTP 200 response with an empty HTTP body.
*
*
*
* @param deleteMobileDeviceAccessOverrideRequest
* @return A Java Future containing the result of the DeleteMobileDeviceAccessOverride operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default CompletableFuture deleteMobileDeviceAccessOverride(
DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the mobile device access override for the given WorkMail organization, user, and device.
*
*
*
* Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends
* back an HTTP 200 response with an empty HTTP body.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMobileDeviceAccessOverrideRequest.Builder}
* avoiding the need to create one manually via {@link DeleteMobileDeviceAccessOverrideRequest#builder()}
*
*
* @param deleteMobileDeviceAccessOverrideRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteMobileDeviceAccessOverrideRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteMobileDeviceAccessOverride operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default CompletableFuture deleteMobileDeviceAccessOverride(
Consumer deleteMobileDeviceAccessOverrideRequest) {
return deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest.builder()
.applyMutation(deleteMobileDeviceAccessOverrideRequest).build());
}
/**
*
* Deletes a mobile device access rule for the specified WorkMail organization.
*
*
*
* Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back
* an HTTP 200 response with an empty HTTP body.
*
*
*
* @param deleteMobileDeviceAccessRuleRequest
* @return A Java Future containing the result of the DeleteMobileDeviceAccessRule operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteMobileDeviceAccessRule
* @see AWS API Documentation
*/
default CompletableFuture deleteMobileDeviceAccessRule(
DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a mobile device access rule for the specified WorkMail organization.
*
*
*
* Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back
* an HTTP 200 response with an empty HTTP body.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMobileDeviceAccessRuleRequest.Builder}
* avoiding the need to create one manually via {@link DeleteMobileDeviceAccessRuleRequest#builder()}
*
*
* @param deleteMobileDeviceAccessRuleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteMobileDeviceAccessRuleRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteMobileDeviceAccessRule operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteMobileDeviceAccessRule
* @see AWS API Documentation
*/
default CompletableFuture deleteMobileDeviceAccessRule(
Consumer deleteMobileDeviceAccessRuleRequest) {
return deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest.builder()
.applyMutation(deleteMobileDeviceAccessRuleRequest).build());
}
/**
*
* Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the
* organization. You can choose whether to delete the associated directory. For more information, see Removing an
* organization in the WorkMail Administrator Guide.
*
*
* @param deleteOrganizationRequest
* @return A Java Future containing the result of the DeleteOrganization operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteOrganization
* @see AWS
* API Documentation
*/
default CompletableFuture deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the
* organization. You can choose whether to delete the associated directory. For more information, see Removing an
* organization in the WorkMail Administrator Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteOrganizationRequest.Builder} avoiding the
* need to create one manually via {@link DeleteOrganizationRequest#builder()}
*
*
* @param deleteOrganizationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteOrganizationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteOrganization operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteOrganization
* @see AWS
* API Documentation
*/
default CompletableFuture deleteOrganization(
Consumer deleteOrganizationRequest) {
return deleteOrganization(DeleteOrganizationRequest.builder().applyMutation(deleteOrganizationRequest).build());
}
/**
*
* Deletes the Personal Access Token from the provided WorkMail Organization.
*
*
* @param deletePersonalAccessTokenRequest
* @return A Java Future containing the result of the DeletePersonalAccessToken operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeletePersonalAccessToken
* @see AWS API Documentation
*/
default CompletableFuture deletePersonalAccessToken(
DeletePersonalAccessTokenRequest deletePersonalAccessTokenRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the Personal Access Token from the provided WorkMail Organization.
*
*
*
* This is a convenience which creates an instance of the {@link DeletePersonalAccessTokenRequest.Builder} avoiding
* the need to create one manually via {@link DeletePersonalAccessTokenRequest#builder()}
*
*
* @param deletePersonalAccessTokenRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeletePersonalAccessTokenRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DeletePersonalAccessToken operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeletePersonalAccessToken
* @see AWS API Documentation
*/
default CompletableFuture deletePersonalAccessToken(
Consumer deletePersonalAccessTokenRequest) {
return deletePersonalAccessToken(DeletePersonalAccessTokenRequest.builder()
.applyMutation(deletePersonalAccessTokenRequest).build());
}
/**
*
* Deletes the specified resource.
*
*
* @param deleteResourceRequest
* @return A Java Future containing the result of the DeleteResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteResource
* @see AWS API
* Documentation
*/
default CompletableFuture deleteResource(DeleteResourceRequest deleteResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteResourceRequest.Builder} avoiding the need to
* create one manually via {@link DeleteResourceRequest#builder()}
*
*
* @param deleteResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteResource
* @see AWS API
* Documentation
*/
default CompletableFuture deleteResource(Consumer deleteResourceRequest) {
return deleteResource(DeleteResourceRequest.builder().applyMutation(deleteResourceRequest).build());
}
/**
*
* Deletes the specified retention policy from the specified organization.
*
*
* @param deleteRetentionPolicyRequest
* @return A Java Future containing the result of the DeleteRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteRetentionPolicy
* @see AWS API Documentation
*/
default CompletableFuture deleteRetentionPolicy(
DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified retention policy from the specified organization.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRetentionPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteRetentionPolicyRequest#builder()}
*
*
* @param deleteRetentionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteRetentionPolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteRetentionPolicy
* @see AWS API Documentation
*/
default CompletableFuture deleteRetentionPolicy(
Consumer deleteRetentionPolicyRequest) {
return deleteRetentionPolicy(DeleteRetentionPolicyRequest.builder().applyMutation(deleteRetentionPolicyRequest).build());
}
/**
*
* Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be
* DISABLED. Use the DescribeUser action to confirm the user state.
*
*
* Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are
* permanently removed.
*
*
* @param deleteUserRequest
* @return A Java Future containing the result of the DeleteUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteUser
* @see AWS API
* Documentation
*/
default CompletableFuture deleteUser(DeleteUserRequest deleteUserRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be
* DISABLED. Use the DescribeUser action to confirm the user state.
*
*
* Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are
* permanently removed.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteUserRequest.Builder} avoiding the need to
* create one manually via {@link DeleteUserRequest#builder()}
*
*
* @param deleteUserRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeleteUserRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeleteUser
* @see AWS API
* Documentation
*/
default CompletableFuture deleteUser(Consumer deleteUserRequest) {
return deleteUser(DeleteUserRequest.builder().applyMutation(deleteUserRequest).build());
}
/**
*
* Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and
* schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The
* functionality in the console is Disable.
*
*
* @param deregisterFromWorkMailRequest
* @return A Java Future containing the result of the DeregisterFromWorkMail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeregisterFromWorkMail
* @see AWS API Documentation
*/
default CompletableFuture deregisterFromWorkMail(
DeregisterFromWorkMailRequest deregisterFromWorkMailRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and
* schedules it for clean-up. 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 {@link DeregisterFromWorkMailRequest.Builder} avoiding the
* need to create one manually via {@link DeregisterFromWorkMailRequest#builder()}
*
*
* @param deregisterFromWorkMailRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeregisterFromWorkMailRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeregisterFromWorkMail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeregisterFromWorkMail
* @see AWS API Documentation
*/
default CompletableFuture deregisterFromWorkMail(
Consumer deregisterFromWorkMailRequest) {
return deregisterFromWorkMail(DeregisterFromWorkMailRequest.builder().applyMutation(deregisterFromWorkMailRequest)
.build());
}
/**
*
* Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail
* use. SES keeps the domain because other applications may use it. You must first remove any email address used by
* WorkMail entities before you remove the domain.
*
*
* @param deregisterMailDomainRequest
* @return A Java Future containing the result of the DeregisterMailDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - MailDomainInUseException The domain you're trying to change is in use by another user or organization
* in your account. See the error message for details.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - InvalidCustomSesConfigurationException You SES configuration has customizations that WorkMail cannot
* save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeregisterMailDomain
* @see AWS
* API Documentation
*/
default CompletableFuture deregisterMailDomain(
DeregisterMailDomainRequest deregisterMailDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail
* use. SES keeps the domain because other applications may use it. You must first remove any email address used by
* WorkMail entities before you remove the domain.
*
*
*
* This is a convenience which creates an instance of the {@link DeregisterMailDomainRequest.Builder} avoiding the
* need to create one manually via {@link DeregisterMailDomainRequest#builder()}
*
*
* @param deregisterMailDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DeregisterMailDomainRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeregisterMailDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - MailDomainInUseException The domain you're trying to change is in use by another user or organization
* in your account. See the error message for details.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - InvalidCustomSesConfigurationException You SES configuration has customizations that WorkMail cannot
* save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DeregisterMailDomain
* @see AWS
* API Documentation
*/
default CompletableFuture deregisterMailDomain(
Consumer deregisterMailDomainRequest) {
return deregisterMailDomain(DeregisterMailDomainRequest.builder().applyMutation(deregisterMailDomainRequest).build());
}
/**
*
* Describes the current email monitoring configuration for a specified organization.
*
*
* @param describeEmailMonitoringConfigurationRequest
* @return A Java Future containing the result of the DescribeEmailMonitoringConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The resource cannot be found.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeEmailMonitoringConfiguration(
DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the current email monitoring configuration for a specified organization.
*
*
*
* This is a convenience which creates an instance of the
* {@link DescribeEmailMonitoringConfigurationRequest.Builder} avoiding the need to create one manually via
* {@link DescribeEmailMonitoringConfigurationRequest#builder()}
*
*
* @param describeEmailMonitoringConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DescribeEmailMonitoringConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DescribeEmailMonitoringConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The resource cannot be found.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeEmailMonitoringConfiguration(
Consumer describeEmailMonitoringConfigurationRequest) {
return describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest.builder()
.applyMutation(describeEmailMonitoringConfigurationRequest).build());
}
/**
*
* Returns basic details about an entity in WorkMail.
*
*
* @param describeEntityRequest
* @return A Java Future containing the result of the DescribeEntity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeEntity
* @see AWS API
* Documentation
*/
default CompletableFuture describeEntity(DescribeEntityRequest describeEntityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns basic details about an entity in WorkMail.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEntityRequest.Builder} avoiding the need to
* create one manually via {@link DescribeEntityRequest#builder()}
*
*
* @param describeEntityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DescribeEntityRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeEntity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeEntity
* @see AWS API
* Documentation
*/
default CompletableFuture describeEntity(Consumer describeEntityRequest) {
return describeEntity(DescribeEntityRequest.builder().applyMutation(describeEntityRequest).build());
}
/**
*
* Returns the data available for the group.
*
*
* @param describeGroupRequest
* @return A Java Future containing the result of the DescribeGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeGroup
* @see AWS API
* Documentation
*/
default CompletableFuture describeGroup(DescribeGroupRequest describeGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the data available for the group.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeGroupRequest.Builder} avoiding the need to
* create one manually via {@link DescribeGroupRequest#builder()}
*
*
* @param describeGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DescribeGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeGroup
* @see AWS API
* Documentation
*/
default CompletableFuture describeGroup(Consumer describeGroupRequest) {
return describeGroup(DescribeGroupRequest.builder().applyMutation(describeGroupRequest).build());
}
/**
*
* Returns detailed information on the current IdC setup for the WorkMail organization.
*
*
* @param describeIdentityProviderConfigurationRequest
* @return A Java Future containing the result of the DescribeIdentityProviderConfiguration operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeIdentityProviderConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeIdentityProviderConfiguration(
DescribeIdentityProviderConfigurationRequest describeIdentityProviderConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns detailed information on the current IdC setup for the WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the
* {@link DescribeIdentityProviderConfigurationRequest.Builder} avoiding the need to create one manually via
* {@link DescribeIdentityProviderConfigurationRequest#builder()}
*
*
* @param describeIdentityProviderConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DescribeIdentityProviderConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DescribeIdentityProviderConfiguration operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeIdentityProviderConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeIdentityProviderConfiguration(
Consumer describeIdentityProviderConfigurationRequest) {
return describeIdentityProviderConfiguration(DescribeIdentityProviderConfigurationRequest.builder()
.applyMutation(describeIdentityProviderConfigurationRequest).build());
}
/**
*
* Lists the settings in a DMARC policy for a specified organization.
*
*
* @param describeInboundDmarcSettingsRequest
* @return A Java Future containing the result of the DescribeInboundDmarcSettings operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeInboundDmarcSettings
* @see AWS API Documentation
*/
default CompletableFuture describeInboundDmarcSettings(
DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the settings in a DMARC policy for a specified organization.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeInboundDmarcSettingsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeInboundDmarcSettingsRequest#builder()}
*
*
* @param describeInboundDmarcSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DescribeInboundDmarcSettingsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeInboundDmarcSettings operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeInboundDmarcSettings
* @see AWS API Documentation
*/
default CompletableFuture describeInboundDmarcSettings(
Consumer describeInboundDmarcSettingsRequest) {
return describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest.builder()
.applyMutation(describeInboundDmarcSettingsRequest).build());
}
/**
*
* Describes the current status of a mailbox export job.
*
*
* @param describeMailboxExportJobRequest
* @return A Java Future containing the result of the DescribeMailboxExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeMailboxExportJob
* @see AWS API Documentation
*/
default CompletableFuture describeMailboxExportJob(
DescribeMailboxExportJobRequest describeMailboxExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the current status of a mailbox export job.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeMailboxExportJobRequest.Builder} avoiding
* the need to create one manually via {@link DescribeMailboxExportJobRequest#builder()}
*
*
* @param describeMailboxExportJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DescribeMailboxExportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeMailboxExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeMailboxExportJob
* @see AWS API Documentation
*/
default CompletableFuture describeMailboxExportJob(
Consumer describeMailboxExportJobRequest) {
return describeMailboxExportJob(DescribeMailboxExportJobRequest.builder().applyMutation(describeMailboxExportJobRequest)
.build());
}
/**
*
* Provides more information regarding a given organization based on its identifier.
*
*
* @param describeOrganizationRequest
* @return A Java Future containing the result of the DescribeOrganization operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeOrganization
* @see AWS
* API Documentation
*/
default CompletableFuture describeOrganization(
DescribeOrganizationRequest describeOrganizationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Provides more information regarding a given organization based on its identifier.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeOrganizationRequest.Builder} avoiding the
* need to create one manually via {@link DescribeOrganizationRequest#builder()}
*
*
* @param describeOrganizationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DescribeOrganizationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeOrganization operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeOrganization
* @see AWS
* API Documentation
*/
default CompletableFuture describeOrganization(
Consumer describeOrganizationRequest) {
return describeOrganization(DescribeOrganizationRequest.builder().applyMutation(describeOrganizationRequest).build());
}
/**
*
* Returns the data available for the resource.
*
*
* @param describeResourceRequest
* @return A Java Future containing the result of the DescribeResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeResource
* @see AWS API
* Documentation
*/
default CompletableFuture describeResource(DescribeResourceRequest describeResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the data available for the resource.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeResourceRequest.Builder} avoiding the need
* to create one manually via {@link DescribeResourceRequest#builder()}
*
*
* @param describeResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DescribeResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeResource
* @see AWS API
* Documentation
*/
default CompletableFuture describeResource(
Consumer describeResourceRequest) {
return describeResource(DescribeResourceRequest.builder().applyMutation(describeResourceRequest).build());
}
/**
*
* Provides information regarding the user.
*
*
* @param describeUserRequest
* @return A Java Future containing the result of the DescribeUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeUser
* @see AWS API
* Documentation
*/
default CompletableFuture describeUser(DescribeUserRequest describeUserRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Provides information regarding the user.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeUserRequest.Builder} avoiding the need to
* create one manually via {@link DescribeUserRequest#builder()}
*
*
* @param describeUserRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DescribeUserRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DescribeUser
* @see AWS API
* Documentation
*/
default CompletableFuture describeUser(Consumer describeUserRequest) {
return describeUser(DescribeUserRequest.builder().applyMutation(describeUserRequest).build());
}
/**
*
* Removes a member from the resource's set of delegates.
*
*
* @param disassociateDelegateFromResourceRequest
* @return A Java Future containing the result of the DisassociateDelegateFromResource operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DisassociateDelegateFromResource
* @see AWS API Documentation
*/
default CompletableFuture disassociateDelegateFromResource(
DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes a member from the resource's set of delegates.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateDelegateFromResourceRequest.Builder}
* avoiding the need to create one manually via {@link DisassociateDelegateFromResourceRequest#builder()}
*
*
* @param disassociateDelegateFromResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DisassociateDelegateFromResourceRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DisassociateDelegateFromResource operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DisassociateDelegateFromResource
* @see AWS API Documentation
*/
default CompletableFuture disassociateDelegateFromResource(
Consumer disassociateDelegateFromResourceRequest) {
return disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest.builder()
.applyMutation(disassociateDelegateFromResourceRequest).build());
}
/**
*
* Removes a member from a group.
*
*
* @param disassociateMemberFromGroupRequest
* @return A Java Future containing the result of the DisassociateMemberFromGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DisassociateMemberFromGroup
* @see AWS API Documentation
*/
default CompletableFuture disassociateMemberFromGroup(
DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes a member from a group.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateMemberFromGroupRequest.Builder}
* avoiding the need to create one manually via {@link DisassociateMemberFromGroupRequest#builder()}
*
*
* @param disassociateMemberFromGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.DisassociateMemberFromGroupRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DisassociateMemberFromGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.DisassociateMemberFromGroup
* @see AWS API Documentation
*/
default CompletableFuture disassociateMemberFromGroup(
Consumer disassociateMemberFromGroupRequest) {
return disassociateMemberFromGroup(DisassociateMemberFromGroupRequest.builder()
.applyMutation(disassociateMemberFromGroupRequest).build());
}
/**
*
* Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access
* protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role
* ID. Impersonation role ID can only be used with Action EWS.
*
*
* @param getAccessControlEffectRequest
* @return A Java Future containing the result of the GetAccessControlEffect operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - ResourceNotFoundException The resource cannot be found.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetAccessControlEffect
* @see AWS API Documentation
*/
default CompletableFuture getAccessControlEffect(
GetAccessControlEffectRequest getAccessControlEffectRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access
* protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role
* ID. Impersonation role ID can only be used with Action EWS.
*
*
*
* This is a convenience which creates an instance of the {@link GetAccessControlEffectRequest.Builder} avoiding the
* need to create one manually via {@link GetAccessControlEffectRequest#builder()}
*
*
* @param getAccessControlEffectRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.GetAccessControlEffectRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetAccessControlEffect operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - ResourceNotFoundException The resource cannot be found.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetAccessControlEffect
* @see AWS API Documentation
*/
default CompletableFuture getAccessControlEffect(
Consumer getAccessControlEffectRequest) {
return getAccessControlEffect(GetAccessControlEffectRequest.builder().applyMutation(getAccessControlEffectRequest)
.build());
}
/**
*
* Gets the default retention policy details for the specified organization.
*
*
* @param getDefaultRetentionPolicyRequest
* @return A Java Future containing the result of the GetDefaultRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetDefaultRetentionPolicy
* @see AWS API Documentation
*/
default CompletableFuture getDefaultRetentionPolicy(
GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the default retention policy details for the specified organization.
*
*
*
* This is a convenience which creates an instance of the {@link GetDefaultRetentionPolicyRequest.Builder} avoiding
* the need to create one manually via {@link GetDefaultRetentionPolicyRequest#builder()}
*
*
* @param getDefaultRetentionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.GetDefaultRetentionPolicyRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the GetDefaultRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetDefaultRetentionPolicy
* @see AWS API Documentation
*/
default CompletableFuture getDefaultRetentionPolicy(
Consumer getDefaultRetentionPolicyRequest) {
return getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest.builder()
.applyMutation(getDefaultRetentionPolicyRequest).build());
}
/**
*
* Gets the impersonation role details for the given WorkMail organization.
*
*
* @param getImpersonationRoleRequest
* @return A Java Future containing the result of the GetImpersonationRole operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetImpersonationRole
* @see AWS
* API Documentation
*/
default CompletableFuture getImpersonationRole(
GetImpersonationRoleRequest getImpersonationRoleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the impersonation role details for the given WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link GetImpersonationRoleRequest.Builder} avoiding the
* need to create one manually via {@link GetImpersonationRoleRequest#builder()}
*
*
* @param getImpersonationRoleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.GetImpersonationRoleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetImpersonationRole operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetImpersonationRole
* @see AWS
* API Documentation
*/
default CompletableFuture getImpersonationRole(
Consumer getImpersonationRoleRequest) {
return getImpersonationRole(GetImpersonationRoleRequest.builder().applyMutation(getImpersonationRoleRequest).build());
}
/**
*
* Tests whether the given impersonation role can impersonate a target user.
*
*
* @param getImpersonationRoleEffectRequest
* @return A Java Future containing the result of the GetImpersonationRoleEffect operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetImpersonationRoleEffect
* @see AWS API Documentation
*/
default CompletableFuture getImpersonationRoleEffect(
GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Tests whether the given impersonation role can impersonate a target user.
*
*
*
* This is a convenience which creates an instance of the {@link GetImpersonationRoleEffectRequest.Builder} avoiding
* the need to create one manually via {@link GetImpersonationRoleEffectRequest#builder()}
*
*
* @param getImpersonationRoleEffectRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.GetImpersonationRoleEffectRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the GetImpersonationRoleEffect operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetImpersonationRoleEffect
* @see AWS API Documentation
*/
default CompletableFuture getImpersonationRoleEffect(
Consumer getImpersonationRoleEffectRequest) {
return getImpersonationRoleEffect(GetImpersonationRoleEffectRequest.builder()
.applyMutation(getImpersonationRoleEffectRequest).build());
}
/**
*
* Gets details for a mail domain, including domain records required to configure your domain with recommended
* security.
*
*
* @param getMailDomainRequest
* @return A Java Future containing the result of the GetMailDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - MailDomainNotFoundException The domain specified is not found in your organization.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetMailDomain
* @see AWS API
* Documentation
*/
default CompletableFuture getMailDomain(GetMailDomainRequest getMailDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets details for a mail domain, including domain records required to configure your domain with recommended
* security.
*
*
*
* This is a convenience which creates an instance of the {@link GetMailDomainRequest.Builder} avoiding the need to
* create one manually via {@link GetMailDomainRequest#builder()}
*
*
* @param getMailDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.GetMailDomainRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetMailDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - MailDomainNotFoundException The domain specified is not found in your organization.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetMailDomain
* @see AWS API
* Documentation
*/
default CompletableFuture getMailDomain(Consumer getMailDomainRequest) {
return getMailDomain(GetMailDomainRequest.builder().applyMutation(getMailDomainRequest).build());
}
/**
*
* Requests a user's mailbox details for a specified organization and user.
*
*
* @param getMailboxDetailsRequest
* @return A Java Future containing the result of the GetMailboxDetails operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetMailboxDetails
* @see AWS
* API Documentation
*/
default CompletableFuture getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Requests a user's mailbox details for a specified organization and user.
*
*
*
* This is a convenience which creates an instance of the {@link GetMailboxDetailsRequest.Builder} avoiding the need
* to create one manually via {@link GetMailboxDetailsRequest#builder()}
*
*
* @param getMailboxDetailsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.GetMailboxDetailsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetMailboxDetails operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetMailboxDetails
* @see AWS
* API Documentation
*/
default CompletableFuture getMailboxDetails(
Consumer getMailboxDetailsRequest) {
return getMailboxDetails(GetMailboxDetailsRequest.builder().applyMutation(getMailboxDetailsRequest).build());
}
/**
*
* Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use
* this method to test the effects of the current set of mobile device access rules for the WorkMail organization
* for a particular user's attributes.
*
*
* @param getMobileDeviceAccessEffectRequest
* @return A Java Future containing the result of the GetMobileDeviceAccessEffect operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetMobileDeviceAccessEffect
* @see AWS API Documentation
*/
default CompletableFuture getMobileDeviceAccessEffect(
GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use
* this method to test the effects of the current set of mobile device access rules for the WorkMail organization
* for a particular user's attributes.
*
*
*
* This is a convenience which creates an instance of the {@link GetMobileDeviceAccessEffectRequest.Builder}
* avoiding the need to create one manually via {@link GetMobileDeviceAccessEffectRequest#builder()}
*
*
* @param getMobileDeviceAccessEffectRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.GetMobileDeviceAccessEffectRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetMobileDeviceAccessEffect operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetMobileDeviceAccessEffect
* @see AWS API Documentation
*/
default CompletableFuture getMobileDeviceAccessEffect(
Consumer getMobileDeviceAccessEffectRequest) {
return getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest.builder()
.applyMutation(getMobileDeviceAccessEffectRequest).build());
}
/**
*
* Gets the mobile device access override for the given WorkMail organization, user, and device.
*
*
* @param getMobileDeviceAccessOverrideRequest
* @return A Java Future containing the result of the GetMobileDeviceAccessOverride operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default CompletableFuture getMobileDeviceAccessOverride(
GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the mobile device access override for the given WorkMail organization, user, and device.
*
*
*
* This is a convenience which creates an instance of the {@link GetMobileDeviceAccessOverrideRequest.Builder}
* avoiding the need to create one manually via {@link GetMobileDeviceAccessOverrideRequest#builder()}
*
*
* @param getMobileDeviceAccessOverrideRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.GetMobileDeviceAccessOverrideRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetMobileDeviceAccessOverride operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default CompletableFuture getMobileDeviceAccessOverride(
Consumer getMobileDeviceAccessOverrideRequest) {
return getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest.builder()
.applyMutation(getMobileDeviceAccessOverrideRequest).build());
}
/**
*
* Requests details of a specific Personal Access Token within the WorkMail organization.
*
*
* @param getPersonalAccessTokenMetadataRequest
* @return A Java Future containing the result of the GetPersonalAccessTokenMetadata operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The resource cannot be found.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetPersonalAccessTokenMetadata
* @see AWS API Documentation
*/
default CompletableFuture getPersonalAccessTokenMetadata(
GetPersonalAccessTokenMetadataRequest getPersonalAccessTokenMetadataRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Requests details of a specific Personal Access Token within the WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link GetPersonalAccessTokenMetadataRequest.Builder}
* avoiding the need to create one manually via {@link GetPersonalAccessTokenMetadataRequest#builder()}
*
*
* @param getPersonalAccessTokenMetadataRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.GetPersonalAccessTokenMetadataRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetPersonalAccessTokenMetadata operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The resource cannot be found.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.GetPersonalAccessTokenMetadata
* @see AWS API Documentation
*/
default CompletableFuture getPersonalAccessTokenMetadata(
Consumer getPersonalAccessTokenMetadataRequest) {
return getPersonalAccessTokenMetadata(GetPersonalAccessTokenMetadataRequest.builder()
.applyMutation(getPersonalAccessTokenMetadataRequest).build());
}
/**
*
* Lists the access control rules for the specified organization.
*
*
* @param listAccessControlRulesRequest
* @return A Java Future containing the result of the ListAccessControlRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAccessControlRules
* @see AWS API Documentation
*/
default CompletableFuture listAccessControlRules(
ListAccessControlRulesRequest listAccessControlRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the access control rules for the specified organization.
*
*
*
* This is a convenience which creates an instance of the {@link ListAccessControlRulesRequest.Builder} avoiding the
* need to create one manually via {@link ListAccessControlRulesRequest#builder()}
*
*
* @param listAccessControlRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListAccessControlRulesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListAccessControlRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAccessControlRules
* @see AWS API Documentation
*/
default CompletableFuture listAccessControlRules(
Consumer listAccessControlRulesRequest) {
return listAccessControlRules(ListAccessControlRulesRequest.builder().applyMutation(listAccessControlRulesRequest)
.build());
}
/**
*
* Creates a paginated call to list the aliases associated with a given entity.
*
*
* @param listAliasesRequest
* @return A Java Future containing the result of the ListAliases operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAliases
* @see AWS API
* Documentation
*/
default CompletableFuture listAliases(ListAliasesRequest listAliasesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a paginated call to list the aliases associated with a given entity.
*
*
*
* This is a convenience which creates an instance of the {@link ListAliasesRequest.Builder} avoiding the need to
* create one manually via {@link ListAliasesRequest#builder()}
*
*
* @param listAliasesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListAliasesRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListAliases operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAliases
* @see AWS API
* Documentation
*/
default CompletableFuture listAliases(Consumer listAliasesRequest) {
return listAliases(ListAliasesRequest.builder().applyMutation(listAliasesRequest).build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)} operation.
*
*
* @param listAliasesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAliases
* @see AWS API
* Documentation
*/
default ListAliasesPublisher listAliasesPaginator(ListAliasesRequest listAliasesRequest) {
return new ListAliasesPublisher(this, listAliasesRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListAliasesRequest.Builder} avoiding the need to
* create one manually via {@link ListAliasesRequest#builder()}
*
*
* @param listAliasesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListAliasesRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAliases
* @see AWS API
* Documentation
*/
default ListAliasesPublisher listAliasesPaginator(Consumer listAliasesRequest) {
return listAliasesPaginator(ListAliasesRequest.builder().applyMutation(listAliasesRequest).build());
}
/**
*
* List all the AvailabilityConfiguration's for the given WorkMail organization.
*
*
* @param listAvailabilityConfigurationsRequest
* @return A Java Future containing the result of the ListAvailabilityConfigurations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAvailabilityConfigurations
* @see AWS API Documentation
*/
default CompletableFuture listAvailabilityConfigurations(
ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* List all the AvailabilityConfiguration's for the given WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link ListAvailabilityConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListAvailabilityConfigurationsRequest#builder()}
*
*
* @param listAvailabilityConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListAvailabilityConfigurations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAvailabilityConfigurations
* @see AWS API Documentation
*/
default CompletableFuture listAvailabilityConfigurations(
Consumer listAvailabilityConfigurationsRequest) {
return listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest.builder()
.applyMutation(listAvailabilityConfigurationsRequest).build());
}
/**
*
* This is a variant of
* {@link #listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)}
* operation.
*
*
* @param listAvailabilityConfigurationsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAvailabilityConfigurations
* @see AWS API Documentation
*/
default ListAvailabilityConfigurationsPublisher listAvailabilityConfigurationsPaginator(
ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) {
return new ListAvailabilityConfigurationsPublisher(this, listAvailabilityConfigurationsRequest);
}
/**
*
* This is a variant of
* {@link #listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListAvailabilityConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListAvailabilityConfigurationsRequest#builder()}
*
*
* @param listAvailabilityConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListAvailabilityConfigurations
* @see AWS API Documentation
*/
default ListAvailabilityConfigurationsPublisher listAvailabilityConfigurationsPaginator(
Consumer listAvailabilityConfigurationsRequest) {
return listAvailabilityConfigurationsPaginator(ListAvailabilityConfigurationsRequest.builder()
.applyMutation(listAvailabilityConfigurationsRequest).build());
}
/**
*
* Returns an overview of the members of a group. Users and groups can be members of a group.
*
*
* @param listGroupMembersRequest
* @return A Java Future containing the result of the ListGroupMembers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroupMembers
* @see AWS API
* Documentation
*/
default CompletableFuture listGroupMembers(ListGroupMembersRequest listGroupMembersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns an overview of the members of a group. Users and groups can be members of a group.
*
*
*
* This is a convenience which creates an instance of the {@link ListGroupMembersRequest.Builder} avoiding the need
* to create one manually via {@link ListGroupMembersRequest#builder()}
*
*
* @param listGroupMembersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListGroupMembers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroupMembers
* @see AWS API
* Documentation
*/
default CompletableFuture listGroupMembers(
Consumer listGroupMembersRequest) {
return listGroupMembers(ListGroupMembersRequest.builder().applyMutation(listGroupMembersRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)} operation.
*
*
* @param listGroupMembersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroupMembers
* @see AWS API
* Documentation
*/
default ListGroupMembersPublisher listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest) {
return new ListGroupMembersPublisher(this, listGroupMembersRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListGroupMembersRequest.Builder} avoiding the need
* to create one manually via {@link ListGroupMembersRequest#builder()}
*
*
* @param listGroupMembersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroupMembers
* @see AWS API
* Documentation
*/
default ListGroupMembersPublisher listGroupMembersPaginator(Consumer listGroupMembersRequest) {
return listGroupMembersPaginator(ListGroupMembersRequest.builder().applyMutation(listGroupMembersRequest).build());
}
/**
*
* Returns summaries of the organization's groups.
*
*
* @param listGroupsRequest
* @return A Java Future containing the result of the ListGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroups
* @see AWS API
* Documentation
*/
default CompletableFuture listGroups(ListGroupsRequest listGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summaries of the organization's groups.
*
*
*
* This is a convenience which creates an instance of the {@link ListGroupsRequest.Builder} avoiding the need to
* create one manually via {@link ListGroupsRequest#builder()}
*
*
* @param listGroupsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListGroupsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroups
* @see AWS API
* Documentation
*/
default CompletableFuture listGroups(Consumer listGroupsRequest) {
return listGroups(ListGroupsRequest.builder().applyMutation(listGroupsRequest).build());
}
/**
*
* Returns all the groups to which an entity belongs.
*
*
* @param listGroupsForEntityRequest
* @return A Java Future containing the result of the ListGroupsForEntity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroupsForEntity
* @see AWS
* API Documentation
*/
default CompletableFuture listGroupsForEntity(
ListGroupsForEntityRequest listGroupsForEntityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns all the groups to which an entity belongs.
*
*
*
* This is a convenience which creates an instance of the {@link ListGroupsForEntityRequest.Builder} avoiding the
* need to create one manually via {@link ListGroupsForEntityRequest#builder()}
*
*
* @param listGroupsForEntityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListGroupsForEntity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroupsForEntity
* @see AWS
* API Documentation
*/
default CompletableFuture listGroupsForEntity(
Consumer listGroupsForEntityRequest) {
return listGroupsForEntity(ListGroupsForEntityRequest.builder().applyMutation(listGroupsForEntityRequest).build());
}
/**
*
* This is a variant of
* {@link #listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityPublisher publisher = client.listGroupsForEntityPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityPublisher publisher = client.listGroupsForEntityPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)}
* operation.
*
*
* @param listGroupsForEntityRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroupsForEntity
* @see AWS
* API Documentation
*/
default ListGroupsForEntityPublisher listGroupsForEntityPaginator(ListGroupsForEntityRequest listGroupsForEntityRequest) {
return new ListGroupsForEntityPublisher(this, listGroupsForEntityRequest);
}
/**
*
* This is a variant of
* {@link #listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityPublisher publisher = client.listGroupsForEntityPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityPublisher publisher = client.listGroupsForEntityPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListGroupsForEntityRequest.Builder} avoiding the
* need to create one manually via {@link ListGroupsForEntityRequest#builder()}
*
*
* @param listGroupsForEntityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroupsForEntity
* @see AWS
* API Documentation
*/
default ListGroupsForEntityPublisher listGroupsForEntityPaginator(
Consumer listGroupsForEntityRequest) {
return listGroupsForEntityPaginator(ListGroupsForEntityRequest.builder().applyMutation(listGroupsForEntityRequest)
.build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)} operation.
*
*
* @param listGroupsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroups
* @see AWS API
* Documentation
*/
default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest) {
return new ListGroupsPublisher(this, listGroupsRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListGroupsRequest.Builder} avoiding the need to
* create one manually via {@link ListGroupsRequest#builder()}
*
*
* @param listGroupsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListGroupsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListGroups
* @see AWS API
* Documentation
*/
default ListGroupsPublisher listGroupsPaginator(Consumer listGroupsRequest) {
return listGroupsPaginator(ListGroupsRequest.builder().applyMutation(listGroupsRequest).build());
}
/**
*
* Lists all the impersonation roles for the given WorkMail organization.
*
*
* @param listImpersonationRolesRequest
* @return A Java Future containing the result of the ListImpersonationRoles operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListImpersonationRoles
* @see AWS API Documentation
*/
default CompletableFuture listImpersonationRoles(
ListImpersonationRolesRequest listImpersonationRolesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all the impersonation roles for the given WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link ListImpersonationRolesRequest.Builder} avoiding the
* need to create one manually via {@link ListImpersonationRolesRequest#builder()}
*
*
* @param listImpersonationRolesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListImpersonationRoles operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListImpersonationRoles
* @see AWS API Documentation
*/
default CompletableFuture listImpersonationRoles(
Consumer listImpersonationRolesRequest) {
return listImpersonationRoles(ListImpersonationRolesRequest.builder().applyMutation(listImpersonationRolesRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)}
* operation.
*
*
* @param listImpersonationRolesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListImpersonationRoles
* @see AWS API Documentation
*/
default ListImpersonationRolesPublisher listImpersonationRolesPaginator(
ListImpersonationRolesRequest listImpersonationRolesRequest) {
return new ListImpersonationRolesPublisher(this, listImpersonationRolesRequest);
}
/**
*
* This is a variant of
* {@link #listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListImpersonationRolesRequest.Builder} avoiding the
* need to create one manually via {@link ListImpersonationRolesRequest#builder()}
*
*
* @param listImpersonationRolesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListImpersonationRoles
* @see AWS API Documentation
*/
default ListImpersonationRolesPublisher listImpersonationRolesPaginator(
Consumer listImpersonationRolesRequest) {
return listImpersonationRolesPaginator(ListImpersonationRolesRequest.builder()
.applyMutation(listImpersonationRolesRequest).build());
}
/**
*
* Lists the mail domains in a given WorkMail organization.
*
*
* @param listMailDomainsRequest
* @return A Java Future containing the result of the ListMailDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailDomains
* @see AWS API
* Documentation
*/
default CompletableFuture listMailDomains(ListMailDomainsRequest listMailDomainsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the mail domains in a given WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link ListMailDomainsRequest.Builder} avoiding the need
* to create one manually via {@link ListMailDomainsRequest#builder()}
*
*
* @param listMailDomainsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListMailDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailDomains
* @see AWS API
* Documentation
*/
default CompletableFuture listMailDomains(
Consumer listMailDomainsRequest) {
return listMailDomains(ListMailDomainsRequest.builder().applyMutation(listMailDomainsRequest).build());
}
/**
*
* This is a variant of
* {@link #listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)} operation.
*
*
* @param listMailDomainsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailDomains
* @see AWS API
* Documentation
*/
default ListMailDomainsPublisher listMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest) {
return new ListMailDomainsPublisher(this, listMailDomainsRequest);
}
/**
*
* This is a variant of
* {@link #listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListMailDomainsRequest.Builder} avoiding the need
* to create one manually via {@link ListMailDomainsRequest#builder()}
*
*
* @param listMailDomainsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailDomains
* @see AWS API
* Documentation
*/
default ListMailDomainsPublisher listMailDomainsPaginator(Consumer listMailDomainsRequest) {
return listMailDomainsPaginator(ListMailDomainsRequest.builder().applyMutation(listMailDomainsRequest).build());
}
/**
*
* Lists the mailbox export jobs started for the specified organization within the last seven days.
*
*
* @param listMailboxExportJobsRequest
* @return A Java Future containing the result of the ListMailboxExportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailboxExportJobs
* @see AWS API Documentation
*/
default CompletableFuture listMailboxExportJobs(
ListMailboxExportJobsRequest listMailboxExportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the mailbox export jobs started for the specified organization within the last seven days.
*
*
*
* This is a convenience which creates an instance of the {@link ListMailboxExportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListMailboxExportJobsRequest#builder()}
*
*
* @param listMailboxExportJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListMailboxExportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailboxExportJobs
* @see AWS API Documentation
*/
default CompletableFuture listMailboxExportJobs(
Consumer listMailboxExportJobsRequest) {
return listMailboxExportJobs(ListMailboxExportJobsRequest.builder().applyMutation(listMailboxExportJobsRequest).build());
}
/**
*
* This is a variant of
* {@link #listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)}
* operation.
*
*
* @param listMailboxExportJobsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailboxExportJobs
* @see AWS API Documentation
*/
default ListMailboxExportJobsPublisher listMailboxExportJobsPaginator(
ListMailboxExportJobsRequest listMailboxExportJobsRequest) {
return new ListMailboxExportJobsPublisher(this, listMailboxExportJobsRequest);
}
/**
*
* This is a variant of
* {@link #listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListMailboxExportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListMailboxExportJobsRequest#builder()}
*
*
* @param listMailboxExportJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailboxExportJobs
* @see AWS API Documentation
*/
default ListMailboxExportJobsPublisher listMailboxExportJobsPaginator(
Consumer listMailboxExportJobsRequest) {
return listMailboxExportJobsPaginator(ListMailboxExportJobsRequest.builder().applyMutation(listMailboxExportJobsRequest)
.build());
}
/**
*
* Lists the mailbox permissions associated with a user, group, or resource mailbox.
*
*
* @param listMailboxPermissionsRequest
* @return A Java Future containing the result of the ListMailboxPermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailboxPermissions
* @see AWS API Documentation
*/
default CompletableFuture listMailboxPermissions(
ListMailboxPermissionsRequest listMailboxPermissionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the mailbox permissions associated with a user, group, or resource mailbox.
*
*
*
* This is a convenience which creates an instance of the {@link ListMailboxPermissionsRequest.Builder} avoiding the
* need to create one manually via {@link ListMailboxPermissionsRequest#builder()}
*
*
* @param listMailboxPermissionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListMailboxPermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailboxPermissions
* @see AWS API Documentation
*/
default CompletableFuture listMailboxPermissions(
Consumer listMailboxPermissionsRequest) {
return listMailboxPermissions(ListMailboxPermissionsRequest.builder().applyMutation(listMailboxPermissionsRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)}
* operation.
*
*
* @param listMailboxPermissionsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailboxPermissions
* @see AWS API Documentation
*/
default ListMailboxPermissionsPublisher listMailboxPermissionsPaginator(
ListMailboxPermissionsRequest listMailboxPermissionsRequest) {
return new ListMailboxPermissionsPublisher(this, listMailboxPermissionsRequest);
}
/**
*
* This is a variant of
* {@link #listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListMailboxPermissionsRequest.Builder} avoiding the
* need to create one manually via {@link ListMailboxPermissionsRequest#builder()}
*
*
* @param listMailboxPermissionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMailboxPermissions
* @see AWS API Documentation
*/
default ListMailboxPermissionsPublisher listMailboxPermissionsPaginator(
Consumer listMailboxPermissionsRequest) {
return listMailboxPermissionsPaginator(ListMailboxPermissionsRequest.builder()
.applyMutation(listMailboxPermissionsRequest).build());
}
/**
*
* Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
*
*
* @param listMobileDeviceAccessOverridesRequest
* @return A Java Future containing the result of the ListMobileDeviceAccessOverrides operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMobileDeviceAccessOverrides
* @see AWS API Documentation
*/
default CompletableFuture listMobileDeviceAccessOverrides(
ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
*
*
*
* This is a convenience which creates an instance of the {@link ListMobileDeviceAccessOverridesRequest.Builder}
* avoiding the need to create one manually via {@link ListMobileDeviceAccessOverridesRequest#builder()}
*
*
* @param listMobileDeviceAccessOverridesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListMobileDeviceAccessOverrides operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMobileDeviceAccessOverrides
* @see AWS API Documentation
*/
default CompletableFuture listMobileDeviceAccessOverrides(
Consumer listMobileDeviceAccessOverridesRequest) {
return listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest.builder()
.applyMutation(listMobileDeviceAccessOverridesRequest).build());
}
/**
*
* This is a variant of
* {@link #listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)}
* operation.
*
*
* @param listMobileDeviceAccessOverridesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMobileDeviceAccessOverrides
* @see AWS API Documentation
*/
default ListMobileDeviceAccessOverridesPublisher listMobileDeviceAccessOverridesPaginator(
ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) {
return new ListMobileDeviceAccessOverridesPublisher(this, listMobileDeviceAccessOverridesRequest);
}
/**
*
* This is a variant of
* {@link #listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListMobileDeviceAccessOverridesRequest.Builder}
* avoiding the need to create one manually via {@link ListMobileDeviceAccessOverridesRequest#builder()}
*
*
* @param listMobileDeviceAccessOverridesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMobileDeviceAccessOverrides
* @see AWS API Documentation
*/
default ListMobileDeviceAccessOverridesPublisher listMobileDeviceAccessOverridesPaginator(
Consumer listMobileDeviceAccessOverridesRequest) {
return listMobileDeviceAccessOverridesPaginator(ListMobileDeviceAccessOverridesRequest.builder()
.applyMutation(listMobileDeviceAccessOverridesRequest).build());
}
/**
*
* Lists the mobile device access rules for the specified WorkMail organization.
*
*
* @param listMobileDeviceAccessRulesRequest
* @return A Java Future containing the result of the ListMobileDeviceAccessRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMobileDeviceAccessRules
* @see AWS API Documentation
*/
default CompletableFuture listMobileDeviceAccessRules(
ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the mobile device access rules for the specified WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link ListMobileDeviceAccessRulesRequest.Builder}
* avoiding the need to create one manually via {@link ListMobileDeviceAccessRulesRequest#builder()}
*
*
* @param listMobileDeviceAccessRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessRulesRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListMobileDeviceAccessRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListMobileDeviceAccessRules
* @see AWS API Documentation
*/
default CompletableFuture listMobileDeviceAccessRules(
Consumer listMobileDeviceAccessRulesRequest) {
return listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest.builder()
.applyMutation(listMobileDeviceAccessRulesRequest).build());
}
/**
*
* Returns summaries of the customer's organizations.
*
*
* @param listOrganizationsRequest
* @return A Java Future containing the result of the ListOrganizations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListOrganizations
* @see AWS
* API Documentation
*/
default CompletableFuture listOrganizations(ListOrganizationsRequest listOrganizationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summaries of the customer's organizations.
*
*
*
* This is a convenience which creates an instance of the {@link ListOrganizationsRequest.Builder} avoiding the need
* to create one manually via {@link ListOrganizationsRequest#builder()}
*
*
* @param listOrganizationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListOrganizations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListOrganizations
* @see AWS
* API Documentation
*/
default CompletableFuture listOrganizations(
Consumer listOrganizationsRequest) {
return listOrganizations(ListOrganizationsRequest.builder().applyMutation(listOrganizationsRequest).build());
}
/**
*
* Returns summaries of the customer's organizations.
*
*
* @return A Java Future containing the result of the ListOrganizations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListOrganizations
* @see AWS
* API Documentation
*/
default CompletableFuture listOrganizations() {
return listOrganizations(ListOrganizationsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListOrganizations
* @see AWS
* API Documentation
*/
default ListOrganizationsPublisher listOrganizationsPaginator() {
return listOrganizationsPaginator(ListOrganizationsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)}
* operation.
*
*
* @param listOrganizationsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListOrganizations
* @see AWS
* API Documentation
*/
default ListOrganizationsPublisher listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest) {
return new ListOrganizationsPublisher(this, listOrganizationsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListOrganizationsRequest.Builder} avoiding the need
* to create one manually via {@link ListOrganizationsRequest#builder()}
*
*
* @param listOrganizationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListOrganizations
* @see AWS
* API Documentation
*/
default ListOrganizationsPublisher listOrganizationsPaginator(
Consumer listOrganizationsRequest) {
return listOrganizationsPaginator(ListOrganizationsRequest.builder().applyMutation(listOrganizationsRequest).build());
}
/**
*
* Returns a summary of your Personal Access Tokens.
*
*
* @param listPersonalAccessTokensRequest
* @return A Java Future containing the result of the ListPersonalAccessTokens operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListPersonalAccessTokens
* @see AWS API Documentation
*/
default CompletableFuture listPersonalAccessTokens(
ListPersonalAccessTokensRequest listPersonalAccessTokensRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a summary of your Personal Access Tokens.
*
*
*
* This is a convenience which creates an instance of the {@link ListPersonalAccessTokensRequest.Builder} avoiding
* the need to create one manually via {@link ListPersonalAccessTokensRequest#builder()}
*
*
* @param listPersonalAccessTokensRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListPersonalAccessTokens operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListPersonalAccessTokens
* @see AWS API Documentation
*/
default CompletableFuture listPersonalAccessTokens(
Consumer listPersonalAccessTokensRequest) {
return listPersonalAccessTokens(ListPersonalAccessTokensRequest.builder().applyMutation(listPersonalAccessTokensRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listPersonalAccessTokens(software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListPersonalAccessTokensPublisher publisher = client.listPersonalAccessTokensPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListPersonalAccessTokensPublisher publisher = client.listPersonalAccessTokensPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listPersonalAccessTokens(software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensRequest)}
* operation.
*
*
* @param listPersonalAccessTokensRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListPersonalAccessTokens
* @see AWS API Documentation
*/
default ListPersonalAccessTokensPublisher listPersonalAccessTokensPaginator(
ListPersonalAccessTokensRequest listPersonalAccessTokensRequest) {
return new ListPersonalAccessTokensPublisher(this, listPersonalAccessTokensRequest);
}
/**
*
* This is a variant of
* {@link #listPersonalAccessTokens(software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListPersonalAccessTokensPublisher publisher = client.listPersonalAccessTokensPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListPersonalAccessTokensPublisher publisher = client.listPersonalAccessTokensPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listPersonalAccessTokens(software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListPersonalAccessTokensRequest.Builder} avoiding
* the need to create one manually via {@link ListPersonalAccessTokensRequest#builder()}
*
*
* @param listPersonalAccessTokensRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListPersonalAccessTokensRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListPersonalAccessTokens
* @see AWS API Documentation
*/
default ListPersonalAccessTokensPublisher listPersonalAccessTokensPaginator(
Consumer listPersonalAccessTokensRequest) {
return listPersonalAccessTokensPaginator(ListPersonalAccessTokensRequest.builder()
.applyMutation(listPersonalAccessTokensRequest).build());
}
/**
*
* Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on
* behalf of the resource.
*
*
* @param listResourceDelegatesRequest
* @return A Java Future containing the result of the ListResourceDelegates operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListResourceDelegates
* @see AWS API Documentation
*/
default CompletableFuture listResourceDelegates(
ListResourceDelegatesRequest listResourceDelegatesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListResourceDelegatesRequest.Builder} avoiding the
* need to create one manually via {@link ListResourceDelegatesRequest#builder()}
*
*
* @param listResourceDelegatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListResourceDelegates operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListResourceDelegates
* @see AWS API Documentation
*/
default CompletableFuture listResourceDelegates(
Consumer listResourceDelegatesRequest) {
return listResourceDelegates(ListResourceDelegatesRequest.builder().applyMutation(listResourceDelegatesRequest).build());
}
/**
*
* This is a variant of
* {@link #listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)}
* operation.
*
*
* @param listResourceDelegatesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListResourceDelegates
* @see AWS API Documentation
*/
default ListResourceDelegatesPublisher listResourceDelegatesPaginator(
ListResourceDelegatesRequest listResourceDelegatesRequest) {
return new ListResourceDelegatesPublisher(this, listResourceDelegatesRequest);
}
/**
*
* This is a variant of
* {@link #listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListResourceDelegatesRequest.Builder} avoiding the
* need to create one manually via {@link ListResourceDelegatesRequest#builder()}
*
*
* @param listResourceDelegatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListResourceDelegates
* @see AWS API Documentation
*/
default ListResourceDelegatesPublisher listResourceDelegatesPaginator(
Consumer listResourceDelegatesRequest) {
return listResourceDelegatesPaginator(ListResourceDelegatesRequest.builder().applyMutation(listResourceDelegatesRequest)
.build());
}
/**
*
* Returns summaries of the organization's resources.
*
*
* @param listResourcesRequest
* @return A Java Future containing the result of the ListResources operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListResources
* @see AWS API
* Documentation
*/
default CompletableFuture listResources(ListResourcesRequest listResourcesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summaries of the organization's resources.
*
*
*
* This is a convenience which creates an instance of the {@link ListResourcesRequest.Builder} avoiding the need to
* create one manually via {@link ListResourcesRequest#builder()}
*
*
* @param listResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListResourcesRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListResources operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListResources
* @see AWS API
* Documentation
*/
default CompletableFuture listResources(Consumer listResourcesRequest) {
return listResources(ListResourcesRequest.builder().applyMutation(listResourcesRequest).build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)} operation.
*
*
* @param listResourcesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListResources
* @see AWS API
* Documentation
*/
default ListResourcesPublisher listResourcesPaginator(ListResourcesRequest listResourcesRequest) {
return new ListResourcesPublisher(this, listResourcesRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListResourcesRequest.Builder} avoiding the need to
* create one manually via {@link ListResourcesRequest#builder()}
*
*
* @param listResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListResourcesRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - UnsupportedOperationException You can't perform a write operation against a read-only directory.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListResources
* @see AWS API
* Documentation
*/
default ListResourcesPublisher listResourcesPaginator(Consumer listResourcesRequest) {
return listResourcesPaginator(ListResourcesRequest.builder().applyMutation(listResourcesRequest).build());
}
/**
*
* Lists the tags applied to an WorkMail organization resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the tags applied to an WorkMail organization resource.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListTagsForResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Returns summaries of the organization's users.
*
*
* @param listUsersRequest
* @return A Java Future containing the result of the ListUsers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListUsers
* @see AWS API
* Documentation
*/
default CompletableFuture listUsers(ListUsersRequest listUsersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summaries of the organization's users.
*
*
*
* This is a convenience which creates an instance of the {@link ListUsersRequest.Builder} avoiding the need to
* create one manually via {@link ListUsersRequest#builder()}
*
*
* @param listUsersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListUsersRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListUsers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListUsers
* @see AWS API
* Documentation
*/
default CompletableFuture listUsers(Consumer listUsersRequest) {
return listUsers(ListUsersRequest.builder().applyMutation(listUsersRequest).build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)} operation.
*
*
* @param listUsersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest) {
return new ListUsersPublisher(this, listUsersRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListUsersRequest.Builder} avoiding the need to
* create one manually via {@link ListUsersRequest#builder()}
*
*
* @param listUsersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ListUsersRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersPublisher listUsersPaginator(Consumer listUsersRequest) {
return listUsersPaginator(ListUsersRequest.builder().applyMutation(listUsersRequest).build());
}
/**
*
* Adds a new access control rule for the specified organization. The rule allows or denies access to the
* organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a
* new rule with the same name as an existing rule replaces the older rule.
*
*
* @param putAccessControlRuleRequest
* @return A Java Future containing the result of the PutAccessControlRule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - LimitExceededException The request exceeds the limit of the resource.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - ResourceNotFoundException The resource cannot be found.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutAccessControlRule
* @see AWS
* API Documentation
*/
default CompletableFuture putAccessControlRule(
PutAccessControlRuleRequest putAccessControlRuleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds a new access control rule for the specified organization. The rule allows or denies access to the
* organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a
* new rule with the same name as an existing rule replaces the older rule.
*
*
*
* This is a convenience which creates an instance of the {@link PutAccessControlRuleRequest.Builder} avoiding the
* need to create one manually via {@link PutAccessControlRuleRequest#builder()}
*
*
* @param putAccessControlRuleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.PutAccessControlRuleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutAccessControlRule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - LimitExceededException The request exceeds the limit of the resource.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - ResourceNotFoundException The resource cannot be found.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutAccessControlRule
* @see AWS
* API Documentation
*/
default CompletableFuture putAccessControlRule(
Consumer putAccessControlRuleRequest) {
return putAccessControlRule(PutAccessControlRuleRequest.builder().applyMutation(putAccessControlRuleRequest).build());
}
/**
*
* Creates or updates the email monitoring configuration for a specified organization.
*
*
* @param putEmailMonitoringConfigurationRequest
* @return A Java Future containing the result of the PutEmailMonitoringConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The resource cannot be found.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default CompletableFuture putEmailMonitoringConfiguration(
PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates the email monitoring configuration for a specified organization.
*
*
*
* This is a convenience which creates an instance of the {@link PutEmailMonitoringConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link PutEmailMonitoringConfigurationRequest#builder()}
*
*
* @param putEmailMonitoringConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.PutEmailMonitoringConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutEmailMonitoringConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The resource cannot be found.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default CompletableFuture putEmailMonitoringConfiguration(
Consumer putEmailMonitoringConfigurationRequest) {
return putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest.builder()
.applyMutation(putEmailMonitoringConfigurationRequest).build());
}
/**
*
* Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox
* users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to
* WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA)
* and Personal Access Tokens.
*
*
* @param putIdentityProviderConfigurationRequest
* @return A Java Future containing the result of the PutIdentityProviderConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutIdentityProviderConfiguration
* @see AWS API Documentation
*/
default CompletableFuture putIdentityProviderConfiguration(
PutIdentityProviderConfigurationRequest putIdentityProviderConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox
* users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to
* WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA)
* and Personal Access Tokens.
*
*
*
* This is a convenience which creates an instance of the {@link PutIdentityProviderConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link PutIdentityProviderConfigurationRequest#builder()}
*
*
* @param putIdentityProviderConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.PutIdentityProviderConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutIdentityProviderConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - ResourceNotFoundException The resource cannot be found.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutIdentityProviderConfiguration
* @see AWS API Documentation
*/
default CompletableFuture putIdentityProviderConfiguration(
Consumer putIdentityProviderConfigurationRequest) {
return putIdentityProviderConfiguration(PutIdentityProviderConfigurationRequest.builder()
.applyMutation(putIdentityProviderConfigurationRequest).build());
}
/**
*
* Enables or disables a DMARC policy for a given organization.
*
*
* @param putInboundDmarcSettingsRequest
* @return A Java Future containing the result of the PutInboundDmarcSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutInboundDmarcSettings
* @see AWS API Documentation
*/
default CompletableFuture putInboundDmarcSettings(
PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Enables or disables a DMARC policy for a given organization.
*
*
*
* This is a convenience which creates an instance of the {@link PutInboundDmarcSettingsRequest.Builder} avoiding
* the need to create one manually via {@link PutInboundDmarcSettingsRequest#builder()}
*
*
* @param putInboundDmarcSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.PutInboundDmarcSettingsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutInboundDmarcSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutInboundDmarcSettings
* @see AWS API Documentation
*/
default CompletableFuture putInboundDmarcSettings(
Consumer putInboundDmarcSettingsRequest) {
return putInboundDmarcSettings(PutInboundDmarcSettingsRequest.builder().applyMutation(putInboundDmarcSettingsRequest)
.build());
}
/**
*
* Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
*
*
* @param putMailboxPermissionsRequest
* @return A Java Future containing the result of the PutMailboxPermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutMailboxPermissions
* @see AWS API Documentation
*/
default CompletableFuture putMailboxPermissions(
PutMailboxPermissionsRequest putMailboxPermissionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
*
*
*
* This is a convenience which creates an instance of the {@link PutMailboxPermissionsRequest.Builder} avoiding the
* need to create one manually via {@link PutMailboxPermissionsRequest#builder()}
*
*
* @param putMailboxPermissionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.PutMailboxPermissionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutMailboxPermissions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutMailboxPermissions
* @see AWS API Documentation
*/
default CompletableFuture putMailboxPermissions(
Consumer putMailboxPermissionsRequest) {
return putMailboxPermissions(PutMailboxPermissionsRequest.builder().applyMutation(putMailboxPermissionsRequest).build());
}
/**
*
* Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
*
*
* @param putMobileDeviceAccessOverrideRequest
* @return A Java Future containing the result of the PutMobileDeviceAccessOverride operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default CompletableFuture putMobileDeviceAccessOverride(
PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
*
*
*
* This is a convenience which creates an instance of the {@link PutMobileDeviceAccessOverrideRequest.Builder}
* avoiding the need to create one manually via {@link PutMobileDeviceAccessOverrideRequest#builder()}
*
*
* @param putMobileDeviceAccessOverrideRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.PutMobileDeviceAccessOverrideRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutMobileDeviceAccessOverride operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default CompletableFuture putMobileDeviceAccessOverride(
Consumer putMobileDeviceAccessOverrideRequest) {
return putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest.builder()
.applyMutation(putMobileDeviceAccessOverrideRequest).build());
}
/**
*
* Puts a retention policy to the specified organization.
*
*
* @param putRetentionPolicyRequest
* @return A Java Future containing the result of the PutRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - LimitExceededException The request exceeds the limit of the resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutRetentionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Puts a retention policy to the specified organization.
*
*
*
* This is a convenience which creates an instance of the {@link PutRetentionPolicyRequest.Builder} avoiding the
* need to create one manually via {@link PutRetentionPolicyRequest#builder()}
*
*
* @param putRetentionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.PutRetentionPolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - LimitExceededException The request exceeds the limit of the resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.PutRetentionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture putRetentionPolicy(
Consumer putRetentionPolicyRequest) {
return putRetentionPolicy(PutRetentionPolicyRequest.builder().applyMutation(putRetentionPolicyRequest).build());
}
/**
*
* Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for
* this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the
* specified domain for sending your users' emails.
*
*
* @param registerMailDomainRequest
* @return A Java Future containing the result of the RegisterMailDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - MailDomainInUseException The domain you're trying to change is in use by another user or organization
* in your account. See the error message for details.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - LimitExceededException The request exceeds the limit of the resource.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.RegisterMailDomain
* @see AWS
* API Documentation
*/
default CompletableFuture registerMailDomain(RegisterMailDomainRequest registerMailDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for
* this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the
* specified domain for sending your users' emails.
*
*
*
* This is a convenience which creates an instance of the {@link RegisterMailDomainRequest.Builder} avoiding the
* need to create one manually via {@link RegisterMailDomainRequest#builder()}
*
*
* @param registerMailDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.RegisterMailDomainRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RegisterMailDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - MailDomainInUseException The domain you're trying to change is in use by another user or organization
* in your account. See the error message for details.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - LimitExceededException The request exceeds the limit of the resource.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.RegisterMailDomain
* @see AWS
* API Documentation
*/
default CompletableFuture registerMailDomain(
Consumer registerMailDomainRequest) {
return registerMailDomain(RegisterMailDomainRequest.builder().applyMutation(registerMailDomainRequest).build());
}
/**
*
* Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and
* calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user,
* group, or resource 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 operation or they can be synchronized from your
* directory. For more information, see DeregisterFromWorkMail.
*
*
* @param registerToWorkMailRequest
* @return A Java Future containing the result of the RegisterToWorkMail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials
* supplied by WorkMail.
* - DirectoryUnavailableException The directory is unavailable. It might be located in another Region or
* deleted.
* - EmailAddressInUseException The email address that you're trying to assign is already created for a
* different user, group, or resource.
* - EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in
* your organization.
* - EntityStateException You are performing an operation on a user, group, or resource that isn't in the
* expected state, such as trying to delete an active user.
* - EntityAlreadyRegisteredException The user, group, or resource that you're trying to register is
* already registered.
* - InvalidParameterException One or more of the input parameters don't match the service's restrictions.
*
* - MailDomainNotFoundException The domain specified is not found in your organization.
* - MailDomainStateException After a domain has been added to the organization, it must be verified. The
* domain is not yet verified.
* - OrganizationNotFoundException An operation received a valid organization identifier that either
* doesn't belong or exist in the system.
* - OrganizationStateException The organization must have a valid state to perform certain operations on
* the organization or its members.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample WorkMailAsyncClient.RegisterToWorkMail
* @see AWS
* API Documentation
*/
default CompletableFuture registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and
* calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user,
* group, or resource is deleted. This operation results in the accumulation of costs. For more information, see