software.amazon.awssdk.services.workmail.WorkMailClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of workmail Show documentation
Show all versions of workmail Show documentation
The AWS Java SDK for Amazon WorkMail module holds the client classes that are used for communicating
with Amazon WorkMail Service
/*
* 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.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.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
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.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.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.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.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.DirectoryInUseException;
import software.amazon.awssdk.services.workmail.model.DirectoryServiceAuthenticationFailedException;
import software.amazon.awssdk.services.workmail.model.DirectoryUnavailableException;
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.EmailAddressInUseException;
import software.amazon.awssdk.services.workmail.model.EntityAlreadyRegisteredException;
import software.amazon.awssdk.services.workmail.model.EntityNotFoundException;
import software.amazon.awssdk.services.workmail.model.EntityStateException;
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.InvalidConfigurationException;
import software.amazon.awssdk.services.workmail.model.InvalidCustomSesConfigurationException;
import software.amazon.awssdk.services.workmail.model.InvalidParameterException;
import software.amazon.awssdk.services.workmail.model.InvalidPasswordException;
import software.amazon.awssdk.services.workmail.model.LimitExceededException;
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.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.MailDomainInUseException;
import software.amazon.awssdk.services.workmail.model.MailDomainNotFoundException;
import software.amazon.awssdk.services.workmail.model.MailDomainStateException;
import software.amazon.awssdk.services.workmail.model.NameAvailabilityException;
import software.amazon.awssdk.services.workmail.model.OrganizationNotFoundException;
import software.amazon.awssdk.services.workmail.model.OrganizationStateException;
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.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.ReservedNameException;
import software.amazon.awssdk.services.workmail.model.ResetPasswordRequest;
import software.amazon.awssdk.services.workmail.model.ResetPasswordResponse;
import software.amazon.awssdk.services.workmail.model.ResourceNotFoundException;
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.TooManyTagsException;
import software.amazon.awssdk.services.workmail.model.UnsupportedOperationException;
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.model.WorkMailException;
import software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable;
import software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable;
import software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable;
import software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable;
import software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable;
import software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable;
import software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable;
import software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable;
import software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable;
import software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable;
import software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable;
import software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable;
import software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable;
import software.amazon.awssdk.services.workmail.paginators.ListUsersIterable;
/**
* Service client for accessing Amazon WorkMail. This can be created using the static {@link #builder()} method.
*
*
* 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 WorkMailClient 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 Result of the AssociateDelegateToResource operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.AssociateDelegateToResource
* @see AWS API Documentation
*/
default AssociateDelegateToResourceResponse associateDelegateToResource(
AssociateDelegateToResourceRequest associateDelegateToResourceRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the AssociateDelegateToResource operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.AssociateDelegateToResource
* @see AWS API Documentation
*/
default AssociateDelegateToResourceResponse associateDelegateToResource(
Consumer associateDelegateToResourceRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return associateDelegateToResource(AssociateDelegateToResourceRequest.builder()
.applyMutation(associateDelegateToResourceRequest).build());
}
/**
*
* Adds a member (user or group) to the group's set.
*
*
* @param associateMemberToGroupRequest
* @return Result of the AssociateMemberToGroup operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.AssociateMemberToGroup
* @see AWS API Documentation
*/
default AssociateMemberToGroupResponse associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the AssociateMemberToGroup operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.AssociateMemberToGroup
* @see AWS API Documentation
*/
default AssociateMemberToGroupResponse associateMemberToGroup(
Consumer associateMemberToGroupRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
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 Result of the AssumeImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.AssumeImpersonationRole
* @see AWS API Documentation
*/
default AssumeImpersonationRoleResponse assumeImpersonationRole(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the AssumeImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.AssumeImpersonationRole
* @see AWS API Documentation
*/
default AssumeImpersonationRoleResponse assumeImpersonationRole(
Consumer assumeImpersonationRoleRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException,
SdkClientException, WorkMailException {
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 Result of the CancelMailboxExportJob operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CancelMailboxExportJob
* @see AWS API Documentation
*/
default CancelMailboxExportJobResponse cancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the CancelMailboxExportJob operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CancelMailboxExportJob
* @see AWS API Documentation
*/
default CancelMailboxExportJobResponse cancelMailboxExportJob(
Consumer cancelMailboxExportJobRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException,
SdkClientException, WorkMailException {
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 Result of the CreateAlias operation returned by the service.
* @throws EmailAddressInUseException
* The email address that you're trying to assign is already created for a different user, group, or
* resource.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateAlias
* @see AWS API
* Documentation
*/
default CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws EmailAddressInUseException,
EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException,
MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the CreateAlias operation returned by the service.
* @throws EmailAddressInUseException
* The email address that you're trying to assign is already created for a different user, group, or
* resource.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateAlias
* @see AWS API
* Documentation
*/
default CreateAliasResponse createAlias(Consumer createAliasRequest)
throws EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException,
MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException,
LimitExceededException, AwsServiceException, SdkClientException, WorkMailException {
return createAlias(CreateAliasRequest.builder().applyMutation(createAliasRequest).build());
}
/**
*
* Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
*
*
* @param createAvailabilityConfigurationRequest
* @return Result of the CreateAvailabilityConfiguration operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateAvailabilityConfiguration
* @see AWS API Documentation
*/
default CreateAvailabilityConfigurationResponse createAvailabilityConfiguration(
CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest) throws OrganizationNotFoundException,
OrganizationStateException, NameAvailabilityException, InvalidParameterException, LimitExceededException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the CreateAvailabilityConfiguration operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateAvailabilityConfiguration
* @see AWS API Documentation
*/
default CreateAvailabilityConfigurationResponse createAvailabilityConfiguration(
Consumer createAvailabilityConfigurationRequest)
throws OrganizationNotFoundException, OrganizationStateException, NameAvailabilityException,
InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException {
return createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest.builder()
.applyMutation(createAvailabilityConfigurationRequest).build());
}
/**
*
* Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
*
*
* @param createGroupRequest
* @return Result of the CreateGroup operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ReservedNameException
* This user, group, or resource name is not allowed in WorkMail.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateGroup
* @see AWS API
* Documentation
*/
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException,
NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the CreateGroup operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ReservedNameException
* This user, group, or resource name is not allowed in WorkMail.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateGroup
* @see AWS API
* Documentation
*/
default CreateGroupResponse createGroup(Consumer createGroupRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException,
NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return createGroup(CreateGroupRequest.builder().applyMutation(createGroupRequest).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 Result of the CreateImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateImpersonationRole
* @see AWS API Documentation
*/
default CreateImpersonationRoleResponse createImpersonationRole(CreateImpersonationRoleRequest createImpersonationRoleRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the CreateImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateImpersonationRole
* @see AWS API Documentation
*/
default CreateImpersonationRoleResponse createImpersonationRole(
Consumer createImpersonationRoleRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException,
LimitExceededException, AwsServiceException, SdkClientException, WorkMailException {
return createImpersonationRole(CreateImpersonationRoleRequest.builder().applyMutation(createImpersonationRoleRequest)
.build());
}
/**
*
* Creates a new mobile device access rule for the specified WorkMail organization.
*
*
* @param createMobileDeviceAccessRuleRequest
* @return Result of the CreateMobileDeviceAccessRule operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateMobileDeviceAccessRule
* @see AWS API Documentation
*/
default CreateMobileDeviceAccessRuleResponse createMobileDeviceAccessRule(
CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest) throws InvalidParameterException,
LimitExceededException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the CreateMobileDeviceAccessRule operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateMobileDeviceAccessRule
* @see AWS API Documentation
*/
default CreateMobileDeviceAccessRuleResponse createMobileDeviceAccessRule(
Consumer createMobileDeviceAccessRuleRequest)
throws InvalidParameterException, LimitExceededException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
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 Result of the CreateOrganization operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws DirectoryInUseException
* The directory is already in use by another WorkMail organization in the same account and Region.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateOrganization
* @see AWS
* API Documentation
*/
default CreateOrganizationResponse createOrganization(CreateOrganizationRequest createOrganizationRequest)
throws InvalidParameterException, DirectoryInUseException, DirectoryUnavailableException, LimitExceededException,
NameAvailabilityException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the CreateOrganization operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws DirectoryInUseException
* The directory is already in use by another WorkMail organization in the same account and Region.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateOrganization
* @see AWS
* API Documentation
*/
default CreateOrganizationResponse createOrganization(Consumer createOrganizationRequest)
throws InvalidParameterException, DirectoryInUseException, DirectoryUnavailableException, LimitExceededException,
NameAvailabilityException, AwsServiceException, SdkClientException, WorkMailException {
return createOrganization(CreateOrganizationRequest.builder().applyMutation(createOrganizationRequest).build());
}
/**
*
* Creates a new WorkMail resource.
*
*
* @param createResourceRequest
* @return Result of the CreateResource operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ReservedNameException
* This user, group, or resource name is not allowed in WorkMail.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateResource
* @see AWS API
* Documentation
*/
default CreateResourceResponse createResource(CreateResourceRequest createResourceRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException,
NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the CreateResource operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ReservedNameException
* This user, group, or resource name is not allowed in WorkMail.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateResource
* @see AWS API
* Documentation
*/
default CreateResourceResponse createResource(Consumer createResourceRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException,
NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return createResource(CreateResourceRequest.builder().applyMutation(createResourceRequest).build());
}
/**
*
* Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
*
*
* @param createUserRequest
* @return Result of the CreateUser operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws InvalidPasswordException
* The supplied password doesn't match the minimum security constraints, such as length or use of special
* characters.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ReservedNameException
* This user, group, or resource name is not allowed in WorkMail.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateUser
* @see AWS API
* Documentation
*/
default CreateUserResponse createUser(CreateUserRequest createUserRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException,
InvalidPasswordException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException,
ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the CreateUser operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws InvalidPasswordException
* The supplied password doesn't match the minimum security constraints, such as length or use of special
* characters.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ReservedNameException
* This user, group, or resource name is not allowed in WorkMail.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.CreateUser
* @see AWS API
* Documentation
*/
default CreateUserResponse createUser(Consumer createUserRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException,
InvalidPasswordException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException,
ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
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 Result of the DeleteAccessControlRule operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteAccessControlRule
* @see AWS API Documentation
*/
default DeleteAccessControlRuleResponse deleteAccessControlRule(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest)
throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
throw new java.lang.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 Result of the DeleteAccessControlRule operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteAccessControlRule
* @see AWS API Documentation
*/
default DeleteAccessControlRuleResponse deleteAccessControlRule(
Consumer deleteAccessControlRuleRequest)
throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
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 Result of the DeleteAlias operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteAlias
* @see AWS API
* Documentation
*/
default DeleteAliasResponse deleteAlias(DeleteAliasRequest deleteAliasRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteAlias operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteAlias
* @see AWS API
* Documentation
*/
default DeleteAliasResponse deleteAlias(Consumer deleteAliasRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return deleteAlias(DeleteAliasRequest.builder().applyMutation(deleteAliasRequest).build());
}
/**
*
* Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
*
*
* @param deleteAvailabilityConfigurationRequest
* @return Result of the DeleteAvailabilityConfiguration operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteAvailabilityConfiguration
* @see AWS API Documentation
*/
default DeleteAvailabilityConfigurationResponse deleteAvailabilityConfiguration(
DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest) throws OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteAvailabilityConfiguration operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteAvailabilityConfiguration
* @see AWS API Documentation
*/
default DeleteAvailabilityConfigurationResponse deleteAvailabilityConfiguration(
Consumer deleteAvailabilityConfigurationRequest)
throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
return deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest.builder()
.applyMutation(deleteAvailabilityConfigurationRequest).build());
}
/**
*
* Deletes the email monitoring configuration for a specified organization.
*
*
* @param deleteEmailMonitoringConfigurationRequest
* @return Result of the DeleteEmailMonitoringConfiguration operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default DeleteEmailMonitoringConfigurationResponse deleteEmailMonitoringConfiguration(
DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteEmailMonitoringConfiguration operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default DeleteEmailMonitoringConfigurationResponse deleteEmailMonitoringConfiguration(
Consumer deleteEmailMonitoringConfigurationRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
return deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest.builder()
.applyMutation(deleteEmailMonitoringConfigurationRequest).build());
}
/**
*
* Deletes a group from WorkMail.
*
*
* @param deleteGroupRequest
* @return Result of the DeleteGroup operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteGroup
* @see AWS API
* Documentation
*/
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteGroup operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteGroup
* @see AWS API
* Documentation
*/
default DeleteGroupResponse deleteGroup(Consumer deleteGroupRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
AwsServiceException, SdkClientException, WorkMailException {
return deleteGroup(DeleteGroupRequest.builder().applyMutation(deleteGroupRequest).build());
}
/**
*
* Deletes an impersonation role for the given WorkMail organization.
*
*
* @param deleteImpersonationRoleRequest
* @return Result of the DeleteImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteImpersonationRole
* @see AWS API Documentation
*/
default DeleteImpersonationRoleResponse deleteImpersonationRole(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteImpersonationRole
* @see AWS API Documentation
*/
default DeleteImpersonationRoleResponse deleteImpersonationRole(
Consumer deleteImpersonationRoleRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return deleteImpersonationRole(DeleteImpersonationRoleRequest.builder().applyMutation(deleteImpersonationRoleRequest)
.build());
}
/**
*
* Deletes permissions granted to a member (user or group).
*
*
* @param deleteMailboxPermissionsRequest
* @return Result of the DeleteMailboxPermissions operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteMailboxPermissions
* @see AWS API Documentation
*/
default DeleteMailboxPermissionsResponse deleteMailboxPermissions(
DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteMailboxPermissions operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteMailboxPermissions
* @see AWS API Documentation
*/
default DeleteMailboxPermissionsResponse deleteMailboxPermissions(
Consumer deleteMailboxPermissionsRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
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 Result of the DeleteMobileDeviceAccessOverride operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default DeleteMobileDeviceAccessOverrideResponse deleteMobileDeviceAccessOverride(
DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteMobileDeviceAccessOverride operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default DeleteMobileDeviceAccessOverrideResponse deleteMobileDeviceAccessOverride(
Consumer deleteMobileDeviceAccessOverrideRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
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 Result of the DeleteMobileDeviceAccessRule operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteMobileDeviceAccessRule
* @see AWS API Documentation
*/
default DeleteMobileDeviceAccessRuleResponse deleteMobileDeviceAccessRule(
DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteMobileDeviceAccessRule operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteMobileDeviceAccessRule
* @see AWS API Documentation
*/
default DeleteMobileDeviceAccessRuleResponse deleteMobileDeviceAccessRule(
Consumer deleteMobileDeviceAccessRuleRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
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 Result of the DeleteOrganization operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteOrganization
* @see AWS
* API Documentation
*/
default DeleteOrganizationResponse deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteOrganization operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteOrganization
* @see AWS
* API Documentation
*/
default DeleteOrganizationResponse deleteOrganization(Consumer deleteOrganizationRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
return deleteOrganization(DeleteOrganizationRequest.builder().applyMutation(deleteOrganizationRequest).build());
}
/**
*
* Deletes the specified resource.
*
*
* @param deleteResourceRequest
* @return Result of the DeleteResource operation returned by the service.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteResource
* @see AWS API
* Documentation
*/
default DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest) throws EntityStateException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteResource operation returned by the service.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteResource
* @see AWS API
* Documentation
*/
default DeleteResourceResponse deleteResource(Consumer deleteResourceRequest)
throws EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return deleteResource(DeleteResourceRequest.builder().applyMutation(deleteResourceRequest).build());
}
/**
*
* Deletes the specified retention policy from the specified organization.
*
*
* @param deleteRetentionPolicyRequest
* @return Result of the DeleteRetentionPolicy operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteRetentionPolicy
* @see AWS API Documentation
*/
default DeleteRetentionPolicyResponse deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteRetentionPolicy operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteRetentionPolicy
* @see AWS API Documentation
*/
default DeleteRetentionPolicyResponse deleteRetentionPolicy(
Consumer deleteRetentionPolicyRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
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 Result of the DeleteUser operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteUser
* @see AWS API
* Documentation
*/
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeleteUser operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeleteUser
* @see AWS API
* Documentation
*/
default DeleteUserResponse deleteUser(Consumer deleteUserRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
AwsServiceException, SdkClientException, WorkMailException {
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 Result of the DeregisterFromWorkMail operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeregisterFromWorkMail
* @see AWS API Documentation
*/
default DeregisterFromWorkMailResponse deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DeregisterFromWorkMail operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeregisterFromWorkMail
* @see AWS API Documentation
*/
default DeregisterFromWorkMailResponse deregisterFromWorkMail(
Consumer deregisterFromWorkMailRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
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 Result of the DeregisterMailDomain operation returned by the service.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeregisterMailDomain
* @see AWS
* API Documentation
*/
default DeregisterMailDomainResponse deregisterMailDomain(DeregisterMailDomainRequest deregisterMailDomainRequest)
throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException,
InvalidParameterException, InvalidCustomSesConfigurationException, AwsServiceException, SdkClientException,
WorkMailException {
throw new java.lang.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 Result of the DeregisterMailDomain operation returned by the service.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DeregisterMailDomain
* @see AWS
* API Documentation
*/
default DeregisterMailDomainResponse deregisterMailDomain(
Consumer deregisterMailDomainRequest) throws MailDomainInUseException,
OrganizationNotFoundException, OrganizationStateException, InvalidParameterException,
InvalidCustomSesConfigurationException, AwsServiceException, SdkClientException, WorkMailException {
return deregisterMailDomain(DeregisterMailDomainRequest.builder().applyMutation(deregisterMailDomainRequest).build());
}
/**
*
* Describes the current email monitoring configuration for a specified organization.
*
*
* @param describeEmailMonitoringConfigurationRequest
* @return Result of the DescribeEmailMonitoringConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default DescribeEmailMonitoringConfigurationResponse describeEmailMonitoringConfiguration(
DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest)
throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DescribeEmailMonitoringConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default DescribeEmailMonitoringConfigurationResponse describeEmailMonitoringConfiguration(
Consumer describeEmailMonitoringConfigurationRequest)
throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest.builder()
.applyMutation(describeEmailMonitoringConfigurationRequest).build());
}
/**
*
* Returns basic details about an entity in WorkMail.
*
*
* @param describeEntityRequest
* @return Result of the DescribeEntity operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeEntity
* @see AWS API
* Documentation
*/
default DescribeEntityResponse describeEntity(DescribeEntityRequest describeEntityRequest) throws EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DescribeEntity operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeEntity
* @see AWS API
* Documentation
*/
default DescribeEntityResponse describeEntity(Consumer describeEntityRequest)
throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
return describeEntity(DescribeEntityRequest.builder().applyMutation(describeEntityRequest).build());
}
/**
*
* Returns the data available for the group.
*
*
* @param describeGroupRequest
* @return Result of the DescribeGroup operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeGroup
* @see AWS API
* Documentation
*/
default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest) throws EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DescribeGroup operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeGroup
* @see AWS API
* Documentation
*/
default DescribeGroupResponse describeGroup(Consumer describeGroupRequest)
throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
return describeGroup(DescribeGroupRequest.builder().applyMutation(describeGroupRequest).build());
}
/**
*
* Lists the settings in a DMARC policy for a specified organization.
*
*
* @param describeInboundDmarcSettingsRequest
* @return Result of the DescribeInboundDmarcSettings operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeInboundDmarcSettings
* @see AWS API Documentation
*/
default DescribeInboundDmarcSettingsResponse describeInboundDmarcSettings(
DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest) throws OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DescribeInboundDmarcSettings operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeInboundDmarcSettings
* @see AWS API Documentation
*/
default DescribeInboundDmarcSettingsResponse describeInboundDmarcSettings(
Consumer describeInboundDmarcSettingsRequest)
throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
return describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest.builder()
.applyMutation(describeInboundDmarcSettingsRequest).build());
}
/**
*
* Describes the current status of a mailbox export job.
*
*
* @param describeMailboxExportJobRequest
* @return Result of the DescribeMailboxExportJob operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeMailboxExportJob
* @see AWS API Documentation
*/
default DescribeMailboxExportJobResponse describeMailboxExportJob(
DescribeMailboxExportJobRequest describeMailboxExportJobRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DescribeMailboxExportJob operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeMailboxExportJob
* @see AWS API Documentation
*/
default DescribeMailboxExportJobResponse describeMailboxExportJob(
Consumer describeMailboxExportJobRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException,
SdkClientException, WorkMailException {
return describeMailboxExportJob(DescribeMailboxExportJobRequest.builder().applyMutation(describeMailboxExportJobRequest)
.build());
}
/**
*
* Provides more information regarding a given organization based on its identifier.
*
*
* @param describeOrganizationRequest
* @return Result of the DescribeOrganization operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeOrganization
* @see AWS
* API Documentation
*/
default DescribeOrganizationResponse describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
throws InvalidParameterException, OrganizationNotFoundException, AwsServiceException, SdkClientException,
WorkMailException {
throw new java.lang.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 Result of the DescribeOrganization operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeOrganization
* @see AWS
* API Documentation
*/
default DescribeOrganizationResponse describeOrganization(
Consumer describeOrganizationRequest) throws InvalidParameterException,
OrganizationNotFoundException, AwsServiceException, SdkClientException, WorkMailException {
return describeOrganization(DescribeOrganizationRequest.builder().applyMutation(describeOrganizationRequest).build());
}
/**
*
* Returns the data available for the resource.
*
*
* @param describeResourceRequest
* @return Result of the DescribeResource operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeResource
* @see AWS API
* Documentation
*/
default DescribeResourceResponse describeResource(DescribeResourceRequest describeResourceRequest)
throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DescribeResource operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeResource
* @see AWS API
* Documentation
*/
default DescribeResourceResponse describeResource(Consumer describeResourceRequest)
throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return describeResource(DescribeResourceRequest.builder().applyMutation(describeResourceRequest).build());
}
/**
*
* Provides information regarding the user.
*
*
* @param describeUserRequest
* @return Result of the DescribeUser operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeUser
* @see AWS API
* Documentation
*/
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DescribeUser operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DescribeUser
* @see AWS API
* Documentation
*/
default DescribeUserResponse describeUser(Consumer describeUserRequest)
throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
return describeUser(DescribeUserRequest.builder().applyMutation(describeUserRequest).build());
}
/**
*
* Removes a member from the resource's set of delegates.
*
*
* @param disassociateDelegateFromResourceRequest
* @return Result of the DisassociateDelegateFromResource operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DisassociateDelegateFromResource
* @see AWS API Documentation
*/
default DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(
DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DisassociateDelegateFromResource operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DisassociateDelegateFromResource
* @see AWS API Documentation
*/
default DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(
Consumer disassociateDelegateFromResourceRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest.builder()
.applyMutation(disassociateDelegateFromResourceRequest).build());
}
/**
*
* Removes a member from a group.
*
*
* @param disassociateMemberFromGroupRequest
* @return Result of the DisassociateMemberFromGroup operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DisassociateMemberFromGroup
* @see AWS API Documentation
*/
default DisassociateMemberFromGroupResponse disassociateMemberFromGroup(
DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the DisassociateMemberFromGroup operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.DisassociateMemberFromGroup
* @see AWS API Documentation
*/
default DisassociateMemberFromGroupResponse disassociateMemberFromGroup(
Consumer disassociateMemberFromGroupRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
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 Result of the GetAccessControlEffect operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetAccessControlEffect
* @see AWS API Documentation
*/
default GetAccessControlEffectResponse getAccessControlEffect(GetAccessControlEffectRequest getAccessControlEffectRequest)
throws EntityNotFoundException, ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the GetAccessControlEffect operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetAccessControlEffect
* @see AWS API Documentation
*/
default GetAccessControlEffectResponse getAccessControlEffect(
Consumer getAccessControlEffectRequest) throws EntityNotFoundException,
ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
return getAccessControlEffect(GetAccessControlEffectRequest.builder().applyMutation(getAccessControlEffectRequest)
.build());
}
/**
*
* Gets the default retention policy details for the specified organization.
*
*
* @param getDefaultRetentionPolicyRequest
* @return Result of the GetDefaultRetentionPolicy operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetDefaultRetentionPolicy
* @see AWS API Documentation
*/
default GetDefaultRetentionPolicyResponse getDefaultRetentionPolicy(
GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the GetDefaultRetentionPolicy operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetDefaultRetentionPolicy
* @see AWS API Documentation
*/
default GetDefaultRetentionPolicyResponse getDefaultRetentionPolicy(
Consumer getDefaultRetentionPolicyRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
return getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest.builder()
.applyMutation(getDefaultRetentionPolicyRequest).build());
}
/**
*
* Gets the impersonation role details for the given WorkMail organization.
*
*
* @param getImpersonationRoleRequest
* @return Result of the GetImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetImpersonationRole
* @see AWS
* API Documentation
*/
default GetImpersonationRoleResponse getImpersonationRole(GetImpersonationRoleRequest getImpersonationRoleRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the GetImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetImpersonationRole
* @see AWS
* API Documentation
*/
default GetImpersonationRoleResponse getImpersonationRole(
Consumer getImpersonationRoleRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException,
SdkClientException, WorkMailException {
return getImpersonationRole(GetImpersonationRoleRequest.builder().applyMutation(getImpersonationRoleRequest).build());
}
/**
*
* Tests whether the given impersonation role can impersonate a target user.
*
*
* @param getImpersonationRoleEffectRequest
* @return Result of the GetImpersonationRoleEffect operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetImpersonationRoleEffect
* @see AWS API Documentation
*/
default GetImpersonationRoleEffectResponse getImpersonationRoleEffect(
GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException,
EntityStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the GetImpersonationRoleEffect operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetImpersonationRoleEffect
* @see AWS API Documentation
*/
default GetImpersonationRoleEffectResponse getImpersonationRoleEffect(
Consumer getImpersonationRoleEffectRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
ResourceNotFoundException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException,
WorkMailException {
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 Result of the GetMailDomain operation returned by the service.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetMailDomain
* @see AWS API
* Documentation
*/
default GetMailDomainResponse getMailDomain(GetMailDomainRequest getMailDomainRequest) throws MailDomainNotFoundException,
OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the GetMailDomain operation returned by the service.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetMailDomain
* @see AWS API
* Documentation
*/
default GetMailDomainResponse getMailDomain(Consumer getMailDomainRequest)
throws MailDomainNotFoundException, OrganizationNotFoundException, OrganizationStateException,
InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
return getMailDomain(GetMailDomainRequest.builder().applyMutation(getMailDomainRequest).build());
}
/**
*
* Requests a user's mailbox details for a specified organization and user.
*
*
* @param getMailboxDetailsRequest
* @return Result of the GetMailboxDetails operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetMailboxDetails
* @see AWS
* API Documentation
*/
default GetMailboxDetailsResponse getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the GetMailboxDetails operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetMailboxDetails
* @see AWS
* API Documentation
*/
default GetMailboxDetailsResponse getMailboxDetails(Consumer getMailboxDetailsRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
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 Result of the GetMobileDeviceAccessEffect operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetMobileDeviceAccessEffect
* @see AWS API Documentation
*/
default GetMobileDeviceAccessEffectResponse getMobileDeviceAccessEffect(
GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the GetMobileDeviceAccessEffect operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetMobileDeviceAccessEffect
* @see AWS API Documentation
*/
default GetMobileDeviceAccessEffectResponse getMobileDeviceAccessEffect(
Consumer getMobileDeviceAccessEffectRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
return getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest.builder()
.applyMutation(getMobileDeviceAccessEffectRequest).build());
}
/**
*
* Gets the mobile device access override for the given WorkMail organization, user, and device.
*
*
* @param getMobileDeviceAccessOverrideRequest
* @return Result of the GetMobileDeviceAccessOverride operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default GetMobileDeviceAccessOverrideResponse getMobileDeviceAccessOverride(
GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, ResourceNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the GetMobileDeviceAccessOverride operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.GetMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default GetMobileDeviceAccessOverrideResponse getMobileDeviceAccessOverride(
Consumer getMobileDeviceAccessOverrideRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException {
return getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest.builder()
.applyMutation(getMobileDeviceAccessOverrideRequest).build());
}
/**
*
* Lists the access control rules for the specified organization.
*
*
* @param listAccessControlRulesRequest
* @return Result of the ListAccessControlRules operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAccessControlRules
* @see AWS API Documentation
*/
default ListAccessControlRulesResponse listAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest)
throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
throw new java.lang.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 Result of the ListAccessControlRules operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAccessControlRules
* @see AWS API Documentation
*/
default ListAccessControlRulesResponse listAccessControlRules(
Consumer listAccessControlRulesRequest) throws OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return listAccessControlRules(ListAccessControlRulesRequest.builder().applyMutation(listAccessControlRulesRequest)
.build());
}
/**
*
* Creates a paginated call to list the aliases associated with a given entity.
*
*
* @param listAliasesRequest
* @return Result of the ListAliases operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAliases
* @see AWS API
* Documentation
*/
default ListAliasesResponse listAliases(ListAliasesRequest listAliasesRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListAliases operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAliases
* @see AWS API
* Documentation
*/
default ListAliasesResponse listAliases(Consumer listAliasesRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListAliasesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAliases
* @see AWS API
* Documentation
*/
default ListAliasesIterable listAliasesPaginator(ListAliasesRequest listAliasesRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
return new ListAliasesIterable(this, listAliasesRequest);
}
/**
*
* This is a variant of {@link #listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListAliasesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAliases
* @see AWS API
* Documentation
*/
default ListAliasesIterable listAliasesPaginator(Consumer listAliasesRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return listAliasesPaginator(ListAliasesRequest.builder().applyMutation(listAliasesRequest).build());
}
/**
*
* List all the AvailabilityConfiguration's for the given WorkMail organization.
*
*
* @param listAvailabilityConfigurationsRequest
* @return Result of the ListAvailabilityConfigurations operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAvailabilityConfigurations
* @see AWS API Documentation
*/
default ListAvailabilityConfigurationsResponse listAvailabilityConfigurations(
ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListAvailabilityConfigurations operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAvailabilityConfigurations
* @see AWS API Documentation
*/
default ListAvailabilityConfigurationsResponse listAvailabilityConfigurations(
Consumer listAvailabilityConfigurationsRequest)
throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client
* .listAvailabilityConfigurationsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAvailabilityConfigurations
* @see AWS API Documentation
*/
default ListAvailabilityConfigurationsIterable listAvailabilityConfigurationsPaginator(
ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return new ListAvailabilityConfigurationsIterable(this, listAvailabilityConfigurationsRequest);
}
/**
*
* This is a variant of
* {@link #listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client
* .listAvailabilityConfigurationsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListAvailabilityConfigurations
* @see AWS API Documentation
*/
default ListAvailabilityConfigurationsIterable listAvailabilityConfigurationsPaginator(
Consumer listAvailabilityConfigurationsRequest)
throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
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 Result of the ListGroupMembers operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroupMembers
* @see AWS API
* Documentation
*/
default ListGroupMembersResponse listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListGroupMembers operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroupMembers
* @see AWS API
* Documentation
*/
default ListGroupMembersResponse listGroupMembers(Consumer listGroupMembersRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client
* .listGroupMembersPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroupMembers
* @see AWS API
* Documentation
*/
default ListGroupMembersIterable listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return new ListGroupMembersIterable(this, listGroupMembersRequest);
}
/**
*
* This is a variant of
* {@link #listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client
* .listGroupMembersPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroupMembers
* @see AWS API
* Documentation
*/
default ListGroupMembersIterable listGroupMembersPaginator(Consumer listGroupMembersRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return listGroupMembersPaginator(ListGroupMembersRequest.builder().applyMutation(listGroupMembersRequest).build());
}
/**
*
* Returns summaries of the organization's groups.
*
*
* @param listGroupsRequest
* @return Result of the ListGroups operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroups
* @see AWS API
* Documentation
*/
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListGroups operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroups
* @see AWS API
* Documentation
*/
default ListGroupsResponse listGroups(Consumer listGroupsRequest) throws EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
return listGroups(ListGroupsRequest.builder().applyMutation(listGroupsRequest).build());
}
/**
*
* This is a variant of {@link #listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroups
* @see AWS API
* Documentation
*/
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
return new ListGroupsIterable(this, listGroupsRequest);
}
/**
*
* This is a variant of {@link #listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroups
* @see AWS API
* Documentation
*/
default ListGroupsIterable listGroupsPaginator(Consumer listGroupsRequest)
throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
return listGroupsPaginator(ListGroupsRequest.builder().applyMutation(listGroupsRequest).build());
}
/**
*
* Returns all the groups to which an entity belongs.
*
*
* @param listGroupsForEntityRequest
* @return Result of the ListGroupsForEntity operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroupsForEntity
* @see AWS
* API Documentation
*/
default ListGroupsForEntityResponse listGroupsForEntity(ListGroupsForEntityRequest listGroupsForEntityRequest)
throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException,
InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListGroupsForEntity operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroupsForEntity
* @see AWS
* API Documentation
*/
default ListGroupsForEntityResponse listGroupsForEntity(
Consumer listGroupsForEntityRequest) throws EntityNotFoundException,
EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException,
AwsServiceException, SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client
* .listGroupsForEntityPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroupsForEntity
* @see AWS
* API Documentation
*/
default ListGroupsForEntityIterable listGroupsForEntityPaginator(ListGroupsForEntityRequest listGroupsForEntityRequest)
throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException,
InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
return new ListGroupsForEntityIterable(this, listGroupsForEntityRequest);
}
/**
*
* This is a variant of
* {@link #listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client
* .listGroupsForEntityPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListGroupsForEntity
* @see AWS
* API Documentation
*/
default ListGroupsForEntityIterable listGroupsForEntityPaginator(
Consumer listGroupsForEntityRequest) throws EntityNotFoundException,
EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException,
AwsServiceException, SdkClientException, WorkMailException {
return listGroupsForEntityPaginator(ListGroupsForEntityRequest.builder().applyMutation(listGroupsForEntityRequest)
.build());
}
/**
*
* Lists all the impersonation roles for the given WorkMail organization.
*
*
* @param listImpersonationRolesRequest
* @return Result of the ListImpersonationRoles operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListImpersonationRoles
* @see AWS API Documentation
*/
default ListImpersonationRolesResponse listImpersonationRoles(ListImpersonationRolesRequest listImpersonationRolesRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListImpersonationRoles operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListImpersonationRoles
* @see AWS API Documentation
*/
default ListImpersonationRolesResponse listImpersonationRoles(
Consumer listImpersonationRolesRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client
* .listImpersonationRolesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListImpersonationRoles
* @see AWS API Documentation
*/
default ListImpersonationRolesIterable listImpersonationRolesPaginator(
ListImpersonationRolesRequest listImpersonationRolesRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return new ListImpersonationRolesIterable(this, listImpersonationRolesRequest);
}
/**
*
* This is a variant of
* {@link #listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client
* .listImpersonationRolesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListImpersonationRoles
* @see AWS API Documentation
*/
default ListImpersonationRolesIterable listImpersonationRolesPaginator(
Consumer listImpersonationRolesRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return listImpersonationRolesPaginator(ListImpersonationRolesRequest.builder()
.applyMutation(listImpersonationRolesRequest).build());
}
/**
*
* Lists the mail domains in a given WorkMail organization.
*
*
* @param listMailDomainsRequest
* @return Result of the ListMailDomains operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailDomains
* @see AWS API
* Documentation
*/
default ListMailDomainsResponse listMailDomains(ListMailDomainsRequest listMailDomainsRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListMailDomains operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailDomains
* @see AWS API
* Documentation
*/
default ListMailDomainsResponse listMailDomains(Consumer listMailDomainsRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client
* .listMailDomainsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailDomains
* @see AWS API
* Documentation
*/
default ListMailDomainsIterable listMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
return new ListMailDomainsIterable(this, listMailDomainsRequest);
}
/**
*
* This is a variant of
* {@link #listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client
* .listMailDomainsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailDomains
* @see AWS API
* Documentation
*/
default ListMailDomainsIterable listMailDomainsPaginator(Consumer listMailDomainsRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
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 Result of the ListMailboxExportJobs operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailboxExportJobs
* @see AWS API Documentation
*/
default ListMailboxExportJobsResponse listMailboxExportJobs(ListMailboxExportJobsRequest listMailboxExportJobsRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListMailboxExportJobs operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailboxExportJobs
* @see AWS API Documentation
*/
default ListMailboxExportJobsResponse listMailboxExportJobs(
Consumer listMailboxExportJobsRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client
* .listMailboxExportJobsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailboxExportJobs
* @see AWS API Documentation
*/
default ListMailboxExportJobsIterable listMailboxExportJobsPaginator(ListMailboxExportJobsRequest listMailboxExportJobsRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
return new ListMailboxExportJobsIterable(this, listMailboxExportJobsRequest);
}
/**
*
* This is a variant of
* {@link #listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client
* .listMailboxExportJobsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailboxExportJobs
* @see AWS API Documentation
*/
default ListMailboxExportJobsIterable listMailboxExportJobsPaginator(
Consumer listMailboxExportJobsRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return listMailboxExportJobsPaginator(ListMailboxExportJobsRequest.builder().applyMutation(listMailboxExportJobsRequest)
.build());
}
/**
*
* Lists the mailbox permissions associated with a user, group, or resource mailbox.
*
*
* @param listMailboxPermissionsRequest
* @return Result of the ListMailboxPermissions operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailboxPermissions
* @see AWS API Documentation
*/
default ListMailboxPermissionsResponse listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListMailboxPermissions operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailboxPermissions
* @see AWS API Documentation
*/
default ListMailboxPermissionsResponse listMailboxPermissions(
Consumer listMailboxPermissionsRequest) throws EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client
* .listMailboxPermissionsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailboxPermissions
* @see AWS API Documentation
*/
default ListMailboxPermissionsIterable listMailboxPermissionsPaginator(
ListMailboxPermissionsRequest listMailboxPermissionsRequest) throws EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
return new ListMailboxPermissionsIterable(this, listMailboxPermissionsRequest);
}
/**
*
* This is a variant of
* {@link #listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client
* .listMailboxPermissionsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMailboxPermissions
* @see AWS API Documentation
*/
default ListMailboxPermissionsIterable listMailboxPermissionsPaginator(
Consumer listMailboxPermissionsRequest) throws EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
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 Result of the ListMobileDeviceAccessOverrides operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMobileDeviceAccessOverrides
* @see AWS API Documentation
*/
default ListMobileDeviceAccessOverridesResponse listMobileDeviceAccessOverrides(
ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListMobileDeviceAccessOverrides operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMobileDeviceAccessOverrides
* @see AWS API Documentation
*/
default ListMobileDeviceAccessOverridesResponse listMobileDeviceAccessOverrides(
Consumer listMobileDeviceAccessOverridesRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client
* .listMobileDeviceAccessOverridesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMobileDeviceAccessOverrides
* @see AWS API Documentation
*/
default ListMobileDeviceAccessOverridesIterable listMobileDeviceAccessOverridesPaginator(
ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException,
SdkClientException, WorkMailException {
return new ListMobileDeviceAccessOverridesIterable(this, listMobileDeviceAccessOverridesRequest);
}
/**
*
* This is a variant of
* {@link #listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client
* .listMobileDeviceAccessOverridesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMobileDeviceAccessOverrides
* @see AWS API Documentation
*/
default ListMobileDeviceAccessOverridesIterable listMobileDeviceAccessOverridesPaginator(
Consumer listMobileDeviceAccessOverridesRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
return listMobileDeviceAccessOverridesPaginator(ListMobileDeviceAccessOverridesRequest.builder()
.applyMutation(listMobileDeviceAccessOverridesRequest).build());
}
/**
*
* Lists the mobile device access rules for the specified WorkMail organization.
*
*
* @param listMobileDeviceAccessRulesRequest
* @return Result of the ListMobileDeviceAccessRules operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMobileDeviceAccessRules
* @see AWS API Documentation
*/
default ListMobileDeviceAccessRulesResponse listMobileDeviceAccessRules(
ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListMobileDeviceAccessRules operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListMobileDeviceAccessRules
* @see AWS API Documentation
*/
default ListMobileDeviceAccessRulesResponse listMobileDeviceAccessRules(
Consumer listMobileDeviceAccessRulesRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
return listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest.builder()
.applyMutation(listMobileDeviceAccessRulesRequest).build());
}
/**
*
* Returns summaries of the customer's organizations.
*
*
* @param listOrganizationsRequest
* @return Result of the ListOrganizations operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListOrganizations
* @see AWS
* API Documentation
*/
default ListOrganizationsResponse listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListOrganizations operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListOrganizations
* @see AWS
* API Documentation
*/
default ListOrganizationsResponse listOrganizations(Consumer listOrganizationsRequest)
throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
return listOrganizations(ListOrganizationsRequest.builder().applyMutation(listOrganizationsRequest).build());
}
/**
*
* Returns summaries of the customer's organizations.
*
*
* @return Result of the ListOrganizations operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListOrganizations
* @see #listOrganizations(ListOrganizationsRequest)
* @see AWS
* API Documentation
*/
default ListOrganizationsResponse listOrganizations() throws InvalidParameterException, AwsServiceException,
SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client
* .listOrganizationsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListOrganizations
* @see #listOrganizationsPaginator(ListOrganizationsRequest)
* @see AWS
* API Documentation
*/
default ListOrganizationsIterable listOrganizationsPaginator() throws InvalidParameterException, AwsServiceException,
SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client
* .listOrganizationsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListOrganizations
* @see AWS
* API Documentation
*/
default ListOrganizationsIterable listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest)
throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
return new ListOrganizationsIterable(this, listOrganizationsRequest);
}
/**
*
* This is a variant of
* {@link #listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client
* .listOrganizationsPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListOrganizations
* @see AWS
* API Documentation
*/
default ListOrganizationsIterable listOrganizationsPaginator(
Consumer listOrganizationsRequest) throws InvalidParameterException,
AwsServiceException, SdkClientException, WorkMailException {
return listOrganizationsPaginator(ListOrganizationsRequest.builder().applyMutation(listOrganizationsRequest).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 Result of the ListResourceDelegates operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListResourceDelegates
* @see AWS API Documentation
*/
default ListResourceDelegatesResponse listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListResourceDelegates operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListResourceDelegates
* @see AWS API Documentation
*/
default ListResourceDelegatesResponse listResourceDelegates(
Consumer listResourceDelegatesRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client
* .listResourceDelegatesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListResourceDelegates
* @see AWS API Documentation
*/
default ListResourceDelegatesIterable listResourceDelegatesPaginator(ListResourceDelegatesRequest listResourceDelegatesRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return new ListResourceDelegatesIterable(this, listResourceDelegatesRequest);
}
/**
*
* This is a variant of
* {@link #listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client
* .listResourceDelegatesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListResourceDelegates
* @see AWS API Documentation
*/
default ListResourceDelegatesIterable listResourceDelegatesPaginator(
Consumer listResourceDelegatesRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return listResourceDelegatesPaginator(ListResourceDelegatesRequest.builder().applyMutation(listResourceDelegatesRequest)
.build());
}
/**
*
* Returns summaries of the organization's resources.
*
*
* @param listResourcesRequest
* @return Result of the ListResources operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListResources
* @see AWS API
* Documentation
*/
default ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListResources operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListResources
* @see AWS API
* Documentation
*/
default ListResourcesResponse listResources(Consumer listResourcesRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListResourcesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListResources
* @see AWS API
* Documentation
*/
default ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return new ListResourcesIterable(this, listResourcesRequest);
}
/**
*
* This is a variant of {@link #listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListResourcesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListResources
* @see AWS API
* Documentation
*/
default ListResourcesIterable listResourcesPaginator(Consumer listResourcesRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return listResourcesPaginator(ListResourcesRequest.builder().applyMutation(listResourcesRequest).build());
}
/**
*
* Lists the tags applied to an WorkMail organization resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Returns summaries of the organization's users.
*
*
* @param listUsersRequest
* @return Result of the ListUsers operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the ListUsers operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersResponse listUsers(Consumer listUsersRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
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 iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListUsersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return new ListUsersIterable(this, listUsersRequest);
}
/**
*
* This is a variant of {@link #listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
* for (software.amazon.awssdk.services.workmail.model.ListUsersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ListUsers
* @see AWS API
* Documentation
*/
default ListUsersIterable listUsersPaginator(Consumer listUsersRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
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 Result of the PutAccessControlRule operation returned by the service.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutAccessControlRule
* @see AWS
* API Documentation
*/
default PutAccessControlRuleResponse putAccessControlRule(PutAccessControlRuleRequest putAccessControlRuleRequest)
throws LimitExceededException, InvalidParameterException, EntityNotFoundException, ResourceNotFoundException,
OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the PutAccessControlRule operation returned by the service.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutAccessControlRule
* @see AWS
* API Documentation
*/
default PutAccessControlRuleResponse putAccessControlRule(
Consumer putAccessControlRuleRequest) throws LimitExceededException,
InvalidParameterException, EntityNotFoundException, ResourceNotFoundException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return putAccessControlRule(PutAccessControlRuleRequest.builder().applyMutation(putAccessControlRuleRequest).build());
}
/**
*
* Creates or updates the email monitoring configuration for a specified organization.
*
*
* @param putEmailMonitoringConfigurationRequest
* @return Result of the PutEmailMonitoringConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default PutEmailMonitoringConfigurationResponse putEmailMonitoringConfiguration(
PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest) throws ResourceNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.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 Result of the PutEmailMonitoringConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutEmailMonitoringConfiguration
* @see AWS API Documentation
*/
default PutEmailMonitoringConfigurationResponse putEmailMonitoringConfiguration(
Consumer putEmailMonitoringConfigurationRequest)
throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
return putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest.builder()
.applyMutation(putEmailMonitoringConfigurationRequest).build());
}
/**
*
* Enables or disables a DMARC policy for a given organization.
*
*
* @param putInboundDmarcSettingsRequest
* @return Result of the PutInboundDmarcSettings operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutInboundDmarcSettings
* @see AWS API Documentation
*/
default PutInboundDmarcSettingsResponse putInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest)
throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
throw new java.lang.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 Result of the PutInboundDmarcSettings operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutInboundDmarcSettings
* @see AWS API Documentation
*/
default PutInboundDmarcSettingsResponse putInboundDmarcSettings(
Consumer putInboundDmarcSettingsRequest)
throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
return putInboundDmarcSettings(PutInboundDmarcSettingsRequest.builder().applyMutation(putInboundDmarcSettingsRequest)
.build());
}
/**
*
* Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
*
*
* @param putMailboxPermissionsRequest
* @return Result of the PutMailboxPermissions operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutMailboxPermissions
* @see AWS API Documentation
*/
default PutMailboxPermissionsResponse putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest)
throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException,
OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the PutMailboxPermissions operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutMailboxPermissions
* @see AWS API Documentation
*/
default PutMailboxPermissionsResponse putMailboxPermissions(
Consumer putMailboxPermissionsRequest) throws EntityNotFoundException,
EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
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 Result of the PutMobileDeviceAccessOverride operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default PutMobileDeviceAccessOverrideResponse putMobileDeviceAccessOverride(
PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the PutMobileDeviceAccessOverride operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutMobileDeviceAccessOverride
* @see AWS API Documentation
*/
default PutMobileDeviceAccessOverrideResponse putMobileDeviceAccessOverride(
Consumer putMobileDeviceAccessOverrideRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
EntityStateException, AwsServiceException, SdkClientException, WorkMailException {
return putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest.builder()
.applyMutation(putMobileDeviceAccessOverrideRequest).build());
}
/**
*
* Puts a retention policy to the specified organization.
*
*
* @param putRetentionPolicyRequest
* @return Result of the PutRetentionPolicy operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutRetentionPolicy
* @see AWS
* API Documentation
*/
default PutRetentionPolicyResponse putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the PutRetentionPolicy operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.PutRetentionPolicy
* @see AWS
* API Documentation
*/
default PutRetentionPolicyResponse putRetentionPolicy(Consumer putRetentionPolicyRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException,
AwsServiceException, SdkClientException, WorkMailException {
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 Result of the RegisterMailDomain operation returned by the service.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.RegisterMailDomain
* @see AWS
* API Documentation
*/
default RegisterMailDomainResponse registerMailDomain(RegisterMailDomainRequest registerMailDomainRequest)
throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException,
InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 Result of the RegisterMailDomain operation returned by the service.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.RegisterMailDomain
* @see AWS
* API Documentation
*/
default RegisterMailDomainResponse registerMailDomain(Consumer registerMailDomainRequest)
throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException,
InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
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 Result of the RegisterToWorkMail operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EmailAddressInUseException
* The email address that you're trying to assign is already created for a different user, group, or
* resource.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws EntityAlreadyRegisteredException
* The user, group, or resource that you're trying to register is already registered.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.RegisterToWorkMail
* @see AWS
* API Documentation
*/
default RegisterToWorkMailResponse registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException,
EntityNotFoundException, EntityStateException, EntityAlreadyRegisteredException, InvalidParameterException,
MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.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 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.
*
*
*
* This is a convenience which creates an instance of the {@link RegisterToWorkMailRequest.Builder} avoiding the
* need to create one manually via {@link RegisterToWorkMailRequest#builder()}
*
*
* @param registerToWorkMailRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.RegisterToWorkMailRequest.Builder} to create a
* request.
* @return Result of the RegisterToWorkMail operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EmailAddressInUseException
* The email address that you're trying to assign is already created for a different user, group, or
* resource.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws EntityAlreadyRegisteredException
* The user, group, or resource that you're trying to register is already registered.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.RegisterToWorkMail
* @see AWS
* API Documentation
*/
default RegisterToWorkMailResponse registerToWorkMail(Consumer registerToWorkMailRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException,
EntityNotFoundException, EntityStateException, EntityAlreadyRegisteredException, InvalidParameterException,
MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
return registerToWorkMail(RegisterToWorkMailRequest.builder().applyMutation(registerToWorkMailRequest).build());
}
/**
*
* Allows the administrator to reset the password for a user.
*
*
* @param resetPasswordRequest
* @return Result of the ResetPassword operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws InvalidPasswordException
* The supplied password doesn't match the minimum security constraints, such as length or use of special
* characters.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ResetPassword
* @see AWS API
* Documentation
*/
default ResetPasswordResponse resetPassword(ResetPasswordRequest resetPasswordRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException,
EntityStateException, InvalidParameterException, InvalidPasswordException, OrganizationNotFoundException,
OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Allows the administrator to reset the password for a user.
*
*
*
* This is a convenience which creates an instance of the {@link ResetPasswordRequest.Builder} avoiding the need to
* create one manually via {@link ResetPasswordRequest#builder()}
*
*
* @param resetPasswordRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ResetPasswordRequest.Builder} to create a request.
* @return Result of the ResetPassword operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws InvalidPasswordException
* The supplied password doesn't match the minimum security constraints, such as length or use of special
* characters.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.ResetPassword
* @see AWS API
* Documentation
*/
default ResetPasswordResponse resetPassword(Consumer resetPasswordRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException,
EntityStateException, InvalidParameterException, InvalidPasswordException, OrganizationNotFoundException,
OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException {
return resetPassword(ResetPasswordRequest.builder().applyMutation(resetPasswordRequest).build());
}
/**
*
* Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to
* the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in
* the WorkMail Administrator Guide.
*
*
* @param startMailboxExportJobRequest
* @return Result of the StartMailboxExportJob operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.StartMailboxExportJob
* @see AWS API Documentation
*/
default StartMailboxExportJobResponse startMailboxExportJob(StartMailboxExportJobRequest startMailboxExportJobRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
LimitExceededException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to
* the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in
* the WorkMail Administrator Guide.
*
*
*
* This is a convenience which creates an instance of the {@link StartMailboxExportJobRequest.Builder} avoiding the
* need to create one manually via {@link StartMailboxExportJobRequest#builder()}
*
*
* @param startMailboxExportJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.StartMailboxExportJobRequest.Builder} to create a
* request.
* @return Result of the StartMailboxExportJob operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.StartMailboxExportJob
* @see AWS API Documentation
*/
default StartMailboxExportJobResponse startMailboxExportJob(
Consumer startMailboxExportJobRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, LimitExceededException,
AwsServiceException, SdkClientException, WorkMailException {
return startMailboxExportJob(StartMailboxExportJobRequest.builder().applyMutation(startMailboxExportJobRequest).build());
}
/**
*
* Applies the specified tags to the specified WorkMailorganization resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws TooManyTagsException
* The resource can have up to 50 user-applied tags.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException,
ResourceNotFoundException, TooManyTagsException, OrganizationStateException, AwsServiceException, SdkClientException,
WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Applies the specified tags to the specified WorkMailorganization resource.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws TooManyTagsException
* The resource can have up to 50 user-applied tags.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws InvalidParameterException, ResourceNotFoundException, TooManyTagsException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided
* credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked
* and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done
* without providing either a SourceArn or SourceAccount header.
*
*
*
* The request must contain either one provider definition (EwsProvider or LambdaProvider)
* or the DomainName parameter. If the DomainName parameter is provided, the configuration
* stored under the DomainName will be tested.
*
*
*
* @param testAvailabilityConfigurationRequest
* @return Result of the TestAvailabilityConfiguration operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.TestAvailabilityConfiguration
* @see AWS API Documentation
*/
default TestAvailabilityConfigurationResponse testAvailabilityConfiguration(
TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest) throws OrganizationNotFoundException,
OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided
* credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked
* and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done
* without providing either a SourceArn or SourceAccount header.
*
*
*
* The request must contain either one provider definition (EwsProvider or LambdaProvider)
* or the DomainName parameter. If the DomainName parameter is provided, the configuration
* stored under the DomainName will be tested.
*
*
*
* This is a convenience which creates an instance of the {@link TestAvailabilityConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link TestAvailabilityConfigurationRequest#builder()}
*
*
* @param testAvailabilityConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.TestAvailabilityConfigurationRequest.Builder} to
* create a request.
* @return Result of the TestAvailabilityConfiguration operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.TestAvailabilityConfiguration
* @see AWS API Documentation
*/
default TestAvailabilityConfigurationResponse testAvailabilityConfiguration(
Consumer testAvailabilityConfigurationRequest)
throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException,
InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
return testAvailabilityConfiguration(TestAvailabilityConfigurationRequest.builder()
.applyMutation(testAvailabilityConfigurationRequest).build());
}
/**
*
* Untags the specified tags from the specified WorkMail organization resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Untags the specified tags from the specified WorkMail organization resource.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
*
*
* @param updateAvailabilityConfigurationRequest
* @return Result of the UpdateAvailabilityConfiguration operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateAvailabilityConfiguration
* @see AWS API Documentation
*/
default UpdateAvailabilityConfigurationResponse updateAvailabilityConfiguration(
UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest) throws OrganizationNotFoundException,
OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAvailabilityConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link UpdateAvailabilityConfigurationRequest#builder()}
*
*
* @param updateAvailabilityConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UpdateAvailabilityConfigurationRequest.Builder} to
* create a request.
* @return Result of the UpdateAvailabilityConfiguration operation returned by the service.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateAvailabilityConfiguration
* @see AWS API Documentation
*/
default UpdateAvailabilityConfigurationResponse updateAvailabilityConfiguration(
Consumer updateAvailabilityConfigurationRequest)
throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException,
InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
return updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest.builder()
.applyMutation(updateAvailabilityConfigurationRequest).build());
}
/**
*
* Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console
* to suggest an email address when enabling a mail user. You can only have one default domain.
*
*
* @param updateDefaultMailDomainRequest
* @return Result of the UpdateDefaultMailDomain operation returned by the service.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateDefaultMailDomain
* @see AWS API Documentation
*/
default UpdateDefaultMailDomainResponse updateDefaultMailDomain(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest)
throws MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException,
OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console
* to suggest an email address when enabling a mail user. You can only have one default domain.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDefaultMailDomainRequest.Builder} avoiding
* the need to create one manually via {@link UpdateDefaultMailDomainRequest#builder()}
*
*
* @param updateDefaultMailDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UpdateDefaultMailDomainRequest.Builder} to create a
* request.
* @return Result of the UpdateDefaultMailDomain operation returned by the service.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateDefaultMailDomain
* @see AWS API Documentation
*/
default UpdateDefaultMailDomainResponse updateDefaultMailDomain(
Consumer updateDefaultMailDomainRequest) throws MailDomainNotFoundException,
MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException,
AwsServiceException, SdkClientException, WorkMailException {
return updateDefaultMailDomain(UpdateDefaultMailDomainRequest.builder().applyMutation(updateDefaultMailDomainRequest)
.build());
}
/**
*
* Updates attibutes in a group.
*
*
* @param updateGroupRequest
* @return Result of the UpdateGroup operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateGroup
* @see AWS API
* Documentation
*/
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws EntityNotFoundException,
EntityStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Updates attibutes in a group.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateGroupRequest.Builder} avoiding the need to
* create one manually via {@link UpdateGroupRequest#builder()}
*
*
* @param updateGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UpdateGroupRequest.Builder} to create a request.
* @return Result of the UpdateGroup operation returned by the service.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateGroup
* @see AWS API
* Documentation
*/
default UpdateGroupResponse updateGroup(Consumer updateGroupRequest)
throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException,
UnsupportedOperationException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException {
return updateGroup(UpdateGroupRequest.builder().applyMutation(updateGroupRequest).build());
}
/**
*
* Updates an impersonation role for the given WorkMail organization.
*
*
* @param updateImpersonationRoleRequest
* @return Result of the UpdateImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateImpersonationRole
* @see AWS API Documentation
*/
default UpdateImpersonationRoleResponse updateImpersonationRole(UpdateImpersonationRoleRequest updateImpersonationRoleRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException,
ResourceNotFoundException, EntityNotFoundException, EntityStateException, LimitExceededException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Updates an impersonation role for the given WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateImpersonationRoleRequest.Builder} avoiding
* the need to create one manually via {@link UpdateImpersonationRoleRequest#builder()}
*
*
* @param updateImpersonationRoleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UpdateImpersonationRoleRequest.Builder} to create a
* request.
* @return Result of the UpdateImpersonationRole operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws ResourceNotFoundException
* The resource cannot be found.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws LimitExceededException
* The request exceeds the limit of the resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateImpersonationRole
* @see AWS API Documentation
*/
default UpdateImpersonationRoleResponse updateImpersonationRole(
Consumer updateImpersonationRoleRequest) throws InvalidParameterException,
OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException,
EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException {
return updateImpersonationRole(UpdateImpersonationRoleRequest.builder().applyMutation(updateImpersonationRoleRequest)
.build());
}
/**
*
* Updates a user's current mailbox quota for a specified organization and user.
*
*
* @param updateMailboxQuotaRequest
* @return Result of the UpdateMailboxQuota operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateMailboxQuota
* @see AWS
* API Documentation
*/
default UpdateMailboxQuotaResponse updateMailboxQuota(UpdateMailboxQuotaRequest updateMailboxQuotaRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
EntityStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Updates a user's current mailbox quota for a specified organization and user.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateMailboxQuotaRequest.Builder} avoiding the
* need to create one manually via {@link UpdateMailboxQuotaRequest#builder()}
*
*
* @param updateMailboxQuotaRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UpdateMailboxQuotaRequest.Builder} to create a
* request.
* @return Result of the UpdateMailboxQuota operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateMailboxQuota
* @see AWS
* API Documentation
*/
default UpdateMailboxQuotaResponse updateMailboxQuota(Consumer updateMailboxQuotaRequest)
throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException,
EntityStateException, AwsServiceException, SdkClientException, WorkMailException {
return updateMailboxQuota(UpdateMailboxQuotaRequest.builder().applyMutation(updateMailboxQuotaRequest).build());
}
/**
*
* Updates a mobile device access rule for the specified WorkMail organization.
*
*
* @param updateMobileDeviceAccessRuleRequest
* @return Result of the UpdateMobileDeviceAccessRule operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateMobileDeviceAccessRule
* @see AWS API Documentation
*/
default UpdateMobileDeviceAccessRuleResponse updateMobileDeviceAccessRule(
UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest) throws InvalidParameterException,
EntityNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException,
SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Updates a mobile device access rule for the specified WorkMail organization.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateMobileDeviceAccessRuleRequest.Builder}
* avoiding the need to create one manually via {@link UpdateMobileDeviceAccessRuleRequest#builder()}
*
*
* @param updateMobileDeviceAccessRuleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UpdateMobileDeviceAccessRuleRequest.Builder} to
* create a request.
* @return Result of the UpdateMobileDeviceAccessRule operation returned by the service.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateMobileDeviceAccessRule
* @see AWS API Documentation
*/
default UpdateMobileDeviceAccessRuleResponse updateMobileDeviceAccessRule(
Consumer updateMobileDeviceAccessRuleRequest)
throws InvalidParameterException, EntityNotFoundException, OrganizationNotFoundException, OrganizationStateException,
AwsServiceException, SdkClientException, WorkMailException {
return updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest.builder()
.applyMutation(updateMobileDeviceAccessRuleRequest).build());
}
/**
*
* Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or
* swapped between an existing alias and the current primary email), and the email provided in the input is promoted
* as the primary.
*
*
* @param updatePrimaryEmailAddressRequest
* @return Result of the UpdatePrimaryEmailAddress operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EmailAddressInUseException
* The email address that you're trying to assign is already created for a different user, group, or
* resource.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdatePrimaryEmailAddress
* @see AWS API Documentation
*/
default UpdatePrimaryEmailAddressResponse updatePrimaryEmailAddress(
UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException,
EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException,
MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or
* swapped between an existing alias and the current primary email), and the email provided in the input is promoted
* as the primary.
*
*
*
* This is a convenience which creates an instance of the {@link UpdatePrimaryEmailAddressRequest.Builder} avoiding
* the need to create one manually via {@link UpdatePrimaryEmailAddressRequest#builder()}
*
*
* @param updatePrimaryEmailAddressRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UpdatePrimaryEmailAddressRequest.Builder} to create
* a request.
* @return Result of the UpdatePrimaryEmailAddress operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EmailAddressInUseException
* The email address that you're trying to assign is already created for a different user, group, or
* resource.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdatePrimaryEmailAddress
* @see AWS API Documentation
*/
default UpdatePrimaryEmailAddressResponse updatePrimaryEmailAddress(
Consumer updatePrimaryEmailAddressRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException,
EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException,
MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
AwsServiceException, SdkClientException, WorkMailException {
return updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest.builder()
.applyMutation(updatePrimaryEmailAddressRequest).build());
}
/**
*
* Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource
* call. The dataset in the request should be the one expected when performing another DescribeResource
* call.
*
*
* @param updateResourceRequest
* @return Result of the UpdateResource operation returned by the service.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidConfigurationException
* The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests
* or have at least one delegate associated that can do so on its behalf.
* @throws EmailAddressInUseException
* The email address that you're trying to assign is already created for a different user, group, or
* resource.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateResource
* @see AWS API
* Documentation
*/
default UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest)
throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException,
EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException,
OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException,
AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource
* call. The dataset in the request should be the one expected when performing another DescribeResource
* call.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateResourceRequest.Builder} avoiding the need to
* create one manually via {@link UpdateResourceRequest#builder()}
*
*
* @param updateResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UpdateResourceRequest.Builder} to create a request.
* @return Result of the UpdateResource operation returned by the service.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws 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.
* @throws InvalidConfigurationException
* The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests
* or have at least one delegate associated that can do so on its behalf.
* @throws EmailAddressInUseException
* The email address that you're trying to assign is already created for a different user, group, or
* resource.
* @throws MailDomainNotFoundException
* The domain specified is not found in your organization.
* @throws MailDomainStateException
* After a domain has been added to the organization, it must be verified. The domain is not yet verified.
* @throws NameAvailabilityException
* The user, group, or resource name isn't unique in WorkMail.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateResource
* @see AWS API
* Documentation
*/
default UpdateResourceResponse updateResource(Consumer updateResourceRequest)
throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException,
EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException,
OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException,
AwsServiceException, SdkClientException, WorkMailException {
return updateResource(UpdateResourceRequest.builder().applyMutation(updateResourceRequest).build());
}
/**
*
* Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The
* dataset in the request should be the one expected when performing another DescribeUser call.
*
*
* @param updateUserRequest
* @return Result of the UpdateUser operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateUser
* @see AWS API
* Documentation
*/
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
EntityStateException, AwsServiceException, SdkClientException, WorkMailException {
throw new java.lang.UnsupportedOperationException();
}
/**
*
* Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The
* dataset in the request should be the one expected when performing another DescribeUser call.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateUserRequest.Builder} avoiding the need to
* create one manually via {@link UpdateUserRequest#builder()}
*
*
* @param updateUserRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.UpdateUserRequest.Builder} to create a request.
* @return Result of the UpdateUser operation returned by the service.
* @throws DirectoryServiceAuthenticationFailedException
* The directory service doesn't recognize the credentials supplied by WorkMail.
* @throws DirectoryUnavailableException
* The directory is unavailable. It might be located in another Region or deleted.
* @throws EntityNotFoundException
* The identifier supplied for the user, group, or resource does not exist in your organization.
* @throws InvalidParameterException
* One or more of the input parameters don't match the service's restrictions.
* @throws OrganizationNotFoundException
* An operation received a valid organization identifier that either doesn't belong or exist in the system.
* @throws OrganizationStateException
* The organization must have a valid state to perform certain operations on the organization or its
* members.
* @throws UnsupportedOperationException
* You can't perform a write operation against a read-only directory.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws WorkMailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample WorkMailClient.UpdateUser
* @see AWS API
* Documentation
*/
default UpdateUserResponse updateUser(Consumer updateUserRequest)
throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException,
InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException,
EntityStateException, AwsServiceException, SdkClientException, WorkMailException {
return updateUser(UpdateUserRequest.builder().applyMutation(updateUserRequest).build());
}
/**
* Create a {@link WorkMailClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static WorkMailClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link WorkMailClient}.
*/
static WorkMailClientBuilder builder() {
return new DefaultWorkMailClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default WorkMailServiceClientConfiguration serviceClientConfiguration() {
throw new java.lang.UnsupportedOperationException();
}
}