Interface WorkMailAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The WorkMail API is designed for the following scenarios:
-
Listing and describing organizations
-
Managing users
-
Managing groups
-
Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateDelegateToResource
(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest) Adds a member (user or group) to the resource's set of delegates.associateDelegateToResource
(AssociateDelegateToResourceRequest associateDelegateToResourceRequest) Adds a member (user or group) to the resource's set of delegates.associateMemberToGroup
(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest) Adds a member (user or group) to the group's set.associateMemberToGroup
(AssociateMemberToGroupRequest associateMemberToGroupRequest) Adds a member (user or group) to the group's set.assumeImpersonationRole
(Consumer<AssumeImpersonationRoleRequest.Builder> assumeImpersonationRoleRequest) Assumes an impersonation role for the given WorkMail organization.assumeImpersonationRole
(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest) Assumes an impersonation role for the given WorkMail organization.static WorkMailAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aWorkMailAsyncClient
.cancelMailboxExportJob
(Consumer<CancelMailboxExportJobRequest.Builder> cancelMailboxExportJobRequest) Cancels a mailbox export job.cancelMailboxExportJob
(CancelMailboxExportJobRequest cancelMailboxExportJobRequest) Cancels a mailbox export job.static WorkMailAsyncClient
create()
Create aWorkMailAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAliasResponse> createAlias
(Consumer<CreateAliasRequest.Builder> createAliasRequest) Adds an alias to the set of a given member (user or group) of WorkMail.default CompletableFuture
<CreateAliasResponse> createAlias
(CreateAliasRequest createAliasRequest) Adds an alias to the set of a given member (user or group) of WorkMail.createAvailabilityConfiguration
(Consumer<CreateAvailabilityConfigurationRequest.Builder> createAvailabilityConfigurationRequest) Creates anAvailabilityConfiguration
for the given WorkMail organization and domain.createAvailabilityConfiguration
(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest) Creates anAvailabilityConfiguration
for the given WorkMail organization and domain.default CompletableFuture
<CreateGroupResponse> createGroup
(Consumer<CreateGroupRequest.Builder> createGroupRequest) Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.default CompletableFuture
<CreateGroupResponse> createGroup
(CreateGroupRequest createGroupRequest) Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.createImpersonationRole
(Consumer<CreateImpersonationRoleRequest.Builder> createImpersonationRoleRequest) Creates an impersonation role for the given WorkMail organization.createImpersonationRole
(CreateImpersonationRoleRequest createImpersonationRoleRequest) Creates an impersonation role for the given WorkMail organization.createMobileDeviceAccessRule
(Consumer<CreateMobileDeviceAccessRuleRequest.Builder> createMobileDeviceAccessRuleRequest) Creates a new mobile device access rule for the specified WorkMail organization.createMobileDeviceAccessRule
(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest) Creates a new mobile device access rule for the specified WorkMail organization.createOrganization
(Consumer<CreateOrganizationRequest.Builder> createOrganizationRequest) Creates a new WorkMail organization.createOrganization
(CreateOrganizationRequest createOrganizationRequest) Creates a new WorkMail organization.default CompletableFuture
<CreateResourceResponse> createResource
(Consumer<CreateResourceRequest.Builder> createResourceRequest) Creates a new WorkMail resource.default CompletableFuture
<CreateResourceResponse> createResource
(CreateResourceRequest createResourceRequest) Creates a new WorkMail resource.default CompletableFuture
<CreateUserResponse> createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.default CompletableFuture
<CreateUserResponse> createUser
(CreateUserRequest createUserRequest) Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.deleteAccessControlRule
(Consumer<DeleteAccessControlRuleRequest.Builder> deleteAccessControlRuleRequest) Deletes an access control rule for the specified WorkMail organization.deleteAccessControlRule
(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest) Deletes an access control rule for the specified WorkMail organization.default CompletableFuture
<DeleteAliasResponse> deleteAlias
(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) Remove one or more specified aliases from a set of aliases for a given user.default CompletableFuture
<DeleteAliasResponse> deleteAlias
(DeleteAliasRequest deleteAliasRequest) Remove one or more specified aliases from a set of aliases for a given user.deleteAvailabilityConfiguration
(Consumer<DeleteAvailabilityConfigurationRequest.Builder> deleteAvailabilityConfigurationRequest) Deletes theAvailabilityConfiguration
for the given WorkMail organization and domain.deleteAvailabilityConfiguration
(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest) Deletes theAvailabilityConfiguration
for the given WorkMail organization and domain.deleteEmailMonitoringConfiguration
(Consumer<DeleteEmailMonitoringConfigurationRequest.Builder> deleteEmailMonitoringConfigurationRequest) Deletes the email monitoring configuration for a specified organization.deleteEmailMonitoringConfiguration
(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest) Deletes the email monitoring configuration for a specified organization.default CompletableFuture
<DeleteGroupResponse> deleteGroup
(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Deletes a group from WorkMail.default CompletableFuture
<DeleteGroupResponse> deleteGroup
(DeleteGroupRequest deleteGroupRequest) Deletes a group from WorkMail.deleteImpersonationRole
(Consumer<DeleteImpersonationRoleRequest.Builder> deleteImpersonationRoleRequest) Deletes an impersonation role for the given WorkMail organization.deleteImpersonationRole
(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest) Deletes an impersonation role for the given WorkMail organization.deleteMailboxPermissions
(Consumer<DeleteMailboxPermissionsRequest.Builder> deleteMailboxPermissionsRequest) Deletes permissions granted to a member (user or group).deleteMailboxPermissions
(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest) Deletes permissions granted to a member (user or group).deleteMobileDeviceAccessOverride
(Consumer<DeleteMobileDeviceAccessOverrideRequest.Builder> deleteMobileDeviceAccessOverrideRequest) Deletes the mobile device access override for the given WorkMail organization, user, and device.deleteMobileDeviceAccessOverride
(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest) Deletes the mobile device access override for the given WorkMail organization, user, and device.deleteMobileDeviceAccessRule
(Consumer<DeleteMobileDeviceAccessRuleRequest.Builder> deleteMobileDeviceAccessRuleRequest) Deletes a mobile device access rule for the specified WorkMail organization.deleteMobileDeviceAccessRule
(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest) Deletes a mobile device access rule for the specified WorkMail organization.deleteOrganization
(Consumer<DeleteOrganizationRequest.Builder> deleteOrganizationRequest) Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization.deleteOrganization
(DeleteOrganizationRequest deleteOrganizationRequest) Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization.default CompletableFuture
<DeleteResourceResponse> deleteResource
(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) Deletes the specified resource.default CompletableFuture
<DeleteResourceResponse> deleteResource
(DeleteResourceRequest deleteResourceRequest) Deletes the specified resource.deleteRetentionPolicy
(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest) Deletes the specified retention policy from the specified organization.deleteRetentionPolicy
(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) Deletes the specified retention policy from the specified organization.default CompletableFuture
<DeleteUserResponse> deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user from WorkMail and all subsequent systems.default CompletableFuture
<DeleteUserResponse> deleteUser
(DeleteUserRequest deleteUserRequest) Deletes a user from WorkMail and all subsequent systems.deregisterFromWorkMail
(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest) Mark a user, group, or resource as no longer used in WorkMail.deregisterFromWorkMail
(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest) Mark a user, group, or resource as no longer used in WorkMail.deregisterMailDomain
(Consumer<DeregisterMailDomainRequest.Builder> deregisterMailDomainRequest) Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.deregisterMailDomain
(DeregisterMailDomainRequest deregisterMailDomainRequest) Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.describeEmailMonitoringConfiguration
(Consumer<DescribeEmailMonitoringConfigurationRequest.Builder> describeEmailMonitoringConfigurationRequest) Describes the current email monitoring configuration for a specified organization.describeEmailMonitoringConfiguration
(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest) Describes the current email monitoring configuration for a specified organization.default CompletableFuture
<DescribeEntityResponse> describeEntity
(Consumer<DescribeEntityRequest.Builder> describeEntityRequest) Returns basic details about an entity in WorkMail.default CompletableFuture
<DescribeEntityResponse> describeEntity
(DescribeEntityRequest describeEntityRequest) Returns basic details about an entity in WorkMail.default CompletableFuture
<DescribeGroupResponse> describeGroup
(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Returns the data available for the group.default CompletableFuture
<DescribeGroupResponse> describeGroup
(DescribeGroupRequest describeGroupRequest) Returns the data available for the group.describeInboundDmarcSettings
(Consumer<DescribeInboundDmarcSettingsRequest.Builder> describeInboundDmarcSettingsRequest) Lists the settings in a DMARC policy for a specified organization.describeInboundDmarcSettings
(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest) Lists the settings in a DMARC policy for a specified organization.describeMailboxExportJob
(Consumer<DescribeMailboxExportJobRequest.Builder> describeMailboxExportJobRequest) Describes the current status of a mailbox export job.describeMailboxExportJob
(DescribeMailboxExportJobRequest describeMailboxExportJobRequest) Describes the current status of a mailbox export job.describeOrganization
(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest) Provides more information regarding a given organization based on its identifier.describeOrganization
(DescribeOrganizationRequest describeOrganizationRequest) Provides more information regarding a given organization based on its identifier.describeResource
(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) Returns the data available for the resource.describeResource
(DescribeResourceRequest describeResourceRequest) Returns the data available for the resource.default CompletableFuture
<DescribeUserResponse> describeUser
(Consumer<DescribeUserRequest.Builder> describeUserRequest) Provides information regarding the user.default CompletableFuture
<DescribeUserResponse> describeUser
(DescribeUserRequest describeUserRequest) Provides information regarding the user.disassociateDelegateFromResource
(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest) Removes a member from the resource's set of delegates.disassociateDelegateFromResource
(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest) Removes a member from the resource's set of delegates.disassociateMemberFromGroup
(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest) Removes a member from a group.disassociateMemberFromGroup
(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest) Removes a member from a group.getAccessControlEffect
(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.getAccessControlEffect
(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.getDefaultRetentionPolicy
(Consumer<GetDefaultRetentionPolicyRequest.Builder> getDefaultRetentionPolicyRequest) Gets the default retention policy details for the specified organization.getDefaultRetentionPolicy
(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest) Gets the default retention policy details for the specified organization.getImpersonationRole
(Consumer<GetImpersonationRoleRequest.Builder> getImpersonationRoleRequest) Gets the impersonation role details for the given WorkMail organization.getImpersonationRole
(GetImpersonationRoleRequest getImpersonationRoleRequest) Gets the impersonation role details for the given WorkMail organization.getImpersonationRoleEffect
(Consumer<GetImpersonationRoleEffectRequest.Builder> getImpersonationRoleEffectRequest) Tests whether the given impersonation role can impersonate a target user.getImpersonationRoleEffect
(GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest) Tests whether the given impersonation role can impersonate a target user.getMailboxDetails
(Consumer<GetMailboxDetailsRequest.Builder> getMailboxDetailsRequest) Requests a user's mailbox details for a specified organization and user.getMailboxDetails
(GetMailboxDetailsRequest getMailboxDetailsRequest) Requests a user's mailbox details for a specified organization and user.default CompletableFuture
<GetMailDomainResponse> getMailDomain
(Consumer<GetMailDomainRequest.Builder> getMailDomainRequest) Gets details for a mail domain, including domain records required to configure your domain with recommended security.default CompletableFuture
<GetMailDomainResponse> getMailDomain
(GetMailDomainRequest getMailDomainRequest) Gets details for a mail domain, including domain records required to configure your domain with recommended security.getMobileDeviceAccessEffect
(Consumer<GetMobileDeviceAccessEffectRequest.Builder> getMobileDeviceAccessEffectRequest) Simulates the effect of the mobile device access rules for the given attributes of a sample access event.getMobileDeviceAccessEffect
(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest) Simulates the effect of the mobile device access rules for the given attributes of a sample access event.getMobileDeviceAccessOverride
(Consumer<GetMobileDeviceAccessOverrideRequest.Builder> getMobileDeviceAccessOverrideRequest) Gets the mobile device access override for the given WorkMail organization, user, and device.getMobileDeviceAccessOverride
(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest) Gets the mobile device access override for the given WorkMail organization, user, and device.listAccessControlRules
(Consumer<ListAccessControlRulesRequest.Builder> listAccessControlRulesRequest) Lists the access control rules for the specified organization.listAccessControlRules
(ListAccessControlRulesRequest listAccessControlRulesRequest) Lists the access control rules for the specified organization.default CompletableFuture
<ListAliasesResponse> listAliases
(Consumer<ListAliasesRequest.Builder> listAliasesRequest) Creates a paginated call to list the aliases associated with a given entity.default CompletableFuture
<ListAliasesResponse> listAliases
(ListAliasesRequest listAliasesRequest) Creates a paginated call to list the aliases associated with a given entity.default ListAliasesPublisher
listAliasesPaginator
(Consumer<ListAliasesRequest.Builder> listAliasesRequest) This is a variant oflistAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation.default ListAliasesPublisher
listAliasesPaginator
(ListAliasesRequest listAliasesRequest) This is a variant oflistAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation.listAvailabilityConfigurations
(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest) List all theAvailabilityConfiguration
's for the given WorkMail organization.listAvailabilityConfigurations
(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) List all theAvailabilityConfiguration
's for the given WorkMail organization.listAvailabilityConfigurationsPaginator
(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest) This is a variant oflistAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation.listAvailabilityConfigurationsPaginator
(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) This is a variant oflistAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation.listGroupMembers
(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) Returns an overview of the members of a group.listGroupMembers
(ListGroupMembersRequest listGroupMembersRequest) Returns an overview of the members of a group.default ListGroupMembersPublisher
listGroupMembersPaginator
(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) This is a variant oflistGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation.default ListGroupMembersPublisher
listGroupMembersPaginator
(ListGroupMembersRequest listGroupMembersRequest) This is a variant oflistGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation.default CompletableFuture
<ListGroupsResponse> listGroups
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Returns summaries of the organization's groups.default CompletableFuture
<ListGroupsResponse> listGroups
(ListGroupsRequest listGroupsRequest) Returns summaries of the organization's groups.listGroupsForEntity
(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) Returns all the groups to which an entity belongs.listGroupsForEntity
(ListGroupsForEntityRequest listGroupsForEntityRequest) Returns all the groups to which an entity belongs.default ListGroupsForEntityPublisher
listGroupsForEntityPaginator
(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) This is a variant oflistGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation.default ListGroupsForEntityPublisher
listGroupsForEntityPaginator
(ListGroupsForEntityRequest listGroupsForEntityRequest) This is a variant oflistGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation.default ListGroupsPublisher
listGroupsPaginator
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation.default ListGroupsPublisher
listGroupsPaginator
(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation.listImpersonationRoles
(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) Lists all the impersonation roles for the given WorkMail organization.listImpersonationRoles
(ListImpersonationRolesRequest listImpersonationRolesRequest) Lists all the impersonation roles for the given WorkMail organization.default ListImpersonationRolesPublisher
listImpersonationRolesPaginator
(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) This is a variant oflistImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation.default ListImpersonationRolesPublisher
listImpersonationRolesPaginator
(ListImpersonationRolesRequest listImpersonationRolesRequest) This is a variant oflistImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation.listMailboxExportJobs
(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) Lists the mailbox export jobs started for the specified organization within the last seven days.listMailboxExportJobs
(ListMailboxExportJobsRequest listMailboxExportJobsRequest) Lists the mailbox export jobs started for the specified organization within the last seven days.default ListMailboxExportJobsPublisher
listMailboxExportJobsPaginator
(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) This is a variant oflistMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation.default ListMailboxExportJobsPublisher
listMailboxExportJobsPaginator
(ListMailboxExportJobsRequest listMailboxExportJobsRequest) This is a variant oflistMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation.listMailboxPermissions
(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) Lists the mailbox permissions associated with a user, group, or resource mailbox.listMailboxPermissions
(ListMailboxPermissionsRequest listMailboxPermissionsRequest) Lists the mailbox permissions associated with a user, group, or resource mailbox.default ListMailboxPermissionsPublisher
listMailboxPermissionsPaginator
(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) This is a variant oflistMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation.default ListMailboxPermissionsPublisher
listMailboxPermissionsPaginator
(ListMailboxPermissionsRequest listMailboxPermissionsRequest) This is a variant oflistMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation.default CompletableFuture
<ListMailDomainsResponse> listMailDomains
(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) Lists the mail domains in a given WorkMail organization.default CompletableFuture
<ListMailDomainsResponse> listMailDomains
(ListMailDomainsRequest listMailDomainsRequest) Lists the mail domains in a given WorkMail organization.default ListMailDomainsPublisher
listMailDomainsPaginator
(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) This is a variant oflistMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)
operation.default ListMailDomainsPublisher
listMailDomainsPaginator
(ListMailDomainsRequest listMailDomainsRequest) This is a variant oflistMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)
operation.listMobileDeviceAccessOverrides
(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest) Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.listMobileDeviceAccessOverrides
(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.listMobileDeviceAccessOverridesPaginator
(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest) This is a variant oflistMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation.listMobileDeviceAccessOverridesPaginator
(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) This is a variant oflistMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation.listMobileDeviceAccessRules
(Consumer<ListMobileDeviceAccessRulesRequest.Builder> listMobileDeviceAccessRulesRequest) Lists the mobile device access rules for the specified WorkMail organization.listMobileDeviceAccessRules
(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest) Lists the mobile device access rules for the specified WorkMail organization.Returns summaries of the customer's organizations.listOrganizations
(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) Returns summaries of the customer's organizations.listOrganizations
(ListOrganizationsRequest listOrganizationsRequest) Returns summaries of the customer's organizations.default ListOrganizationsPublisher
This is a variant oflistOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.default ListOrganizationsPublisher
listOrganizationsPaginator
(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) This is a variant oflistOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.default ListOrganizationsPublisher
listOrganizationsPaginator
(ListOrganizationsRequest listOrganizationsRequest) This is a variant oflistOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.listResourceDelegates
(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) Lists the delegates associated with a resource.listResourceDelegates
(ListResourceDelegatesRequest listResourceDelegatesRequest) Lists the delegates associated with a resource.default ListResourceDelegatesPublisher
listResourceDelegatesPaginator
(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) This is a variant oflistResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation.default ListResourceDelegatesPublisher
listResourceDelegatesPaginator
(ListResourceDelegatesRequest listResourceDelegatesRequest) This is a variant oflistResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation.default CompletableFuture
<ListResourcesResponse> listResources
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Returns summaries of the organization's resources.default CompletableFuture
<ListResourcesResponse> listResources
(ListResourcesRequest listResourcesRequest) Returns summaries of the organization's resources.default ListResourcesPublisher
listResourcesPaginator
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation.default ListResourcesPublisher
listResourcesPaginator
(ListResourcesRequest listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to an WorkMail organization resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to an WorkMail organization resource.default CompletableFuture
<ListUsersResponse> listUsers
(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns summaries of the organization's users.default CompletableFuture
<ListUsersResponse> listUsers
(ListUsersRequest listUsersRequest) Returns summaries of the organization's users.default ListUsersPublisher
listUsersPaginator
(Consumer<ListUsersRequest.Builder> listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation.default ListUsersPublisher
listUsersPaginator
(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation.putAccessControlRule
(Consumer<PutAccessControlRuleRequest.Builder> putAccessControlRuleRequest) Adds a new access control rule for the specified organization.putAccessControlRule
(PutAccessControlRuleRequest putAccessControlRuleRequest) Adds a new access control rule for the specified organization.putEmailMonitoringConfiguration
(Consumer<PutEmailMonitoringConfigurationRequest.Builder> putEmailMonitoringConfigurationRequest) Creates or updates the email monitoring configuration for a specified organization.putEmailMonitoringConfiguration
(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest) Creates or updates the email monitoring configuration for a specified organization.putInboundDmarcSettings
(Consumer<PutInboundDmarcSettingsRequest.Builder> putInboundDmarcSettingsRequest) Enables or disables a DMARC policy for a given organization.putInboundDmarcSettings
(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest) Enables or disables a DMARC policy for a given organization.putMailboxPermissions
(Consumer<PutMailboxPermissionsRequest.Builder> putMailboxPermissionsRequest) Sets permissions for a user, group, or resource.putMailboxPermissions
(PutMailboxPermissionsRequest putMailboxPermissionsRequest) Sets permissions for a user, group, or resource.putMobileDeviceAccessOverride
(Consumer<PutMobileDeviceAccessOverrideRequest.Builder> putMobileDeviceAccessOverrideRequest) Creates or updates a mobile device access override for the given WorkMail organization, user, and device.putMobileDeviceAccessOverride
(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest) Creates or updates a mobile device access override for the given WorkMail organization, user, and device.putRetentionPolicy
(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest) Puts a retention policy to the specified organization.putRetentionPolicy
(PutRetentionPolicyRequest putRetentionPolicyRequest) Puts a retention policy to the specified organization.registerMailDomain
(Consumer<RegisterMailDomainRequest.Builder> registerMailDomainRequest) Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.registerMailDomain
(RegisterMailDomainRequest registerMailDomainRequest) Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.registerToWorkMail
(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest) Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities.registerToWorkMail
(RegisterToWorkMailRequest registerToWorkMailRequest) Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities.default CompletableFuture
<ResetPasswordResponse> resetPassword
(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest) Allows the administrator to reset the password for a user.default CompletableFuture
<ResetPasswordResponse> resetPassword
(ResetPasswordRequest resetPasswordRequest) Allows the administrator to reset the password for a user.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartMailboxExportJob
(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.startMailboxExportJob
(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 CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies the specified tags to the specified WorkMailorganization resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Applies the specified tags to the specified WorkMailorganization resource.testAvailabilityConfiguration
(Consumer<TestAvailabilityConfigurationRequest.Builder> testAvailabilityConfigurationRequest) Performs a test on an availability provider to ensure that access is allowed.testAvailabilityConfiguration
(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest) Performs a test on an availability provider to ensure that access is allowed.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Untags the specified tags from the specified WorkMail organization resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Untags the specified tags from the specified WorkMail organization resource.updateAvailabilityConfiguration
(Consumer<UpdateAvailabilityConfigurationRequest.Builder> updateAvailabilityConfigurationRequest) Updates an existingAvailabilityConfiguration
for the given WorkMail organization and domain.updateAvailabilityConfiguration
(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest) Updates an existingAvailabilityConfiguration
for the given WorkMail organization and domain.updateDefaultMailDomain
(Consumer<UpdateDefaultMailDomainRequest.Builder> updateDefaultMailDomainRequest) Updates the default mail domain for an organization.updateDefaultMailDomain
(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest) Updates the default mail domain for an organization.default CompletableFuture
<UpdateGroupResponse> updateGroup
(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Updates attibutes in a group.default CompletableFuture
<UpdateGroupResponse> updateGroup
(UpdateGroupRequest updateGroupRequest) Updates attibutes in a group.updateImpersonationRole
(Consumer<UpdateImpersonationRoleRequest.Builder> updateImpersonationRoleRequest) Updates an impersonation role for the given WorkMail organization.updateImpersonationRole
(UpdateImpersonationRoleRequest updateImpersonationRoleRequest) Updates an impersonation role for the given WorkMail organization.updateMailboxQuota
(Consumer<UpdateMailboxQuotaRequest.Builder> updateMailboxQuotaRequest) Updates a user's current mailbox quota for a specified organization and user.updateMailboxQuota
(UpdateMailboxQuotaRequest updateMailboxQuotaRequest) Updates a user's current mailbox quota for a specified organization and user.updateMobileDeviceAccessRule
(Consumer<UpdateMobileDeviceAccessRuleRequest.Builder> updateMobileDeviceAccessRuleRequest) Updates a mobile device access rule for the specified WorkMail organization.updateMobileDeviceAccessRule
(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest) Updates a mobile device access rule for the specified WorkMail organization.updatePrimaryEmailAddress
(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest) Updates the primary email for a user, group, or resource.updatePrimaryEmailAddress
(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest) Updates the primary email for a user, group, or resource.default CompletableFuture
<UpdateResourceResponse> updateResource
(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) Updates data for the resource.default CompletableFuture
<UpdateResourceResponse> updateResource
(UpdateResourceRequest updateResourceRequest) Updates data for the resource.default CompletableFuture
<UpdateUserResponse> updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates data for the user.default CompletableFuture
<UpdateUserResponse> updateUser
(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 Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateDelegateToResource
default CompletableFuture<AssociateDelegateToResourceResponse> associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest) Adds a member (user or group) to the resource's set of delegates.
- Parameters:
associateDelegateToResourceRequest
-- Returns:
- A Java Future containing the result of the AssociateDelegateToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateDelegateToResource
default CompletableFuture<AssociateDelegateToResourceResponse> associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest) Adds a member (user or group) to the resource's set of delegates.
This is a convenience which creates an instance of the
AssociateDelegateToResourceRequest.Builder
avoiding the need to create one manually viaAssociateDelegateToResourceRequest.builder()
- Parameters:
associateDelegateToResourceRequest
- AConsumer
that will call methods onAssociateDelegateToResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateDelegateToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateMemberToGroup
default CompletableFuture<AssociateMemberToGroupResponse> associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest) Adds a member (user or group) to the group's set.
- Parameters:
associateMemberToGroupRequest
-- Returns:
- A Java Future containing the result of the AssociateMemberToGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateMemberToGroup
default CompletableFuture<AssociateMemberToGroupResponse> associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest) Adds a member (user or group) to the group's set.
This is a convenience which creates an instance of the
AssociateMemberToGroupRequest.Builder
avoiding the need to create one manually viaAssociateMemberToGroupRequest.builder()
- Parameters:
associateMemberToGroupRequest
- AConsumer
that will call methods onAssociateMemberToGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateMemberToGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
assumeImpersonationRole
default CompletableFuture<AssumeImpersonationRoleResponse> assumeImpersonationRole(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest) 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:
- A Java Future containing the result of the AssumeImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
assumeImpersonationRole
default CompletableFuture<AssumeImpersonationRoleResponse> assumeImpersonationRole(Consumer<AssumeImpersonationRoleRequest.Builder> assumeImpersonationRoleRequest) 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.Builder
avoiding the need to create one manually viaAssumeImpersonationRoleRequest.builder()
- Parameters:
assumeImpersonationRoleRequest
- AConsumer
that will call methods onAssumeImpersonationRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssumeImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelMailboxExportJob
default CompletableFuture<CancelMailboxExportJobResponse> cancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest) Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
- Parameters:
cancelMailboxExportJobRequest
-- Returns:
- A Java Future containing the result of the CancelMailboxExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelMailboxExportJob
default CompletableFuture<CancelMailboxExportJobResponse> cancelMailboxExportJob(Consumer<CancelMailboxExportJobRequest.Builder> cancelMailboxExportJobRequest) 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.Builder
avoiding the need to create one manually viaCancelMailboxExportJobRequest.builder()
- Parameters:
cancelMailboxExportJobRequest
- AConsumer
that will call methods onCancelMailboxExportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelMailboxExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAlias
Adds an alias to the set of a given member (user or group) of WorkMail.
- Parameters:
createAliasRequest
-- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- MailDomainNotFoundException The domain specified is not found in your organization.
- MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- LimitExceededException The request exceeds the limit of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAlias
default CompletableFuture<CreateAliasResponse> createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) 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.Builder
avoiding the need to create one manually viaCreateAliasRequest.builder()
- Parameters:
createAliasRequest
- AConsumer
that will call methods onCreateAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- MailDomainNotFoundException The domain specified is not found in your organization.
- MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- LimitExceededException The request exceeds the limit of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAvailabilityConfiguration
default CompletableFuture<CreateAvailabilityConfigurationResponse> createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest) Creates an
AvailabilityConfiguration
for the given WorkMail organization and domain.- Parameters:
createAvailabilityConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateAvailabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- LimitExceededException The request exceeds the limit of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAvailabilityConfiguration
default CompletableFuture<CreateAvailabilityConfigurationResponse> createAvailabilityConfiguration(Consumer<CreateAvailabilityConfigurationRequest.Builder> createAvailabilityConfigurationRequest) Creates an
AvailabilityConfiguration
for the given WorkMail organization and domain.
This is a convenience which creates an instance of the
CreateAvailabilityConfigurationRequest.Builder
avoiding the need to create one manually viaCreateAvailabilityConfigurationRequest.builder()
- Parameters:
createAvailabilityConfigurationRequest
- AConsumer
that will call methods onCreateAvailabilityConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAvailabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- LimitExceededException The request exceeds the limit of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroup
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
- Parameters:
createGroupRequest
-- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ReservedNameException This user, group, or resource name is not allowed in WorkMail.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroup
default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) 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.Builder
avoiding the need to create one manually viaCreateGroupRequest.builder()
- Parameters:
createGroupRequest
- AConsumer
that will call methods onCreateGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ReservedNameException This user, group, or resource name is not allowed in WorkMail.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createImpersonationRole
default CompletableFuture<CreateImpersonationRoleResponse> createImpersonationRole(CreateImpersonationRoleRequest createImpersonationRoleRequest) 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:
- A Java Future containing the result of the CreateImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- LimitExceededException The request exceeds the limit of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createImpersonationRole
default CompletableFuture<CreateImpersonationRoleResponse> createImpersonationRole(Consumer<CreateImpersonationRoleRequest.Builder> createImpersonationRoleRequest) 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.Builder
avoiding the need to create one manually viaCreateImpersonationRoleRequest.builder()
- Parameters:
createImpersonationRoleRequest
- AConsumer
that will call methods onCreateImpersonationRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- LimitExceededException The request exceeds the limit of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMobileDeviceAccessRule
default CompletableFuture<CreateMobileDeviceAccessRuleResponse> createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest) Creates a new mobile device access rule for the specified WorkMail organization.
- Parameters:
createMobileDeviceAccessRuleRequest
-- Returns:
- A Java Future containing the result of the CreateMobileDeviceAccessRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- LimitExceededException The request exceeds the limit of the resource.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMobileDeviceAccessRule
default CompletableFuture<CreateMobileDeviceAccessRuleResponse> createMobileDeviceAccessRule(Consumer<CreateMobileDeviceAccessRuleRequest.Builder> createMobileDeviceAccessRuleRequest) Creates a new mobile device access rule for the specified WorkMail organization.
This is a convenience which creates an instance of the
CreateMobileDeviceAccessRuleRequest.Builder
avoiding the need to create one manually viaCreateMobileDeviceAccessRuleRequest.builder()
- Parameters:
createMobileDeviceAccessRuleRequest
- AConsumer
that will call methods onCreateMobileDeviceAccessRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMobileDeviceAccessRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- LimitExceededException The request exceeds the limit of the resource.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOrganization
default CompletableFuture<CreateOrganizationResponse> createOrganization(CreateOrganizationRequest createOrganizationRequest) 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:
- A Java Future containing the result of the CreateOrganization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- DirectoryInUseException The directory is already in use by another WorkMail organization in the same account and Region.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- LimitExceededException The request exceeds the limit of the resource.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOrganization
default CompletableFuture<CreateOrganizationResponse> createOrganization(Consumer<CreateOrganizationRequest.Builder> createOrganizationRequest) 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.Builder
avoiding the need to create one manually viaCreateOrganizationRequest.builder()
- Parameters:
createOrganizationRequest
- AConsumer
that will call methods onCreateOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateOrganization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- DirectoryInUseException The directory is already in use by another WorkMail organization in the same account and Region.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- LimitExceededException The request exceeds the limit of the resource.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createResource
default CompletableFuture<CreateResourceResponse> createResource(CreateResourceRequest createResourceRequest) Creates a new WorkMail resource.
- Parameters:
createResourceRequest
-- Returns:
- A Java Future containing the result of the CreateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ReservedNameException This user, group, or resource name is not allowed in WorkMail.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createResource
default CompletableFuture<CreateResourceResponse> createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest) Creates a new WorkMail resource.
This is a convenience which creates an instance of the
CreateResourceRequest.Builder
avoiding the need to create one manually viaCreateResourceRequest.builder()
- Parameters:
createResourceRequest
- AConsumer
that will call methods onCreateResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ReservedNameException This user, group, or resource name is not allowed in WorkMail.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
- Parameters:
createUserRequest
-- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- InvalidPasswordException The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ReservedNameException This user, group, or resource name is not allowed in WorkMail.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest) 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.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- InvalidPasswordException The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
- NameAvailabilityException The user, group, or resource name isn't unique in WorkMail.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ReservedNameException This user, group, or resource name is not allowed in WorkMail.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccessControlRule
default CompletableFuture<DeleteAccessControlRuleResponse> deleteAccessControlRule(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest) 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:
- A Java Future containing the result of the DeleteAccessControlRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccessControlRule
default CompletableFuture<DeleteAccessControlRuleResponse> deleteAccessControlRule(Consumer<DeleteAccessControlRuleRequest.Builder> deleteAccessControlRuleRequest) 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.Builder
avoiding the need to create one manually viaDeleteAccessControlRuleRequest.builder()
- Parameters:
deleteAccessControlRuleRequest
- AConsumer
that will call methods onDeleteAccessControlRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccessControlRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlias
Remove one or more specified aliases from a set of aliases for a given user.
- Parameters:
deleteAliasRequest
-- Returns:
- A Java Future containing the result of the DeleteAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlias
default CompletableFuture<DeleteAliasResponse> deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) 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.Builder
avoiding the need to create one manually viaDeleteAliasRequest.builder()
- Parameters:
deleteAliasRequest
- AConsumer
that will call methods onDeleteAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAvailabilityConfiguration
default CompletableFuture<DeleteAvailabilityConfigurationResponse> deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest) Deletes the
AvailabilityConfiguration
for the given WorkMail organization and domain.- Parameters:
deleteAvailabilityConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteAvailabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAvailabilityConfiguration
default CompletableFuture<DeleteAvailabilityConfigurationResponse> deleteAvailabilityConfiguration(Consumer<DeleteAvailabilityConfigurationRequest.Builder> deleteAvailabilityConfigurationRequest) Deletes the
AvailabilityConfiguration
for the given WorkMail organization and domain.
This is a convenience which creates an instance of the
DeleteAvailabilityConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteAvailabilityConfigurationRequest.builder()
- Parameters:
deleteAvailabilityConfigurationRequest
- AConsumer
that will call methods onDeleteAvailabilityConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAvailabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEmailMonitoringConfiguration
default CompletableFuture<DeleteEmailMonitoringConfigurationResponse> deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest) Deletes the email monitoring configuration for a specified organization.
- Parameters:
deleteEmailMonitoringConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteEmailMonitoringConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEmailMonitoringConfiguration
default CompletableFuture<DeleteEmailMonitoringConfigurationResponse> deleteEmailMonitoringConfiguration(Consumer<DeleteEmailMonitoringConfigurationRequest.Builder> deleteEmailMonitoringConfigurationRequest) Deletes the email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
DeleteEmailMonitoringConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteEmailMonitoringConfigurationRequest.builder()
- Parameters:
deleteEmailMonitoringConfigurationRequest
- AConsumer
that will call methods onDeleteEmailMonitoringConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEmailMonitoringConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroup
Deletes a group from WorkMail.
- Parameters:
deleteGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroup
default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Deletes a group from WorkMail.
This is a convenience which creates an instance of the
DeleteGroupRequest.Builder
avoiding the need to create one manually viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteImpersonationRole
default CompletableFuture<DeleteImpersonationRoleResponse> deleteImpersonationRole(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest) Deletes an impersonation role for the given WorkMail organization.
- Parameters:
deleteImpersonationRoleRequest
-- Returns:
- A Java Future containing the result of the DeleteImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteImpersonationRole
default CompletableFuture<DeleteImpersonationRoleResponse> deleteImpersonationRole(Consumer<DeleteImpersonationRoleRequest.Builder> deleteImpersonationRoleRequest) Deletes an impersonation role for the given WorkMail organization.
This is a convenience which creates an instance of the
DeleteImpersonationRoleRequest.Builder
avoiding the need to create one manually viaDeleteImpersonationRoleRequest.builder()
- Parameters:
deleteImpersonationRoleRequest
- AConsumer
that will call methods onDeleteImpersonationRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMailboxPermissions
default CompletableFuture<DeleteMailboxPermissionsResponse> deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest) Deletes permissions granted to a member (user or group).
- Parameters:
deleteMailboxPermissionsRequest
-- Returns:
- A Java Future containing the result of the DeleteMailboxPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMailboxPermissions
default CompletableFuture<DeleteMailboxPermissionsResponse> deleteMailboxPermissions(Consumer<DeleteMailboxPermissionsRequest.Builder> deleteMailboxPermissionsRequest) Deletes permissions granted to a member (user or group).
This is a convenience which creates an instance of the
DeleteMailboxPermissionsRequest.Builder
avoiding the need to create one manually viaDeleteMailboxPermissionsRequest.builder()
- Parameters:
deleteMailboxPermissionsRequest
- AConsumer
that will call methods onDeleteMailboxPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMailboxPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMobileDeviceAccessOverride
default CompletableFuture<DeleteMobileDeviceAccessOverrideResponse> deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest) 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:
- A Java Future containing the result of the DeleteMobileDeviceAccessOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMobileDeviceAccessOverride
default CompletableFuture<DeleteMobileDeviceAccessOverrideResponse> deleteMobileDeviceAccessOverride(Consumer<DeleteMobileDeviceAccessOverrideRequest.Builder> deleteMobileDeviceAccessOverrideRequest) 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.Builder
avoiding the need to create one manually viaDeleteMobileDeviceAccessOverrideRequest.builder()
- Parameters:
deleteMobileDeviceAccessOverrideRequest
- AConsumer
that will call methods onDeleteMobileDeviceAccessOverrideRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMobileDeviceAccessOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMobileDeviceAccessRule
default CompletableFuture<DeleteMobileDeviceAccessRuleResponse> deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest) 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:
- A Java Future containing the result of the DeleteMobileDeviceAccessRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMobileDeviceAccessRule
default CompletableFuture<DeleteMobileDeviceAccessRuleResponse> deleteMobileDeviceAccessRule(Consumer<DeleteMobileDeviceAccessRuleRequest.Builder> deleteMobileDeviceAccessRuleRequest) 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.Builder
avoiding the need to create one manually viaDeleteMobileDeviceAccessRuleRequest.builder()
- Parameters:
deleteMobileDeviceAccessRuleRequest
- AConsumer
that will call methods onDeleteMobileDeviceAccessRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMobileDeviceAccessRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOrganization
default CompletableFuture<DeleteOrganizationResponse> deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest) 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:
- A Java Future containing the result of the DeleteOrganization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOrganization
default CompletableFuture<DeleteOrganizationResponse> deleteOrganization(Consumer<DeleteOrganizationRequest.Builder> deleteOrganizationRequest) 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.Builder
avoiding the need to create one manually viaDeleteOrganizationRequest.builder()
- Parameters:
deleteOrganizationRequest
- AConsumer
that will call methods onDeleteOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOrganization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResource
default CompletableFuture<DeleteResourceResponse> deleteResource(DeleteResourceRequest deleteResourceRequest) Deletes the specified resource.
- Parameters:
deleteResourceRequest
-- Returns:
- A Java Future containing the result of the DeleteResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResource
default CompletableFuture<DeleteResourceResponse> deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) Deletes the specified resource.
This is a convenience which creates an instance of the
DeleteResourceRequest.Builder
avoiding the need to create one manually viaDeleteResourceRequest.builder()
- Parameters:
deleteResourceRequest
- AConsumer
that will call methods onDeleteResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRetentionPolicy
default CompletableFuture<DeleteRetentionPolicyResponse> deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) Deletes the specified retention policy from the specified organization.
- Parameters:
deleteRetentionPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteRetentionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRetentionPolicy
default CompletableFuture<DeleteRetentionPolicyResponse> deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest) Deletes the specified retention policy from the specified organization.
This is a convenience which creates an instance of the
DeleteRetentionPolicyRequest.Builder
avoiding the need to create one manually viaDeleteRetentionPolicyRequest.builder()
- Parameters:
deleteRetentionPolicyRequest
- AConsumer
that will call methods onDeleteRetentionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRetentionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
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:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) 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.Builder
avoiding the need to create one manually viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterFromWorkMail
default CompletableFuture<DeregisterFromWorkMailResponse> deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest) 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:
- A Java Future containing the result of the DeregisterFromWorkMail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterFromWorkMail
default CompletableFuture<DeregisterFromWorkMailResponse> deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest) 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.Builder
avoiding the need to create one manually viaDeregisterFromWorkMailRequest.builder()
- Parameters:
deregisterFromWorkMailRequest
- AConsumer
that will call methods onDeregisterFromWorkMailRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterFromWorkMail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterMailDomain
default CompletableFuture<DeregisterMailDomainResponse> deregisterMailDomain(DeregisterMailDomainRequest deregisterMailDomainRequest) 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:
- A Java Future containing the result of the DeregisterMailDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MailDomainInUseException The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- InvalidCustomSesConfigurationException You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterMailDomain
default CompletableFuture<DeregisterMailDomainResponse> deregisterMailDomain(Consumer<DeregisterMailDomainRequest.Builder> deregisterMailDomainRequest) 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.Builder
avoiding the need to create one manually viaDeregisterMailDomainRequest.builder()
- Parameters:
deregisterMailDomainRequest
- AConsumer
that will call methods onDeregisterMailDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterMailDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MailDomainInUseException The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- InvalidCustomSesConfigurationException You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEmailMonitoringConfiguration
default CompletableFuture<DescribeEmailMonitoringConfigurationResponse> describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest) Describes the current email monitoring configuration for a specified organization.
- Parameters:
describeEmailMonitoringConfigurationRequest
-- Returns:
- A Java Future containing the result of the DescribeEmailMonitoringConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource cannot be found.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEmailMonitoringConfiguration
default CompletableFuture<DescribeEmailMonitoringConfigurationResponse> describeEmailMonitoringConfiguration(Consumer<DescribeEmailMonitoringConfigurationRequest.Builder> describeEmailMonitoringConfigurationRequest) Describes the current email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
DescribeEmailMonitoringConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeEmailMonitoringConfigurationRequest.builder()
- Parameters:
describeEmailMonitoringConfigurationRequest
- AConsumer
that will call methods onDescribeEmailMonitoringConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEmailMonitoringConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource cannot be found.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEntity
default CompletableFuture<DescribeEntityResponse> describeEntity(DescribeEntityRequest describeEntityRequest) Returns basic details about an entity in WorkMail.
- Parameters:
describeEntityRequest
-- Returns:
- A Java Future containing the result of the DescribeEntity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEntity
default CompletableFuture<DescribeEntityResponse> describeEntity(Consumer<DescribeEntityRequest.Builder> describeEntityRequest) Returns basic details about an entity in WorkMail.
This is a convenience which creates an instance of the
DescribeEntityRequest.Builder
avoiding the need to create one manually viaDescribeEntityRequest.builder()
- Parameters:
describeEntityRequest
- AConsumer
that will call methods onDescribeEntityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEntity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroup
default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest) Returns the data available for the group.
- Parameters:
describeGroupRequest
-- Returns:
- A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroup
default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Returns the data available for the group.
This is a convenience which creates an instance of the
DescribeGroupRequest.Builder
avoiding the need to create one manually viaDescribeGroupRequest.builder()
- Parameters:
describeGroupRequest
- AConsumer
that will call methods onDescribeGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInboundDmarcSettings
default CompletableFuture<DescribeInboundDmarcSettingsResponse> describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest) Lists the settings in a DMARC policy for a specified organization.
- Parameters:
describeInboundDmarcSettingsRequest
-- Returns:
- A Java Future containing the result of the DescribeInboundDmarcSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInboundDmarcSettings
default CompletableFuture<DescribeInboundDmarcSettingsResponse> describeInboundDmarcSettings(Consumer<DescribeInboundDmarcSettingsRequest.Builder> describeInboundDmarcSettingsRequest) Lists the settings in a DMARC policy for a specified organization.
This is a convenience which creates an instance of the
DescribeInboundDmarcSettingsRequest.Builder
avoiding the need to create one manually viaDescribeInboundDmarcSettingsRequest.builder()
- Parameters:
describeInboundDmarcSettingsRequest
- AConsumer
that will call methods onDescribeInboundDmarcSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeInboundDmarcSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMailboxExportJob
default CompletableFuture<DescribeMailboxExportJobResponse> describeMailboxExportJob(DescribeMailboxExportJobRequest describeMailboxExportJobRequest) Describes the current status of a mailbox export job.
- Parameters:
describeMailboxExportJobRequest
-- Returns:
- A Java Future containing the result of the DescribeMailboxExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMailboxExportJob
default CompletableFuture<DescribeMailboxExportJobResponse> describeMailboxExportJob(Consumer<DescribeMailboxExportJobRequest.Builder> describeMailboxExportJobRequest) Describes the current status of a mailbox export job.
This is a convenience which creates an instance of the
DescribeMailboxExportJobRequest.Builder
avoiding the need to create one manually viaDescribeMailboxExportJobRequest.builder()
- Parameters:
describeMailboxExportJobRequest
- AConsumer
that will call methods onDescribeMailboxExportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeMailboxExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganization
default CompletableFuture<DescribeOrganizationResponse> describeOrganization(DescribeOrganizationRequest describeOrganizationRequest) Provides more information regarding a given organization based on its identifier.
- Parameters:
describeOrganizationRequest
-- Returns:
- A Java Future containing the result of the DescribeOrganization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganization
default CompletableFuture<DescribeOrganizationResponse> describeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest) Provides more information regarding a given organization based on its identifier.
This is a convenience which creates an instance of the
DescribeOrganizationRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationRequest.builder()
- Parameters:
describeOrganizationRequest
- AConsumer
that will call methods onDescribeOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOrganization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeResource
default CompletableFuture<DescribeResourceResponse> describeResource(DescribeResourceRequest describeResourceRequest) Returns the data available for the resource.
- Parameters:
describeResourceRequest
-- Returns:
- A Java Future containing the result of the DescribeResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeResource
default CompletableFuture<DescribeResourceResponse> describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) Returns the data available for the resource.
This is a convenience which creates an instance of the
DescribeResourceRequest.Builder
avoiding the need to create one manually viaDescribeResourceRequest.builder()
- Parameters:
describeResourceRequest
- AConsumer
that will call methods onDescribeResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest) Provides information regarding the user.
- Parameters:
describeUserRequest
-- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Provides information regarding the user.
This is a convenience which creates an instance of the
DescribeUserRequest.Builder
avoiding the need to create one manually viaDescribeUserRequest.builder()
- Parameters:
describeUserRequest
- AConsumer
that will call methods onDescribeUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateDelegateFromResource
default CompletableFuture<DisassociateDelegateFromResourceResponse> disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest) Removes a member from the resource's set of delegates.
- Parameters:
disassociateDelegateFromResourceRequest
-- Returns:
- A Java Future containing the result of the DisassociateDelegateFromResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateDelegateFromResource
default CompletableFuture<DisassociateDelegateFromResourceResponse> disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest) Removes a member from the resource's set of delegates.
This is a convenience which creates an instance of the
DisassociateDelegateFromResourceRequest.Builder
avoiding the need to create one manually viaDisassociateDelegateFromResourceRequest.builder()
- Parameters:
disassociateDelegateFromResourceRequest
- AConsumer
that will call methods onDisassociateDelegateFromResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateDelegateFromResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateMemberFromGroup
default CompletableFuture<DisassociateMemberFromGroupResponse> disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest) Removes a member from a group.
- Parameters:
disassociateMemberFromGroupRequest
-- Returns:
- A Java Future containing the result of the DisassociateMemberFromGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateMemberFromGroup
default CompletableFuture<DisassociateMemberFromGroupResponse> disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest) Removes a member from a group.
This is a convenience which creates an instance of the
DisassociateMemberFromGroupRequest.Builder
avoiding the need to create one manually viaDisassociateMemberFromGroupRequest.builder()
- Parameters:
disassociateMemberFromGroupRequest
- AConsumer
that will call methods onDisassociateMemberFromGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateMemberFromGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccessControlEffect
default CompletableFuture<GetAccessControlEffectResponse> getAccessControlEffect(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. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
- Parameters:
getAccessControlEffectRequest
-- Returns:
- A Java Future containing the result of the GetAccessControlEffect operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- ResourceNotFoundException The resource cannot be found.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccessControlEffect
default CompletableFuture<GetAccessControlEffectResponse> getAccessControlEffect(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. 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.Builder
avoiding the need to create one manually viaGetAccessControlEffectRequest.builder()
- Parameters:
getAccessControlEffectRequest
- AConsumer
that will call methods onGetAccessControlEffectRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccessControlEffect operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- ResourceNotFoundException The resource cannot be found.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDefaultRetentionPolicy
default CompletableFuture<GetDefaultRetentionPolicyResponse> getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest) Gets the default retention policy details for the specified organization.
- Parameters:
getDefaultRetentionPolicyRequest
-- Returns:
- A Java Future containing the result of the GetDefaultRetentionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDefaultRetentionPolicy
default CompletableFuture<GetDefaultRetentionPolicyResponse> getDefaultRetentionPolicy(Consumer<GetDefaultRetentionPolicyRequest.Builder> getDefaultRetentionPolicyRequest) Gets the default retention policy details for the specified organization.
This is a convenience which creates an instance of the
GetDefaultRetentionPolicyRequest.Builder
avoiding the need to create one manually viaGetDefaultRetentionPolicyRequest.builder()
- Parameters:
getDefaultRetentionPolicyRequest
- AConsumer
that will call methods onGetDefaultRetentionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDefaultRetentionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImpersonationRole
default CompletableFuture<GetImpersonationRoleResponse> getImpersonationRole(GetImpersonationRoleRequest getImpersonationRoleRequest) Gets the impersonation role details for the given WorkMail organization.
- Parameters:
getImpersonationRoleRequest
-- Returns:
- A Java Future containing the result of the GetImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImpersonationRole
default CompletableFuture<GetImpersonationRoleResponse> getImpersonationRole(Consumer<GetImpersonationRoleRequest.Builder> getImpersonationRoleRequest) Gets the impersonation role details for the given WorkMail organization.
This is a convenience which creates an instance of the
GetImpersonationRoleRequest.Builder
avoiding the need to create one manually viaGetImpersonationRoleRequest.builder()
- Parameters:
getImpersonationRoleRequest
- AConsumer
that will call methods onGetImpersonationRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImpersonationRoleEffect
default CompletableFuture<GetImpersonationRoleEffectResponse> getImpersonationRoleEffect(GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest) Tests whether the given impersonation role can impersonate a target user.
- Parameters:
getImpersonationRoleEffectRequest
-- Returns:
- A Java Future containing the result of the GetImpersonationRoleEffect operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ResourceNotFoundException The resource cannot be found.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImpersonationRoleEffect
default CompletableFuture<GetImpersonationRoleEffectResponse> getImpersonationRoleEffect(Consumer<GetImpersonationRoleEffectRequest.Builder> getImpersonationRoleEffectRequest) Tests whether the given impersonation role can impersonate a target user.
This is a convenience which creates an instance of the
GetImpersonationRoleEffectRequest.Builder
avoiding the need to create one manually viaGetImpersonationRoleEffectRequest.builder()
- Parameters:
getImpersonationRoleEffectRequest
- AConsumer
that will call methods onGetImpersonationRoleEffectRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetImpersonationRoleEffect operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ResourceNotFoundException The resource cannot be found.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMailDomain
default CompletableFuture<GetMailDomainResponse> getMailDomain(GetMailDomainRequest getMailDomainRequest) Gets details for a mail domain, including domain records required to configure your domain with recommended security.
- Parameters:
getMailDomainRequest
-- Returns:
- A Java Future containing the result of the GetMailDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MailDomainNotFoundException The domain specified is not found in your organization.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMailDomain
default CompletableFuture<GetMailDomainResponse> getMailDomain(Consumer<GetMailDomainRequest.Builder> getMailDomainRequest) 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.Builder
avoiding the need to create one manually viaGetMailDomainRequest.builder()
- Parameters:
getMailDomainRequest
- AConsumer
that will call methods onGetMailDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMailDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MailDomainNotFoundException The domain specified is not found in your organization.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMailboxDetails
default CompletableFuture<GetMailboxDetailsResponse> getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest) Requests a user's mailbox details for a specified organization and user.
- Parameters:
getMailboxDetailsRequest
-- Returns:
- A Java Future containing the result of the GetMailboxDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMailboxDetails
default CompletableFuture<GetMailboxDetailsResponse> getMailboxDetails(Consumer<GetMailboxDetailsRequest.Builder> getMailboxDetailsRequest) Requests a user's mailbox details for a specified organization and user.
This is a convenience which creates an instance of the
GetMailboxDetailsRequest.Builder
avoiding the need to create one manually viaGetMailboxDetailsRequest.builder()
- Parameters:
getMailboxDetailsRequest
- AConsumer
that will call methods onGetMailboxDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMailboxDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMobileDeviceAccessEffect
default CompletableFuture<GetMobileDeviceAccessEffectResponse> getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest) 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:
- A Java Future containing the result of the GetMobileDeviceAccessEffect operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMobileDeviceAccessEffect
default CompletableFuture<GetMobileDeviceAccessEffectResponse> getMobileDeviceAccessEffect(Consumer<GetMobileDeviceAccessEffectRequest.Builder> getMobileDeviceAccessEffectRequest) 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.Builder
avoiding the need to create one manually viaGetMobileDeviceAccessEffectRequest.builder()
- Parameters:
getMobileDeviceAccessEffectRequest
- AConsumer
that will call methods onGetMobileDeviceAccessEffectRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMobileDeviceAccessEffect operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMobileDeviceAccessOverride
default CompletableFuture<GetMobileDeviceAccessOverrideResponse> getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest) Gets the mobile device access override for the given WorkMail organization, user, and device.
- Parameters:
getMobileDeviceAccessOverrideRequest
-- Returns:
- A Java Future containing the result of the GetMobileDeviceAccessOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMobileDeviceAccessOverride
default CompletableFuture<GetMobileDeviceAccessOverrideResponse> getMobileDeviceAccessOverride(Consumer<GetMobileDeviceAccessOverrideRequest.Builder> getMobileDeviceAccessOverrideRequest) 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.Builder
avoiding the need to create one manually viaGetMobileDeviceAccessOverrideRequest.builder()
- Parameters:
getMobileDeviceAccessOverrideRequest
- AConsumer
that will call methods onGetMobileDeviceAccessOverrideRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMobileDeviceAccessOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessControlRules
default CompletableFuture<ListAccessControlRulesResponse> listAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest) Lists the access control rules for the specified organization.
- Parameters:
listAccessControlRulesRequest
-- Returns:
- A Java Future containing the result of the ListAccessControlRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessControlRules
default CompletableFuture<ListAccessControlRulesResponse> listAccessControlRules(Consumer<ListAccessControlRulesRequest.Builder> listAccessControlRulesRequest) Lists the access control rules for the specified organization.
This is a convenience which creates an instance of the
ListAccessControlRulesRequest.Builder
avoiding the need to create one manually viaListAccessControlRulesRequest.builder()
- Parameters:
listAccessControlRulesRequest
- AConsumer
that will call methods onListAccessControlRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccessControlRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAliases
Creates a paginated call to list the aliases associated with a given entity.
- Parameters:
listAliasesRequest
-- Returns:
- A Java Future containing the result of the ListAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAliases
default CompletableFuture<ListAliasesResponse> listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest) Creates a paginated call to list the aliases associated with a given entity.
This is a convenience which creates an instance of the
ListAliasesRequest.Builder
avoiding the need to create one manually viaListAliasesRequest.builder()
- Parameters:
listAliasesRequest
- AConsumer
that will call methods onListAliasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAliasesPaginator
This is a variant of
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListAliasesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAliasesPaginator
default ListAliasesPublisher listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest) This is a variant of
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListAliasesResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListAliasesRequest.builder()
- Parameters:
listAliasesRequest
- AConsumer
that will call methods onListAliasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAvailabilityConfigurations
default CompletableFuture<ListAvailabilityConfigurationsResponse> listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) List all the
AvailabilityConfiguration
's for the given WorkMail organization.- Parameters:
listAvailabilityConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListAvailabilityConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAvailabilityConfigurations
default CompletableFuture<ListAvailabilityConfigurationsResponse> listAvailabilityConfigurations(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest) List all the
AvailabilityConfiguration
's for the given WorkMail organization.
This is a convenience which creates an instance of the
ListAvailabilityConfigurationsRequest.Builder
avoiding the need to create one manually viaListAvailabilityConfigurationsRequest.builder()
- Parameters:
listAvailabilityConfigurationsRequest
- AConsumer
that will call methods onListAvailabilityConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAvailabilityConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAvailabilityConfigurationsPaginator
default ListAvailabilityConfigurationsPublisher listAvailabilityConfigurationsPaginator(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) This is a variant of
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAvailabilityConfigurationsPaginator
default ListAvailabilityConfigurationsPublisher listAvailabilityConfigurationsPaginator(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest) This is a variant of
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListAvailabilityConfigurationsRequest.builder()
- Parameters:
listAvailabilityConfigurationsRequest
- AConsumer
that will call methods onListAvailabilityConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembers
default CompletableFuture<ListGroupMembersResponse> listGroupMembers(ListGroupMembersRequest listGroupMembersRequest) Returns an overview of the members of a group. Users and groups can be members of a group.
- Parameters:
listGroupMembersRequest
-- Returns:
- A Java Future containing the result of the ListGroupMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembers
default CompletableFuture<ListGroupMembersResponse> listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) 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.Builder
avoiding the need to create one manually viaListGroupMembersRequest.builder()
- Parameters:
listGroupMembersRequest
- AConsumer
that will call methods onListGroupMembersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroupMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembersPaginator
default ListGroupMembersPublisher listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest) This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembersPaginator
default ListGroupMembersPublisher listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListGroupMembersRequest.builder()
- Parameters:
listGroupMembersRequest
- AConsumer
that will call methods onListGroupMembersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroups
Returns summaries of the organization's groups.
- Parameters:
listGroupsRequest
-- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroups
default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Returns summaries of the organization's groups.
This is a convenience which creates an instance of the
ListGroupsRequest.Builder
avoiding the need to create one manually viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsForEntity
default CompletableFuture<ListGroupsForEntityResponse> listGroupsForEntity(ListGroupsForEntityRequest listGroupsForEntityRequest) Returns all the groups to which an entity belongs.
- Parameters:
listGroupsForEntityRequest
-- Returns:
- A Java Future containing the result of the ListGroupsForEntity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsForEntity
default CompletableFuture<ListGroupsForEntityResponse> listGroupsForEntity(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) Returns all the groups to which an entity belongs.
This is a convenience which creates an instance of the
ListGroupsForEntityRequest.Builder
avoiding the need to create one manually viaListGroupsForEntityRequest.builder()
- Parameters:
listGroupsForEntityRequest
- AConsumer
that will call methods onListGroupsForEntityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroupsForEntity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsForEntityPaginator
default ListGroupsForEntityPublisher listGroupsForEntityPaginator(ListGroupsForEntityRequest listGroupsForEntityRequest) This is a variant of
listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityPublisher publisher = client.listGroupsForEntityPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityPublisher publisher = client.listGroupsForEntityPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsForEntityPaginator
default ListGroupsForEntityPublisher listGroupsForEntityPaginator(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) This is a variant of
listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityPublisher publisher = client.listGroupsForEntityPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityPublisher publisher = client.listGroupsForEntityPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListGroupsForEntityRequest.builder()
- Parameters:
listGroupsForEntityRequest
- AConsumer
that will call methods onListGroupsForEntityRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsPaginator
This is a variant of
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsPaginator
default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant of
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImpersonationRoles
default CompletableFuture<ListImpersonationRolesResponse> listImpersonationRoles(ListImpersonationRolesRequest listImpersonationRolesRequest) Lists all the impersonation roles for the given WorkMail organization.
- Parameters:
listImpersonationRolesRequest
-- Returns:
- A Java Future containing the result of the ListImpersonationRoles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImpersonationRoles
default CompletableFuture<ListImpersonationRolesResponse> listImpersonationRoles(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) Lists all the impersonation roles for the given WorkMail organization.
This is a convenience which creates an instance of the
ListImpersonationRolesRequest.Builder
avoiding the need to create one manually viaListImpersonationRolesRequest.builder()
- Parameters:
listImpersonationRolesRequest
- AConsumer
that will call methods onListImpersonationRolesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListImpersonationRoles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImpersonationRolesPaginator
default ListImpersonationRolesPublisher listImpersonationRolesPaginator(ListImpersonationRolesRequest listImpersonationRolesRequest) This is a variant of
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImpersonationRolesPaginator
default ListImpersonationRolesPublisher listImpersonationRolesPaginator(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) This is a variant of
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListImpersonationRolesRequest.builder()
- Parameters:
listImpersonationRolesRequest
- AConsumer
that will call methods onListImpersonationRolesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailDomains
default CompletableFuture<ListMailDomainsResponse> listMailDomains(ListMailDomainsRequest listMailDomainsRequest) Lists the mail domains in a given WorkMail organization.
- Parameters:
listMailDomainsRequest
-- Returns:
- A Java Future containing the result of the ListMailDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailDomains
default CompletableFuture<ListMailDomainsResponse> listMailDomains(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) Lists the mail domains in a given WorkMail organization.
This is a convenience which creates an instance of the
ListMailDomainsRequest.Builder
avoiding the need to create one manually viaListMailDomainsRequest.builder()
- Parameters:
listMailDomainsRequest
- AConsumer
that will call methods onListMailDomainsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMailDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailDomainsPaginator
default ListMailDomainsPublisher listMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest) This is a variant of
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailDomainsPaginator
default ListMailDomainsPublisher listMailDomainsPaginator(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) This is a variant of
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListMailDomainsRequest.builder()
- Parameters:
listMailDomainsRequest
- AConsumer
that will call methods onListMailDomainsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailboxExportJobs
default CompletableFuture<ListMailboxExportJobsResponse> listMailboxExportJobs(ListMailboxExportJobsRequest listMailboxExportJobsRequest) Lists the mailbox export jobs started for the specified organization within the last seven days.
- Parameters:
listMailboxExportJobsRequest
-- Returns:
- A Java Future containing the result of the ListMailboxExportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailboxExportJobs
default CompletableFuture<ListMailboxExportJobsResponse> listMailboxExportJobs(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) 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.Builder
avoiding the need to create one manually viaListMailboxExportJobsRequest.builder()
- Parameters:
listMailboxExportJobsRequest
- AConsumer
that will call methods onListMailboxExportJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMailboxExportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailboxExportJobsPaginator
default ListMailboxExportJobsPublisher listMailboxExportJobsPaginator(ListMailboxExportJobsRequest listMailboxExportJobsRequest) This is a variant of
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailboxExportJobsPaginator
default ListMailboxExportJobsPublisher listMailboxExportJobsPaginator(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) This is a variant of
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListMailboxExportJobsRequest.builder()
- Parameters:
listMailboxExportJobsRequest
- AConsumer
that will call methods onListMailboxExportJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailboxPermissions
default CompletableFuture<ListMailboxPermissionsResponse> listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest) Lists the mailbox permissions associated with a user, group, or resource mailbox.
- Parameters:
listMailboxPermissionsRequest
-- Returns:
- A Java Future containing the result of the ListMailboxPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailboxPermissions
default CompletableFuture<ListMailboxPermissionsResponse> listMailboxPermissions(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) Lists the mailbox permissions associated with a user, group, or resource mailbox.
This is a convenience which creates an instance of the
ListMailboxPermissionsRequest.Builder
avoiding the need to create one manually viaListMailboxPermissionsRequest.builder()
- Parameters:
listMailboxPermissionsRequest
- AConsumer
that will call methods onListMailboxPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMailboxPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailboxPermissionsPaginator
default ListMailboxPermissionsPublisher listMailboxPermissionsPaginator(ListMailboxPermissionsRequest listMailboxPermissionsRequest) This is a variant of
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMailboxPermissionsPaginator
default ListMailboxPermissionsPublisher listMailboxPermissionsPaginator(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) This is a variant of
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListMailboxPermissionsRequest.builder()
- Parameters:
listMailboxPermissionsRequest
- AConsumer
that will call methods onListMailboxPermissionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMobileDeviceAccessOverrides
default CompletableFuture<ListMobileDeviceAccessOverridesResponse> listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
- Parameters:
listMobileDeviceAccessOverridesRequest
-- Returns:
- A Java Future containing the result of the ListMobileDeviceAccessOverrides operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMobileDeviceAccessOverrides
default CompletableFuture<ListMobileDeviceAccessOverridesResponse> listMobileDeviceAccessOverrides(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest) 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.Builder
avoiding the need to create one manually viaListMobileDeviceAccessOverridesRequest.builder()
- Parameters:
listMobileDeviceAccessOverridesRequest
- AConsumer
that will call methods onListMobileDeviceAccessOverridesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMobileDeviceAccessOverrides operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMobileDeviceAccessOverridesPaginator
default ListMobileDeviceAccessOverridesPublisher listMobileDeviceAccessOverridesPaginator(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) This is a variant of
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMobileDeviceAccessOverridesPaginator
default ListMobileDeviceAccessOverridesPublisher listMobileDeviceAccessOverridesPaginator(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest) This is a variant of
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListMobileDeviceAccessOverridesRequest.builder()
- Parameters:
listMobileDeviceAccessOverridesRequest
- AConsumer
that will call methods onListMobileDeviceAccessOverridesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMobileDeviceAccessRules
default CompletableFuture<ListMobileDeviceAccessRulesResponse> listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest) Lists the mobile device access rules for the specified WorkMail organization.
- Parameters:
listMobileDeviceAccessRulesRequest
-- Returns:
- A Java Future containing the result of the ListMobileDeviceAccessRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMobileDeviceAccessRules
default CompletableFuture<ListMobileDeviceAccessRulesResponse> listMobileDeviceAccessRules(Consumer<ListMobileDeviceAccessRulesRequest.Builder> listMobileDeviceAccessRulesRequest) Lists the mobile device access rules for the specified WorkMail organization.
This is a convenience which creates an instance of the
ListMobileDeviceAccessRulesRequest.Builder
avoiding the need to create one manually viaListMobileDeviceAccessRulesRequest.builder()
- Parameters:
listMobileDeviceAccessRulesRequest
- AConsumer
that will call methods onListMobileDeviceAccessRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMobileDeviceAccessRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizations
default CompletableFuture<ListOrganizationsResponse> listOrganizations(ListOrganizationsRequest listOrganizationsRequest) Returns summaries of the customer's organizations.
- Parameters:
listOrganizationsRequest
-- Returns:
- A Java Future containing the result of the ListOrganizations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizations
default CompletableFuture<ListOrganizationsResponse> listOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) Returns summaries of the customer's organizations.
This is a convenience which creates an instance of the
ListOrganizationsRequest.Builder
avoiding the need to create one manually viaListOrganizationsRequest.builder()
- Parameters:
listOrganizationsRequest
- AConsumer
that will call methods onListOrganizationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOrganizations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizations
Returns summaries of the customer's organizations.
- Returns:
- A Java Future containing the result of the ListOrganizations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizationsPaginator
This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizationsPaginator
default ListOrganizationsPublisher listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest) This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrganizationsPaginator
default ListOrganizationsPublisher listOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListOrganizationsRequest.builder()
- Parameters:
listOrganizationsRequest
- AConsumer
that will call methods onListOrganizationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceDelegates
default CompletableFuture<ListResourceDelegatesResponse> listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest) Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
- Parameters:
listResourceDelegatesRequest
-- Returns:
- A Java Future containing the result of the ListResourceDelegates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceDelegates
default CompletableFuture<ListResourceDelegatesResponse> listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
This is a convenience which creates an instance of the
ListResourceDelegatesRequest.Builder
avoiding the need to create one manually viaListResourceDelegatesRequest.builder()
- Parameters:
listResourceDelegatesRequest
- AConsumer
that will call methods onListResourceDelegatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourceDelegates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceDelegatesPaginator
default ListResourceDelegatesPublisher listResourceDelegatesPaginator(ListResourceDelegatesRequest listResourceDelegatesRequest) This is a variant of
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceDelegatesPaginator
default ListResourceDelegatesPublisher listResourceDelegatesPaginator(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) This is a variant of
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListResourceDelegatesRequest.builder()
- Parameters:
listResourceDelegatesRequest
- AConsumer
that will call methods onListResourceDelegatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest) Returns summaries of the organization's resources.
- Parameters:
listResourcesRequest
-- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Returns summaries of the organization's resources.
This is a convenience which creates an instance of the
ListResourcesRequest.Builder
avoiding the need to create one manually viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
This is a variant of
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListResourcesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
default ListResourcesPublisher listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant of
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListResourcesResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- UnsupportedOperationException You can't perform a write operation against a read-only directory.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to an WorkMail organization resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to an WorkMail organization resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
Returns summaries of the organization's users.
- Parameters:
listUsersRequest
-- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns summaries of the organization's users.
This is a convenience which creates an instance of the
ListUsersRequest.Builder
avoiding the need to create one manually viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListUsersResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workmail.model.ListUsersResponse response) { //... }; });
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.Builder
avoiding the need to create one manually viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAccessControlRule
default CompletableFuture<PutAccessControlRuleResponse> putAccessControlRule(PutAccessControlRuleRequest putAccessControlRuleRequest) 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:
- A Java Future containing the result of the PutAccessControlRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeds the limit of the resource.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- ResourceNotFoundException The resource cannot be found.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAccessControlRule
default CompletableFuture<PutAccessControlRuleResponse> putAccessControlRule(Consumer<PutAccessControlRuleRequest.Builder> putAccessControlRuleRequest) 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.Builder
avoiding the need to create one manually viaPutAccessControlRuleRequest.builder()
- Parameters:
putAccessControlRuleRequest
- AConsumer
that will call methods onPutAccessControlRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAccessControlRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The request exceeds the limit of the resource.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- ResourceNotFoundException The resource cannot be found.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEmailMonitoringConfiguration
default CompletableFuture<PutEmailMonitoringConfigurationResponse> putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest) Creates or updates the email monitoring configuration for a specified organization.
- Parameters:
putEmailMonitoringConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutEmailMonitoringConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource cannot be found.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEmailMonitoringConfiguration
default CompletableFuture<PutEmailMonitoringConfigurationResponse> putEmailMonitoringConfiguration(Consumer<PutEmailMonitoringConfigurationRequest.Builder> putEmailMonitoringConfigurationRequest) Creates or updates the email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
PutEmailMonitoringConfigurationRequest.Builder
avoiding the need to create one manually viaPutEmailMonitoringConfigurationRequest.builder()
- Parameters:
putEmailMonitoringConfigurationRequest
- AConsumer
that will call methods onPutEmailMonitoringConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutEmailMonitoringConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource cannot be found.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putInboundDmarcSettings
default CompletableFuture<PutInboundDmarcSettingsResponse> putInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest) Enables or disables a DMARC policy for a given organization.
- Parameters:
putInboundDmarcSettingsRequest
-- Returns:
- A Java Future containing the result of the PutInboundDmarcSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putInboundDmarcSettings
default CompletableFuture<PutInboundDmarcSettingsResponse> putInboundDmarcSettings(Consumer<PutInboundDmarcSettingsRequest.Builder> putInboundDmarcSettingsRequest) Enables or disables a DMARC policy for a given organization.
This is a convenience which creates an instance of the
PutInboundDmarcSettingsRequest.Builder
avoiding the need to create one manually viaPutInboundDmarcSettingsRequest.builder()
- Parameters:
putInboundDmarcSettingsRequest
- AConsumer
that will call methods onPutInboundDmarcSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutInboundDmarcSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putMailboxPermissions
default CompletableFuture<PutMailboxPermissionsResponse> putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest) Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
- Parameters:
putMailboxPermissionsRequest
-- Returns:
- A Java Future containing the result of the PutMailboxPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putMailboxPermissions
default CompletableFuture<PutMailboxPermissionsResponse> putMailboxPermissions(Consumer<PutMailboxPermissionsRequest.Builder> putMailboxPermissionsRequest) 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.Builder
avoiding the need to create one manually viaPutMailboxPermissionsRequest.builder()
- Parameters:
putMailboxPermissionsRequest
- AConsumer
that will call methods onPutMailboxPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutMailboxPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putMobileDeviceAccessOverride
default CompletableFuture<PutMobileDeviceAccessOverrideResponse> putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest) Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
- Parameters:
putMobileDeviceAccessOverrideRequest
-- Returns:
- A Java Future containing the result of the PutMobileDeviceAccessOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putMobileDeviceAccessOverride
default CompletableFuture<PutMobileDeviceAccessOverrideResponse> putMobileDeviceAccessOverride(Consumer<PutMobileDeviceAccessOverrideRequest.Builder> putMobileDeviceAccessOverrideRequest) 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.Builder
avoiding the need to create one manually viaPutMobileDeviceAccessOverrideRequest.builder()
- Parameters:
putMobileDeviceAccessOverrideRequest
- AConsumer
that will call methods onPutMobileDeviceAccessOverrideRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutMobileDeviceAccessOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRetentionPolicy
default CompletableFuture<PutRetentionPolicyResponse> putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) Puts a retention policy to the specified organization.
- Parameters:
putRetentionPolicyRequest
-- Returns:
- A Java Future containing the result of the PutRetentionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- LimitExceededException The request exceeds the limit of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRetentionPolicy
default CompletableFuture<PutRetentionPolicyResponse> putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest) Puts a retention policy to the specified organization.
This is a convenience which creates an instance of the
PutRetentionPolicyRequest.Builder
avoiding the need to create one manually viaPutRetentionPolicyRequest.builder()
- Parameters:
putRetentionPolicyRequest
- AConsumer
that will call methods onPutRetentionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRetentionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- LimitExceededException The request exceeds the limit of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerMailDomain
default CompletableFuture<RegisterMailDomainResponse> registerMailDomain(RegisterMailDomainRequest registerMailDomainRequest) 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:
- A Java Future containing the result of the RegisterMailDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MailDomainInUseException The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- LimitExceededException The request exceeds the limit of the resource.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerMailDomain
default CompletableFuture<RegisterMailDomainResponse> registerMailDomain(Consumer<RegisterMailDomainRequest.Builder> registerMailDomainRequest) 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.Builder
avoiding the need to create one manually viaRegisterMailDomainRequest.builder()
- Parameters:
registerMailDomainRequest
- AConsumer
that will call methods onRegisterMailDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterMailDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MailDomainInUseException The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- LimitExceededException The request exceeds the limit of the resource.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerToWorkMail
default CompletableFuture<RegisterToWorkMailResponse> registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest) 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:
- A Java Future containing the result of the RegisterToWorkMail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- EntityAlreadyRegisteredException The user, group, or resource that you're trying to register is already registered.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- MailDomainNotFoundException The domain specified is not found in your organization.
- MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerToWorkMail
default CompletableFuture<RegisterToWorkMailResponse> registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest) 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.Builder
avoiding the need to create one manually viaRegisterToWorkMailRequest.builder()
- Parameters:
registerToWorkMailRequest
- AConsumer
that will call methods onRegisterToWorkMailRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterToWorkMail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- EntityAlreadyRegisteredException The user, group, or resource that you're trying to register is already registered.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- MailDomainNotFoundException The domain specified is not found in your organization.
- MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetPassword
default CompletableFuture<ResetPasswordResponse> resetPassword(ResetPasswordRequest resetPasswordRequest) Allows the administrator to reset the password for a user.
- Parameters:
resetPasswordRequest
-- Returns:
- A Java Future containing the result of the ResetPassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- 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.
- See Also:
-
resetPassword
default CompletableFuture<ResetPasswordResponse> resetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest) Allows the administrator to reset the password for a user.
This is a convenience which creates an instance of the
ResetPasswordRequest.Builder
avoiding the need to create one manually viaResetPasswordRequest.builder()
- Parameters:
resetPasswordRequest
- AConsumer
that will call methods onResetPasswordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetPassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- 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.
- See Also:
-
startMailboxExportJob
default CompletableFuture<StartMailboxExportJobResponse> startMailboxExportJob(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. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
- Parameters:
startMailboxExportJobRequest
-- Returns:
- A Java Future containing the result of the StartMailboxExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- 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.
- See Also:
-
startMailboxExportJob
default CompletableFuture<StartMailboxExportJobResponse> startMailboxExportJob(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. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
This is a convenience which creates an instance of the
StartMailboxExportJobRequest.Builder
avoiding the need to create one manually viaStartMailboxExportJobRequest.builder()
- Parameters:
startMailboxExportJobRequest
- AConsumer
that will call methods onStartMailboxExportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartMailboxExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- 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.
- See Also:
-
tagResource
Applies the specified tags to the specified WorkMailorganization resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies the specified tags to the specified WorkMailorganization resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
testAvailabilityConfiguration
default CompletableFuture<TestAvailabilityConfigurationResponse> testAvailabilityConfiguration(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest) Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a
SourceArn
orSourceAccount
header.The request must contain either one provider definition (
EwsProvider
orLambdaProvider
) or theDomainName
parameter. If theDomainName
parameter is provided, the configuration stored under theDomainName
will be tested.- Parameters:
testAvailabilityConfigurationRequest
-- Returns:
- A Java Future containing the result of the TestAvailabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- 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.
- See Also:
-
testAvailabilityConfiguration
default CompletableFuture<TestAvailabilityConfigurationResponse> testAvailabilityConfiguration(Consumer<TestAvailabilityConfigurationRequest.Builder> testAvailabilityConfigurationRequest) Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a
SourceArn
orSourceAccount
header.The request must contain either one provider definition (
EwsProvider
orLambdaProvider
) or theDomainName
parameter. If theDomainName
parameter is provided, the configuration stored under theDomainName
will be tested.
This is a convenience which creates an instance of the
TestAvailabilityConfigurationRequest.Builder
avoiding the need to create one manually viaTestAvailabilityConfigurationRequest.builder()
- Parameters:
testAvailabilityConfigurationRequest
- AConsumer
that will call methods onTestAvailabilityConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestAvailabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- 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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Untags the specified tags from the specified WorkMail organization resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Untags the specified tags from the specified WorkMail organization resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource cannot be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAvailabilityConfiguration
default CompletableFuture<UpdateAvailabilityConfigurationResponse> updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest) Updates an existing
AvailabilityConfiguration
for the given WorkMail organization and domain.- Parameters:
updateAvailabilityConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateAvailabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- 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.
- See Also:
-
updateAvailabilityConfiguration
default CompletableFuture<UpdateAvailabilityConfigurationResponse> updateAvailabilityConfiguration(Consumer<UpdateAvailabilityConfigurationRequest.Builder> updateAvailabilityConfigurationRequest) Updates an existing
AvailabilityConfiguration
for the given WorkMail organization and domain.
This is a convenience which creates an instance of the
UpdateAvailabilityConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateAvailabilityConfigurationRequest.builder()
- Parameters:
updateAvailabilityConfigurationRequest
- AConsumer
that will call methods onUpdateAvailabilityConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAvailabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- 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.
- See Also:
-
updateDefaultMailDomain
default CompletableFuture<UpdateDefaultMailDomainResponse> updateDefaultMailDomain(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest) 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:
- A Java Future containing the result of the UpdateDefaultMailDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateDefaultMailDomain
default CompletableFuture<UpdateDefaultMailDomainResponse> updateDefaultMailDomain(Consumer<UpdateDefaultMailDomainRequest.Builder> updateDefaultMailDomainRequest) 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.Builder
avoiding the need to create one manually viaUpdateDefaultMailDomainRequest.builder()
- Parameters:
updateDefaultMailDomainRequest
- AConsumer
that will call methods onUpdateDefaultMailDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDefaultMailDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateGroup
Updates attibutes in a group.
- Parameters:
updateGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- 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.
- See Also:
-
updateGroup
default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Updates attibutes in a group.
This is a convenience which creates an instance of the
UpdateGroupRequest.Builder
avoiding the need to create one manually viaUpdateGroupRequest.builder()
- Parameters:
updateGroupRequest
- AConsumer
that will call methods onUpdateGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- 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.
- See Also:
-
updateImpersonationRole
default CompletableFuture<UpdateImpersonationRoleResponse> updateImpersonationRole(UpdateImpersonationRoleRequest updateImpersonationRoleRequest) Updates an impersonation role for the given WorkMail organization.
- Parameters:
updateImpersonationRoleRequest
-- Returns:
- A Java Future containing the result of the UpdateImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ResourceNotFoundException The resource cannot be found.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- 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.
- See Also:
-
updateImpersonationRole
default CompletableFuture<UpdateImpersonationRoleResponse> updateImpersonationRole(Consumer<UpdateImpersonationRoleRequest.Builder> updateImpersonationRoleRequest) Updates an impersonation role for the given WorkMail organization.
This is a convenience which creates an instance of the
UpdateImpersonationRoleRequest.Builder
avoiding the need to create one manually viaUpdateImpersonationRoleRequest.builder()
- Parameters:
updateImpersonationRoleRequest
- AConsumer
that will call methods onUpdateImpersonationRoleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateImpersonationRole operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- ResourceNotFoundException The resource cannot be found.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- 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.
- See Also:
-
updateMailboxQuota
default CompletableFuture<UpdateMailboxQuotaResponse> updateMailboxQuota(UpdateMailboxQuotaRequest updateMailboxQuotaRequest) Updates a user's current mailbox quota for a specified organization and user.
- Parameters:
updateMailboxQuotaRequest
-- Returns:
- A Java Future containing the result of the UpdateMailboxQuota operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMailboxQuota
default CompletableFuture<UpdateMailboxQuotaResponse> updateMailboxQuota(Consumer<UpdateMailboxQuotaRequest.Builder> updateMailboxQuotaRequest) Updates a user's current mailbox quota for a specified organization and user.
This is a convenience which creates an instance of the
UpdateMailboxQuotaRequest.Builder
avoiding the need to create one manually viaUpdateMailboxQuotaRequest.builder()
- Parameters:
updateMailboxQuotaRequest
- AConsumer
that will call methods onUpdateMailboxQuotaRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMailboxQuota operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkMailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMobileDeviceAccessRule
default CompletableFuture<UpdateMobileDeviceAccessRuleResponse> updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest) Updates a mobile device access rule for the specified WorkMail organization.
- Parameters:
updateMobileDeviceAccessRuleRequest
-- Returns:
- A Java Future containing the result of the UpdateMobileDeviceAccessRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't 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.
- See Also:
-
updateMobileDeviceAccessRule
default CompletableFuture<UpdateMobileDeviceAccessRuleResponse> updateMobileDeviceAccessRule(Consumer<UpdateMobileDeviceAccessRuleRequest.Builder> updateMobileDeviceAccessRuleRequest) Updates a mobile device access rule for the specified WorkMail organization.
This is a convenience which creates an instance of the
UpdateMobileDeviceAccessRuleRequest.Builder
avoiding the need to create one manually viaUpdateMobileDeviceAccessRuleRequest.builder()
- Parameters:
updateMobileDeviceAccessRuleRequest
- AConsumer
that will call methods onUpdateMobileDeviceAccessRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMobileDeviceAccessRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't 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.
- See Also:
-
updatePrimaryEmailAddress
default CompletableFuture<UpdatePrimaryEmailAddressResponse> updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest) 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:
- A Java Future containing the result of the UpdatePrimaryEmailAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- 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.
- See Also:
-
updatePrimaryEmailAddress
default CompletableFuture<UpdatePrimaryEmailAddressResponse> updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest) 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.Builder
avoiding the need to create one manually viaUpdatePrimaryEmailAddressRequest.builder()
- Parameters:
updatePrimaryEmailAddressRequest
- AConsumer
that will call methods onUpdatePrimaryEmailAddressRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePrimaryEmailAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
- 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.
- See Also:
-
updateResource
default CompletableFuture<UpdateResourceResponse> updateResource(UpdateResourceRequest updateResourceRequest) Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another
DescribeResource
call.- Parameters:
updateResourceRequest
-- Returns:
- A Java Future containing the result of the UpdateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateResource
default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another
DescribeResource
call.
This is a convenience which creates an instance of the
UpdateResourceRequest.Builder
avoiding the need to create one manually viaUpdateResourceRequest.builder()
- Parameters:
updateResourceRequest
- AConsumer
that will call methods onUpdateResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateUser
Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another
DescribeUser
call.- Parameters:
updateUserRequest
-- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- 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.
- See Also:
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another
DescribeUser
call.
This is a convenience which creates an instance of the
UpdateUserRequest.Builder
avoiding the need to create one manually viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
- DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
- EntityNotFoundException The identifier supplied for the user, group, or resource does not exist in your organization.
- InvalidParameterException One or more of the input parameters don't match the service's restrictions.
- OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
- OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
- 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.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aWorkMailAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWorkMailAsyncClient
.
-