Interface WorkMailClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The WorkMail API is designed for the following scenarios:
-
Listing and describing organizations
-
Managing users
-
Managing groups
-
Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
-
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.default AssociateMemberToGroupResponse
associateMemberToGroup
(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest) Adds a member (user or group) to the group's set.default AssociateMemberToGroupResponse
associateMemberToGroup
(AssociateMemberToGroupRequest associateMemberToGroupRequest) Adds a member (user or group) to the group's set.default AssumeImpersonationRoleResponse
assumeImpersonationRole
(Consumer<AssumeImpersonationRoleRequest.Builder> assumeImpersonationRoleRequest) Assumes an impersonation role for the given WorkMail organization.default AssumeImpersonationRoleResponse
assumeImpersonationRole
(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest) Assumes an impersonation role for the given WorkMail organization.static WorkMailClientBuilder
builder()
Create a builder that can be used to configure and create aWorkMailClient
.default CancelMailboxExportJobResponse
cancelMailboxExportJob
(Consumer<CancelMailboxExportJobRequest.Builder> cancelMailboxExportJobRequest) Cancels a mailbox export job.default CancelMailboxExportJobResponse
cancelMailboxExportJob
(CancelMailboxExportJobRequest cancelMailboxExportJobRequest) Cancels a mailbox export job.static WorkMailClient
create()
Create aWorkMailClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAliasResponse
createAlias
(Consumer<CreateAliasRequest.Builder> createAliasRequest) Adds an alias to the set of a given member (user or group) of WorkMail.default 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 CreateGroupResponse
createGroup
(Consumer<CreateGroupRequest.Builder> createGroupRequest) Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.default CreateGroupResponse
createGroup
(CreateGroupRequest createGroupRequest) Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.default CreateImpersonationRoleResponse
createImpersonationRole
(Consumer<CreateImpersonationRoleRequest.Builder> createImpersonationRoleRequest) Creates an impersonation role for the given WorkMail organization.default CreateImpersonationRoleResponse
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.default CreateOrganizationResponse
createOrganization
(Consumer<CreateOrganizationRequest.Builder> createOrganizationRequest) Creates a new WorkMail organization.default CreateOrganizationResponse
createOrganization
(CreateOrganizationRequest createOrganizationRequest) Creates a new WorkMail organization.default CreateResourceResponse
createResource
(Consumer<CreateResourceRequest.Builder> createResourceRequest) Creates a new WorkMail resource.default CreateResourceResponse
createResource
(CreateResourceRequest createResourceRequest) Creates a new WorkMail resource.default CreateUserResponse
createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.default CreateUserResponse
createUser
(CreateUserRequest createUserRequest) Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.default DeleteAccessControlRuleResponse
deleteAccessControlRule
(Consumer<DeleteAccessControlRuleRequest.Builder> deleteAccessControlRuleRequest) Deletes an access control rule for the specified WorkMail organization.default DeleteAccessControlRuleResponse
deleteAccessControlRule
(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest) Deletes an access control rule for the specified WorkMail organization.default DeleteAliasResponse
deleteAlias
(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) Remove one or more specified aliases from a set of aliases for a given user.default 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 DeleteGroupResponse
deleteGroup
(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Deletes a group from WorkMail.default DeleteGroupResponse
deleteGroup
(DeleteGroupRequest deleteGroupRequest) Deletes a group from WorkMail.default DeleteImpersonationRoleResponse
deleteImpersonationRole
(Consumer<DeleteImpersonationRoleRequest.Builder> deleteImpersonationRoleRequest) Deletes an impersonation role for the given WorkMail organization.default DeleteImpersonationRoleResponse
deleteImpersonationRole
(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest) Deletes an impersonation role for the given WorkMail organization.default DeleteMailboxPermissionsResponse
deleteMailboxPermissions
(Consumer<DeleteMailboxPermissionsRequest.Builder> deleteMailboxPermissionsRequest) Deletes permissions granted to a member (user or group).default DeleteMailboxPermissionsResponse
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.default DeleteOrganizationResponse
deleteOrganization
(Consumer<DeleteOrganizationRequest.Builder> deleteOrganizationRequest) Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization.default DeleteOrganizationResponse
deleteOrganization
(DeleteOrganizationRequest deleteOrganizationRequest) Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization.default DeleteResourceResponse
deleteResource
(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) Deletes the specified resource.default DeleteResourceResponse
deleteResource
(DeleteResourceRequest deleteResourceRequest) Deletes the specified resource.default DeleteRetentionPolicyResponse
deleteRetentionPolicy
(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest) Deletes the specified retention policy from the specified organization.default DeleteRetentionPolicyResponse
deleteRetentionPolicy
(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) Deletes the specified retention policy from the specified organization.default DeleteUserResponse
deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user from WorkMail and all subsequent systems.default DeleteUserResponse
deleteUser
(DeleteUserRequest deleteUserRequest) Deletes a user from WorkMail and all subsequent systems.default DeregisterFromWorkMailResponse
deregisterFromWorkMail
(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest) Mark a user, group, or resource as no longer used in WorkMail.default DeregisterFromWorkMailResponse
deregisterFromWorkMail
(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest) Mark a user, group, or resource as no longer used in WorkMail.default DeregisterMailDomainResponse
deregisterMailDomain
(Consumer<DeregisterMailDomainRequest.Builder> deregisterMailDomainRequest) Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.default DeregisterMailDomainResponse
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 DescribeEntityResponse
describeEntity
(Consumer<DescribeEntityRequest.Builder> describeEntityRequest) Returns basic details about an entity in WorkMail.default DescribeEntityResponse
describeEntity
(DescribeEntityRequest describeEntityRequest) Returns basic details about an entity in WorkMail.default DescribeGroupResponse
describeGroup
(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Returns the data available for the group.default 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.default DescribeMailboxExportJobResponse
describeMailboxExportJob
(Consumer<DescribeMailboxExportJobRequest.Builder> describeMailboxExportJobRequest) Describes the current status of a mailbox export job.default DescribeMailboxExportJobResponse
describeMailboxExportJob
(DescribeMailboxExportJobRequest describeMailboxExportJobRequest) Describes the current status of a mailbox export job.default DescribeOrganizationResponse
describeOrganization
(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest) Provides more information regarding a given organization based on its identifier.default DescribeOrganizationResponse
describeOrganization
(DescribeOrganizationRequest describeOrganizationRequest) Provides more information regarding a given organization based on its identifier.default DescribeResourceResponse
describeResource
(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) Returns the data available for the resource.default DescribeResourceResponse
describeResource
(DescribeResourceRequest describeResourceRequest) Returns the data available for the resource.default DescribeUserResponse
describeUser
(Consumer<DescribeUserRequest.Builder> describeUserRequest) Provides information regarding the user.default 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.default 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.default 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.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.default GetImpersonationRoleResponse
getImpersonationRole
(Consumer<GetImpersonationRoleRequest.Builder> getImpersonationRoleRequest) Gets the impersonation role details for the given WorkMail organization.default GetImpersonationRoleResponse
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.default GetMailboxDetailsResponse
getMailboxDetails
(Consumer<GetMailboxDetailsRequest.Builder> getMailboxDetailsRequest) Requests a user's mailbox details for a specified organization and user.default GetMailboxDetailsResponse
getMailboxDetails
(GetMailboxDetailsRequest getMailboxDetailsRequest) Requests a user's mailbox details for a specified organization and user.default GetMailDomainResponse
getMailDomain
(Consumer<GetMailDomainRequest.Builder> getMailDomainRequest) Gets details for a mail domain, including domain records required to configure your domain with recommended security.default 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.default ListAccessControlRulesResponse
listAccessControlRules
(Consumer<ListAccessControlRulesRequest.Builder> listAccessControlRulesRequest) Lists the access control rules for the specified organization.default ListAccessControlRulesResponse
listAccessControlRules
(ListAccessControlRulesRequest listAccessControlRulesRequest) Lists the access control rules for the specified organization.default ListAliasesResponse
listAliases
(Consumer<ListAliasesRequest.Builder> listAliasesRequest) Creates a paginated call to list the aliases associated with a given entity.default ListAliasesResponse
listAliases
(ListAliasesRequest listAliasesRequest) Creates a paginated call to list the aliases associated with a given entity.default ListAliasesIterable
listAliasesPaginator
(Consumer<ListAliasesRequest.Builder> listAliasesRequest) This is a variant oflistAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation.default ListAliasesIterable
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.default ListGroupMembersResponse
listGroupMembers
(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) Returns an overview of the members of a group.default ListGroupMembersResponse
listGroupMembers
(ListGroupMembersRequest listGroupMembersRequest) Returns an overview of the members of a group.default ListGroupMembersIterable
listGroupMembersPaginator
(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) This is a variant oflistGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation.default ListGroupMembersIterable
listGroupMembersPaginator
(ListGroupMembersRequest listGroupMembersRequest) This is a variant oflistGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation.default ListGroupsResponse
listGroups
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Returns summaries of the organization's groups.default ListGroupsResponse
listGroups
(ListGroupsRequest listGroupsRequest) Returns summaries of the organization's groups.default ListGroupsForEntityResponse
listGroupsForEntity
(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) Returns all the groups to which an entity belongs.default ListGroupsForEntityResponse
listGroupsForEntity
(ListGroupsForEntityRequest listGroupsForEntityRequest) Returns all the groups to which an entity belongs.default ListGroupsForEntityIterable
listGroupsForEntityPaginator
(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) This is a variant oflistGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation.default ListGroupsForEntityIterable
listGroupsForEntityPaginator
(ListGroupsForEntityRequest listGroupsForEntityRequest) This is a variant oflistGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation.default ListGroupsIterable
listGroupsPaginator
(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation.default ListGroupsIterable
listGroupsPaginator
(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation.default ListImpersonationRolesResponse
listImpersonationRoles
(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) Lists all the impersonation roles for the given WorkMail organization.default ListImpersonationRolesResponse
listImpersonationRoles
(ListImpersonationRolesRequest listImpersonationRolesRequest) Lists all the impersonation roles for the given WorkMail organization.default ListImpersonationRolesIterable
listImpersonationRolesPaginator
(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) This is a variant oflistImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation.default ListImpersonationRolesIterable
listImpersonationRolesPaginator
(ListImpersonationRolesRequest listImpersonationRolesRequest) This is a variant oflistImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation.default ListMailboxExportJobsResponse
listMailboxExportJobs
(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) Lists the mailbox export jobs started for the specified organization within the last seven days.default ListMailboxExportJobsResponse
listMailboxExportJobs
(ListMailboxExportJobsRequest listMailboxExportJobsRequest) Lists the mailbox export jobs started for the specified organization within the last seven days.default ListMailboxExportJobsIterable
listMailboxExportJobsPaginator
(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) This is a variant oflistMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation.default ListMailboxExportJobsIterable
listMailboxExportJobsPaginator
(ListMailboxExportJobsRequest listMailboxExportJobsRequest) This is a variant oflistMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation.default ListMailboxPermissionsResponse
listMailboxPermissions
(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) Lists the mailbox permissions associated with a user, group, or resource mailbox.default ListMailboxPermissionsResponse
listMailboxPermissions
(ListMailboxPermissionsRequest listMailboxPermissionsRequest) Lists the mailbox permissions associated with a user, group, or resource mailbox.default ListMailboxPermissionsIterable
listMailboxPermissionsPaginator
(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) This is a variant oflistMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation.default ListMailboxPermissionsIterable
listMailboxPermissionsPaginator
(ListMailboxPermissionsRequest listMailboxPermissionsRequest) This is a variant oflistMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation.default ListMailDomainsResponse
listMailDomains
(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) Lists the mail domains in a given WorkMail organization.default ListMailDomainsResponse
listMailDomains
(ListMailDomainsRequest listMailDomainsRequest) Lists the mail domains in a given WorkMail organization.default ListMailDomainsIterable
listMailDomainsPaginator
(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) This is a variant oflistMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)
operation.default ListMailDomainsIterable
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.default ListOrganizationsResponse
Returns summaries of the customer's organizations.default ListOrganizationsResponse
listOrganizations
(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) Returns summaries of the customer's organizations.default ListOrganizationsResponse
listOrganizations
(ListOrganizationsRequest listOrganizationsRequest) Returns summaries of the customer's organizations.default ListOrganizationsIterable
This is a variant oflistOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.default ListOrganizationsIterable
listOrganizationsPaginator
(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) This is a variant oflistOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.default ListOrganizationsIterable
listOrganizationsPaginator
(ListOrganizationsRequest listOrganizationsRequest) This is a variant oflistOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.default ListResourceDelegatesResponse
listResourceDelegates
(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) Lists the delegates associated with a resource.default ListResourceDelegatesResponse
listResourceDelegates
(ListResourceDelegatesRequest listResourceDelegatesRequest) Lists the delegates associated with a resource.default ListResourceDelegatesIterable
listResourceDelegatesPaginator
(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) This is a variant oflistResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation.default ListResourceDelegatesIterable
listResourceDelegatesPaginator
(ListResourceDelegatesRequest listResourceDelegatesRequest) This is a variant oflistResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation.default ListResourcesResponse
listResources
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Returns summaries of the organization's resources.default ListResourcesResponse
listResources
(ListResourcesRequest listResourcesRequest) Returns summaries of the organization's resources.default ListResourcesIterable
listResourcesPaginator
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation.default ListResourcesIterable
listResourcesPaginator
(ListResourcesRequest listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to an WorkMail organization resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to an WorkMail organization resource.default ListUsersResponse
listUsers
(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns summaries of the organization's users.default ListUsersResponse
listUsers
(ListUsersRequest listUsersRequest) Returns summaries of the organization's users.default ListUsersIterable
listUsersPaginator
(Consumer<ListUsersRequest.Builder> listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation.default ListUsersIterable
listUsersPaginator
(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation.default PutAccessControlRuleResponse
putAccessControlRule
(Consumer<PutAccessControlRuleRequest.Builder> putAccessControlRuleRequest) Adds a new access control rule for the specified organization.default PutAccessControlRuleResponse
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.default PutInboundDmarcSettingsResponse
putInboundDmarcSettings
(Consumer<PutInboundDmarcSettingsRequest.Builder> putInboundDmarcSettingsRequest) Enables or disables a DMARC policy for a given organization.default PutInboundDmarcSettingsResponse
putInboundDmarcSettings
(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest) Enables or disables a DMARC policy for a given organization.default PutMailboxPermissionsResponse
putMailboxPermissions
(Consumer<PutMailboxPermissionsRequest.Builder> putMailboxPermissionsRequest) Sets permissions for a user, group, or resource.default PutMailboxPermissionsResponse
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.default PutRetentionPolicyResponse
putRetentionPolicy
(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest) Puts a retention policy to the specified organization.default PutRetentionPolicyResponse
putRetentionPolicy
(PutRetentionPolicyRequest putRetentionPolicyRequest) Puts a retention policy to the specified organization.default RegisterMailDomainResponse
registerMailDomain
(Consumer<RegisterMailDomainRequest.Builder> registerMailDomainRequest) Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.default RegisterMailDomainResponse
registerMailDomain
(RegisterMailDomainRequest registerMailDomainRequest) Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.default 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.default RegisterToWorkMailResponse
registerToWorkMail
(RegisterToWorkMailRequest registerToWorkMailRequest) Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities.default ResetPasswordResponse
resetPassword
(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest) Allows the administrator to reset the password for a user.default 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., ClientOverrideConfigurationstatic ServiceMetadata
default 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.default 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.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies the specified tags to the specified WorkMailorganization resource.default 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 UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Untags the specified tags from the specified WorkMail organization resource.default 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.default UpdateDefaultMailDomainResponse
updateDefaultMailDomain
(Consumer<UpdateDefaultMailDomainRequest.Builder> updateDefaultMailDomainRequest) Updates the default mail domain for an organization.default UpdateDefaultMailDomainResponse
updateDefaultMailDomain
(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest) Updates the default mail domain for an organization.default UpdateGroupResponse
updateGroup
(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Updates attibutes in a group.default UpdateGroupResponse
updateGroup
(UpdateGroupRequest updateGroupRequest) Updates attibutes in a group.default UpdateImpersonationRoleResponse
updateImpersonationRole
(Consumer<UpdateImpersonationRoleRequest.Builder> updateImpersonationRoleRequest) Updates an impersonation role for the given WorkMail organization.default UpdateImpersonationRoleResponse
updateImpersonationRole
(UpdateImpersonationRoleRequest updateImpersonationRoleRequest) Updates an impersonation role for the given WorkMail organization.default UpdateMailboxQuotaResponse
updateMailboxQuota
(Consumer<UpdateMailboxQuotaRequest.Builder> updateMailboxQuotaRequest) Updates a user's current mailbox quota for a specified organization and user.default UpdateMailboxQuotaResponse
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 UpdateResourceResponse
updateResource
(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) Updates data for the resource.default UpdateResourceResponse
updateResource
(UpdateResourceRequest updateResourceRequest) Updates data for the resource.default UpdateUserResponse
updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates data for the user.default 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 AssociateDelegateToResourceResponse associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Adds a member (user or group) to the resource's set of delegates.
- Parameters:
associateDelegateToResourceRequest
-- Returns:
- Result of the AssociateDelegateToResource operation returned by the service.
- See Also:
-
associateDelegateToResource
default AssociateDelegateToResourceResponse associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Adds a member (user or group) to the resource's set of delegates.
This is a convenience which creates an instance of the
AssociateDelegateToResourceRequest.Builder
avoiding the need to create one manually viaAssociateDelegateToResourceRequest.builder()
- Parameters:
associateDelegateToResourceRequest
- AConsumer
that will call methods onAssociateDelegateToResourceRequest.Builder
to create a request.- Returns:
- Result of the AssociateDelegateToResource operation returned by the service.
- See Also:
-
associateMemberToGroup
default AssociateMemberToGroupResponse associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Adds a member (user or group) to the group's set.
- Parameters:
associateMemberToGroupRequest
-- Returns:
- Result of the AssociateMemberToGroup operation returned by the service.
- See Also:
-
associateMemberToGroup
default AssociateMemberToGroupResponse associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Adds a member (user or group) to the group's set.
This is a convenience which creates an instance of the
AssociateMemberToGroupRequest.Builder
avoiding the need to create one manually viaAssociateMemberToGroupRequest.builder()
- Parameters:
associateMemberToGroupRequest
- AConsumer
that will call methods onAssociateMemberToGroupRequest.Builder
to create a request.- Returns:
- Result of the AssociateMemberToGroup operation returned by the service.
- See Also:
-
assumeImpersonationRole
default AssumeImpersonationRoleResponse assumeImpersonationRole(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
- Parameters:
assumeImpersonationRoleRequest
-- Returns:
- Result of the AssumeImpersonationRole operation returned by the service.
- See Also:
-
assumeImpersonationRole
default AssumeImpersonationRoleResponse assumeImpersonationRole(Consumer<AssumeImpersonationRoleRequest.Builder> assumeImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
This is a convenience which creates an instance of the
AssumeImpersonationRoleRequest.Builder
avoiding the need to create one manually viaAssumeImpersonationRoleRequest.builder()
- Parameters:
assumeImpersonationRoleRequest
- AConsumer
that will call methods onAssumeImpersonationRoleRequest.Builder
to create a request.- Returns:
- Result of the AssumeImpersonationRole operation returned by the service.
- See Also:
-
cancelMailboxExportJob
default CancelMailboxExportJobResponse cancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
- Parameters:
cancelMailboxExportJobRequest
-- Returns:
- Result of the CancelMailboxExportJob operation returned by the service.
- See Also:
-
cancelMailboxExportJob
default CancelMailboxExportJobResponse cancelMailboxExportJob(Consumer<CancelMailboxExportJobRequest.Builder> cancelMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
This is a convenience which creates an instance of the
CancelMailboxExportJobRequest.Builder
avoiding the need to create one manually viaCancelMailboxExportJobRequest.builder()
- Parameters:
cancelMailboxExportJobRequest
- AConsumer
that will call methods onCancelMailboxExportJobRequest.Builder
to create a request.- Returns:
- Result of the CancelMailboxExportJob operation returned by the service.
- See Also:
-
createAlias
default CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Adds an alias to the set of a given member (user or group) of WorkMail.
- Parameters:
createAliasRequest
-- Returns:
- Result of the CreateAlias operation returned by the service.
- See Also:
-
createAlias
default CreateAliasResponse createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) throws EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Adds an alias to the set of a given member (user or group) of WorkMail.
This is a convenience which creates an instance of the
CreateAliasRequest.Builder
avoiding the need to create one manually viaCreateAliasRequest.builder()
- Parameters:
createAliasRequest
- AConsumer
that will call methods onCreateAliasRequest.Builder
to create a request.- Returns:
- Result of the CreateAlias operation returned by the service.
- See Also:
-
createAvailabilityConfiguration
default CreateAvailabilityConfigurationResponse createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, NameAvailabilityException, InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Creates an
AvailabilityConfiguration
for the given WorkMail organization and domain.- Parameters:
createAvailabilityConfigurationRequest
-- Returns:
- Result of the CreateAvailabilityConfiguration operation returned by the service.
- See Also:
-
createAvailabilityConfiguration
default CreateAvailabilityConfigurationResponse createAvailabilityConfiguration(Consumer<CreateAvailabilityConfigurationRequest.Builder> createAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, NameAvailabilityException, InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException 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:
- Result of the CreateAvailabilityConfiguration operation returned by the service.
- See Also:
-
createGroup
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
- Parameters:
createGroupRequest
-- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
createGroup
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the
CreateGroupRequest.Builder
avoiding the need to create one manually viaCreateGroupRequest.builder()
- Parameters:
createGroupRequest
- AConsumer
that will call methods onCreateGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
createImpersonationRole
default CreateImpersonationRoleResponse createImpersonationRole(CreateImpersonationRoleRequest createImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Creates an impersonation role for the given WorkMail organization.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.
- Parameters:
createImpersonationRoleRequest
-- Returns:
- Result of the CreateImpersonationRole operation returned by the service.
- See Also:
-
createImpersonationRole
default CreateImpersonationRoleResponse createImpersonationRole(Consumer<CreateImpersonationRoleRequest.Builder> createImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Creates an impersonation role for the given WorkMail organization.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.
This is a convenience which creates an instance of the
CreateImpersonationRoleRequest.Builder
avoiding the need to create one manually viaCreateImpersonationRoleRequest.builder()
- Parameters:
createImpersonationRoleRequest
- AConsumer
that will call methods onCreateImpersonationRoleRequest.Builder
to create a request.- Returns:
- Result of the CreateImpersonationRole operation returned by the service.
- See Also:
-
createMobileDeviceAccessRule
default CreateMobileDeviceAccessRuleResponse createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest) throws InvalidParameterException, LimitExceededException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Creates a new mobile device access rule for the specified WorkMail organization.
- Parameters:
createMobileDeviceAccessRuleRequest
-- Returns:
- Result of the CreateMobileDeviceAccessRule operation returned by the service.
- See Also:
-
createMobileDeviceAccessRule
default CreateMobileDeviceAccessRuleResponse createMobileDeviceAccessRule(Consumer<CreateMobileDeviceAccessRuleRequest.Builder> createMobileDeviceAccessRuleRequest) throws InvalidParameterException, LimitExceededException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Creates a new mobile device access rule for the specified WorkMail organization.
This is a convenience which creates an instance of the
CreateMobileDeviceAccessRuleRequest.Builder
avoiding the need to create one manually viaCreateMobileDeviceAccessRuleRequest.builder()
- Parameters:
createMobileDeviceAccessRuleRequest
- AConsumer
that will call methods onCreateMobileDeviceAccessRuleRequest.Builder
to create a request.- Returns:
- Result of the CreateMobileDeviceAccessRule operation returned by the service.
- See Also:
-
createOrganization
default CreateOrganizationResponse createOrganization(CreateOrganizationRequest createOrganizationRequest) throws InvalidParameterException, DirectoryInUseException, DirectoryUnavailableException, LimitExceededException, NameAvailabilityException, AwsServiceException, SdkClientException, WorkMailException Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide.
Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
- Parameters:
createOrganizationRequest
-- Returns:
- Result of the CreateOrganization operation returned by the service.
- See Also:
-
createOrganization
default CreateOrganizationResponse createOrganization(Consumer<CreateOrganizationRequest.Builder> createOrganizationRequest) throws InvalidParameterException, DirectoryInUseException, DirectoryUnavailableException, LimitExceededException, NameAvailabilityException, AwsServiceException, SdkClientException, WorkMailException Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide.
Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
This is a convenience which creates an instance of the
CreateOrganizationRequest.Builder
avoiding the need to create one manually viaCreateOrganizationRequest.builder()
- Parameters:
createOrganizationRequest
- AConsumer
that will call methods onCreateOrganizationRequest.Builder
to create a request.- Returns:
- Result of the CreateOrganization operation returned by the service.
- See Also:
-
createResource
default CreateResourceResponse createResource(CreateResourceRequest createResourceRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Creates a new WorkMail resource.
- Parameters:
createResourceRequest
-- Returns:
- Result of the CreateResource operation returned by the service.
- See Also:
-
createResource
default CreateResourceResponse createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Creates a new WorkMail resource.
This is a convenience which creates an instance of the
CreateResourceRequest.Builder
avoiding the need to create one manually viaCreateResourceRequest.builder()
- Parameters:
createResourceRequest
- AConsumer
that will call methods onCreateResourceRequest.Builder
to create a request.- Returns:
- Result of the CreateResource operation returned by the service.
- See Also:
-
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, InvalidPasswordException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
- Parameters:
createUserRequest
-- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, InvalidPasswordException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the
CreateUserRequest.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
deleteAccessControlRule
default DeleteAccessControlRuleResponse deleteAccessControlRule(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes an access control rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
- Parameters:
deleteAccessControlRuleRequest
-- Returns:
- Result of the DeleteAccessControlRule operation returned by the service.
- See Also:
-
deleteAccessControlRule
default DeleteAccessControlRuleResponse deleteAccessControlRule(Consumer<DeleteAccessControlRuleRequest.Builder> deleteAccessControlRuleRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes an access control rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
This is a convenience which creates an instance of the
DeleteAccessControlRuleRequest.Builder
avoiding the need to create one manually viaDeleteAccessControlRuleRequest.builder()
- Parameters:
deleteAccessControlRuleRequest
- AConsumer
that will call methods onDeleteAccessControlRuleRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessControlRule operation returned by the service.
- See Also:
-
deleteAlias
default DeleteAliasResponse deleteAlias(DeleteAliasRequest deleteAliasRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Remove one or more specified aliases from a set of aliases for a given user.
- Parameters:
deleteAliasRequest
-- Returns:
- Result of the DeleteAlias operation returned by the service.
- See Also:
-
deleteAlias
default DeleteAliasResponse deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Remove one or more specified aliases from a set of aliases for a given user.
This is a convenience which creates an instance of the
DeleteAliasRequest.Builder
avoiding the need to create one manually viaDeleteAliasRequest.builder()
- Parameters:
deleteAliasRequest
- AConsumer
that will call methods onDeleteAliasRequest.Builder
to create a request.- Returns:
- Result of the DeleteAlias operation returned by the service.
- See Also:
-
deleteAvailabilityConfiguration
default DeleteAvailabilityConfigurationResponse deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes the
AvailabilityConfiguration
for the given WorkMail organization and domain.- Parameters:
deleteAvailabilityConfigurationRequest
-- Returns:
- Result of the DeleteAvailabilityConfiguration operation returned by the service.
- See Also:
-
deleteAvailabilityConfiguration
default DeleteAvailabilityConfigurationResponse deleteAvailabilityConfiguration(Consumer<DeleteAvailabilityConfigurationRequest.Builder> deleteAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException 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:
- Result of the DeleteAvailabilityConfiguration operation returned by the service.
- See Also:
-
deleteEmailMonitoringConfiguration
default DeleteEmailMonitoringConfigurationResponse deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes the email monitoring configuration for a specified organization.
- Parameters:
deleteEmailMonitoringConfigurationRequest
-- Returns:
- Result of the DeleteEmailMonitoringConfiguration operation returned by the service.
- See Also:
-
deleteEmailMonitoringConfiguration
default DeleteEmailMonitoringConfigurationResponse deleteEmailMonitoringConfiguration(Consumer<DeleteEmailMonitoringConfigurationRequest.Builder> deleteEmailMonitoringConfigurationRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes the email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
DeleteEmailMonitoringConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteEmailMonitoringConfigurationRequest.builder()
- Parameters:
deleteEmailMonitoringConfigurationRequest
- AConsumer
that will call methods onDeleteEmailMonitoringConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteEmailMonitoringConfiguration operation returned by the service.
- See Also:
-
deleteGroup
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Deletes a group from WorkMail.
- Parameters:
deleteGroupRequest
-- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
deleteGroup
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Deletes a group from WorkMail.
This is a convenience which creates an instance of the
DeleteGroupRequest.Builder
avoiding the need to create one manually viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
deleteImpersonationRole
default DeleteImpersonationRoleResponse deleteImpersonationRole(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes an impersonation role for the given WorkMail organization.
- Parameters:
deleteImpersonationRoleRequest
-- Returns:
- Result of the DeleteImpersonationRole operation returned by the service.
- See Also:
-
deleteImpersonationRole
default DeleteImpersonationRoleResponse deleteImpersonationRole(Consumer<DeleteImpersonationRoleRequest.Builder> deleteImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes an impersonation role for the given WorkMail organization.
This is a convenience which creates an instance of the
DeleteImpersonationRoleRequest.Builder
avoiding the need to create one manually viaDeleteImpersonationRoleRequest.builder()
- Parameters:
deleteImpersonationRoleRequest
- AConsumer
that will call methods onDeleteImpersonationRoleRequest.Builder
to create a request.- Returns:
- Result of the DeleteImpersonationRole operation returned by the service.
- See Also:
-
deleteMailboxPermissions
default DeleteMailboxPermissionsResponse deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes permissions granted to a member (user or group).
- Parameters:
deleteMailboxPermissionsRequest
-- Returns:
- Result of the DeleteMailboxPermissions operation returned by the service.
- See Also:
-
deleteMailboxPermissions
default DeleteMailboxPermissionsResponse deleteMailboxPermissions(Consumer<DeleteMailboxPermissionsRequest.Builder> deleteMailboxPermissionsRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes permissions granted to a member (user or group).
This is a convenience which creates an instance of the
DeleteMailboxPermissionsRequest.Builder
avoiding the need to create one manually viaDeleteMailboxPermissionsRequest.builder()
- Parameters:
deleteMailboxPermissionsRequest
- AConsumer
that will call methods onDeleteMailboxPermissionsRequest.Builder
to create a request.- Returns:
- Result of the DeleteMailboxPermissions operation returned by the service.
- See Also:
-
deleteMobileDeviceAccessOverride
default DeleteMobileDeviceAccessOverrideResponse deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Deletes the mobile device access override for the given WorkMail organization, user, and device.
Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
- Parameters:
deleteMobileDeviceAccessOverrideRequest
-- Returns:
- Result of the DeleteMobileDeviceAccessOverride operation returned by the service.
- See Also:
-
deleteMobileDeviceAccessOverride
default DeleteMobileDeviceAccessOverrideResponse deleteMobileDeviceAccessOverride(Consumer<DeleteMobileDeviceAccessOverrideRequest.Builder> deleteMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Deletes the mobile device access override for the given WorkMail organization, user, and device.
Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
This is a convenience which creates an instance of the
DeleteMobileDeviceAccessOverrideRequest.Builder
avoiding the need to create one manually viaDeleteMobileDeviceAccessOverrideRequest.builder()
- Parameters:
deleteMobileDeviceAccessOverrideRequest
- AConsumer
that will call methods onDeleteMobileDeviceAccessOverrideRequest.Builder
to create a request.- Returns:
- Result of the DeleteMobileDeviceAccessOverride operation returned by the service.
- See Also:
-
deleteMobileDeviceAccessRule
default DeleteMobileDeviceAccessRuleResponse deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes a mobile device access rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
- Parameters:
deleteMobileDeviceAccessRuleRequest
-- Returns:
- Result of the DeleteMobileDeviceAccessRule operation returned by the service.
- See Also:
-
deleteMobileDeviceAccessRule
default DeleteMobileDeviceAccessRuleResponse deleteMobileDeviceAccessRule(Consumer<DeleteMobileDeviceAccessRuleRequest.Builder> deleteMobileDeviceAccessRuleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes a mobile device access rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
This is a convenience which creates an instance of the
DeleteMobileDeviceAccessRuleRequest.Builder
avoiding the need to create one manually viaDeleteMobileDeviceAccessRuleRequest.builder()
- Parameters:
deleteMobileDeviceAccessRuleRequest
- AConsumer
that will call methods onDeleteMobileDeviceAccessRuleRequest.Builder
to create a request.- Returns:
- Result of the DeleteMobileDeviceAccessRule operation returned by the service.
- See Also:
-
deleteOrganization
default DeleteOrganizationResponse deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.
- Parameters:
deleteOrganizationRequest
-- Returns:
- Result of the DeleteOrganization operation returned by the service.
- See Also:
-
deleteOrganization
default DeleteOrganizationResponse deleteOrganization(Consumer<DeleteOrganizationRequest.Builder> deleteOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.
This is a convenience which creates an instance of the
DeleteOrganizationRequest.Builder
avoiding the need to create one manually viaDeleteOrganizationRequest.builder()
- Parameters:
deleteOrganizationRequest
- AConsumer
that will call methods onDeleteOrganizationRequest.Builder
to create a request.- Returns:
- Result of the DeleteOrganization operation returned by the service.
- See Also:
-
deleteResource
default DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest) throws EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Deletes the specified resource.
- Parameters:
deleteResourceRequest
-- Returns:
- Result of the DeleteResource operation returned by the service.
- See Also:
-
deleteResource
default DeleteResourceResponse deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) throws EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Deletes the specified resource.
This is a convenience which creates an instance of the
DeleteResourceRequest.Builder
avoiding the need to create one manually viaDeleteResourceRequest.builder()
- Parameters:
deleteResourceRequest
- AConsumer
that will call methods onDeleteResourceRequest.Builder
to create a request.- Returns:
- Result of the DeleteResource operation returned by the service.
- See Also:
-
deleteRetentionPolicy
default DeleteRetentionPolicyResponse deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes the specified retention policy from the specified organization.
- Parameters:
deleteRetentionPolicyRequest
-- Returns:
- Result of the DeleteRetentionPolicy operation returned by the service.
- See Also:
-
deleteRetentionPolicy
default DeleteRetentionPolicyResponse deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Deletes the specified retention policy from the specified organization.
This is a convenience which creates an instance of the
DeleteRetentionPolicyRequest.Builder
avoiding the need to create one manually viaDeleteRetentionPolicyRequest.builder()
- Parameters:
deleteRetentionPolicyRequest
- AConsumer
that will call methods onDeleteRetentionPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteRetentionPolicy operation returned by the service.
- See Also:
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be
DISABLED
. Use the DescribeUser action to confirm the user state.Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
- Parameters:
deleteUserRequest
-- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be
DISABLED
. Use the DescribeUser action to confirm the user state.Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
This is a convenience which creates an instance of the
DeleteUserRequest.Builder
avoiding the need to create one manually viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
deregisterFromWorkMail
default DeregisterFromWorkMailResponse deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
- Parameters:
deregisterFromWorkMailRequest
-- Returns:
- Result of the DeregisterFromWorkMail operation returned by the service.
- See Also:
-
deregisterFromWorkMail
default DeregisterFromWorkMailResponse deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
This is a convenience which creates an instance of the
DeregisterFromWorkMailRequest.Builder
avoiding the need to create one manually viaDeregisterFromWorkMailRequest.builder()
- Parameters:
deregisterFromWorkMailRequest
- AConsumer
that will call methods onDeregisterFromWorkMailRequest.Builder
to create a request.- Returns:
- Result of the DeregisterFromWorkMail operation returned by the service.
- See Also:
-
deregisterMailDomain
default DeregisterMailDomainResponse deregisterMailDomain(DeregisterMailDomainRequest deregisterMailDomainRequest) throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, InvalidCustomSesConfigurationException, AwsServiceException, SdkClientException, WorkMailException Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
- Parameters:
deregisterMailDomainRequest
-- Returns:
- Result of the DeregisterMailDomain operation returned by the service.
- See Also:
-
deregisterMailDomain
default DeregisterMailDomainResponse deregisterMailDomain(Consumer<DeregisterMailDomainRequest.Builder> deregisterMailDomainRequest) throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, InvalidCustomSesConfigurationException, AwsServiceException, SdkClientException, WorkMailException Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
This is a convenience which creates an instance of the
DeregisterMailDomainRequest.Builder
avoiding the need to create one manually viaDeregisterMailDomainRequest.builder()
- Parameters:
deregisterMailDomainRequest
- AConsumer
that will call methods onDeregisterMailDomainRequest.Builder
to create a request.- Returns:
- Result of the DeregisterMailDomain operation returned by the service.
- See Also:
-
describeEmailMonitoringConfiguration
default DescribeEmailMonitoringConfigurationResponse describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Describes the current email monitoring configuration for a specified organization.
- Parameters:
describeEmailMonitoringConfigurationRequest
-- Returns:
- Result of the DescribeEmailMonitoringConfiguration operation returned by the service.
- See Also:
-
describeEmailMonitoringConfiguration
default DescribeEmailMonitoringConfigurationResponse describeEmailMonitoringConfiguration(Consumer<DescribeEmailMonitoringConfigurationRequest.Builder> describeEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Describes the current email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
DescribeEmailMonitoringConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeEmailMonitoringConfigurationRequest.builder()
- Parameters:
describeEmailMonitoringConfigurationRequest
- AConsumer
that will call methods onDescribeEmailMonitoringConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DescribeEmailMonitoringConfiguration operation returned by the service.
- See Also:
-
describeEntity
default DescribeEntityResponse describeEntity(DescribeEntityRequest describeEntityRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns basic details about an entity in WorkMail.
- Parameters:
describeEntityRequest
-- Returns:
- Result of the DescribeEntity operation returned by the service.
- See Also:
-
describeEntity
default DescribeEntityResponse describeEntity(Consumer<DescribeEntityRequest.Builder> describeEntityRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns basic details about an entity in WorkMail.
This is a convenience which creates an instance of the
DescribeEntityRequest.Builder
avoiding the need to create one manually viaDescribeEntityRequest.builder()
- Parameters:
describeEntityRequest
- AConsumer
that will call methods onDescribeEntityRequest.Builder
to create a request.- Returns:
- Result of the DescribeEntity operation returned by the service.
- See Also:
-
describeGroup
default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns the data available for the group.
- Parameters:
describeGroupRequest
-- Returns:
- Result of the DescribeGroup operation returned by the service.
- See Also:
-
describeGroup
default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns the data available for the group.
This is a convenience which creates an instance of the
DescribeGroupRequest.Builder
avoiding the need to create one manually viaDescribeGroupRequest.builder()
- Parameters:
describeGroupRequest
- AConsumer
that will call methods onDescribeGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeGroup operation returned by the service.
- See Also:
-
describeInboundDmarcSettings
default DescribeInboundDmarcSettingsResponse describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the settings in a DMARC policy for a specified organization.
- Parameters:
describeInboundDmarcSettingsRequest
-- Returns:
- Result of the DescribeInboundDmarcSettings operation returned by the service.
- See Also:
-
describeInboundDmarcSettings
default DescribeInboundDmarcSettingsResponse describeInboundDmarcSettings(Consumer<DescribeInboundDmarcSettingsRequest.Builder> describeInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the settings in a DMARC policy for a specified organization.
This is a convenience which creates an instance of the
DescribeInboundDmarcSettingsRequest.Builder
avoiding the need to create one manually viaDescribeInboundDmarcSettingsRequest.builder()
- Parameters:
describeInboundDmarcSettingsRequest
- AConsumer
that will call methods onDescribeInboundDmarcSettingsRequest.Builder
to create a request.- Returns:
- Result of the DescribeInboundDmarcSettings operation returned by the service.
- See Also:
-
describeMailboxExportJob
default DescribeMailboxExportJobResponse describeMailboxExportJob(DescribeMailboxExportJobRequest describeMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Describes the current status of a mailbox export job.
- Parameters:
describeMailboxExportJobRequest
-- Returns:
- Result of the DescribeMailboxExportJob operation returned by the service.
- See Also:
-
describeMailboxExportJob
default DescribeMailboxExportJobResponse describeMailboxExportJob(Consumer<DescribeMailboxExportJobRequest.Builder> describeMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Describes the current status of a mailbox export job.
This is a convenience which creates an instance of the
DescribeMailboxExportJobRequest.Builder
avoiding the need to create one manually viaDescribeMailboxExportJobRequest.builder()
- Parameters:
describeMailboxExportJobRequest
- AConsumer
that will call methods onDescribeMailboxExportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeMailboxExportJob operation returned by the service.
- See Also:
-
describeOrganization
default DescribeOrganizationResponse describeOrganization(DescribeOrganizationRequest describeOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, AwsServiceException, SdkClientException, WorkMailException Provides more information regarding a given organization based on its identifier.
- Parameters:
describeOrganizationRequest
-- Returns:
- Result of the DescribeOrganization operation returned by the service.
- See Also:
-
describeOrganization
default DescribeOrganizationResponse describeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, AwsServiceException, SdkClientException, WorkMailException Provides more information regarding a given organization based on its identifier.
This is a convenience which creates an instance of the
DescribeOrganizationRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationRequest.builder()
- Parameters:
describeOrganizationRequest
- AConsumer
that will call methods onDescribeOrganizationRequest.Builder
to create a request.- Returns:
- Result of the DescribeOrganization operation returned by the service.
- See Also:
-
describeResource
default DescribeResourceResponse describeResource(DescribeResourceRequest describeResourceRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Returns the data available for the resource.
- Parameters:
describeResourceRequest
-- Returns:
- Result of the DescribeResource operation returned by the service.
- See Also:
-
describeResource
default DescribeResourceResponse describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Returns the data available for the resource.
This is a convenience which creates an instance of the
DescribeResourceRequest.Builder
avoiding the need to create one manually viaDescribeResourceRequest.builder()
- Parameters:
describeResourceRequest
- AConsumer
that will call methods onDescribeResourceRequest.Builder
to create a request.- Returns:
- Result of the DescribeResource operation returned by the service.
- See Also:
-
describeUser
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Provides information regarding the user.
- Parameters:
describeUserRequest
-- Returns:
- Result of the DescribeUser operation returned by the service.
- See Also:
-
describeUser
default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Provides information regarding the user.
This is a convenience which creates an instance of the
DescribeUserRequest.Builder
avoiding the need to create one manually viaDescribeUserRequest.builder()
- Parameters:
describeUserRequest
- AConsumer
that will call methods onDescribeUserRequest.Builder
to create a request.- Returns:
- Result of the DescribeUser operation returned by the service.
- See Also:
-
disassociateDelegateFromResource
default DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Removes a member from the resource's set of delegates.
- Parameters:
disassociateDelegateFromResourceRequest
-- Returns:
- Result of the DisassociateDelegateFromResource operation returned by the service.
- See Also:
-
disassociateDelegateFromResource
default DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Removes a member from the resource's set of delegates.
This is a convenience which creates an instance of the
DisassociateDelegateFromResourceRequest.Builder
avoiding the need to create one manually viaDisassociateDelegateFromResourceRequest.builder()
- Parameters:
disassociateDelegateFromResourceRequest
- AConsumer
that will call methods onDisassociateDelegateFromResourceRequest.Builder
to create a request.- Returns:
- Result of the DisassociateDelegateFromResource operation returned by the service.
- See Also:
-
disassociateMemberFromGroup
default DisassociateMemberFromGroupResponse disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Removes a member from a group.
- Parameters:
disassociateMemberFromGroupRequest
-- Returns:
- Result of the DisassociateMemberFromGroup operation returned by the service.
- See Also:
-
disassociateMemberFromGroup
default DisassociateMemberFromGroupResponse disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Removes a member from a group.
This is a convenience which creates an instance of the
DisassociateMemberFromGroupRequest.Builder
avoiding the need to create one manually viaDisassociateMemberFromGroupRequest.builder()
- Parameters:
disassociateMemberFromGroupRequest
- AConsumer
that will call methods onDisassociateMemberFromGroupRequest.Builder
to create a request.- Returns:
- Result of the DisassociateMemberFromGroup operation returned by the service.
- See Also:
-
getAccessControlEffect
default GetAccessControlEffectResponse getAccessControlEffect(GetAccessControlEffectRequest getAccessControlEffectRequest) throws EntityNotFoundException, ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
- Parameters:
getAccessControlEffectRequest
-- Returns:
- Result of the GetAccessControlEffect operation returned by the service.
- See Also:
-
getAccessControlEffect
default GetAccessControlEffectResponse getAccessControlEffect(Consumer<GetAccessControlEffectRequest.Builder> getAccessControlEffectRequest) throws EntityNotFoundException, ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
This is a convenience which creates an instance of the
GetAccessControlEffectRequest.Builder
avoiding the need to create one manually viaGetAccessControlEffectRequest.builder()
- Parameters:
getAccessControlEffectRequest
- AConsumer
that will call methods onGetAccessControlEffectRequest.Builder
to create a request.- Returns:
- Result of the GetAccessControlEffect operation returned by the service.
- See Also:
-
getDefaultRetentionPolicy
default GetDefaultRetentionPolicyResponse getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Gets the default retention policy details for the specified organization.
- Parameters:
getDefaultRetentionPolicyRequest
-- Returns:
- Result of the GetDefaultRetentionPolicy operation returned by the service.
- See Also:
-
getDefaultRetentionPolicy
default GetDefaultRetentionPolicyResponse getDefaultRetentionPolicy(Consumer<GetDefaultRetentionPolicyRequest.Builder> getDefaultRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Gets the default retention policy details for the specified organization.
This is a convenience which creates an instance of the
GetDefaultRetentionPolicyRequest.Builder
avoiding the need to create one manually viaGetDefaultRetentionPolicyRequest.builder()
- Parameters:
getDefaultRetentionPolicyRequest
- AConsumer
that will call methods onGetDefaultRetentionPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetDefaultRetentionPolicy operation returned by the service.
- See Also:
-
getImpersonationRole
default GetImpersonationRoleResponse getImpersonationRole(GetImpersonationRoleRequest getImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Gets the impersonation role details for the given WorkMail organization.
- Parameters:
getImpersonationRoleRequest
-- Returns:
- Result of the GetImpersonationRole operation returned by the service.
- See Also:
-
getImpersonationRole
default GetImpersonationRoleResponse getImpersonationRole(Consumer<GetImpersonationRoleRequest.Builder> getImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Gets the impersonation role details for the given WorkMail organization.
This is a convenience which creates an instance of the
GetImpersonationRoleRequest.Builder
avoiding the need to create one manually viaGetImpersonationRoleRequest.builder()
- Parameters:
getImpersonationRoleRequest
- AConsumer
that will call methods onGetImpersonationRoleRequest.Builder
to create a request.- Returns:
- Result of the GetImpersonationRole operation returned by the service.
- See Also:
-
getImpersonationRoleEffect
default GetImpersonationRoleEffectResponse getImpersonationRoleEffect(GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException Tests whether the given impersonation role can impersonate a target user.
- Parameters:
getImpersonationRoleEffectRequest
-- Returns:
- Result of the GetImpersonationRoleEffect operation returned by the service.
- See Also:
-
getImpersonationRoleEffect
default GetImpersonationRoleEffectResponse getImpersonationRoleEffect(Consumer<GetImpersonationRoleEffectRequest.Builder> getImpersonationRoleEffectRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException Tests whether the given impersonation role can impersonate a target user.
This is a convenience which creates an instance of the
GetImpersonationRoleEffectRequest.Builder
avoiding the need to create one manually viaGetImpersonationRoleEffectRequest.builder()
- Parameters:
getImpersonationRoleEffectRequest
- AConsumer
that will call methods onGetImpersonationRoleEffectRequest.Builder
to create a request.- Returns:
- Result of the GetImpersonationRoleEffect operation returned by the service.
- See Also:
-
getMailDomain
default GetMailDomainResponse getMailDomain(GetMailDomainRequest getMailDomainRequest) throws MailDomainNotFoundException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Gets details for a mail domain, including domain records required to configure your domain with recommended security.
- Parameters:
getMailDomainRequest
-- Returns:
- Result of the GetMailDomain operation returned by the service.
- See Also:
-
getMailDomain
default GetMailDomainResponse getMailDomain(Consumer<GetMailDomainRequest.Builder> getMailDomainRequest) throws MailDomainNotFoundException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Gets details for a mail domain, including domain records required to configure your domain with recommended security.
This is a convenience which creates an instance of the
GetMailDomainRequest.Builder
avoiding the need to create one manually viaGetMailDomainRequest.builder()
- Parameters:
getMailDomainRequest
- AConsumer
that will call methods onGetMailDomainRequest.Builder
to create a request.- Returns:
- Result of the GetMailDomain operation returned by the service.
- See Also:
-
getMailboxDetails
default GetMailboxDetailsResponse getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Requests a user's mailbox details for a specified organization and user.
- Parameters:
getMailboxDetailsRequest
-- Returns:
- Result of the GetMailboxDetails operation returned by the service.
- See Also:
-
getMailboxDetails
default GetMailboxDetailsResponse getMailboxDetails(Consumer<GetMailboxDetailsRequest.Builder> getMailboxDetailsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Requests a user's mailbox details for a specified organization and user.
This is a convenience which creates an instance of the
GetMailboxDetailsRequest.Builder
avoiding the need to create one manually viaGetMailboxDetailsRequest.builder()
- Parameters:
getMailboxDetailsRequest
- AConsumer
that will call methods onGetMailboxDetailsRequest.Builder
to create a request.- Returns:
- Result of the GetMailboxDetails operation returned by the service.
- See Also:
-
getMobileDeviceAccessEffect
default GetMobileDeviceAccessEffectResponse getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
- Parameters:
getMobileDeviceAccessEffectRequest
-- Returns:
- Result of the GetMobileDeviceAccessEffect operation returned by the service.
- See Also:
-
getMobileDeviceAccessEffect
default GetMobileDeviceAccessEffectResponse getMobileDeviceAccessEffect(Consumer<GetMobileDeviceAccessEffectRequest.Builder> getMobileDeviceAccessEffectRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
This is a convenience which creates an instance of the
GetMobileDeviceAccessEffectRequest.Builder
avoiding the need to create one manually viaGetMobileDeviceAccessEffectRequest.builder()
- Parameters:
getMobileDeviceAccessEffectRequest
- AConsumer
that will call methods onGetMobileDeviceAccessEffectRequest.Builder
to create a request.- Returns:
- Result of the GetMobileDeviceAccessEffect operation returned by the service.
- See Also:
-
getMobileDeviceAccessOverride
default GetMobileDeviceAccessOverrideResponse getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Gets the mobile device access override for the given WorkMail organization, user, and device.
- Parameters:
getMobileDeviceAccessOverrideRequest
-- Returns:
- Result of the GetMobileDeviceAccessOverride operation returned by the service.
- See Also:
-
getMobileDeviceAccessOverride
default GetMobileDeviceAccessOverrideResponse getMobileDeviceAccessOverride(Consumer<GetMobileDeviceAccessOverrideRequest.Builder> getMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Gets the mobile device access override for the given WorkMail organization, user, and device.
This is a convenience which creates an instance of the
GetMobileDeviceAccessOverrideRequest.Builder
avoiding the need to create one manually viaGetMobileDeviceAccessOverrideRequest.builder()
- Parameters:
getMobileDeviceAccessOverrideRequest
- AConsumer
that will call methods onGetMobileDeviceAccessOverrideRequest.Builder
to create a request.- Returns:
- Result of the GetMobileDeviceAccessOverride operation returned by the service.
- See Also:
-
listAccessControlRules
default ListAccessControlRulesResponse listAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the access control rules for the specified organization.
- Parameters:
listAccessControlRulesRequest
-- Returns:
- Result of the ListAccessControlRules operation returned by the service.
- See Also:
-
listAccessControlRules
default ListAccessControlRulesResponse listAccessControlRules(Consumer<ListAccessControlRulesRequest.Builder> listAccessControlRulesRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the access control rules for the specified organization.
This is a convenience which creates an instance of the
ListAccessControlRulesRequest.Builder
avoiding the need to create one manually viaListAccessControlRulesRequest.builder()
- Parameters:
listAccessControlRulesRequest
- AConsumer
that will call methods onListAccessControlRulesRequest.Builder
to create a request.- Returns:
- Result of the ListAccessControlRules operation returned by the service.
- See Also:
-
listAliases
default ListAliasesResponse listAliases(ListAliasesRequest listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Creates a paginated call to list the aliases associated with a given entity.
- Parameters:
listAliasesRequest
-- Returns:
- Result of the ListAliases operation returned by the service.
- See Also:
-
listAliases
default ListAliasesResponse listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Creates a paginated call to list the aliases associated with a given entity.
This is a convenience which creates an instance of the
ListAliasesRequest.Builder
avoiding the need to create one manually viaListAliasesRequest.builder()
- Parameters:
listAliasesRequest
- AConsumer
that will call methods onListAliasesRequest.Builder
to create a request.- Returns:
- Result of the ListAliases operation returned by the service.
- See Also:
-
listAliasesPaginator
default ListAliasesIterable listAliasesPaginator(ListAliasesRequest listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListAliasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation.- Parameters:
listAliasesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAliasesPaginator
default ListAliasesIterable listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListAliasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation.
This is a convenience which creates an instance of the
ListAliasesRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listAvailabilityConfigurations
default ListAvailabilityConfigurationsResponse listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException List all the
AvailabilityConfiguration
's for the given WorkMail organization.- Parameters:
listAvailabilityConfigurationsRequest
-- Returns:
- Result of the ListAvailabilityConfigurations operation returned by the service.
- See Also:
-
listAvailabilityConfigurations
default ListAvailabilityConfigurationsResponse listAvailabilityConfigurations(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException List all the
AvailabilityConfiguration
's for the given WorkMail organization.
This is a convenience which creates an instance of the
ListAvailabilityConfigurationsRequest.Builder
avoiding the need to create one manually viaListAvailabilityConfigurationsRequest.builder()
- Parameters:
listAvailabilityConfigurationsRequest
- AConsumer
that will call methods onListAvailabilityConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the ListAvailabilityConfigurations operation returned by the service.
- See Also:
-
listAvailabilityConfigurationsPaginator
default ListAvailabilityConfigurationsIterable listAvailabilityConfigurationsPaginator(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client .listAvailabilityConfigurationsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation.- Parameters:
listAvailabilityConfigurationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAvailabilityConfigurationsPaginator
default ListAvailabilityConfigurationsIterable listAvailabilityConfigurationsPaginator(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client .listAvailabilityConfigurationsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListAvailabilityConfigurationsRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupMembers
default ListGroupMembersResponse listGroupMembers(ListGroupMembersRequest listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns an overview of the members of a group. Users and groups can be members of a group.
- Parameters:
listGroupMembersRequest
-- Returns:
- Result of the ListGroupMembers operation returned by the service.
- See Also:
-
listGroupMembers
default ListGroupMembersResponse listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns an overview of the members of a group. Users and groups can be members of a group.
This is a convenience which creates an instance of the
ListGroupMembersRequest.Builder
avoiding the need to create one manually viaListGroupMembersRequest.builder()
- Parameters:
listGroupMembersRequest
- AConsumer
that will call methods onListGroupMembersRequest.Builder
to create a request.- Returns:
- Result of the ListGroupMembers operation returned by the service.
- See Also:
-
listGroupMembersPaginator
default ListGroupMembersIterable listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client .listGroupMembersPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation.- Parameters:
listGroupMembersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupMembersPaginator
default ListGroupMembersIterable listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client .listGroupMembersPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest)
operation.
This is a convenience which creates an instance of the
ListGroupMembersRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroups
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns summaries of the organization's groups.
- Parameters:
listGroupsRequest
-- Returns:
- Result of the ListGroups operation returned by the service.
- See Also:
-
listGroups
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns summaries of the organization's groups.
This is a convenience which creates an instance of the
ListGroupsRequest.Builder
avoiding the need to create one manually viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListGroups operation returned by the service.
- See Also:
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation.- Parameters:
listGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListGroupsRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupsForEntity
default ListGroupsForEntityResponse listGroupsForEntity(ListGroupsForEntityRequest listGroupsForEntityRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Returns all the groups to which an entity belongs.
- Parameters:
listGroupsForEntityRequest
-- Returns:
- Result of the ListGroupsForEntity operation returned by the service.
- See Also:
-
listGroupsForEntity
default ListGroupsForEntityResponse listGroupsForEntity(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Returns all the groups to which an entity belongs.
This is a convenience which creates an instance of the
ListGroupsForEntityRequest.Builder
avoiding the need to create one manually viaListGroupsForEntityRequest.builder()
- Parameters:
listGroupsForEntityRequest
- AConsumer
that will call methods onListGroupsForEntityRequest.Builder
to create a request.- Returns:
- Result of the ListGroupsForEntity operation returned by the service.
- See Also:
-
listGroupsForEntityPaginator
default ListGroupsForEntityIterable listGroupsForEntityPaginator(ListGroupsForEntityRequest listGroupsForEntityRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client .listGroupsForEntityPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation.- Parameters:
listGroupsForEntityRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupsForEntityPaginator
default ListGroupsForEntityIterable listGroupsForEntityPaginator(Consumer<ListGroupsForEntityRequest.Builder> listGroupsForEntityRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client .listGroupsForEntityPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListGroupsForEntityResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListGroupsForEntityIterable responses = client.listGroupsForEntityPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupsForEntity(software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest)
operation.
This is a convenience which creates an instance of the
ListGroupsForEntityRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listImpersonationRoles
default ListImpersonationRolesResponse listImpersonationRoles(ListImpersonationRolesRequest listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists all the impersonation roles for the given WorkMail organization.
- Parameters:
listImpersonationRolesRequest
-- Returns:
- Result of the ListImpersonationRoles operation returned by the service.
- See Also:
-
listImpersonationRoles
default ListImpersonationRolesResponse listImpersonationRoles(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists all the impersonation roles for the given WorkMail organization.
This is a convenience which creates an instance of the
ListImpersonationRolesRequest.Builder
avoiding the need to create one manually viaListImpersonationRolesRequest.builder()
- Parameters:
listImpersonationRolesRequest
- AConsumer
that will call methods onListImpersonationRolesRequest.Builder
to create a request.- Returns:
- Result of the ListImpersonationRoles operation returned by the service.
- See Also:
-
listImpersonationRolesPaginator
default ListImpersonationRolesIterable listImpersonationRolesPaginator(ListImpersonationRolesRequest listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client .listImpersonationRolesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation.- Parameters:
listImpersonationRolesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listImpersonationRolesPaginator
default ListImpersonationRolesIterable listImpersonationRolesPaginator(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client .listImpersonationRolesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation.
This is a convenience which creates an instance of the
ListImpersonationRolesRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listMailDomains
default ListMailDomainsResponse listMailDomains(ListMailDomainsRequest listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the mail domains in a given WorkMail organization.
- Parameters:
listMailDomainsRequest
-- Returns:
- Result of the ListMailDomains operation returned by the service.
- See Also:
-
listMailDomains
default ListMailDomainsResponse listMailDomains(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the mail domains in a given WorkMail organization.
This is a convenience which creates an instance of the
ListMailDomainsRequest.Builder
avoiding the need to create one manually viaListMailDomainsRequest.builder()
- Parameters:
listMailDomainsRequest
- AConsumer
that will call methods onListMailDomainsRequest.Builder
to create a request.- Returns:
- Result of the ListMailDomains operation returned by the service.
- See Also:
-
listMailDomainsPaginator
default ListMailDomainsIterable listMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client .listMailDomainsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)
operation.- Parameters:
listMailDomainsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMailDomainsPaginator
default ListMailDomainsIterable listMailDomainsPaginator(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client .listMailDomainsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest)
operation.
This is a convenience which creates an instance of the
ListMailDomainsRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listMailboxExportJobs
default ListMailboxExportJobsResponse listMailboxExportJobs(ListMailboxExportJobsRequest listMailboxExportJobsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the mailbox export jobs started for the specified organization within the last seven days.
- Parameters:
listMailboxExportJobsRequest
-- Returns:
- Result of the ListMailboxExportJobs operation returned by the service.
- See Also:
-
listMailboxExportJobs
default ListMailboxExportJobsResponse listMailboxExportJobs(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the mailbox export jobs started for the specified organization within the last seven days.
This is a convenience which creates an instance of the
ListMailboxExportJobsRequest.Builder
avoiding the need to create one manually viaListMailboxExportJobsRequest.builder()
- Parameters:
listMailboxExportJobsRequest
- AConsumer
that will call methods onListMailboxExportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListMailboxExportJobs operation returned by the service.
- See Also:
-
listMailboxExportJobsPaginator
default ListMailboxExportJobsIterable listMailboxExportJobsPaginator(ListMailboxExportJobsRequest listMailboxExportJobsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client .listMailboxExportJobsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation.- Parameters:
listMailboxExportJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMailboxExportJobsPaginator
default ListMailboxExportJobsIterable listMailboxExportJobsPaginator(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client .listMailboxExportJobsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation.
This is a convenience which creates an instance of the
ListMailboxExportJobsRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listMailboxPermissions
default ListMailboxPermissionsResponse listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the mailbox permissions associated with a user, group, or resource mailbox.
- Parameters:
listMailboxPermissionsRequest
-- Returns:
- Result of the ListMailboxPermissions operation returned by the service.
- See Also:
-
listMailboxPermissions
default ListMailboxPermissionsResponse listMailboxPermissions(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the mailbox permissions associated with a user, group, or resource mailbox.
This is a convenience which creates an instance of the
ListMailboxPermissionsRequest.Builder
avoiding the need to create one manually viaListMailboxPermissionsRequest.builder()
- Parameters:
listMailboxPermissionsRequest
- AConsumer
that will call methods onListMailboxPermissionsRequest.Builder
to create a request.- Returns:
- Result of the ListMailboxPermissions operation returned by the service.
- See Also:
-
listMailboxPermissionsPaginator
default ListMailboxPermissionsIterable listMailboxPermissionsPaginator(ListMailboxPermissionsRequest listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client .listMailboxPermissionsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation.- Parameters:
listMailboxPermissionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMailboxPermissionsPaginator
default ListMailboxPermissionsIterable listMailboxPermissionsPaginator(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client .listMailboxPermissionsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation.
This is a convenience which creates an instance of the
ListMailboxPermissionsRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listMobileDeviceAccessOverrides
default ListMobileDeviceAccessOverridesResponse listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
- Parameters:
listMobileDeviceAccessOverridesRequest
-- Returns:
- Result of the ListMobileDeviceAccessOverrides operation returned by the service.
- See Also:
-
listMobileDeviceAccessOverrides
default ListMobileDeviceAccessOverridesResponse listMobileDeviceAccessOverrides(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
This is a convenience which creates an instance of the
ListMobileDeviceAccessOverridesRequest.Builder
avoiding the need to create one manually viaListMobileDeviceAccessOverridesRequest.builder()
- Parameters:
listMobileDeviceAccessOverridesRequest
- AConsumer
that will call methods onListMobileDeviceAccessOverridesRequest.Builder
to create a request.- Returns:
- Result of the ListMobileDeviceAccessOverrides operation returned by the service.
- See Also:
-
listMobileDeviceAccessOverridesPaginator
default ListMobileDeviceAccessOverridesIterable listMobileDeviceAccessOverridesPaginator(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client .listMobileDeviceAccessOverridesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation.- Parameters:
listMobileDeviceAccessOverridesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMobileDeviceAccessOverridesPaginator
default ListMobileDeviceAccessOverridesIterable listMobileDeviceAccessOverridesPaginator(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client .listMobileDeviceAccessOverridesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation.
This is a convenience which creates an instance of the
ListMobileDeviceAccessOverridesRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listMobileDeviceAccessRules
default ListMobileDeviceAccessRulesResponse listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the mobile device access rules for the specified WorkMail organization.
- Parameters:
listMobileDeviceAccessRulesRequest
-- Returns:
- Result of the ListMobileDeviceAccessRules operation returned by the service.
- See Also:
-
listMobileDeviceAccessRules
default ListMobileDeviceAccessRulesResponse listMobileDeviceAccessRules(Consumer<ListMobileDeviceAccessRulesRequest.Builder> listMobileDeviceAccessRulesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Lists the mobile device access rules for the specified WorkMail organization.
This is a convenience which creates an instance of the
ListMobileDeviceAccessRulesRequest.Builder
avoiding the need to create one manually viaListMobileDeviceAccessRulesRequest.builder()
- Parameters:
listMobileDeviceAccessRulesRequest
- AConsumer
that will call methods onListMobileDeviceAccessRulesRequest.Builder
to create a request.- Returns:
- Result of the ListMobileDeviceAccessRules operation returned by the service.
- See Also:
-
listOrganizations
default ListOrganizationsResponse listOrganizations(ListOrganizationsRequest listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Returns summaries of the customer's organizations.
- Parameters:
listOrganizationsRequest
-- Returns:
- Result of the ListOrganizations operation returned by the service.
- See Also:
-
listOrganizations
default ListOrganizationsResponse listOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Returns summaries of the customer's organizations.
This is a convenience which creates an instance of the
ListOrganizationsRequest.Builder
avoiding the need to create one manually viaListOrganizationsRequest.builder()
- Parameters:
listOrganizationsRequest
- AConsumer
that will call methods onListOrganizationsRequest.Builder
to create a request.- Returns:
- Result of the ListOrganizations operation returned by the service.
- See Also:
-
listOrganizations
default ListOrganizationsResponse listOrganizations() throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailExceptionReturns summaries of the customer's organizations.
- Returns:
- Result of the ListOrganizations operation returned by the service.
- See Also:
-
listOrganizationsPaginator
default ListOrganizationsIterable listOrganizationsPaginator() throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailExceptionThis is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client .listOrganizationsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listOrganizationsPaginator
default ListOrganizationsIterable listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client .listOrganizationsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.- Parameters:
listOrganizationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listOrganizationsPaginator
default ListOrganizationsIterable listOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client .listOrganizationsPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
This is a convenience which creates an instance of the
ListOrganizationsRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceDelegates
default ListResourceDelegatesResponse listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
- Parameters:
listResourceDelegatesRequest
-- Returns:
- Result of the ListResourceDelegates operation returned by the service.
- See Also:
-
listResourceDelegates
default ListResourceDelegatesResponse listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
This is a convenience which creates an instance of the
ListResourceDelegatesRequest.Builder
avoiding the need to create one manually viaListResourceDelegatesRequest.builder()
- Parameters:
listResourceDelegatesRequest
- AConsumer
that will call methods onListResourceDelegatesRequest.Builder
to create a request.- Returns:
- Result of the ListResourceDelegates operation returned by the service.
- See Also:
-
listResourceDelegatesPaginator
default ListResourceDelegatesIterable listResourceDelegatesPaginator(ListResourceDelegatesRequest listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client .listResourceDelegatesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation.- Parameters:
listResourceDelegatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceDelegatesPaginator
default ListResourceDelegatesIterable listResourceDelegatesPaginator(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client .listResourceDelegatesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation.
This is a convenience which creates an instance of the
ListResourceDelegatesRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listResources
default ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Returns summaries of the organization's resources.
- Parameters:
listResourcesRequest
-- Returns:
- Result of the ListResources operation returned by the service.
- See Also:
-
listResources
default ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Returns summaries of the organization's resources.
This is a convenience which creates an instance of the
ListResourcesRequest.Builder
avoiding the need to create one manually viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListResources operation returned by the service.
- See Also:
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation.- Parameters:
listResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListResourcesRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Lists the tags applied to an WorkMail organization resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Lists the tags applied to an WorkMail organization resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listUsers
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns summaries of the organization's users.
- Parameters:
listUsersRequest
-- Returns:
- Result of the ListUsers operation returned by the service.
- See Also:
-
listUsers
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Returns summaries of the organization's users.
This is a convenience which creates an instance of the
ListUsersRequest.Builder
avoiding the need to create one manually viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- Result of the ListUsers operation returned by the service.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation.- Parameters:
listUsersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException This is a variant of
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.workmail.model.ListUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation.
This is a convenience which creates an instance of the
ListUsersRequest.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
putAccessControlRule
default PutAccessControlRuleResponse putAccessControlRule(PutAccessControlRuleRequest putAccessControlRuleRequest) throws LimitExceededException, InvalidParameterException, EntityNotFoundException, ResourceNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
- Parameters:
putAccessControlRuleRequest
-- Returns:
- Result of the PutAccessControlRule operation returned by the service.
- See Also:
-
putAccessControlRule
default PutAccessControlRuleResponse putAccessControlRule(Consumer<PutAccessControlRuleRequest.Builder> putAccessControlRuleRequest) throws LimitExceededException, InvalidParameterException, EntityNotFoundException, ResourceNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
This is a convenience which creates an instance of the
PutAccessControlRuleRequest.Builder
avoiding the need to create one manually viaPutAccessControlRuleRequest.builder()
- Parameters:
putAccessControlRuleRequest
- AConsumer
that will call methods onPutAccessControlRuleRequest.Builder
to create a request.- Returns:
- Result of the PutAccessControlRule operation returned by the service.
- See Also:
-
putEmailMonitoringConfiguration
default PutEmailMonitoringConfigurationResponse putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Creates or updates the email monitoring configuration for a specified organization.
- Parameters:
putEmailMonitoringConfigurationRequest
-- Returns:
- Result of the PutEmailMonitoringConfiguration operation returned by the service.
- See Also:
-
putEmailMonitoringConfiguration
default PutEmailMonitoringConfigurationResponse putEmailMonitoringConfiguration(Consumer<PutEmailMonitoringConfigurationRequest.Builder> putEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Creates or updates the email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
PutEmailMonitoringConfigurationRequest.Builder
avoiding the need to create one manually viaPutEmailMonitoringConfigurationRequest.builder()
- Parameters:
putEmailMonitoringConfigurationRequest
- AConsumer
that will call methods onPutEmailMonitoringConfigurationRequest.Builder
to create a request.- Returns:
- Result of the PutEmailMonitoringConfiguration operation returned by the service.
- See Also:
-
putInboundDmarcSettings
default PutInboundDmarcSettingsResponse putInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Enables or disables a DMARC policy for a given organization.
- Parameters:
putInboundDmarcSettingsRequest
-- Returns:
- Result of the PutInboundDmarcSettings operation returned by the service.
- See Also:
-
putInboundDmarcSettings
default PutInboundDmarcSettingsResponse putInboundDmarcSettings(Consumer<PutInboundDmarcSettingsRequest.Builder> putInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Enables or disables a DMARC policy for a given organization.
This is a convenience which creates an instance of the
PutInboundDmarcSettingsRequest.Builder
avoiding the need to create one manually viaPutInboundDmarcSettingsRequest.builder()
- Parameters:
putInboundDmarcSettingsRequest
- AConsumer
that will call methods onPutInboundDmarcSettingsRequest.Builder
to create a request.- Returns:
- Result of the PutInboundDmarcSettings operation returned by the service.
- See Also:
-
putMailboxPermissions
default PutMailboxPermissionsResponse putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
- Parameters:
putMailboxPermissionsRequest
-- Returns:
- Result of the PutMailboxPermissions operation returned by the service.
- See Also:
-
putMailboxPermissions
default PutMailboxPermissionsResponse putMailboxPermissions(Consumer<PutMailboxPermissionsRequest.Builder> putMailboxPermissionsRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
This is a convenience which creates an instance of the
PutMailboxPermissionsRequest.Builder
avoiding the need to create one manually viaPutMailboxPermissionsRequest.builder()
- Parameters:
putMailboxPermissionsRequest
- AConsumer
that will call methods onPutMailboxPermissionsRequest.Builder
to create a request.- Returns:
- Result of the PutMailboxPermissions operation returned by the service.
- See Also:
-
putMobileDeviceAccessOverride
default PutMobileDeviceAccessOverrideResponse putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
- Parameters:
putMobileDeviceAccessOverrideRequest
-- Returns:
- Result of the PutMobileDeviceAccessOverride operation returned by the service.
- See Also:
-
putMobileDeviceAccessOverride
default PutMobileDeviceAccessOverrideResponse putMobileDeviceAccessOverride(Consumer<PutMobileDeviceAccessOverrideRequest.Builder> putMobileDeviceAccessOverrideRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
This is a convenience which creates an instance of the
PutMobileDeviceAccessOverrideRequest.Builder
avoiding the need to create one manually viaPutMobileDeviceAccessOverrideRequest.builder()
- Parameters:
putMobileDeviceAccessOverrideRequest
- AConsumer
that will call methods onPutMobileDeviceAccessOverrideRequest.Builder
to create a request.- Returns:
- Result of the PutMobileDeviceAccessOverride operation returned by the service.
- See Also:
-
putRetentionPolicy
default PutRetentionPolicyResponse putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Puts a retention policy to the specified organization.
- Parameters:
putRetentionPolicyRequest
-- Returns:
- Result of the PutRetentionPolicy operation returned by the service.
- See Also:
-
putRetentionPolicy
default PutRetentionPolicyResponse putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Puts a retention policy to the specified organization.
This is a convenience which creates an instance of the
PutRetentionPolicyRequest.Builder
avoiding the need to create one manually viaPutRetentionPolicyRequest.builder()
- Parameters:
putRetentionPolicyRequest
- AConsumer
that will call methods onPutRetentionPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutRetentionPolicy operation returned by the service.
- See Also:
-
registerMailDomain
default RegisterMailDomainResponse registerMailDomain(RegisterMailDomainRequest registerMailDomainRequest) throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
- Parameters:
registerMailDomainRequest
-- Returns:
- Result of the RegisterMailDomain operation returned by the service.
- See Also:
-
registerMailDomain
default RegisterMailDomainResponse registerMailDomain(Consumer<RegisterMailDomainRequest.Builder> registerMailDomainRequest) throws MailDomainInUseException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
This is a convenience which creates an instance of the
RegisterMailDomainRequest.Builder
avoiding the need to create one manually viaRegisterMailDomainRequest.builder()
- Parameters:
registerMailDomainRequest
- AConsumer
that will call methods onRegisterMailDomainRequest.Builder
to create a request.- Returns:
- Result of the RegisterMailDomain operation returned by the service.
- See Also:
-
registerToWorkMail
default RegisterToWorkMailResponse registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, EntityAlreadyRegisteredException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
- Parameters:
registerToWorkMailRequest
-- Returns:
- Result of the RegisterToWorkMail operation returned by the service.
- See Also:
-
registerToWorkMail
default RegisterToWorkMailResponse registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, EntityAlreadyRegisteredException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
This is a convenience which creates an instance of the
RegisterToWorkMailRequest.Builder
avoiding the need to create one manually viaRegisterToWorkMailRequest.builder()
- Parameters:
registerToWorkMailRequest
- AConsumer
that will call methods onRegisterToWorkMailRequest.Builder
to create a request.- Returns:
- Result of the RegisterToWorkMail operation returned by the service.
- See Also:
-
resetPassword
default ResetPasswordResponse resetPassword(ResetPasswordRequest resetPasswordRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, InvalidPasswordException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Allows the administrator to reset the password for a user.
- Parameters:
resetPasswordRequest
-- Returns:
- Result of the ResetPassword operation returned by the service.
- See Also:
-
resetPassword
default ResetPasswordResponse resetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, InvalidPasswordException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Allows the administrator to reset the password for a user.
This is a convenience which creates an instance of the
ResetPasswordRequest.Builder
avoiding the need to create one manually viaResetPasswordRequest.builder()
- Parameters:
resetPasswordRequest
- AConsumer
that will call methods onResetPasswordRequest.Builder
to create a request.- Returns:
- Result of the ResetPassword operation returned by the service.
- See Also:
-
startMailboxExportJob
default StartMailboxExportJobResponse startMailboxExportJob(StartMailboxExportJobRequest startMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
- Parameters:
startMailboxExportJobRequest
-- Returns:
- Result of the StartMailboxExportJob operation returned by the service.
- See Also:
-
startMailboxExportJob
default StartMailboxExportJobResponse startMailboxExportJob(Consumer<StartMailboxExportJobRequest.Builder> startMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
This is a convenience which creates an instance of the
StartMailboxExportJobRequest.Builder
avoiding the need to create one manually viaStartMailboxExportJobRequest.builder()
- Parameters:
startMailboxExportJobRequest
- AConsumer
that will call methods onStartMailboxExportJobRequest.Builder
to create a request.- Returns:
- Result of the StartMailboxExportJob operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyTagsException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Applies the specified tags to the specified WorkMailorganization resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyTagsException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Applies the specified tags to the specified WorkMailorganization resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
testAvailabilityConfiguration
default TestAvailabilityConfigurationResponse testAvailabilityConfiguration(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a
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:
- Result of the TestAvailabilityConfiguration operation returned by the service.
- See Also:
-
testAvailabilityConfiguration
default TestAvailabilityConfigurationResponse testAvailabilityConfiguration(Consumer<TestAvailabilityConfigurationRequest.Builder> testAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a
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:
- Result of the TestAvailabilityConfiguration operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Untags the specified tags from the specified WorkMail organization resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException Untags the specified tags from the specified WorkMail organization resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAvailabilityConfiguration
default UpdateAvailabilityConfigurationResponse updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Updates an existing
AvailabilityConfiguration
for the given WorkMail organization and domain.- Parameters:
updateAvailabilityConfigurationRequest
-- Returns:
- Result of the UpdateAvailabilityConfiguration operation returned by the service.
- See Also:
-
updateAvailabilityConfiguration
default UpdateAvailabilityConfigurationResponse updateAvailabilityConfiguration(Consumer<UpdateAvailabilityConfigurationRequest.Builder> updateAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException 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:
- Result of the UpdateAvailabilityConfiguration operation returned by the service.
- See Also:
-
updateDefaultMailDomain
default UpdateDefaultMailDomainResponse updateDefaultMailDomain(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest) throws MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
- Parameters:
updateDefaultMailDomainRequest
-- Returns:
- Result of the UpdateDefaultMailDomain operation returned by the service.
- See Also:
-
updateDefaultMailDomain
default UpdateDefaultMailDomainResponse updateDefaultMailDomain(Consumer<UpdateDefaultMailDomainRequest.Builder> updateDefaultMailDomainRequest) throws MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
This is a convenience which creates an instance of the
UpdateDefaultMailDomainRequest.Builder
avoiding the need to create one manually viaUpdateDefaultMailDomainRequest.builder()
- Parameters:
updateDefaultMailDomainRequest
- AConsumer
that will call methods onUpdateDefaultMailDomainRequest.Builder
to create a request.- Returns:
- Result of the UpdateDefaultMailDomain operation returned by the service.
- See Also:
-
updateGroup
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Updates attibutes in a group.
- Parameters:
updateGroupRequest
-- Returns:
- Result of the UpdateGroup operation returned by the service.
- See Also:
-
updateGroup
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws EntityNotFoundException, EntityStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Updates attibutes in a group.
This is a convenience which creates an instance of the
UpdateGroupRequest.Builder
avoiding the need to create one manually viaUpdateGroupRequest.builder()
- Parameters:
updateGroupRequest
- AConsumer
that will call methods onUpdateGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateGroup operation returned by the service.
- See Also:
-
updateImpersonationRole
default UpdateImpersonationRoleResponse updateImpersonationRole(UpdateImpersonationRoleRequest updateImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException, EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Updates an impersonation role for the given WorkMail organization.
- Parameters:
updateImpersonationRoleRequest
-- Returns:
- Result of the UpdateImpersonationRole operation returned by the service.
- See Also:
-
updateImpersonationRole
default UpdateImpersonationRoleResponse updateImpersonationRole(Consumer<UpdateImpersonationRoleRequest.Builder> updateImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException, EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException Updates an impersonation role for the given WorkMail organization.
This is a convenience which creates an instance of the
UpdateImpersonationRoleRequest.Builder
avoiding the need to create one manually viaUpdateImpersonationRoleRequest.builder()
- Parameters:
updateImpersonationRoleRequest
- AConsumer
that will call methods onUpdateImpersonationRoleRequest.Builder
to create a request.- Returns:
- Result of the UpdateImpersonationRole operation returned by the service.
- See Also:
-
updateMailboxQuota
default UpdateMailboxQuotaResponse updateMailboxQuota(UpdateMailboxQuotaRequest updateMailboxQuotaRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException Updates a user's current mailbox quota for a specified organization and user.
- Parameters:
updateMailboxQuotaRequest
-- Returns:
- Result of the UpdateMailboxQuota operation returned by the service.
- See Also:
-
updateMailboxQuota
default UpdateMailboxQuotaResponse updateMailboxQuota(Consumer<UpdateMailboxQuotaRequest.Builder> updateMailboxQuotaRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException Updates a user's current mailbox quota for a specified organization and user.
This is a convenience which creates an instance of the
UpdateMailboxQuotaRequest.Builder
avoiding the need to create one manually viaUpdateMailboxQuotaRequest.builder()
- Parameters:
updateMailboxQuotaRequest
- AConsumer
that will call methods onUpdateMailboxQuotaRequest.Builder
to create a request.- Returns:
- Result of the UpdateMailboxQuota operation returned by the service.
- See Also:
-
updateMobileDeviceAccessRule
default UpdateMobileDeviceAccessRuleResponse updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest) throws InvalidParameterException, EntityNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Updates a mobile device access rule for the specified WorkMail organization.
- Parameters:
updateMobileDeviceAccessRuleRequest
-- Returns:
- Result of the UpdateMobileDeviceAccessRule operation returned by the service.
- See Also:
-
updateMobileDeviceAccessRule
default UpdateMobileDeviceAccessRuleResponse updateMobileDeviceAccessRule(Consumer<UpdateMobileDeviceAccessRuleRequest.Builder> updateMobileDeviceAccessRuleRequest) throws InvalidParameterException, EntityNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException Updates a mobile device access rule for the specified WorkMail organization.
This is a convenience which creates an instance of the
UpdateMobileDeviceAccessRuleRequest.Builder
avoiding the need to create one manually viaUpdateMobileDeviceAccessRuleRequest.builder()
- Parameters:
updateMobileDeviceAccessRuleRequest
- AConsumer
that will call methods onUpdateMobileDeviceAccessRuleRequest.Builder
to create a request.- Returns:
- Result of the UpdateMobileDeviceAccessRule operation returned by the service.
- See Also:
-
updatePrimaryEmailAddress
default UpdatePrimaryEmailAddressResponse updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
- Parameters:
updatePrimaryEmailAddressRequest
-- Returns:
- Result of the UpdatePrimaryEmailAddress operation returned by the service.
- See Also:
-
updatePrimaryEmailAddress
default UpdatePrimaryEmailAddressResponse updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
This is a convenience which creates an instance of the
UpdatePrimaryEmailAddressRequest.Builder
avoiding the need to create one manually viaUpdatePrimaryEmailAddressRequest.builder()
- Parameters:
updatePrimaryEmailAddressRequest
- AConsumer
that will call methods onUpdatePrimaryEmailAddressRequest.Builder
to create a request.- Returns:
- Result of the UpdatePrimaryEmailAddress operation returned by the service.
- See Also:
-
updateResource
default UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException, EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another
DescribeResource
call.- Parameters:
updateResourceRequest
-- Returns:
- Result of the UpdateResource operation returned by the service.
- See Also:
-
updateResource
default UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException, EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another
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:
- Result of the UpdateResource operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another
DescribeUser
call.- Parameters:
updateUserRequest
-- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, EntityStateException, AwsServiceException, SdkClientException, WorkMailException Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another
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:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
create
Create aWorkMailClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWorkMailClient
. -
serviceMetadata
-
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
-