Interface WorkMailClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface WorkMailClient extends AwsClient
Service client for accessing Amazon WorkMail. This can be created using the staticbuilder()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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AssociateDelegateToResourceResponseassociateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest)Adds a member (user or group) to the resource's set of delegates.default AssociateDelegateToResourceResponseassociateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)Adds a member (user or group) to the resource's set of delegates.default AssociateMemberToGroupResponseassociateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest)Adds a member (user or group) to the group's set.default AssociateMemberToGroupResponseassociateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)Adds a member (user or group) to the group's set.default AssumeImpersonationRoleResponseassumeImpersonationRole(Consumer<AssumeImpersonationRoleRequest.Builder> assumeImpersonationRoleRequest)Assumes an impersonation role for the given WorkMail organization.default AssumeImpersonationRoleResponseassumeImpersonationRole(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest)Assumes an impersonation role for the given WorkMail organization.static WorkMailClientBuilderbuilder()Create a builder that can be used to configure and create aWorkMailClient.default CancelMailboxExportJobResponsecancelMailboxExportJob(Consumer<CancelMailboxExportJobRequest.Builder> cancelMailboxExportJobRequest)Cancels a mailbox export job.default CancelMailboxExportJobResponsecancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest)Cancels a mailbox export job.static WorkMailClientcreate()Create aWorkMailClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAliasResponsecreateAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)Adds an alias to the set of a given member (user or group) of WorkMail.default CreateAliasResponsecreateAlias(CreateAliasRequest createAliasRequest)Adds an alias to the set of a given member (user or group) of WorkMail.default CreateAvailabilityConfigurationResponsecreateAvailabilityConfiguration(Consumer<CreateAvailabilityConfigurationRequest.Builder> createAvailabilityConfigurationRequest)Creates anAvailabilityConfigurationfor the given WorkMail organization and domain.default CreateAvailabilityConfigurationResponsecreateAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest)Creates anAvailabilityConfigurationfor the given WorkMail organization and domain.default CreateGroupResponsecreateGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.default CreateGroupResponsecreateGroup(CreateGroupRequest createGroupRequest)Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.default CreateImpersonationRoleResponsecreateImpersonationRole(Consumer<CreateImpersonationRoleRequest.Builder> createImpersonationRoleRequest)Creates an impersonation role for the given WorkMail organization.default CreateImpersonationRoleResponsecreateImpersonationRole(CreateImpersonationRoleRequest createImpersonationRoleRequest)Creates an impersonation role for the given WorkMail organization.default CreateMobileDeviceAccessRuleResponsecreateMobileDeviceAccessRule(Consumer<CreateMobileDeviceAccessRuleRequest.Builder> createMobileDeviceAccessRuleRequest)Creates a new mobile device access rule for the specified WorkMail organization.default CreateMobileDeviceAccessRuleResponsecreateMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest)Creates a new mobile device access rule for the specified WorkMail organization.default CreateOrganizationResponsecreateOrganization(Consumer<CreateOrganizationRequest.Builder> createOrganizationRequest)Creates a new WorkMail organization.default CreateOrganizationResponsecreateOrganization(CreateOrganizationRequest createOrganizationRequest)Creates a new WorkMail organization.default CreateResourceResponsecreateResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)Creates a new WorkMail resource.default CreateResourceResponsecreateResource(CreateResourceRequest createResourceRequest)Creates a new WorkMail resource.default CreateUserResponsecreateUser(Consumer<CreateUserRequest.Builder> createUserRequest)Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.default CreateUserResponsecreateUser(CreateUserRequest createUserRequest)Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.default DeleteAccessControlRuleResponsedeleteAccessControlRule(Consumer<DeleteAccessControlRuleRequest.Builder> deleteAccessControlRuleRequest)Deletes an access control rule for the specified WorkMail organization.default DeleteAccessControlRuleResponsedeleteAccessControlRule(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest)Deletes an access control rule for the specified WorkMail organization.default DeleteAliasResponsedeleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)Remove one or more specified aliases from a set of aliases for a given user.default DeleteAliasResponsedeleteAlias(DeleteAliasRequest deleteAliasRequest)Remove one or more specified aliases from a set of aliases for a given user.default DeleteAvailabilityConfigurationResponsedeleteAvailabilityConfiguration(Consumer<DeleteAvailabilityConfigurationRequest.Builder> deleteAvailabilityConfigurationRequest)Deletes theAvailabilityConfigurationfor the given WorkMail organization and domain.default DeleteAvailabilityConfigurationResponsedeleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest)Deletes theAvailabilityConfigurationfor the given WorkMail organization and domain.default DeleteEmailMonitoringConfigurationResponsedeleteEmailMonitoringConfiguration(Consumer<DeleteEmailMonitoringConfigurationRequest.Builder> deleteEmailMonitoringConfigurationRequest)Deletes the email monitoring configuration for a specified organization.default DeleteEmailMonitoringConfigurationResponsedeleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest)Deletes the email monitoring configuration for a specified organization.default DeleteGroupResponsedeleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)Deletes a group from WorkMail.default DeleteGroupResponsedeleteGroup(DeleteGroupRequest deleteGroupRequest)Deletes a group from WorkMail.default DeleteImpersonationRoleResponsedeleteImpersonationRole(Consumer<DeleteImpersonationRoleRequest.Builder> deleteImpersonationRoleRequest)Deletes an impersonation role for the given WorkMail organization.default DeleteImpersonationRoleResponsedeleteImpersonationRole(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest)Deletes an impersonation role for the given WorkMail organization.default DeleteMailboxPermissionsResponsedeleteMailboxPermissions(Consumer<DeleteMailboxPermissionsRequest.Builder> deleteMailboxPermissionsRequest)Deletes permissions granted to a member (user or group).default DeleteMailboxPermissionsResponsedeleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest)Deletes permissions granted to a member (user or group).default DeleteMobileDeviceAccessOverrideResponsedeleteMobileDeviceAccessOverride(Consumer<DeleteMobileDeviceAccessOverrideRequest.Builder> deleteMobileDeviceAccessOverrideRequest)Deletes the mobile device access override for the given WorkMail organization, user, and device.default DeleteMobileDeviceAccessOverrideResponsedeleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest)Deletes the mobile device access override for the given WorkMail organization, user, and device.default DeleteMobileDeviceAccessRuleResponsedeleteMobileDeviceAccessRule(Consumer<DeleteMobileDeviceAccessRuleRequest.Builder> deleteMobileDeviceAccessRuleRequest)Deletes a mobile device access rule for the specified WorkMail organization.default DeleteMobileDeviceAccessRuleResponsedeleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest)Deletes a mobile device access rule for the specified WorkMail organization.default DeleteOrganizationResponsedeleteOrganization(Consumer<DeleteOrganizationRequest.Builder> deleteOrganizationRequest)Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization.default DeleteOrganizationResponsedeleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest)Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization.default DeleteResourceResponsedeleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)Deletes the specified resource.default DeleteResourceResponsedeleteResource(DeleteResourceRequest deleteResourceRequest)Deletes the specified resource.default DeleteRetentionPolicyResponsedeleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest)Deletes the specified retention policy from the specified organization.default DeleteRetentionPolicyResponsedeleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)Deletes the specified retention policy from the specified organization.default DeleteUserResponsedeleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)Deletes a user from WorkMail and all subsequent systems.default DeleteUserResponsedeleteUser(DeleteUserRequest deleteUserRequest)Deletes a user from WorkMail and all subsequent systems.default DeregisterFromWorkMailResponsederegisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest)Mark a user, group, or resource as no longer used in WorkMail.default DeregisterFromWorkMailResponsederegisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)Mark a user, group, or resource as no longer used in WorkMail.default DeregisterMailDomainResponsederegisterMailDomain(Consumer<DeregisterMailDomainRequest.Builder> deregisterMailDomainRequest)Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.default DeregisterMailDomainResponsederegisterMailDomain(DeregisterMailDomainRequest deregisterMailDomainRequest)Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.default DescribeEmailMonitoringConfigurationResponsedescribeEmailMonitoringConfiguration(Consumer<DescribeEmailMonitoringConfigurationRequest.Builder> describeEmailMonitoringConfigurationRequest)Describes the current email monitoring configuration for a specified organization.default DescribeEmailMonitoringConfigurationResponsedescribeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest)Describes the current email monitoring configuration for a specified organization.default DescribeEntityResponsedescribeEntity(Consumer<DescribeEntityRequest.Builder> describeEntityRequest)Returns basic details about an entity in WorkMail.default DescribeEntityResponsedescribeEntity(DescribeEntityRequest describeEntityRequest)Returns basic details about an entity in WorkMail.default DescribeGroupResponsedescribeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)Returns the data available for the group.default DescribeGroupResponsedescribeGroup(DescribeGroupRequest describeGroupRequest)Returns the data available for the group.default DescribeInboundDmarcSettingsResponsedescribeInboundDmarcSettings(Consumer<DescribeInboundDmarcSettingsRequest.Builder> describeInboundDmarcSettingsRequest)Lists the settings in a DMARC policy for a specified organization.default DescribeInboundDmarcSettingsResponsedescribeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest)Lists the settings in a DMARC policy for a specified organization.default DescribeMailboxExportJobResponsedescribeMailboxExportJob(Consumer<DescribeMailboxExportJobRequest.Builder> describeMailboxExportJobRequest)Describes the current status of a mailbox export job.default DescribeMailboxExportJobResponsedescribeMailboxExportJob(DescribeMailboxExportJobRequest describeMailboxExportJobRequest)Describes the current status of a mailbox export job.default DescribeOrganizationResponsedescribeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest)Provides more information regarding a given organization based on its identifier.default DescribeOrganizationResponsedescribeOrganization(DescribeOrganizationRequest describeOrganizationRequest)Provides more information regarding a given organization based on its identifier.default DescribeResourceResponsedescribeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)Returns the data available for the resource.default DescribeResourceResponsedescribeResource(DescribeResourceRequest describeResourceRequest)Returns the data available for the resource.default DescribeUserResponsedescribeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)Provides information regarding the user.default DescribeUserResponsedescribeUser(DescribeUserRequest describeUserRequest)Provides information regarding the user.default DisassociateDelegateFromResourceResponsedisassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest)Removes a member from the resource's set of delegates.default DisassociateDelegateFromResourceResponsedisassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)Removes a member from the resource's set of delegates.default DisassociateMemberFromGroupResponsedisassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest)Removes a member from a group.default DisassociateMemberFromGroupResponsedisassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)Removes a member from a group.default GetAccessControlEffectResponsegetAccessControlEffect(Consumer<GetAccessControlEffectRequest.Builder> getAccessControlEffectRequest)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.default GetAccessControlEffectResponsegetAccessControlEffect(GetAccessControlEffectRequest getAccessControlEffectRequest)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.default GetDefaultRetentionPolicyResponsegetDefaultRetentionPolicy(Consumer<GetDefaultRetentionPolicyRequest.Builder> getDefaultRetentionPolicyRequest)Gets the default retention policy details for the specified organization.default GetDefaultRetentionPolicyResponsegetDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest)Gets the default retention policy details for the specified organization.default GetImpersonationRoleResponsegetImpersonationRole(Consumer<GetImpersonationRoleRequest.Builder> getImpersonationRoleRequest)Gets the impersonation role details for the given WorkMail organization.default GetImpersonationRoleResponsegetImpersonationRole(GetImpersonationRoleRequest getImpersonationRoleRequest)Gets the impersonation role details for the given WorkMail organization.default GetImpersonationRoleEffectResponsegetImpersonationRoleEffect(Consumer<GetImpersonationRoleEffectRequest.Builder> getImpersonationRoleEffectRequest)Tests whether the given impersonation role can impersonate a target user.default GetImpersonationRoleEffectResponsegetImpersonationRoleEffect(GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest)Tests whether the given impersonation role can impersonate a target user.default GetMailboxDetailsResponsegetMailboxDetails(Consumer<GetMailboxDetailsRequest.Builder> getMailboxDetailsRequest)Requests a user's mailbox details for a specified organization and user.default GetMailboxDetailsResponsegetMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest)Requests a user's mailbox details for a specified organization and user.default GetMailDomainResponsegetMailDomain(Consumer<GetMailDomainRequest.Builder> getMailDomainRequest)Gets details for a mail domain, including domain records required to configure your domain with recommended security.default GetMailDomainResponsegetMailDomain(GetMailDomainRequest getMailDomainRequest)Gets details for a mail domain, including domain records required to configure your domain with recommended security.default GetMobileDeviceAccessEffectResponsegetMobileDeviceAccessEffect(Consumer<GetMobileDeviceAccessEffectRequest.Builder> getMobileDeviceAccessEffectRequest)Simulates the effect of the mobile device access rules for the given attributes of a sample access event.default GetMobileDeviceAccessEffectResponsegetMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest)Simulates the effect of the mobile device access rules for the given attributes of a sample access event.default GetMobileDeviceAccessOverrideResponsegetMobileDeviceAccessOverride(Consumer<GetMobileDeviceAccessOverrideRequest.Builder> getMobileDeviceAccessOverrideRequest)Gets the mobile device access override for the given WorkMail organization, user, and device.default GetMobileDeviceAccessOverrideResponsegetMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest)Gets the mobile device access override for the given WorkMail organization, user, and device.default ListAccessControlRulesResponselistAccessControlRules(Consumer<ListAccessControlRulesRequest.Builder> listAccessControlRulesRequest)Lists the access control rules for the specified organization.default ListAccessControlRulesResponselistAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest)Lists the access control rules for the specified organization.default ListAliasesResponselistAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)Creates a paginated call to list the aliases associated with a given entity.default ListAliasesResponselistAliases(ListAliasesRequest listAliasesRequest)Creates a paginated call to list the aliases associated with a given entity.default ListAliasesIterablelistAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)This is a variant oflistAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)operation.default ListAliasesIterablelistAliasesPaginator(ListAliasesRequest listAliasesRequest)This is a variant oflistAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)operation.default ListAvailabilityConfigurationsResponselistAvailabilityConfigurations(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest)List all theAvailabilityConfiguration's for the given WorkMail organization.default ListAvailabilityConfigurationsResponselistAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)List all theAvailabilityConfiguration's for the given WorkMail organization.default ListAvailabilityConfigurationsIterablelistAvailabilityConfigurationsPaginator(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest)This is a variant oflistAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)operation.default ListAvailabilityConfigurationsIterablelistAvailabilityConfigurationsPaginator(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)This is a variant oflistAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)operation.default ListGroupMembersResponselistGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)Returns an overview of the members of a group.default ListGroupMembersResponselistGroupMembers(ListGroupMembersRequest listGroupMembersRequest)Returns an overview of the members of a group.default ListGroupMembersIterablelistGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)This is a variant oflistGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)operation.default ListGroupMembersIterablelistGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest)This is a variant oflistGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)operation.default ListGroupsResponselistGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)Returns summaries of the organization's groups.default ListGroupsResponselistGroups(ListGroupsRequest listGroupsRequest)Returns summaries of the organization's groups.default ListGroupsForEntityResponselistGroupsForEntity(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest)Returns all the groups to which an entity belongs.default ListGroupsForEntityResponselistGroupsForEntity(ListGroupsForEntityRequest listGroupsForEntityRequest)Returns all the groups to which an entity belongs.default ListGroupsForEntityIterablelistGroupsForEntityPaginator(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest)This is a variant oflistGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)operation.default ListGroupsForEntityIterablelistGroupsForEntityPaginator(ListGroupsForEntityRequest listGroupsForEntityRequest)This is a variant oflistGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)operation.default ListGroupsIterablelistGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)This is a variant oflistGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)operation.default ListGroupsIterablelistGroupsPaginator(ListGroupsRequest listGroupsRequest)This is a variant oflistGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)operation.default ListImpersonationRolesResponselistImpersonationRoles(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest)Lists all the impersonation roles for the given WorkMail organization.default ListImpersonationRolesResponselistImpersonationRoles(ListImpersonationRolesRequest listImpersonationRolesRequest)Lists all the impersonation roles for the given WorkMail organization.default ListImpersonationRolesIterablelistImpersonationRolesPaginator(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest)This is a variant oflistImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)operation.default ListImpersonationRolesIterablelistImpersonationRolesPaginator(ListImpersonationRolesRequest listImpersonationRolesRequest)This is a variant oflistImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)operation.default ListMailboxExportJobsResponselistMailboxExportJobs(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest)Lists the mailbox export jobs started for the specified organization within the last seven days.default ListMailboxExportJobsResponselistMailboxExportJobs(ListMailboxExportJobsRequest listMailboxExportJobsRequest)Lists the mailbox export jobs started for the specified organization within the last seven days.default ListMailboxExportJobsIterablelistMailboxExportJobsPaginator(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest)This is a variant oflistMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)operation.default ListMailboxExportJobsIterablelistMailboxExportJobsPaginator(ListMailboxExportJobsRequest listMailboxExportJobsRequest)This is a variant oflistMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)operation.default ListMailboxPermissionsResponselistMailboxPermissions(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest)Lists the mailbox permissions associated with a user, group, or resource mailbox.default ListMailboxPermissionsResponselistMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest)Lists the mailbox permissions associated with a user, group, or resource mailbox.default ListMailboxPermissionsIterablelistMailboxPermissionsPaginator(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest)This is a variant oflistMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)operation.default ListMailboxPermissionsIterablelistMailboxPermissionsPaginator(ListMailboxPermissionsRequest listMailboxPermissionsRequest)This is a variant oflistMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)operation.default ListMailDomainsResponselistMailDomains(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest)Lists the mail domains in a given WorkMail organization.default ListMailDomainsResponselistMailDomains(ListMailDomainsRequest listMailDomainsRequest)Lists the mail domains in a given WorkMail organization.default ListMailDomainsIterablelistMailDomainsPaginator(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest)This is a variant oflistMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)operation.default ListMailDomainsIterablelistMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest)This is a variant oflistMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)operation.default ListMobileDeviceAccessOverridesResponselistMobileDeviceAccessOverrides(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest)Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.default ListMobileDeviceAccessOverridesResponselistMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.default ListMobileDeviceAccessOverridesIterablelistMobileDeviceAccessOverridesPaginator(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest)This is a variant oflistMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)operation.default ListMobileDeviceAccessOverridesIterablelistMobileDeviceAccessOverridesPaginator(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)This is a variant oflistMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)operation.default ListMobileDeviceAccessRulesResponselistMobileDeviceAccessRules(Consumer<ListMobileDeviceAccessRulesRequest.Builder> listMobileDeviceAccessRulesRequest)Lists the mobile device access rules for the specified WorkMail organization.default ListMobileDeviceAccessRulesResponselistMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest)Lists the mobile device access rules for the specified WorkMail organization.default ListOrganizationsResponselistOrganizations()Returns summaries of the customer's organizations.default ListOrganizationsResponselistOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)Returns summaries of the customer's organizations.default ListOrganizationsResponselistOrganizations(ListOrganizationsRequest listOrganizationsRequest)Returns summaries of the customer's organizations.default ListOrganizationsIterablelistOrganizationsPaginator()This is a variant oflistOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)operation.default ListOrganizationsIterablelistOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)This is a variant oflistOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)operation.default ListOrganizationsIterablelistOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest)This is a variant oflistOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)operation.default ListResourceDelegatesResponselistResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest)Lists the delegates associated with a resource.default ListResourceDelegatesResponselistResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)Lists the delegates associated with a resource.default ListResourceDelegatesIterablelistResourceDelegatesPaginator(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest)This is a variant oflistResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)operation.default ListResourceDelegatesIterablelistResourceDelegatesPaginator(ListResourceDelegatesRequest listResourceDelegatesRequest)This is a variant oflistResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)operation.default ListResourcesResponselistResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)Returns summaries of the organization's resources.default ListResourcesResponselistResources(ListResourcesRequest listResourcesRequest)Returns summaries of the organization's resources.default ListResourcesIterablelistResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)This is a variant oflistResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)operation.default ListResourcesIterablelistResourcesPaginator(ListResourcesRequest listResourcesRequest)This is a variant oflistResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists the tags applied to an WorkMail organization resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists the tags applied to an WorkMail organization resource.default ListUsersResponselistUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)Returns summaries of the organization's users.default ListUsersResponselistUsers(ListUsersRequest listUsersRequest)Returns summaries of the organization's users.default ListUsersIterablelistUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)This is a variant oflistUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)operation.default ListUsersIterablelistUsersPaginator(ListUsersRequest listUsersRequest)This is a variant oflistUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)operation.default PutAccessControlRuleResponseputAccessControlRule(Consumer<PutAccessControlRuleRequest.Builder> putAccessControlRuleRequest)Adds a new access control rule for the specified organization.default PutAccessControlRuleResponseputAccessControlRule(PutAccessControlRuleRequest putAccessControlRuleRequest)Adds a new access control rule for the specified organization.default PutEmailMonitoringConfigurationResponseputEmailMonitoringConfiguration(Consumer<PutEmailMonitoringConfigurationRequest.Builder> putEmailMonitoringConfigurationRequest)Creates or updates the email monitoring configuration for a specified organization.default PutEmailMonitoringConfigurationResponseputEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest)Creates or updates the email monitoring configuration for a specified organization.default PutInboundDmarcSettingsResponseputInboundDmarcSettings(Consumer<PutInboundDmarcSettingsRequest.Builder> putInboundDmarcSettingsRequest)Enables or disables a DMARC policy for a given organization.default PutInboundDmarcSettingsResponseputInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest)Enables or disables a DMARC policy for a given organization.default PutMailboxPermissionsResponseputMailboxPermissions(Consumer<PutMailboxPermissionsRequest.Builder> putMailboxPermissionsRequest)Sets permissions for a user, group, or resource.default PutMailboxPermissionsResponseputMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest)Sets permissions for a user, group, or resource.default PutMobileDeviceAccessOverrideResponseputMobileDeviceAccessOverride(Consumer<PutMobileDeviceAccessOverrideRequest.Builder> putMobileDeviceAccessOverrideRequest)Creates or updates a mobile device access override for the given WorkMail organization, user, and device.default PutMobileDeviceAccessOverrideResponseputMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest)Creates or updates a mobile device access override for the given WorkMail organization, user, and device.default PutRetentionPolicyResponseputRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest)Puts a retention policy to the specified organization.default PutRetentionPolicyResponseputRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)Puts a retention policy to the specified organization.default RegisterMailDomainResponseregisterMailDomain(Consumer<RegisterMailDomainRequest.Builder> registerMailDomainRequest)Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.default RegisterMailDomainResponseregisterMailDomain(RegisterMailDomainRequest registerMailDomainRequest)Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.default RegisterToWorkMailResponseregisterToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest)Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities.default RegisterToWorkMailResponseregisterToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities.default ResetPasswordResponseresetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest)Allows the administrator to reset the password for a user.default ResetPasswordResponseresetPassword(ResetPasswordRequest resetPasswordRequest)Allows the administrator to reset the password for a user.default WorkMailServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartMailboxExportJobResponsestartMailboxExportJob(Consumer<StartMailboxExportJobRequest.Builder> startMailboxExportJobRequest)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.default StartMailboxExportJobResponsestartMailboxExportJob(StartMailboxExportJobRequest startMailboxExportJobRequest)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.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Applies the specified tags to the specified WorkMailorganization resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Applies the specified tags to the specified WorkMailorganization resource.default TestAvailabilityConfigurationResponsetestAvailabilityConfiguration(Consumer<TestAvailabilityConfigurationRequest.Builder> testAvailabilityConfigurationRequest)Performs a test on an availability provider to ensure that access is allowed.default TestAvailabilityConfigurationResponsetestAvailabilityConfiguration(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest)Performs a test on an availability provider to ensure that access is allowed.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Untags the specified tags from the specified WorkMail organization resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Untags the specified tags from the specified WorkMail organization resource.default UpdateAvailabilityConfigurationResponseupdateAvailabilityConfiguration(Consumer<UpdateAvailabilityConfigurationRequest.Builder> updateAvailabilityConfigurationRequest)Updates an existingAvailabilityConfigurationfor the given WorkMail organization and domain.default UpdateAvailabilityConfigurationResponseupdateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest)Updates an existingAvailabilityConfigurationfor the given WorkMail organization and domain.default UpdateDefaultMailDomainResponseupdateDefaultMailDomain(Consumer<UpdateDefaultMailDomainRequest.Builder> updateDefaultMailDomainRequest)Updates the default mail domain for an organization.default UpdateDefaultMailDomainResponseupdateDefaultMailDomain(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest)Updates the default mail domain for an organization.default UpdateGroupResponseupdateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)Updates attibutes in a group.default UpdateGroupResponseupdateGroup(UpdateGroupRequest updateGroupRequest)Updates attibutes in a group.default UpdateImpersonationRoleResponseupdateImpersonationRole(Consumer<UpdateImpersonationRoleRequest.Builder> updateImpersonationRoleRequest)Updates an impersonation role for the given WorkMail organization.default UpdateImpersonationRoleResponseupdateImpersonationRole(UpdateImpersonationRoleRequest updateImpersonationRoleRequest)Updates an impersonation role for the given WorkMail organization.default UpdateMailboxQuotaResponseupdateMailboxQuota(Consumer<UpdateMailboxQuotaRequest.Builder> updateMailboxQuotaRequest)Updates a user's current mailbox quota for a specified organization and user.default UpdateMailboxQuotaResponseupdateMailboxQuota(UpdateMailboxQuotaRequest updateMailboxQuotaRequest)Updates a user's current mailbox quota for a specified organization and user.default UpdateMobileDeviceAccessRuleResponseupdateMobileDeviceAccessRule(Consumer<UpdateMobileDeviceAccessRuleRequest.Builder> updateMobileDeviceAccessRuleRequest)Updates a mobile device access rule for the specified WorkMail organization.default UpdateMobileDeviceAccessRuleResponseupdateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest)Updates a mobile device access rule for the specified WorkMail organization.default UpdatePrimaryEmailAddressResponseupdatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest)Updates the primary email for a user, group, or resource.default UpdatePrimaryEmailAddressResponseupdatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)Updates the primary email for a user, group, or resource.default UpdateResourceResponseupdateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)Updates data for the resource.default UpdateResourceResponseupdateResource(UpdateResourceRequest updateResourceRequest)Updates data for the resource.default UpdateUserResponseupdateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)Updates data for the user.default UpdateUserResponseupdateUser(UpdateUserRequest updateUserRequest)Updates data for the user.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateDelegateToResource
default AssociateDelegateToResourceResponse associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Adds a member (user or group) to the resource's set of delegates.
- Parameters:
associateDelegateToResourceRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateDelegateToResource
default AssociateDelegateToResourceResponse associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Adds a member (user or group) to the resource's set of delegates.
This is a convenience which creates an instance of the
AssociateDelegateToResourceRequest.Builderavoiding the need to create one manually viaAssociateDelegateToResourceRequest.builder()- Parameters:
associateDelegateToResourceRequest- AConsumerthat will call methods onAssociateDelegateToResourceRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateMemberToGroup
default AssociateMemberToGroupResponse associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Adds a member (user or group) to the group's set.
- Parameters:
associateMemberToGroupRequest-- Returns:
- Result of the AssociateMemberToGroup operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateMemberToGroup
default AssociateMemberToGroupResponse associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Adds a member (user or group) to the group's set.
This is a convenience which creates an instance of the
AssociateMemberToGroupRequest.Builderavoiding the need to create one manually viaAssociateMemberToGroupRequest.builder()- Parameters:
associateMemberToGroupRequest- AConsumerthat will call methods onAssociateMemberToGroupRequest.Builderto create a request.- Returns:
- Result of the AssociateMemberToGroup operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
assumeImpersonationRole
default AssumeImpersonationRoleResponse assumeImpersonationRole(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
- Parameters:
assumeImpersonationRoleRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
assumeImpersonationRole
default AssumeImpersonationRoleResponse assumeImpersonationRole(Consumer<AssumeImpersonationRoleRequest.Builder> assumeImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
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
AssumeImpersonationRoleRequest.Builderavoiding the need to create one manually viaAssumeImpersonationRoleRequest.builder()- Parameters:
assumeImpersonationRoleRequest- AConsumerthat will call methods onAssumeImpersonationRoleRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
cancelMailboxExportJob
default CancelMailboxExportJobResponse cancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
- Parameters:
cancelMailboxExportJobRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
cancelMailboxExportJob
default CancelMailboxExportJobResponse cancelMailboxExportJob(Consumer<CancelMailboxExportJobRequest.Builder> cancelMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
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
CancelMailboxExportJobRequest.Builderavoiding the need to create one manually viaCancelMailboxExportJobRequest.builder()- Parameters:
cancelMailboxExportJobRequest- AConsumerthat will call methods onCancelMailboxExportJobRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAlias
default CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Adds an alias to the set of a given member (user or group) of WorkMail.
- Parameters:
createAliasRequest-- Returns:
- 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.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAlias
default CreateAliasResponse createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) throws EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
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
CreateAliasRequest.Builderavoiding the need to create one manually viaCreateAliasRequest.builder()- Parameters:
createAliasRequest- AConsumerthat will call methods onCreateAliasRequest.Builderto create a request.- Returns:
- 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.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAvailabilityConfiguration
default CreateAvailabilityConfigurationResponse createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, NameAvailabilityException, InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Creates an
AvailabilityConfigurationfor the given WorkMail organization and domain.- Parameters:
createAvailabilityConfigurationRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAvailabilityConfiguration
default CreateAvailabilityConfigurationResponse createAvailabilityConfiguration(Consumer<CreateAvailabilityConfigurationRequest.Builder> createAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, NameAvailabilityException, InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Creates an
AvailabilityConfigurationfor the given WorkMail organization and domain.
This is a convenience which creates an instance of the
CreateAvailabilityConfigurationRequest.Builderavoiding the need to create one manually viaCreateAvailabilityConfigurationRequest.builder()- Parameters:
createAvailabilityConfigurationRequest- AConsumerthat will call methods onCreateAvailabilityConfigurationRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createGroup
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
- Parameters:
createGroupRequest-- Returns:
- Result of the CreateGroup operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ReservedNameException- This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createGroup
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the
CreateGroupRequest.Builderavoiding the need to create one manually viaCreateGroupRequest.builder()- Parameters:
createGroupRequest- AConsumerthat will call methods onCreateGroupRequest.Builderto create a request.- Returns:
- Result of the CreateGroup operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ReservedNameException- This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createImpersonationRole
default CreateImpersonationRoleResponse createImpersonationRole(CreateImpersonationRoleRequest createImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
createImpersonationRoleRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createImpersonationRole
default CreateImpersonationRoleResponse createImpersonationRole(Consumer<CreateImpersonationRoleRequest.Builder> createImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
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
CreateImpersonationRoleRequest.Builderavoiding the need to create one manually viaCreateImpersonationRoleRequest.builder()- Parameters:
createImpersonationRoleRequest- AConsumerthat will call methods onCreateImpersonationRoleRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createMobileDeviceAccessRule
default CreateMobileDeviceAccessRuleResponse createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest) throws InvalidParameterException, LimitExceededException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a new mobile device access rule for the specified WorkMail organization.
- Parameters:
createMobileDeviceAccessRuleRequest-- Returns:
- 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.LimitExceededException- The request exceeds the limit of the resource.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createMobileDeviceAccessRule
default CreateMobileDeviceAccessRuleResponse createMobileDeviceAccessRule(Consumer<CreateMobileDeviceAccessRuleRequest.Builder> createMobileDeviceAccessRuleRequest) throws InvalidParameterException, LimitExceededException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a new mobile device access rule for the specified WorkMail organization.
This is a convenience which creates an instance of the
CreateMobileDeviceAccessRuleRequest.Builderavoiding the need to create one manually viaCreateMobileDeviceAccessRuleRequest.builder()- Parameters:
createMobileDeviceAccessRuleRequest- AConsumerthat will call methods onCreateMobileDeviceAccessRuleRequest.Builderto create a request.- Returns:
- 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.LimitExceededException- The request exceeds the limit of the resource.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createOrganization
default CreateOrganizationResponse createOrganization(CreateOrganizationRequest createOrganizationRequest) throws InvalidParameterException, DirectoryInUseException, DirectoryUnavailableException, LimitExceededException, NameAvailabilityException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
createOrganizationRequest-- Returns:
- 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.DirectoryInUseException- The directory is already in use by another WorkMail organization in the same account and Region.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.LimitExceededException- The request exceeds the limit of the resource.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createOrganization
default CreateOrganizationResponse createOrganization(Consumer<CreateOrganizationRequest.Builder> createOrganizationRequest) throws InvalidParameterException, DirectoryInUseException, DirectoryUnavailableException, LimitExceededException, NameAvailabilityException, AwsServiceException, SdkClientException, WorkMailException
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
CreateOrganizationRequest.Builderavoiding the need to create one manually viaCreateOrganizationRequest.builder()- Parameters:
createOrganizationRequest- AConsumerthat will call methods onCreateOrganizationRequest.Builderto create a request.- Returns:
- 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.DirectoryInUseException- The directory is already in use by another WorkMail organization in the same account and Region.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.LimitExceededException- The request exceeds the limit of the resource.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createResource
default CreateResourceResponse createResource(CreateResourceRequest createResourceRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a new WorkMail resource.
- Parameters:
createResourceRequest-- Returns:
- Result of the CreateResource operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ReservedNameException- This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createResource
default CreateResourceResponse createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a new WorkMail resource.
This is a convenience which creates an instance of the
CreateResourceRequest.Builderavoiding the need to create one manually viaCreateResourceRequest.builder()- Parameters:
createResourceRequest- AConsumerthat will call methods onCreateResourceRequest.Builderto create a request.- Returns:
- Result of the CreateResource operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ReservedNameException- This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, InvalidPasswordException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
- Parameters:
createUserRequest-- Returns:
- Result of the CreateUser operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.InvalidPasswordException- The supplied password doesn't match the minimum security constraints, such as length or use of special characters.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ReservedNameException- This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, InvalidPasswordException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the
CreateUserRequest.Builderavoiding the need to create one manually viaCreateUserRequest.builder()- Parameters:
createUserRequest- AConsumerthat will call methods onCreateUserRequest.Builderto create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.InvalidPasswordException- The supplied password doesn't match the minimum security constraints, such as length or use of special characters.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ReservedNameException- This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccessControlRule
default DeleteAccessControlRuleResponse deleteAccessControlRule(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
deleteAccessControlRuleRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccessControlRule
default DeleteAccessControlRuleResponse deleteAccessControlRule(Consumer<DeleteAccessControlRuleRequest.Builder> deleteAccessControlRuleRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
DeleteAccessControlRuleRequest.Builderavoiding the need to create one manually viaDeleteAccessControlRuleRequest.builder()- Parameters:
deleteAccessControlRuleRequest- AConsumerthat will call methods onDeleteAccessControlRuleRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAlias
default DeleteAliasResponse deleteAlias(DeleteAliasRequest deleteAliasRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Remove one or more specified aliases from a set of aliases for a given user.
- Parameters:
deleteAliasRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAlias
default DeleteAliasResponse deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
DeleteAliasRequest.Builderavoiding the need to create one manually viaDeleteAliasRequest.builder()- Parameters:
deleteAliasRequest- AConsumerthat will call methods onDeleteAliasRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAvailabilityConfiguration
default DeleteAvailabilityConfigurationResponse deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the
AvailabilityConfigurationfor the given WorkMail organization and domain.- Parameters:
deleteAvailabilityConfigurationRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAvailabilityConfiguration
default DeleteAvailabilityConfigurationResponse deleteAvailabilityConfiguration(Consumer<DeleteAvailabilityConfigurationRequest.Builder> deleteAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the
AvailabilityConfigurationfor the given WorkMail organization and domain.
This is a convenience which creates an instance of the
DeleteAvailabilityConfigurationRequest.Builderavoiding the need to create one manually viaDeleteAvailabilityConfigurationRequest.builder()- Parameters:
deleteAvailabilityConfigurationRequest- AConsumerthat will call methods onDeleteAvailabilityConfigurationRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEmailMonitoringConfiguration
default DeleteEmailMonitoringConfigurationResponse deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the email monitoring configuration for a specified organization.
- Parameters:
deleteEmailMonitoringConfigurationRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEmailMonitoringConfiguration
default DeleteEmailMonitoringConfigurationResponse deleteEmailMonitoringConfiguration(Consumer<DeleteEmailMonitoringConfigurationRequest.Builder> deleteEmailMonitoringConfigurationRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
DeleteEmailMonitoringConfigurationRequest.Builderavoiding the need to create one manually viaDeleteEmailMonitoringConfigurationRequest.builder()- Parameters:
deleteEmailMonitoringConfigurationRequest- AConsumerthat will call methods onDeleteEmailMonitoringConfigurationRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes a group from WorkMail.
- Parameters:
deleteGroupRequest-- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes a group from WorkMail.
This is a convenience which creates an instance of the
DeleteGroupRequest.Builderavoiding the need to create one manually viaDeleteGroupRequest.builder()- Parameters:
deleteGroupRequest- AConsumerthat will call methods onDeleteGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteImpersonationRole
default DeleteImpersonationRoleResponse deleteImpersonationRole(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes an impersonation role for the given WorkMail organization.
- Parameters:
deleteImpersonationRoleRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteImpersonationRole
default DeleteImpersonationRoleResponse deleteImpersonationRole(Consumer<DeleteImpersonationRoleRequest.Builder> deleteImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes an impersonation role for the given WorkMail organization.
This is a convenience which creates an instance of the
DeleteImpersonationRoleRequest.Builderavoiding the need to create one manually viaDeleteImpersonationRoleRequest.builder()- Parameters:
deleteImpersonationRoleRequest- AConsumerthat will call methods onDeleteImpersonationRoleRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMailboxPermissions
default DeleteMailboxPermissionsResponse deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes permissions granted to a member (user or group).
- Parameters:
deleteMailboxPermissionsRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMailboxPermissions
default DeleteMailboxPermissionsResponse deleteMailboxPermissions(Consumer<DeleteMailboxPermissionsRequest.Builder> deleteMailboxPermissionsRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes permissions granted to a member (user or group).
This is a convenience which creates an instance of the
DeleteMailboxPermissionsRequest.Builderavoiding the need to create one manually viaDeleteMailboxPermissionsRequest.builder()- Parameters:
deleteMailboxPermissionsRequest- AConsumerthat will call methods onDeleteMailboxPermissionsRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMobileDeviceAccessOverride
default DeleteMobileDeviceAccessOverrideResponse deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
deleteMobileDeviceAccessOverrideRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMobileDeviceAccessOverride
default DeleteMobileDeviceAccessOverrideResponse deleteMobileDeviceAccessOverride(Consumer<DeleteMobileDeviceAccessOverrideRequest.Builder> deleteMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
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
DeleteMobileDeviceAccessOverrideRequest.Builderavoiding the need to create one manually viaDeleteMobileDeviceAccessOverrideRequest.builder()- Parameters:
deleteMobileDeviceAccessOverrideRequest- AConsumerthat will call methods onDeleteMobileDeviceAccessOverrideRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMobileDeviceAccessRule
default DeleteMobileDeviceAccessRuleResponse deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
deleteMobileDeviceAccessRuleRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMobileDeviceAccessRule
default DeleteMobileDeviceAccessRuleResponse deleteMobileDeviceAccessRule(Consumer<DeleteMobileDeviceAccessRuleRequest.Builder> deleteMobileDeviceAccessRuleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
DeleteMobileDeviceAccessRuleRequest.Builderavoiding the need to create one manually viaDeleteMobileDeviceAccessRuleRequest.builder()- Parameters:
deleteMobileDeviceAccessRuleRequest- AConsumerthat will call methods onDeleteMobileDeviceAccessRuleRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteOrganization
default DeleteOrganizationResponse deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
deleteOrganizationRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteOrganization
default DeleteOrganizationResponse deleteOrganization(Consumer<DeleteOrganizationRequest.Builder> deleteOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
DeleteOrganizationRequest.Builderavoiding the need to create one manually viaDeleteOrganizationRequest.builder()- Parameters:
deleteOrganizationRequest- AConsumerthat will call methods onDeleteOrganizationRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResource
default DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest) throws EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes the specified resource.
- Parameters:
deleteResourceRequest-- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResource
default DeleteResourceResponse deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) throws EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes the specified resource.
This is a convenience which creates an instance of the
DeleteResourceRequest.Builderavoiding the need to create one manually viaDeleteResourceRequest.builder()- Parameters:
deleteResourceRequest- AConsumerthat will call methods onDeleteResourceRequest.Builderto create a request.- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRetentionPolicy
default DeleteRetentionPolicyResponse deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the specified retention policy from the specified organization.
- Parameters:
deleteRetentionPolicyRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRetentionPolicy
default DeleteRetentionPolicyResponse deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the specified retention policy from the specified organization.
This is a convenience which creates an instance of the
DeleteRetentionPolicyRequest.Builderavoiding the need to create one manually viaDeleteRetentionPolicyRequest.builder()- Parameters:
deleteRetentionPolicyRequest- AConsumerthat will call methods onDeleteRetentionPolicyRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
deleteUserRequest-- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
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
DeleteUserRequest.Builderavoiding the need to create one manually viaDeleteUserRequest.builder()- Parameters:
deleteUserRequest- AConsumerthat will call methods onDeleteUserRequest.Builderto create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterFromWorkMail
default DeregisterFromWorkMailResponse deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
deregisterFromWorkMailRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterFromWorkMail
default DeregisterFromWorkMailResponse deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
DeregisterFromWorkMailRequest.Builderavoiding the need to create one manually viaDeregisterFromWorkMailRequest.builder()- Parameters:
deregisterFromWorkMailRequest- AConsumerthat will call methods onDeregisterFromWorkMailRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterMailDomain
default DeregisterMailDomainResponse deregisterMailDomain(DeregisterMailDomainRequest deregisterMailDomainRequest) throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, InvalidCustomSesConfigurationException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
deregisterMailDomainRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.InvalidCustomSesConfigurationException- You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterMailDomain
default DeregisterMailDomainResponse deregisterMailDomain(Consumer<DeregisterMailDomainRequest.Builder> deregisterMailDomainRequest) throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, InvalidCustomSesConfigurationException, AwsServiceException, SdkClientException, WorkMailException
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
DeregisterMailDomainRequest.Builderavoiding the need to create one manually viaDeregisterMailDomainRequest.builder()- Parameters:
deregisterMailDomainRequest- AConsumerthat will call methods onDeregisterMailDomainRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.InvalidCustomSesConfigurationException- You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEmailMonitoringConfiguration
default DescribeEmailMonitoringConfigurationResponse describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Describes the current email monitoring configuration for a specified organization.
- Parameters:
describeEmailMonitoringConfigurationRequest-- Returns:
- Result of the DescribeEmailMonitoringConfiguration operation returned by the service.
- Throws:
ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEmailMonitoringConfiguration
default DescribeEmailMonitoringConfigurationResponse describeEmailMonitoringConfiguration(Consumer<DescribeEmailMonitoringConfigurationRequest.Builder> describeEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Describes the current email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
DescribeEmailMonitoringConfigurationRequest.Builderavoiding the need to create one manually viaDescribeEmailMonitoringConfigurationRequest.builder()- Parameters:
describeEmailMonitoringConfigurationRequest- AConsumerthat will call methods onDescribeEmailMonitoringConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeEmailMonitoringConfiguration operation returned by the service.
- Throws:
ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEntity
default DescribeEntityResponse describeEntity(DescribeEntityRequest describeEntityRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns basic details about an entity in WorkMail.
- Parameters:
describeEntityRequest-- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEntity
default DescribeEntityResponse describeEntity(Consumer<DescribeEntityRequest.Builder> describeEntityRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns basic details about an entity in WorkMail.
This is a convenience which creates an instance of the
DescribeEntityRequest.Builderavoiding the need to create one manually viaDescribeEntityRequest.builder()- Parameters:
describeEntityRequest- AConsumerthat will call methods onDescribeEntityRequest.Builderto create a request.- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroup
default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the group.
- Parameters:
describeGroupRequest-- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroup
default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the group.
This is a convenience which creates an instance of the
DescribeGroupRequest.Builderavoiding the need to create one manually viaDescribeGroupRequest.builder()- Parameters:
describeGroupRequest- AConsumerthat will call methods onDescribeGroupRequest.Builderto create a request.- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeInboundDmarcSettings
default DescribeInboundDmarcSettingsResponse describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the settings in a DMARC policy for a specified organization.
- Parameters:
describeInboundDmarcSettingsRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeInboundDmarcSettings
default DescribeInboundDmarcSettingsResponse describeInboundDmarcSettings(Consumer<DescribeInboundDmarcSettingsRequest.Builder> describeInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the settings in a DMARC policy for a specified organization.
This is a convenience which creates an instance of the
DescribeInboundDmarcSettingsRequest.Builderavoiding the need to create one manually viaDescribeInboundDmarcSettingsRequest.builder()- Parameters:
describeInboundDmarcSettingsRequest- AConsumerthat will call methods onDescribeInboundDmarcSettingsRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMailboxExportJob
default DescribeMailboxExportJobResponse describeMailboxExportJob(DescribeMailboxExportJobRequest describeMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Describes the current status of a mailbox export job.
- Parameters:
describeMailboxExportJobRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMailboxExportJob
default DescribeMailboxExportJobResponse describeMailboxExportJob(Consumer<DescribeMailboxExportJobRequest.Builder> describeMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Describes the current status of a mailbox export job.
This is a convenience which creates an instance of the
DescribeMailboxExportJobRequest.Builderavoiding the need to create one manually viaDescribeMailboxExportJobRequest.builder()- Parameters:
describeMailboxExportJobRequest- AConsumerthat will call methods onDescribeMailboxExportJobRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeOrganization
default DescribeOrganizationResponse describeOrganization(DescribeOrganizationRequest describeOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Provides more information regarding a given organization based on its identifier.
- Parameters:
describeOrganizationRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeOrganization
default DescribeOrganizationResponse describeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Provides more information regarding a given organization based on its identifier.
This is a convenience which creates an instance of the
DescribeOrganizationRequest.Builderavoiding the need to create one manually viaDescribeOrganizationRequest.builder()- Parameters:
describeOrganizationRequest- AConsumerthat will call methods onDescribeOrganizationRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeResource
default DescribeResourceResponse describeResource(DescribeResourceRequest describeResourceRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the resource.
- Parameters:
describeResourceRequest-- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeResource
default DescribeResourceResponse describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the resource.
This is a convenience which creates an instance of the
DescribeResourceRequest.Builderavoiding the need to create one manually viaDescribeResourceRequest.builder()- Parameters:
describeResourceRequest- AConsumerthat will call methods onDescribeResourceRequest.Builderto create a request.- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeUser
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Provides information regarding the user.
- Parameters:
describeUserRequest-- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeUser
default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Provides information regarding the user.
This is a convenience which creates an instance of the
DescribeUserRequest.Builderavoiding the need to create one manually viaDescribeUserRequest.builder()- Parameters:
describeUserRequest- AConsumerthat will call methods onDescribeUserRequest.Builderto create a request.- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateDelegateFromResource
default DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from the resource's set of delegates.
- Parameters:
disassociateDelegateFromResourceRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateDelegateFromResource
default DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from the resource's set of delegates.
This is a convenience which creates an instance of the
DisassociateDelegateFromResourceRequest.Builderavoiding the need to create one manually viaDisassociateDelegateFromResourceRequest.builder()- Parameters:
disassociateDelegateFromResourceRequest- AConsumerthat will call methods onDisassociateDelegateFromResourceRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateMemberFromGroup
default DisassociateMemberFromGroupResponse disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from a group.
- Parameters:
disassociateMemberFromGroupRequest-- Returns:
- Result of the DisassociateMemberFromGroup operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateMemberFromGroup
default DisassociateMemberFromGroupResponse disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from a group.
This is a convenience which creates an instance of the
DisassociateMemberFromGroupRequest.Builderavoiding the need to create one manually viaDisassociateMemberFromGroupRequest.builder()- Parameters:
disassociateMemberFromGroupRequest- AConsumerthat will call methods onDisassociateMemberFromGroupRequest.Builderto create a request.- Returns:
- Result of the DisassociateMemberFromGroup operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAccessControlEffect
default GetAccessControlEffectResponse getAccessControlEffect(GetAccessControlEffectRequest getAccessControlEffectRequest) throws EntityNotFoundException, ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
getAccessControlEffectRequest-- Returns:
- 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.ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAccessControlEffect
default GetAccessControlEffectResponse getAccessControlEffect(Consumer<GetAccessControlEffectRequest.Builder> getAccessControlEffectRequest) throws EntityNotFoundException, ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
GetAccessControlEffectRequest.Builderavoiding the need to create one manually viaGetAccessControlEffectRequest.builder()- Parameters:
getAccessControlEffectRequest- AConsumerthat will call methods onGetAccessControlEffectRequest.Builderto create a request.- Returns:
- 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.ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDefaultRetentionPolicy
default GetDefaultRetentionPolicyResponse getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Gets the default retention policy details for the specified organization.
- Parameters:
getDefaultRetentionPolicyRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDefaultRetentionPolicy
default GetDefaultRetentionPolicyResponse getDefaultRetentionPolicy(Consumer<GetDefaultRetentionPolicyRequest.Builder> getDefaultRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Gets the default retention policy details for the specified organization.
This is a convenience which creates an instance of the
GetDefaultRetentionPolicyRequest.Builderavoiding the need to create one manually viaGetDefaultRetentionPolicyRequest.builder()- Parameters:
getDefaultRetentionPolicyRequest- AConsumerthat will call methods onGetDefaultRetentionPolicyRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getImpersonationRole
default GetImpersonationRoleResponse getImpersonationRole(GetImpersonationRoleRequest getImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Gets the impersonation role details for the given WorkMail organization.
- Parameters:
getImpersonationRoleRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getImpersonationRole
default GetImpersonationRoleResponse getImpersonationRole(Consumer<GetImpersonationRoleRequest.Builder> getImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Gets the impersonation role details for the given WorkMail organization.
This is a convenience which creates an instance of the
GetImpersonationRoleRequest.Builderavoiding the need to create one manually viaGetImpersonationRoleRequest.builder()- Parameters:
getImpersonationRoleRequest- AConsumerthat will call methods onGetImpersonationRoleRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getImpersonationRoleEffect
default GetImpersonationRoleEffectResponse getImpersonationRoleEffect(GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException
Tests whether the given impersonation role can impersonate a target user.
- Parameters:
getImpersonationRoleEffectRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getImpersonationRoleEffect
default GetImpersonationRoleEffectResponse getImpersonationRoleEffect(Consumer<GetImpersonationRoleEffectRequest.Builder> getImpersonationRoleEffectRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException
Tests whether the given impersonation role can impersonate a target user.
This is a convenience which creates an instance of the
GetImpersonationRoleEffectRequest.Builderavoiding the need to create one manually viaGetImpersonationRoleEffectRequest.builder()- Parameters:
getImpersonationRoleEffectRequest- AConsumerthat will call methods onGetImpersonationRoleEffectRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMailDomain
default GetMailDomainResponse getMailDomain(GetMailDomainRequest getMailDomainRequest) throws MailDomainNotFoundException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
- Parameters:
getMailDomainRequest-- Returns:
- Result of the GetMailDomain operation returned by the service.
- Throws:
MailDomainNotFoundException- The domain specified is not found in your organization.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMailDomain
default GetMailDomainResponse getMailDomain(Consumer<GetMailDomainRequest.Builder> getMailDomainRequest) throws MailDomainNotFoundException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
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
GetMailDomainRequest.Builderavoiding the need to create one manually viaGetMailDomainRequest.builder()- Parameters:
getMailDomainRequest- AConsumerthat will call methods onGetMailDomainRequest.Builderto create a request.- Returns:
- Result of the GetMailDomain operation returned by the service.
- Throws:
MailDomainNotFoundException- The domain specified is not found in your organization.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMailboxDetails
default GetMailboxDetailsResponse getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Requests a user's mailbox details for a specified organization and user.
- Parameters:
getMailboxDetailsRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMailboxDetails
default GetMailboxDetailsResponse getMailboxDetails(Consumer<GetMailboxDetailsRequest.Builder> getMailboxDetailsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Requests a user's mailbox details for a specified organization and user.
This is a convenience which creates an instance of the
GetMailboxDetailsRequest.Builderavoiding the need to create one manually viaGetMailboxDetailsRequest.builder()- Parameters:
getMailboxDetailsRequest- AConsumerthat will call methods onGetMailboxDetailsRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMobileDeviceAccessEffect
default GetMobileDeviceAccessEffectResponse getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
getMobileDeviceAccessEffectRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMobileDeviceAccessEffect
default GetMobileDeviceAccessEffectResponse getMobileDeviceAccessEffect(Consumer<GetMobileDeviceAccessEffectRequest.Builder> getMobileDeviceAccessEffectRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
GetMobileDeviceAccessEffectRequest.Builderavoiding the need to create one manually viaGetMobileDeviceAccessEffectRequest.builder()- Parameters:
getMobileDeviceAccessEffectRequest- AConsumerthat will call methods onGetMobileDeviceAccessEffectRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMobileDeviceAccessOverride
default GetMobileDeviceAccessOverrideResponse getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Gets the mobile device access override for the given WorkMail organization, user, and device.
- Parameters:
getMobileDeviceAccessOverrideRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMobileDeviceAccessOverride
default GetMobileDeviceAccessOverrideResponse getMobileDeviceAccessOverride(Consumer<GetMobileDeviceAccessOverrideRequest.Builder> getMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Gets the mobile device access override for the given WorkMail organization, user, and device.
This is a convenience which creates an instance of the
GetMobileDeviceAccessOverrideRequest.Builderavoiding the need to create one manually viaGetMobileDeviceAccessOverrideRequest.builder()- Parameters:
getMobileDeviceAccessOverrideRequest- AConsumerthat will call methods onGetMobileDeviceAccessOverrideRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessControlRules
default ListAccessControlRulesResponse listAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the access control rules for the specified organization.
- Parameters:
listAccessControlRulesRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessControlRules
default ListAccessControlRulesResponse listAccessControlRules(Consumer<ListAccessControlRulesRequest.Builder> listAccessControlRulesRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the access control rules for the specified organization.
This is a convenience which creates an instance of the
ListAccessControlRulesRequest.Builderavoiding the need to create one manually viaListAccessControlRulesRequest.builder()- Parameters:
listAccessControlRulesRequest- AConsumerthat will call methods onListAccessControlRulesRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAliases
default ListAliasesResponse listAliases(ListAliasesRequest listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a paginated call to list the aliases associated with a given entity.
- Parameters:
listAliasesRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAliases
default ListAliasesResponse listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a paginated call to list the aliases associated with a given entity.
This is a convenience which creates an instance of the
ListAliasesRequest.Builderavoiding the need to create one manually viaListAliasesRequest.builder()- Parameters:
listAliasesRequest- AConsumerthat will call methods onListAliasesRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAliasesPaginator
default ListAliasesIterable listAliasesPaginator(ListAliasesRequest listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)operation.- Parameters:
listAliasesRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAliasesPaginator
default ListAliasesIterable listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)operation.
This is a convenience which creates an instance of the
ListAliasesRequest.Builderavoiding the need to create one manually viaListAliasesRequest.builder()- Parameters:
listAliasesRequest- AConsumerthat will call methods onListAliasesRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAvailabilityConfigurations
default ListAvailabilityConfigurationsResponse listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
List all the
AvailabilityConfiguration's for the given WorkMail organization.- Parameters:
listAvailabilityConfigurationsRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAvailabilityConfigurations
default ListAvailabilityConfigurationsResponse listAvailabilityConfigurations(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
List all the
AvailabilityConfiguration's for the given WorkMail organization.
This is a convenience which creates an instance of the
ListAvailabilityConfigurationsRequest.Builderavoiding the need to create one manually viaListAvailabilityConfigurationsRequest.builder()- Parameters:
listAvailabilityConfigurationsRequest- AConsumerthat will call methods onListAvailabilityConfigurationsRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAvailabilityConfigurationsPaginator
default ListAvailabilityConfigurationsIterable listAvailabilityConfigurationsPaginator(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)operation.- Parameters:
listAvailabilityConfigurationsRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAvailabilityConfigurationsPaginator
default ListAvailabilityConfigurationsIterable listAvailabilityConfigurationsPaginator(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)operation.
This is a convenience which creates an instance of the
ListAvailabilityConfigurationsRequest.Builderavoiding the need to create one manually viaListAvailabilityConfigurationsRequest.builder()- Parameters:
listAvailabilityConfigurationsRequest- AConsumerthat will call methods onListAvailabilityConfigurationsRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembers
default ListGroupMembersResponse listGroupMembers(ListGroupMembersRequest listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns an overview of the members of a group. Users and groups can be members of a group.
- Parameters:
listGroupMembersRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembers
default ListGroupMembersResponse listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
ListGroupMembersRequest.Builderavoiding the need to create one manually viaListGroupMembersRequest.builder()- Parameters:
listGroupMembersRequest- AConsumerthat will call methods onListGroupMembersRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembersPaginator
default ListGroupMembersIterable listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)operation.- Parameters:
listGroupMembersRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembersPaginator
default ListGroupMembersIterable listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)operation.
This is a convenience which creates an instance of the
ListGroupMembersRequest.Builderavoiding the need to create one manually viaListGroupMembersRequest.builder()- Parameters:
listGroupMembersRequest- AConsumerthat will call methods onListGroupMembersRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's groups.
- Parameters:
listGroupsRequest-- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's groups.
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)operation.- Parameters:
listGroupsRequest-- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)operation.
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsForEntity
default ListGroupsForEntityResponse listGroupsForEntity(ListGroupsForEntityRequest listGroupsForEntityRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns all the groups to which an entity belongs.
- Parameters:
listGroupsForEntityRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsForEntity
default ListGroupsForEntityResponse listGroupsForEntity(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns all the groups to which an entity belongs.
This is a convenience which creates an instance of the
ListGroupsForEntityRequest.Builderavoiding the need to create one manually viaListGroupsForEntityRequest.builder()- Parameters:
listGroupsForEntityRequest- AConsumerthat will call methods onListGroupsForEntityRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsForEntityPaginator
default ListGroupsForEntityIterable listGroupsForEntityPaginator(ListGroupsForEntityRequest listGroupsForEntityRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)operation.- Parameters:
listGroupsForEntityRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsForEntityPaginator
default ListGroupsForEntityIterable listGroupsForEntityPaginator(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)operation.
This is a convenience which creates an instance of the
ListGroupsForEntityRequest.Builderavoiding the need to create one manually viaListGroupsForEntityRequest.builder()- Parameters:
listGroupsForEntityRequest- AConsumerthat will call methods onListGroupsForEntityRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImpersonationRoles
default ListImpersonationRolesResponse listImpersonationRoles(ListImpersonationRolesRequest listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists all the impersonation roles for the given WorkMail organization.
- Parameters:
listImpersonationRolesRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImpersonationRoles
default ListImpersonationRolesResponse listImpersonationRoles(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists all the impersonation roles for the given WorkMail organization.
This is a convenience which creates an instance of the
ListImpersonationRolesRequest.Builderavoiding the need to create one manually viaListImpersonationRolesRequest.builder()- Parameters:
listImpersonationRolesRequest- AConsumerthat will call methods onListImpersonationRolesRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImpersonationRolesPaginator
default ListImpersonationRolesIterable listImpersonationRolesPaginator(ListImpersonationRolesRequest listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)operation.- Parameters:
listImpersonationRolesRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImpersonationRolesPaginator
default ListImpersonationRolesIterable listImpersonationRolesPaginator(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)operation.
This is a convenience which creates an instance of the
ListImpersonationRolesRequest.Builderavoiding the need to create one manually viaListImpersonationRolesRequest.builder()- Parameters:
listImpersonationRolesRequest- AConsumerthat will call methods onListImpersonationRolesRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailDomains
default ListMailDomainsResponse listMailDomains(ListMailDomainsRequest listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mail domains in a given WorkMail organization.
- Parameters:
listMailDomainsRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailDomains
default ListMailDomainsResponse listMailDomains(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mail domains in a given WorkMail organization.
This is a convenience which creates an instance of the
ListMailDomainsRequest.Builderavoiding the need to create one manually viaListMailDomainsRequest.builder()- Parameters:
listMailDomainsRequest- AConsumerthat will call methods onListMailDomainsRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailDomainsPaginator
default ListMailDomainsIterable listMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)operation.- Parameters:
listMailDomainsRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailDomainsPaginator
default ListMailDomainsIterable listMailDomainsPaginator(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)operation.
This is a convenience which creates an instance of the
ListMailDomainsRequest.Builderavoiding the need to create one manually viaListMailDomainsRequest.builder()- Parameters:
listMailDomainsRequest- AConsumerthat will call methods onListMailDomainsRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailboxExportJobs
default ListMailboxExportJobsResponse listMailboxExportJobs(ListMailboxExportJobsRequest listMailboxExportJobsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mailbox export jobs started for the specified organization within the last seven days.
- Parameters:
listMailboxExportJobsRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailboxExportJobs
default ListMailboxExportJobsResponse listMailboxExportJobs(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
ListMailboxExportJobsRequest.Builderavoiding the need to create one manually viaListMailboxExportJobsRequest.builder()- Parameters:
listMailboxExportJobsRequest- AConsumerthat will call methods onListMailboxExportJobsRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailboxExportJobsPaginator
default ListMailboxExportJobsIterable listMailboxExportJobsPaginator(ListMailboxExportJobsRequest listMailboxExportJobsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)operation.- Parameters:
listMailboxExportJobsRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailboxExportJobsPaginator
default ListMailboxExportJobsIterable listMailboxExportJobsPaginator(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)operation.
This is a convenience which creates an instance of the
ListMailboxExportJobsRequest.Builderavoiding the need to create one manually viaListMailboxExportJobsRequest.builder()- Parameters:
listMailboxExportJobsRequest- AConsumerthat will call methods onListMailboxExportJobsRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailboxPermissions
default ListMailboxPermissionsResponse listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mailbox permissions associated with a user, group, or resource mailbox.
- Parameters:
listMailboxPermissionsRequest-- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailboxPermissions
default ListMailboxPermissionsResponse listMailboxPermissions(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mailbox permissions associated with a user, group, or resource mailbox.
This is a convenience which creates an instance of the
ListMailboxPermissionsRequest.Builderavoiding the need to create one manually viaListMailboxPermissionsRequest.builder()- Parameters:
listMailboxPermissionsRequest- AConsumerthat will call methods onListMailboxPermissionsRequest.Builderto create a request.- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailboxPermissionsPaginator
default ListMailboxPermissionsIterable listMailboxPermissionsPaginator(ListMailboxPermissionsRequest listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)operation.- Parameters:
listMailboxPermissionsRequest-- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMailboxPermissionsPaginator
default ListMailboxPermissionsIterable listMailboxPermissionsPaginator(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)operation.
This is a convenience which creates an instance of the
ListMailboxPermissionsRequest.Builderavoiding the need to create one manually viaListMailboxPermissionsRequest.builder()- Parameters:
listMailboxPermissionsRequest- AConsumerthat will call methods onListMailboxPermissionsRequest.Builderto create a request.- Returns:
- 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.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMobileDeviceAccessOverrides
default ListMobileDeviceAccessOverridesResponse listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
- Parameters:
listMobileDeviceAccessOverridesRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMobileDeviceAccessOverrides
default ListMobileDeviceAccessOverridesResponse listMobileDeviceAccessOverrides(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
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
ListMobileDeviceAccessOverridesRequest.Builderavoiding the need to create one manually viaListMobileDeviceAccessOverridesRequest.builder()- Parameters:
listMobileDeviceAccessOverridesRequest- AConsumerthat will call methods onListMobileDeviceAccessOverridesRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMobileDeviceAccessOverridesPaginator
default ListMobileDeviceAccessOverridesIterable listMobileDeviceAccessOverridesPaginator(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)operation.- Parameters:
listMobileDeviceAccessOverridesRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMobileDeviceAccessOverridesPaginator
default ListMobileDeviceAccessOverridesIterable listMobileDeviceAccessOverridesPaginator(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)operation.
This is a convenience which creates an instance of the
ListMobileDeviceAccessOverridesRequest.Builderavoiding the need to create one manually viaListMobileDeviceAccessOverridesRequest.builder()- Parameters:
listMobileDeviceAccessOverridesRequest- AConsumerthat will call methods onListMobileDeviceAccessOverridesRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMobileDeviceAccessRules
default ListMobileDeviceAccessRulesResponse listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mobile device access rules for the specified WorkMail organization.
- Parameters:
listMobileDeviceAccessRulesRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMobileDeviceAccessRules
default ListMobileDeviceAccessRulesResponse listMobileDeviceAccessRules(Consumer<ListMobileDeviceAccessRulesRequest.Builder> listMobileDeviceAccessRulesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mobile device access rules for the specified WorkMail organization.
This is a convenience which creates an instance of the
ListMobileDeviceAccessRulesRequest.Builderavoiding the need to create one manually viaListMobileDeviceAccessRulesRequest.builder()- Parameters:
listMobileDeviceAccessRulesRequest- AConsumerthat will call methods onListMobileDeviceAccessRulesRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listOrganizations
default ListOrganizationsResponse listOrganizations(ListOrganizationsRequest listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's organizations.
- Parameters:
listOrganizationsRequest-- Returns:
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listOrganizations
default ListOrganizationsResponse listOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's organizations.
This is a convenience which creates an instance of the
ListOrganizationsRequest.Builderavoiding the need to create one manually viaListOrganizationsRequest.builder()- Parameters:
listOrganizationsRequest- AConsumerthat will call methods onListOrganizationsRequest.Builderto create a request.- Returns:
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listOrganizations
default ListOrganizationsResponse listOrganizations() throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's organizations.
- Returns:
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listOrganizations(ListOrganizationsRequest), AWS API Documentation
-
listOrganizationsPaginator
default ListOrganizationsIterable listOrganizationsPaginator() throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)operation.- Returns:
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listOrganizationsPaginator(ListOrganizationsRequest), AWS API Documentation
-
listOrganizationsPaginator
default ListOrganizationsIterable listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)operation.- Parameters:
listOrganizationsRequest-- Returns:
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listOrganizationsPaginator
default ListOrganizationsIterable listOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)operation.
This is a convenience which creates an instance of the
ListOrganizationsRequest.Builderavoiding the need to create one manually viaListOrganizationsRequest.builder()- Parameters:
listOrganizationsRequest- AConsumerthat will call methods onListOrganizationsRequest.Builderto create a request.- Returns:
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceDelegates
default ListResourceDelegatesResponse listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
- Parameters:
listResourceDelegatesRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceDelegates
default ListResourceDelegatesResponse listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
This is a convenience which creates an instance of the
ListResourceDelegatesRequest.Builderavoiding the need to create one manually viaListResourceDelegatesRequest.builder()- Parameters:
listResourceDelegatesRequest- AConsumerthat will call methods onListResourceDelegatesRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceDelegatesPaginator
default ListResourceDelegatesIterable listResourceDelegatesPaginator(ListResourceDelegatesRequest listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)operation.- Parameters:
listResourceDelegatesRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceDelegatesPaginator
default ListResourceDelegatesIterable listResourceDelegatesPaginator(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)operation.
This is a convenience which creates an instance of the
ListResourceDelegatesRequest.Builderavoiding the need to create one manually viaListResourceDelegatesRequest.builder()- Parameters:
listResourceDelegatesRequest- AConsumerthat will call methods onListResourceDelegatesRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listResources
default ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's resources.
- Parameters:
listResourcesRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listResources
default ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's resources.
This is a convenience which creates an instance of the
ListResourcesRequest.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)operation.- Parameters:
listResourcesRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)operation.
This is a convenience which creates an instance of the
ListResourcesRequest.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Lists the tags applied to an WorkMail organization resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Lists the tags applied to an WorkMail organization resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listUsers
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's users.
- Parameters:
listUsersRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listUsers
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's users.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)operation.- Parameters:
listUsersRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)operation.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putAccessControlRule
default PutAccessControlRuleResponse putAccessControlRule(PutAccessControlRuleRequest putAccessControlRuleRequest) throws LimitExceededException, InvalidParameterException, EntityNotFoundException, ResourceNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
putAccessControlRuleRequest-- Returns:
- Result of the PutAccessControlRule operation returned by the service.
- Throws:
LimitExceededException- The request exceeds the limit of the resource.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException- The resource cannot be found.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putAccessControlRule
default PutAccessControlRuleResponse putAccessControlRule(Consumer<PutAccessControlRuleRequest.Builder> putAccessControlRuleRequest) throws LimitExceededException, InvalidParameterException, EntityNotFoundException, ResourceNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
PutAccessControlRuleRequest.Builderavoiding the need to create one manually viaPutAccessControlRuleRequest.builder()- Parameters:
putAccessControlRuleRequest- AConsumerthat will call methods onPutAccessControlRuleRequest.Builderto create a request.- Returns:
- Result of the PutAccessControlRule operation returned by the service.
- Throws:
LimitExceededException- The request exceeds the limit of the resource.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException- The resource cannot be found.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putEmailMonitoringConfiguration
default PutEmailMonitoringConfigurationResponse putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates or updates the email monitoring configuration for a specified organization.
- Parameters:
putEmailMonitoringConfigurationRequest-- Returns:
- Result of the PutEmailMonitoringConfiguration operation returned by the service.
- Throws:
ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putEmailMonitoringConfiguration
default PutEmailMonitoringConfigurationResponse putEmailMonitoringConfiguration(Consumer<PutEmailMonitoringConfigurationRequest.Builder> putEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates or updates the email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
PutEmailMonitoringConfigurationRequest.Builderavoiding the need to create one manually viaPutEmailMonitoringConfigurationRequest.builder()- Parameters:
putEmailMonitoringConfigurationRequest- AConsumerthat will call methods onPutEmailMonitoringConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutEmailMonitoringConfiguration operation returned by the service.
- Throws:
ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putInboundDmarcSettings
default PutInboundDmarcSettingsResponse putInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Enables or disables a DMARC policy for a given organization.
- Parameters:
putInboundDmarcSettingsRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putInboundDmarcSettings
default PutInboundDmarcSettingsResponse putInboundDmarcSettings(Consumer<PutInboundDmarcSettingsRequest.Builder> putInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Enables or disables a DMARC policy for a given organization.
This is a convenience which creates an instance of the
PutInboundDmarcSettingsRequest.Builderavoiding the need to create one manually viaPutInboundDmarcSettingsRequest.builder()- Parameters:
putInboundDmarcSettingsRequest- AConsumerthat will call methods onPutInboundDmarcSettingsRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putMailboxPermissions
default PutMailboxPermissionsResponse putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
- Parameters:
putMailboxPermissionsRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putMailboxPermissions
default PutMailboxPermissionsResponse putMailboxPermissions(Consumer<PutMailboxPermissionsRequest.Builder> putMailboxPermissionsRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
This is a convenience which creates an instance of the
PutMailboxPermissionsRequest.Builderavoiding the need to create one manually viaPutMailboxPermissionsRequest.builder()- Parameters:
putMailboxPermissionsRequest- AConsumerthat will call methods onPutMailboxPermissionsRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putMobileDeviceAccessOverride
default PutMobileDeviceAccessOverrideResponse putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
- Parameters:
putMobileDeviceAccessOverrideRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putMobileDeviceAccessOverride
default PutMobileDeviceAccessOverrideResponse putMobileDeviceAccessOverride(Consumer<PutMobileDeviceAccessOverrideRequest.Builder> putMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException
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
PutMobileDeviceAccessOverrideRequest.Builderavoiding the need to create one manually viaPutMobileDeviceAccessOverrideRequest.builder()- Parameters:
putMobileDeviceAccessOverrideRequest- AConsumerthat will call methods onPutMobileDeviceAccessOverrideRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putRetentionPolicy
default PutRetentionPolicyResponse putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Puts a retention policy to the specified organization.
- Parameters:
putRetentionPolicyRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putRetentionPolicy
default PutRetentionPolicyResponse putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Puts a retention policy to the specified organization.
This is a convenience which creates an instance of the
PutRetentionPolicyRequest.Builderavoiding the need to create one manually viaPutRetentionPolicyRequest.builder()- Parameters:
putRetentionPolicyRequest- AConsumerthat will call methods onPutRetentionPolicyRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
registerMailDomain
default RegisterMailDomainResponse registerMailDomain(RegisterMailDomainRequest registerMailDomainRequest) throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
registerMailDomainRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.LimitExceededException- The request exceeds the limit of the resource.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
registerMailDomain
default RegisterMailDomainResponse registerMailDomain(Consumer<RegisterMailDomainRequest.Builder> registerMailDomainRequest) throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
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
RegisterMailDomainRequest.Builderavoiding the need to create one manually viaRegisterMailDomainRequest.builder()- Parameters:
registerMailDomainRequest- AConsumerthat will call methods onRegisterMailDomainRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.LimitExceededException- The request exceeds the limit of the resource.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
registerToWorkMail
default RegisterToWorkMailResponse registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, EntityAlreadyRegisteredException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
registerToWorkMailRequest-- Returns:
- Result of the RegisterToWorkMail operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EmailAddressInUseException- The email address that you're trying to assign is already created for a different user, group, or resource.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.EntityAlreadyRegisteredException- The user, group, or resource that you're trying to register is already registered.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
registerToWorkMail
default RegisterToWorkMailResponse registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, EntityAlreadyRegisteredException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
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
RegisterToWorkMailRequest.Builderavoiding the need to create one manually viaRegisterToWorkMailRequest.builder()- Parameters:
registerToWorkMailRequest- AConsumerthat will call methods onRegisterToWorkMailRequest.Builderto create a request.- Returns:
- Result of the RegisterToWorkMail operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EmailAddressInUseException- The email address that you're trying to assign is already created for a different user, group, or resource.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.EntityAlreadyRegisteredException- The user, group, or resource that you're trying to register is already registered.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resetPassword
default ResetPasswordResponse resetPassword(ResetPasswordRequest resetPasswordRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, InvalidPasswordException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Allows the administrator to reset the password for a user.
- Parameters:
resetPasswordRequest-- Returns:
- Result of the ResetPassword operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.InvalidPasswordException- The supplied password doesn't match the minimum security constraints, such as length or use of special characters.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resetPassword
default ResetPasswordResponse resetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, InvalidPasswordException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Allows the administrator to reset the password for a user.
This is a convenience which creates an instance of the
ResetPasswordRequest.Builderavoiding the need to create one manually viaResetPasswordRequest.builder()- Parameters:
resetPasswordRequest- AConsumerthat will call methods onResetPasswordRequest.Builderto create a request.- Returns:
- Result of the ResetPassword operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.InvalidPasswordException- The supplied password doesn't match the minimum security constraints, such as length or use of special characters.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startMailboxExportJob
default StartMailboxExportJobResponse startMailboxExportJob(StartMailboxExportJobRequest startMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
startMailboxExportJobRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startMailboxExportJob
default StartMailboxExportJobResponse startMailboxExportJob(Consumer<StartMailboxExportJobRequest.Builder> startMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
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
StartMailboxExportJobRequest.Builderavoiding the need to create one manually viaStartMailboxExportJobRequest.builder()- Parameters:
startMailboxExportJobRequest- AConsumerthat will call methods onStartMailboxExportJobRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyTagsException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Applies the specified tags to the specified WorkMailorganization resource.
- Parameters:
tagResourceRequest-- Returns:
- 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.ResourceNotFoundException- The resource cannot be found.TooManyTagsException- The resource can have up to 50 user-applied tags.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyTagsException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Applies the specified tags to the specified WorkMailorganization resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- 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.ResourceNotFoundException- The resource cannot be found.TooManyTagsException- The resource can have up to 50 user-applied tags.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
testAvailabilityConfiguration
default TestAvailabilityConfigurationResponse testAvailabilityConfiguration(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
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
SourceArnorSourceAccountheader.The request must contain either one provider definition (
EwsProviderorLambdaProvider) or theDomainNameparameter. If theDomainNameparameter is provided, the configuration stored under theDomainNamewill be tested.- Parameters:
testAvailabilityConfigurationRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
testAvailabilityConfiguration
default TestAvailabilityConfigurationResponse testAvailabilityConfiguration(Consumer<TestAvailabilityConfigurationRequest.Builder> testAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
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
SourceArnorSourceAccountheader.The request must contain either one provider definition (
EwsProviderorLambdaProvider) or theDomainNameparameter. If theDomainNameparameter is provided, the configuration stored under theDomainNamewill be tested.
This is a convenience which creates an instance of the
TestAvailabilityConfigurationRequest.Builderavoiding the need to create one manually viaTestAvailabilityConfigurationRequest.builder()- Parameters:
testAvailabilityConfigurationRequest- AConsumerthat will call methods onTestAvailabilityConfigurationRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Untags the specified tags from the specified WorkMail organization resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Untags the specified tags from the specified WorkMail organization resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The resource cannot be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAvailabilityConfiguration
default UpdateAvailabilityConfigurationResponse updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Updates an existing
AvailabilityConfigurationfor the given WorkMail organization and domain.- Parameters:
updateAvailabilityConfigurationRequest-- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAvailabilityConfiguration
default UpdateAvailabilityConfigurationResponse updateAvailabilityConfiguration(Consumer<UpdateAvailabilityConfigurationRequest.Builder> updateAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Updates an existing
AvailabilityConfigurationfor the given WorkMail organization and domain.
This is a convenience which creates an instance of the
UpdateAvailabilityConfigurationRequest.Builderavoiding the need to create one manually viaUpdateAvailabilityConfigurationRequest.builder()- Parameters:
updateAvailabilityConfigurationRequest- AConsumerthat will call methods onUpdateAvailabilityConfigurationRequest.Builderto create a request.- Returns:
- 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.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDefaultMailDomain
default UpdateDefaultMailDomainResponse updateDefaultMailDomain(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest) throws MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
updateDefaultMailDomainRequest-- Returns:
- Result of the UpdateDefaultMailDomain operation returned by the service.
- Throws:
MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDefaultMailDomain
default UpdateDefaultMailDomainResponse updateDefaultMailDomain(Consumer<UpdateDefaultMailDomainRequest.Builder> updateDefaultMailDomainRequest) throws MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
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
UpdateDefaultMailDomainRequest.Builderavoiding the need to create one manually viaUpdateDefaultMailDomainRequest.builder()- Parameters:
updateDefaultMailDomainRequest- AConsumerthat will call methods onUpdateDefaultMailDomainRequest.Builderto create a request.- Returns:
- Result of the UpdateDefaultMailDomain operation returned by the service.
- Throws:
MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateGroup
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Updates attibutes in a group.
- Parameters:
updateGroupRequest-- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateGroup
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Updates attibutes in a group.
This is a convenience which creates an instance of the
UpdateGroupRequest.Builderavoiding the need to create one manually viaUpdateGroupRequest.builder()- Parameters:
updateGroupRequest- AConsumerthat will call methods onUpdateGroupRequest.Builderto create a request.- Returns:
- 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.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateImpersonationRole
default UpdateImpersonationRoleResponse updateImpersonationRole(UpdateImpersonationRoleRequest updateImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException, EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Updates an impersonation role for the given WorkMail organization.
- Parameters:
updateImpersonationRoleRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateImpersonationRole
default UpdateImpersonationRoleResponse updateImpersonationRole(Consumer<UpdateImpersonationRoleRequest.Builder> updateImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException, EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Updates an impersonation role for the given WorkMail organization.
This is a convenience which creates an instance of the
UpdateImpersonationRoleRequest.Builderavoiding the need to create one manually viaUpdateImpersonationRoleRequest.builder()- Parameters:
updateImpersonationRoleRequest- AConsumerthat will call methods onUpdateImpersonationRoleRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.ResourceNotFoundException- The resource cannot be found.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.LimitExceededException- The request exceeds the limit of the resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateMailboxQuota
default UpdateMailboxQuotaResponse updateMailboxQuota(UpdateMailboxQuotaRequest updateMailboxQuotaRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException
Updates a user's current mailbox quota for a specified organization and user.
- Parameters:
updateMailboxQuotaRequest-- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateMailboxQuota
default UpdateMailboxQuotaResponse updateMailboxQuota(Consumer<UpdateMailboxQuotaRequest.Builder> updateMailboxQuotaRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException
Updates a user's current mailbox quota for a specified organization and user.
This is a convenience which creates an instance of the
UpdateMailboxQuotaRequest.Builderavoiding the need to create one manually viaUpdateMailboxQuotaRequest.builder()- Parameters:
updateMailboxQuotaRequest- AConsumerthat will call methods onUpdateMailboxQuotaRequest.Builderto create a request.- Returns:
- 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.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateMobileDeviceAccessRule
default UpdateMobileDeviceAccessRuleResponse updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest) throws InvalidParameterException, EntityNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Updates a mobile device access rule for the specified WorkMail organization.
- Parameters:
updateMobileDeviceAccessRuleRequest-- Returns:
- 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.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateMobileDeviceAccessRule
default UpdateMobileDeviceAccessRuleResponse updateMobileDeviceAccessRule(Consumer<UpdateMobileDeviceAccessRuleRequest.Builder> updateMobileDeviceAccessRuleRequest) throws InvalidParameterException, EntityNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Updates a mobile device access rule for the specified WorkMail organization.
This is a convenience which creates an instance of the
UpdateMobileDeviceAccessRuleRequest.Builderavoiding the need to create one manually viaUpdateMobileDeviceAccessRuleRequest.builder()- Parameters:
updateMobileDeviceAccessRuleRequest- AConsumerthat will call methods onUpdateMobileDeviceAccessRuleRequest.Builderto create a request.- Returns:
- 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.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePrimaryEmailAddress
default UpdatePrimaryEmailAddressResponse updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
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.
- Parameters:
updatePrimaryEmailAddressRequest-- Returns:
- Result of the UpdatePrimaryEmailAddress operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EmailAddressInUseException- The email address that you're trying to assign is already created for a different user, group, or resource.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePrimaryEmailAddress
default UpdatePrimaryEmailAddressResponse updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
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
UpdatePrimaryEmailAddressRequest.Builderavoiding the need to create one manually viaUpdatePrimaryEmailAddressRequest.builder()- Parameters:
updatePrimaryEmailAddressRequest- AConsumerthat will call methods onUpdatePrimaryEmailAddressRequest.Builderto create a request.- Returns:
- Result of the UpdatePrimaryEmailAddress operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EmailAddressInUseException- The email address that you're trying to assign is already created for a different user, group, or resource.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateResource
default UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException, EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
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
DescribeResourcecall.- Parameters:
updateResourceRequest-- Returns:
- Result of the UpdateResource operation returned by the service.
- Throws:
DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.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.EmailAddressInUseException- The email address that you're trying to assign is already created for a different user, group, or resource.MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateResource
default UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException, EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
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
DescribeResourcecall.
This is a convenience which creates an instance of the
UpdateResourceRequest.Builderavoiding the need to create one manually viaUpdateResourceRequest.builder()- Parameters:
updateResourceRequest- AConsumerthat will call methods onUpdateResourceRequest.Builderto create a request.- Returns:
- Result of the UpdateResource operation returned by the service.
- Throws:
DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.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.EmailAddressInUseException- The email address that you're trying to assign is already created for a different user, group, or resource.MailDomainNotFoundException- The domain specified is not found in your organization.MailDomainStateException- After a domain has been added to the organization, it must be verified. The domain is not yet verified.NameAvailabilityException- The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException
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
DescribeUsercall.- Parameters:
updateUserRequest-- Returns:
- Result of the UpdateUser operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException
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
DescribeUsercall.
This is a convenience which creates an instance of the
UpdateUserRequest.Builderavoiding the need to create one manually viaUpdateUserRequest.builder()- Parameters:
updateUserRequest- AConsumerthat will call methods onUpdateUserRequest.Builderto create a request.- Returns:
- Result of the UpdateUser operation returned by the service.
- Throws:
DirectoryServiceAuthenticationFailedException- The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException- The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException- The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException- One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException- An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException- The organization must have a valid state to perform certain operations on the organization or its members.UnsupportedOperationException- You can't perform a write operation against a read-only directory.EntityStateException- You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static WorkMailClient create()
Create aWorkMailClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static WorkMailClientBuilder builder()
Create a builder that can be used to configure and create aWorkMailClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default WorkMailServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-