@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface WorkMailClient extends AwsClient
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateDelegateToResourceResponse |
associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member (user or group) to the resource's set of delegates.
|
default AssociateDelegateToResourceResponse |
associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest)
Adds a member (user or group) to the resource's set of delegates.
|
default AssociateMemberToGroupResponse |
associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member (user or group) to the group's set.
|
default AssociateMemberToGroupResponse |
associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest)
Adds a member (user or group) to the group's set.
|
default AssumeImpersonationRoleResponse |
assumeImpersonationRole(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest)
Assumes an impersonation role for the given WorkMail organization.
|
default AssumeImpersonationRoleResponse |
assumeImpersonationRole(Consumer<AssumeImpersonationRoleRequest.Builder> assumeImpersonationRoleRequest)
Assumes an impersonation role for the given WorkMail organization.
|
static WorkMailClientBuilder |
builder()
Create a builder that can be used to configure and create a
WorkMailClient. |
default CancelMailboxExportJobResponse |
cancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest)
Cancels a mailbox export job.
|
default CancelMailboxExportJobResponse |
cancelMailboxExportJob(Consumer<CancelMailboxExportJobRequest.Builder> cancelMailboxExportJobRequest)
Cancels a mailbox export job.
|
static WorkMailClient |
create()
Create a
WorkMailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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.
|
default CreateAvailabilityConfigurationResponse |
createAvailabilityConfiguration(Consumer<CreateAvailabilityConfigurationRequest.Builder> createAvailabilityConfigurationRequest)
Creates an
AvailabilityConfiguration for the given WorkMail organization and domain. |
default CreateAvailabilityConfigurationResponse |
createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest)
Creates an
AvailabilityConfiguration 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.
|
default CreateMobileDeviceAccessRuleResponse |
createMobileDeviceAccessRule(Consumer<CreateMobileDeviceAccessRuleRequest.Builder> createMobileDeviceAccessRuleRequest)
Creates a new mobile device access rule for the specified WorkMail organization.
|
default CreateMobileDeviceAccessRuleResponse |
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.
|
default DeleteAvailabilityConfigurationResponse |
deleteAvailabilityConfiguration(Consumer<DeleteAvailabilityConfigurationRequest.Builder> deleteAvailabilityConfigurationRequest)
Deletes the
AvailabilityConfiguration for the given WorkMail organization and domain. |
default DeleteAvailabilityConfigurationResponse |
deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest)
Deletes the
AvailabilityConfiguration for the given WorkMail organization and domain. |
default DeleteEmailMonitoringConfigurationResponse |
deleteEmailMonitoringConfiguration(Consumer<DeleteEmailMonitoringConfigurationRequest.Builder> deleteEmailMonitoringConfigurationRequest)
Deletes the email monitoring configuration for a specified organization.
|
default DeleteEmailMonitoringConfigurationResponse |
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).
|
default DeleteMobileDeviceAccessOverrideResponse |
deleteMobileDeviceAccessOverride(Consumer<DeleteMobileDeviceAccessOverrideRequest.Builder> deleteMobileDeviceAccessOverrideRequest)
Deletes the mobile device access override for the given WorkMail organization, user, and device.
|
default DeleteMobileDeviceAccessOverrideResponse |
deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest)
Deletes the mobile device access override for the given WorkMail organization, user, and device.
|
default DeleteMobileDeviceAccessRuleResponse |
deleteMobileDeviceAccessRule(Consumer<DeleteMobileDeviceAccessRuleRequest.Builder> deleteMobileDeviceAccessRuleRequest)
Deletes a mobile device access rule for the specified WorkMail organization.
|
default DeleteMobileDeviceAccessRuleResponse |
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.
|
default DescribeEmailMonitoringConfigurationResponse |
describeEmailMonitoringConfiguration(Consumer<DescribeEmailMonitoringConfigurationRequest.Builder> describeEmailMonitoringConfigurationRequest)
Describes the current email monitoring configuration for a specified organization.
|
default DescribeEmailMonitoringConfigurationResponse |
describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest)
Describes the current email monitoring configuration for a specified organization.
|
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.
|
default DescribeInboundDmarcSettingsResponse |
describeInboundDmarcSettings(Consumer<DescribeInboundDmarcSettingsRequest.Builder> describeInboundDmarcSettingsRequest)
Lists the settings in a DMARC policy for a specified organization.
|
default DescribeInboundDmarcSettingsResponse |
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.
|
default DisassociateDelegateFromResourceResponse |
disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
|
default DisassociateDelegateFromResourceResponse |
disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
|
default DisassociateMemberFromGroupResponse |
disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest)
Removes a member from a group.
|
default DisassociateMemberFromGroupResponse |
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.
|
default GetDefaultRetentionPolicyResponse |
getDefaultRetentionPolicy(Consumer<GetDefaultRetentionPolicyRequest.Builder> getDefaultRetentionPolicyRequest)
Gets the default retention policy details for the specified organization.
|
default GetDefaultRetentionPolicyResponse |
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.
|
default GetImpersonationRoleEffectResponse |
getImpersonationRoleEffect(Consumer<GetImpersonationRoleEffectRequest.Builder> getImpersonationRoleEffectRequest)
Tests whether the given impersonation role can impersonate a target user.
|
default GetImpersonationRoleEffectResponse |
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.
|
default GetMobileDeviceAccessEffectResponse |
getMobileDeviceAccessEffect(Consumer<GetMobileDeviceAccessEffectRequest.Builder> getMobileDeviceAccessEffectRequest)
Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
|
default GetMobileDeviceAccessEffectResponse |
getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest)
Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
|
default GetMobileDeviceAccessOverrideResponse |
getMobileDeviceAccessOverride(Consumer<GetMobileDeviceAccessOverrideRequest.Builder> getMobileDeviceAccessOverrideRequest)
Gets the mobile device access override for the given WorkMail organization, user, and device.
|
default GetMobileDeviceAccessOverrideResponse |
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)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListAliasesIterable |
listAliasesPaginator(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListAvailabilityConfigurationsResponse |
listAvailabilityConfigurations(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
default ListAvailabilityConfigurationsResponse |
listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
default ListAvailabilityConfigurationsIterable |
listAvailabilityConfigurationsPaginator(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
default ListAvailabilityConfigurationsIterable |
listAvailabilityConfigurationsPaginator(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
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)
Returns an overview of the members of a group.
|
default ListGroupMembersIterable |
listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
|
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 ListGroupsIterable |
listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
|
default ListGroupsIterable |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
|
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)
Lists all the impersonation roles for the given WorkMail organization.
|
default ListImpersonationRolesIterable |
listImpersonationRolesPaginator(ListImpersonationRolesRequest listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
|
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)
Lists the mailbox export jobs started for the specified organization within the last seven days.
|
default ListMailboxExportJobsIterable |
listMailboxExportJobsPaginator(ListMailboxExportJobsRequest listMailboxExportJobsRequest)
Lists the mailbox export jobs started for the specified organization within the last seven days.
|
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)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
default ListMailboxPermissionsIterable |
listMailboxPermissionsPaginator(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
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)
Lists the mail domains in a given WorkMail organization.
|
default ListMailDomainsIterable |
listMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
|
default ListMobileDeviceAccessOverridesResponse |
listMobileDeviceAccessOverrides(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
default ListMobileDeviceAccessOverridesResponse |
listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
default ListMobileDeviceAccessOverridesIterable |
listMobileDeviceAccessOverridesPaginator(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
default ListMobileDeviceAccessOverridesIterable |
listMobileDeviceAccessOverridesPaginator(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
default ListMobileDeviceAccessRulesResponse |
listMobileDeviceAccessRules(Consumer<ListMobileDeviceAccessRulesRequest.Builder> listMobileDeviceAccessRulesRequest)
Lists the mobile device access rules for the specified WorkMail organization.
|
default ListMobileDeviceAccessRulesResponse |
listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest)
Lists the mobile device access rules for the specified WorkMail organization.
|
default ListOrganizationsResponse |
listOrganizations()
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 |
listOrganizationsPaginator()
Returns summaries of the customer's organizations.
|
default ListOrganizationsIterable |
listOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
Returns summaries of the customer's organizations.
|
default ListOrganizationsIterable |
listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's organizations.
|
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)
Lists the delegates associated with a resource.
|
default ListResourceDelegatesIterable |
listResourceDelegatesPaginator(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
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)
Returns summaries of the organization's resources.
|
default ListResourcesIterable |
listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
|
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)
Returns summaries of the organization's users.
|
default ListUsersIterable |
listUsersPaginator(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
|
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.
|
default PutEmailMonitoringConfigurationResponse |
putEmailMonitoringConfiguration(Consumer<PutEmailMonitoringConfigurationRequest.Builder> putEmailMonitoringConfigurationRequest)
Creates or updates the email monitoring configuration for a specified organization.
|
default PutEmailMonitoringConfigurationResponse |
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.
|
default PutMobileDeviceAccessOverrideResponse |
putMobileDeviceAccessOverride(Consumer<PutMobileDeviceAccessOverrideRequest.Builder> putMobileDeviceAccessOverrideRequest)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
|
default PutMobileDeviceAccessOverrideResponse |
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.
|
default WorkMailServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
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.
|
default TestAvailabilityConfigurationResponse |
testAvailabilityConfiguration(Consumer<TestAvailabilityConfigurationRequest.Builder> testAvailabilityConfigurationRequest)
Performs a test on an availability provider to ensure that access is allowed.
|
default TestAvailabilityConfigurationResponse |
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.
|
default UpdateAvailabilityConfigurationResponse |
updateAvailabilityConfiguration(Consumer<UpdateAvailabilityConfigurationRequest.Builder> updateAvailabilityConfigurationRequest)
Updates an existing
AvailabilityConfiguration for the given WorkMail organization and domain. |
default UpdateAvailabilityConfigurationResponse |
updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest)
Updates an existing
AvailabilityConfiguration 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 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.
|
default UpdateMobileDeviceAccessRuleResponse |
updateMobileDeviceAccessRule(Consumer<UpdateMobileDeviceAccessRuleRequest.Builder> updateMobileDeviceAccessRuleRequest)
Updates a mobile device access rule for the specified WorkMail organization.
|
default UpdateMobileDeviceAccessRuleResponse |
updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest)
Updates a mobile device access rule for the specified WorkMail organization.
|
default UpdatePrimaryEmailAddressResponse |
updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest)
Updates the primary email for a user, group, or resource.
|
default UpdatePrimaryEmailAddressResponse |
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AssociateDelegateToResourceResponse associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Adds a member (user or group) to the resource's set of delegates.
associateDelegateToResourceRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateDelegateToResourceResponse associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, 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 via AssociateDelegateToResourceRequest.builder()
associateDelegateToResourceRequest - A Consumer that will call methods on AssociateDelegateToResourceRequest.Builder to create
a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
associateMemberToGroupRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 via AssociateMemberToGroupRequest.builder()
associateMemberToGroupRequest - A Consumer that will call methods on AssociateMemberToGroupRequest.Builder to create a
request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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.
assumeImpersonationRoleRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via AssumeImpersonationRoleRequest.builder()
assumeImpersonationRoleRequest - A Consumer that will call methods on AssumeImpersonationRoleRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
cancelMailboxExportJobRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CancelMailboxExportJobRequest.builder()
cancelMailboxExportJobRequest - A Consumer that will call methods on CancelMailboxExportJobRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createAliasRequest - EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateAliasRequest.builder()
createAliasRequest - A Consumer that will call methods on CreateAliasRequest.Builder to create a request.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAvailabilityConfigurationResponse createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, NameAvailabilityException, InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
createAvailabilityConfigurationRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateAvailabilityConfigurationRequest.builder()
createAvailabilityConfigurationRequest - A Consumer that will call methods on CreateAvailabilityConfigurationRequest.Builder to
create a request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createGroupRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ReservedNameException - This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 via CreateGroupRequest.builder()
createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ReservedNameException - This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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.
createImpersonationRoleRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateImpersonationRoleRequest.builder()
createImpersonationRoleRequest - A Consumer that will call methods on CreateImpersonationRoleRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateMobileDeviceAccessRuleResponse createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest) throws InvalidParameterException, LimitExceededException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a new mobile device access rule for the specified WorkMail organization.
createMobileDeviceAccessRuleRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.LimitExceededException - The request exceeds the limit of the resource.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateMobileDeviceAccessRuleRequest.builder()
createMobileDeviceAccessRuleRequest - A Consumer that will call methods on CreateMobileDeviceAccessRuleRequest.Builder to create
a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.LimitExceededException - The request exceeds the limit of the resource.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createOrganizationRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.DirectoryInUseException - The directory is already in use by another WorkMail organization in the same account and Region.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.LimitExceededException - The request exceeds the limit of the resource.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateOrganizationRequest.builder()
createOrganizationRequest - A Consumer that will call methods on CreateOrganizationRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.DirectoryInUseException - The directory is already in use by another WorkMail organization in the same account and Region.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.LimitExceededException - The request exceeds the limit of the resource.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateResourceResponse createResource(CreateResourceRequest createResourceRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, AwsServiceException, SdkClientException, WorkMailException
Creates a new WorkMail resource.
createResourceRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ReservedNameException - This user, group, or resource name is not allowed in WorkMail.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateResourceResponse createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, 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 via CreateResourceRequest.builder()
createResourceRequest - A Consumer that will call methods on CreateResourceRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ReservedNameException - This user, group, or resource name is not allowed in WorkMail.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createUserRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special
characters.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ReservedNameException - This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special
characters.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ReservedNameException - This user, group, or resource name is not allowed in WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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.
deleteAccessControlRuleRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteAccessControlRuleRequest.builder()
deleteAccessControlRuleRequest - A Consumer that will call methods on DeleteAccessControlRuleRequest.Builder to create a
request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteAliasRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteAliasRequest.builder()
deleteAliasRequest - A Consumer that will call methods on DeleteAliasRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAvailabilityConfigurationResponse deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
deleteAvailabilityConfigurationRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteAvailabilityConfigurationRequest.builder()
deleteAvailabilityConfigurationRequest - A Consumer that will call methods on DeleteAvailabilityConfigurationRequest.Builder to
create a request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEmailMonitoringConfigurationResponse deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the email monitoring configuration for a specified organization.
deleteEmailMonitoringConfigurationRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteEmailMonitoringConfigurationRequest.builder()
deleteEmailMonitoringConfigurationRequest - A Consumer that will call methods on DeleteEmailMonitoringConfigurationRequest.Builder to
create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes a group from WorkMail.
deleteGroupRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 via DeleteGroupRequest.builder()
deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault DeleteImpersonationRoleResponse deleteImpersonationRole(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes an impersonation role for the given WorkMail organization.
deleteImpersonationRoleRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteImpersonationRoleRequest.builder()
deleteImpersonationRoleRequest - A Consumer that will call methods on DeleteImpersonationRoleRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMailboxPermissionsResponse deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes permissions granted to a member (user or group).
deleteMailboxPermissionsRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteMailboxPermissionsRequest.builder()
deleteMailboxPermissionsRequest - A Consumer that will call methods on DeleteMailboxPermissionsRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteMobileDeviceAccessOverrideRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteMobileDeviceAccessOverrideRequest.builder()
deleteMobileDeviceAccessOverrideRequest - A Consumer that will call methods on DeleteMobileDeviceAccessOverrideRequest.Builder to
create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteMobileDeviceAccessRuleRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteMobileDeviceAccessRuleRequest.builder()
deleteMobileDeviceAccessRuleRequest - A Consumer that will call methods on DeleteMobileDeviceAccessRuleRequest.Builder to create
a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteOrganizationRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteOrganizationRequest.builder()
deleteOrganizationRequest - A Consumer that will call methods on DeleteOrganizationRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest) throws EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the specified resource.
deleteResourceRequest - EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourceResponse deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) throws EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, 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 via DeleteResourceRequest.builder()
deleteResourceRequest - A Consumer that will call methods on DeleteResourceRequest.Builder to create a request.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRetentionPolicyResponse deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the specified retention policy from the specified organization.
deleteRetentionPolicyRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteRetentionPolicyRequest.builder()
deleteRetentionPolicyRequest - A Consumer that will call methods on DeleteRetentionPolicyRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteUserRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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.
deregisterFromWorkMailRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeregisterFromWorkMailRequest.builder()
deregisterFromWorkMailRequest - A Consumer that will call methods on DeregisterFromWorkMailRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deregisterMailDomainRequest - MailDomainInUseException - The domain you're trying to change is in use by another user or organization in your account. See the
error message for details.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidCustomSesConfigurationException - You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid
setting. For examples of invalid settings, refer to CreateReceiptRule.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeregisterMailDomainRequest.builder()
deregisterMailDomainRequest - A Consumer that will call methods on DeregisterMailDomainRequest.Builder to create a
request.MailDomainInUseException - The domain you're trying to change is in use by another user or organization in your account. See the
error message for details.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidCustomSesConfigurationException - You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid
setting. For examples of invalid settings, refer to CreateReceiptRule.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEmailMonitoringConfigurationResponse describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Describes the current email monitoring configuration for a specified organization.
describeEmailMonitoringConfigurationRequest - ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via
DescribeEmailMonitoringConfigurationRequest.builder()
describeEmailMonitoringConfigurationRequest - A Consumer that will call methods on DescribeEmailMonitoringConfigurationRequest.Builder
to create a request.ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the group.
describeGroupRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeGroupRequest.builder()
describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeInboundDmarcSettingsResponse describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the settings in a DMARC policy for a specified organization.
describeInboundDmarcSettingsRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeInboundDmarcSettingsRequest.builder()
describeInboundDmarcSettingsRequest - A Consumer that will call methods on DescribeInboundDmarcSettingsRequest.Builder to create
a request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMailboxExportJobResponse describeMailboxExportJob(DescribeMailboxExportJobRequest describeMailboxExportJobRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Describes the current status of a mailbox export job.
describeMailboxExportJobRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeMailboxExportJobRequest.builder()
describeMailboxExportJobRequest - A Consumer that will call methods on DescribeMailboxExportJobRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOrganizationResponse describeOrganization(DescribeOrganizationRequest describeOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Provides more information regarding a given organization based on its identifier.
describeOrganizationRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeOrganizationRequest.builder()
describeOrganizationRequest - A Consumer that will call methods on DescribeOrganizationRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourceResponse describeResource(DescribeResourceRequest describeResourceRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the resource.
describeResourceRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourceResponse describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, 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 via DescribeResourceRequest.builder()
describeResourceRequest - A Consumer that will call methods on DescribeResourceRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Provides information regarding the user.
describeUserRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from the resource's set of delegates.
disassociateDelegateFromResourceRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, 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 via DisassociateDelegateFromResourceRequest.builder()
disassociateDelegateFromResourceRequest - A Consumer that will call methods on DisassociateDelegateFromResourceRequest.Builder to
create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateMemberFromGroupResponse disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from a group.
disassociateMemberFromGroupRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 via DisassociateMemberFromGroupRequest.builder()
disassociateMemberFromGroupRequest - A Consumer that will call methods on DisassociateMemberFromGroupRequest.Builder to create
a request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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.
getAccessControlEffectRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetAccessControlEffectRequest.builder()
getAccessControlEffectRequest - A Consumer that will call methods on GetAccessControlEffectRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDefaultRetentionPolicyResponse getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Gets the default retention policy details for the specified organization.
getDefaultRetentionPolicyRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetDefaultRetentionPolicyRequest.builder()
getDefaultRetentionPolicyRequest - A Consumer that will call methods on GetDefaultRetentionPolicyRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetImpersonationRoleResponse getImpersonationRole(GetImpersonationRoleRequest getImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Gets the impersonation role details for the given WorkMail organization.
getImpersonationRoleRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetImpersonationRoleRequest.builder()
getImpersonationRoleRequest - A Consumer that will call methods on GetImpersonationRoleRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getImpersonationRoleEffectRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetImpersonationRoleEffectRequest.builder()
getImpersonationRoleEffectRequest - A Consumer that will call methods on GetImpersonationRoleEffectRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getMailDomainRequest - MailDomainNotFoundException - The domain specified is not found in your organization.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetMailDomainRequest.builder()
getMailDomainRequest - A Consumer that will call methods on GetMailDomainRequest.Builder to create a request.MailDomainNotFoundException - The domain specified is not found in your organization.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMailboxDetailsResponse getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest) throws OrganizationNotFoundException, OrganizationStateException, EntityNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Requests a user's mailbox details for a specified organization and user.
getMailboxDetailsRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMailboxDetailsResponse getMailboxDetails(Consumer<GetMailboxDetailsRequest.Builder> getMailboxDetailsRequest) throws 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 via GetMailboxDetailsRequest.builder()
getMailboxDetailsRequest - A Consumer that will call methods on GetMailboxDetailsRequest.Builder to create a request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getMobileDeviceAccessEffectRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetMobileDeviceAccessEffectRequest.builder()
getMobileDeviceAccessEffectRequest - A Consumer that will call methods on GetMobileDeviceAccessEffectRequest.Builder to create
a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getMobileDeviceAccessOverrideRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetMobileDeviceAccessOverrideRequest.builder()
getMobileDeviceAccessOverrideRequest - A Consumer that will call methods on GetMobileDeviceAccessOverrideRequest.Builder to
create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessControlRulesResponse listAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the access control rules for the specified organization.
listAccessControlRulesRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListAccessControlRulesRequest.builder()
listAccessControlRulesRequest - A Consumer that will call methods on ListAccessControlRulesRequest.Builder to create a
request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listAliasesRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListAliasesRequest.builder()
listAliasesRequest - A Consumer that will call methods on ListAliasesRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAliasesIterable listAliasesPaginator(ListAliasesRequest 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 variant of listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest) operation.
listAliasesRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAliasesIterable listAliasesPaginator(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 variant of listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListAliasesRequest.builder()
listAliasesRequest - A Consumer that will call methods on ListAliasesRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAvailabilityConfigurationsResponse listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
List all the AvailabilityConfiguration's for the given WorkMail organization.
listAvailabilityConfigurationsRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListAvailabilityConfigurationsRequest.builder()
listAvailabilityConfigurationsRequest - A Consumer that will call methods on ListAvailabilityConfigurationsRequest.Builder to
create a request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAvailabilityConfigurationsIterable listAvailabilityConfigurationsPaginator(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
List all the AvailabilityConfiguration's for the given WorkMail organization.
This is a variant of
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client
.listAvailabilityConfigurationsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation.
listAvailabilityConfigurationsRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAvailabilityConfigurationsIterable listAvailabilityConfigurationsPaginator(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
List all the AvailabilityConfiguration's for the given WorkMail organization.
This is a variant of
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client
.listAvailabilityConfigurationsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsIterable responses = client.listAvailabilityConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListAvailabilityConfigurationsRequest.builder()
listAvailabilityConfigurationsRequest - A Consumer that will call methods on ListAvailabilityConfigurationsRequest.Builder to
create a request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listGroupMembersRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListGroupMembersRequest.builder()
listGroupMembersRequest - A Consumer that will call methods on ListGroupMembersRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembersIterable listGroupMembersPaginator(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.
This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client
.listGroupMembersPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest) operation.
listGroupMembersRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembersIterable listGroupMembersPaginator(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 variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client
.listGroupMembersPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListGroupMembersRequest.builder()
listGroupMembersRequest - A Consumer that will call methods on ListGroupMembersRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's groups.
listGroupsRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's groups.
This is a variant of listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest) operation.
listGroupsRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's groups.
This is a variant of listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImpersonationRolesResponse listImpersonationRoles(ListImpersonationRolesRequest listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists all the impersonation roles for the given WorkMail organization.
listImpersonationRolesRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListImpersonationRolesRequest.builder()
listImpersonationRolesRequest - A Consumer that will call methods on ListImpersonationRolesRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImpersonationRolesIterable listImpersonationRolesPaginator(ListImpersonationRolesRequest listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists all the impersonation roles for the given WorkMail organization.
This is a variant of
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client
.listImpersonationRolesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation.
listImpersonationRolesRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImpersonationRolesIterable listImpersonationRolesPaginator(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists all the impersonation roles for the given WorkMail organization.
This is a variant of
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client
.listImpersonationRolesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesIterable responses = client.listImpersonationRolesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListImpersonationRolesRequest.builder()
listImpersonationRolesRequest - A Consumer that will call methods on ListImpersonationRolesRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMailDomainsResponse listMailDomains(ListMailDomainsRequest listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mail domains in a given WorkMail organization.
listMailDomainsRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListMailDomainsRequest.builder()
listMailDomainsRequest - A Consumer that will call methods on ListMailDomainsRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMailDomainsIterable listMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mail domains in a given WorkMail organization.
This is a variant of
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client
.listMailDomainsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest) operation.
listMailDomainsRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMailDomainsIterable listMailDomainsPaginator(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mail domains in a given WorkMail organization.
This is a variant of
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client
.listMailDomainsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsIterable responses = client.listMailDomainsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListMailDomainsRequest.builder()
listMailDomainsRequest - A Consumer that will call methods on ListMailDomainsRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listMailboxExportJobsRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListMailboxExportJobsRequest.builder()
listMailboxExportJobsRequest - A Consumer that will call methods on ListMailboxExportJobsRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMailboxExportJobsIterable listMailboxExportJobsPaginator(ListMailboxExportJobsRequest 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 variant of
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client
.listMailboxExportJobsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation.
listMailboxExportJobsRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMailboxExportJobsIterable listMailboxExportJobsPaginator(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 variant of
listMailboxExportJobs(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client
.listMailboxExportJobsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsIterable responses = client.listMailboxExportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListMailboxExportJobsRequest.builder()
listMailboxExportJobsRequest - A Consumer that will call methods on ListMailboxExportJobsRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMailboxPermissionsResponse listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mailbox permissions associated with a user, group, or resource mailbox.
listMailboxPermissionsRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListMailboxPermissionsRequest.builder()
listMailboxPermissionsRequest - A Consumer that will call methods on ListMailboxPermissionsRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMailboxPermissionsIterable listMailboxPermissionsPaginator(ListMailboxPermissionsRequest listMailboxPermissionsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mailbox permissions associated with a user, group, or resource mailbox.
This is a variant of
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client
.listMailboxPermissionsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation.
listMailboxPermissionsRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMailboxPermissionsIterable listMailboxPermissionsPaginator(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 variant of
listMailboxPermissions(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client
.listMailboxPermissionsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsIterable responses = client.listMailboxPermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListMailboxPermissionsRequest.builder()
listMailboxPermissionsRequest - A Consumer that will call methods on ListMailboxPermissionsRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listMobileDeviceAccessOverridesRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListMobileDeviceAccessOverridesRequest.builder()
listMobileDeviceAccessOverridesRequest - A Consumer that will call methods on ListMobileDeviceAccessOverridesRequest.Builder to
create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMobileDeviceAccessOverridesIterable listMobileDeviceAccessOverridesPaginator(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.
This is a variant of
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client
.listMobileDeviceAccessOverridesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation.
listMobileDeviceAccessOverridesRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMobileDeviceAccessOverridesIterable listMobileDeviceAccessOverridesPaginator(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 variant of
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client
.listMobileDeviceAccessOverridesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesIterable responses = client.listMobileDeviceAccessOverridesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListMobileDeviceAccessOverridesRequest.builder()
listMobileDeviceAccessOverridesRequest - A Consumer that will call methods on ListMobileDeviceAccessOverridesRequest.Builder to
create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMobileDeviceAccessRulesResponse listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mobile device access rules for the specified WorkMail organization.
listMobileDeviceAccessRulesRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListMobileDeviceAccessRulesRequest.builder()
listMobileDeviceAccessRulesRequest - A Consumer that will call methods on ListMobileDeviceAccessRulesRequest.Builder to create
a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOrganizationsResponse listOrganizations(ListOrganizationsRequest listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's organizations.
listOrganizationsRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListOrganizationsRequest.builder()
listOrganizationsRequest - A Consumer that will call methods on ListOrganizationsRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOrganizationsResponse listOrganizations() throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's organizations.
InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistOrganizations(ListOrganizationsRequest),
AWS
API Documentationdefault ListOrganizationsIterable listOrganizationsPaginator() throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's organizations.
This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client
.listOrganizationsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistOrganizationsPaginator(ListOrganizationsRequest),
AWS
API Documentationdefault ListOrganizationsIterable listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's organizations.
This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client
.listOrganizationsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
listOrganizationsRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOrganizationsIterable listOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's organizations.
This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client
.listOrganizationsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListOrganizationsRequest.builder()
listOrganizationsRequest - A Consumer that will call methods on ListOrganizationsRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourceDelegatesResponse listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, 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.
listResourceDelegatesRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourceDelegatesResponse listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, 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 via ListResourceDelegatesRequest.builder()
listResourceDelegatesRequest - A Consumer that will call methods on ListResourceDelegatesRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourceDelegatesIterable listResourceDelegatesPaginator(ListResourceDelegatesRequest listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, 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 variant of
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client
.listResourceDelegatesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation.
listResourceDelegatesRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourceDelegatesIterable listResourceDelegatesPaginator(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, 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 variant of
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client
.listResourceDelegatesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesIterable responses = client.listResourceDelegatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListResourceDelegatesRequest.builder()
listResourceDelegatesRequest - A Consumer that will call methods on ListResourceDelegatesRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's resources.
listResourcesRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, 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 via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's resources.
This is a variant of listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest) operation.
listResourcesRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's resources.
This is a variant of listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Lists the tags applied to an WorkMail organization resource.
listTagsForResourceRequest - ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's users.
listUsersRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's users.
This is a variant of listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest) operation.
listUsersRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's users.
This is a variant of listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
putAccessControlRuleRequest - LimitExceededException - The request exceeds the limit of the resource.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException - The resource cannot be found.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via PutAccessControlRuleRequest.builder()
putAccessControlRuleRequest - A Consumer that will call methods on PutAccessControlRuleRequest.Builder to create a
request.LimitExceededException - The request exceeds the limit of the resource.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.ResourceNotFoundException - The resource cannot be found.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEmailMonitoringConfigurationResponse putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates or updates the email monitoring configuration for a specified organization.
putEmailMonitoringConfigurationRequest - ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via PutEmailMonitoringConfigurationRequest.builder()
putEmailMonitoringConfigurationRequest - A Consumer that will call methods on PutEmailMonitoringConfigurationRequest.Builder to
create a request.ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutInboundDmarcSettingsResponse putInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest) throws OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Enables or disables a DMARC policy for a given organization.
putInboundDmarcSettingsRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via PutInboundDmarcSettingsRequest.builder()
putInboundDmarcSettingsRequest - A Consumer that will call methods on PutInboundDmarcSettingsRequest.Builder to create a
request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
putMailboxPermissionsRequest - EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via PutMailboxPermissionsRequest.builder()
putMailboxPermissionsRequest - A Consumer that will call methods on PutMailboxPermissionsRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
putMobileDeviceAccessOverrideRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via PutMobileDeviceAccessOverrideRequest.builder()
putMobileDeviceAccessOverrideRequest - A Consumer that will call methods on PutMobileDeviceAccessOverrideRequest.Builder to
create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRetentionPolicyResponse putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Puts a retention policy to the specified organization.
putRetentionPolicyRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via PutRetentionPolicyRequest.builder()
putRetentionPolicyRequest - A Consumer that will call methods on PutRetentionPolicyRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
registerMailDomainRequest - MailDomainInUseException - The domain you're trying to change is in use by another user or organization in your account. See the
error message for details.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.LimitExceededException - The request exceeds the limit of the resource.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via RegisterMailDomainRequest.builder()
registerMailDomainRequest - A Consumer that will call methods on RegisterMailDomainRequest.Builder to create a
request.MailDomainInUseException - The domain you're trying to change is in use by another user or organization in your account. See the
error message for details.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.LimitExceededException - The request exceeds the limit of the resource.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
registerToWorkMailRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.EntityAlreadyRegisteredException - The user, group, or resource that you're trying to register is already registered.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via RegisterToWorkMailRequest.builder()
registerToWorkMailRequest - A Consumer that will call methods on RegisterToWorkMailRequest.Builder to create a
request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.EntityAlreadyRegisteredException - The user, group, or resource that you're trying to register is already registered.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
resetPasswordRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special
characters.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 via ResetPasswordRequest.builder()
resetPasswordRequest - A Consumer that will call methods on ResetPasswordRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special
characters.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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.
startMailboxExportJobRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StartMailboxExportJobRequest.builder()
startMailboxExportJobRequest - A Consumer that will call methods on StartMailboxExportJobRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, TooManyTagsException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Applies the specified tags to the specified WorkMailorganization resource.
tagResourceRequest - ResourceNotFoundException - The resource cannot be found.TooManyTagsException - The resource can have up to 50 user-applied tags.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.ResourceNotFoundException - The resource cannot be found.TooManyTagsException - The resource can have up to 50 user-applied tags.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 or SourceAccount header.
The request must contain either one provider definition (EwsProvider or LambdaProvider)
or the DomainName parameter. If the DomainName parameter is provided, the configuration
stored under the DomainName will be tested.
testAvailabilityConfigurationRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 or SourceAccount header.
The request must contain either one provider definition (EwsProvider or LambdaProvider)
or the DomainName parameter. If the DomainName parameter is provided, the configuration
stored under the DomainName will be tested.
This is a convenience which creates an instance of the TestAvailabilityConfigurationRequest.Builder
avoiding the need to create one manually via TestAvailabilityConfigurationRequest.builder()
testAvailabilityConfigurationRequest - A Consumer that will call methods on TestAvailabilityConfigurationRequest.Builder to
create a request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Untags the specified tags from the specified WorkMail organization resource.
untagResourceRequest - ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.ResourceNotFoundException - The resource cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAvailabilityConfigurationResponse updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest) throws OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
updateAvailabilityConfigurationRequest - OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateAvailabilityConfigurationRequest.builder()
updateAvailabilityConfigurationRequest - A Consumer that will call methods on UpdateAvailabilityConfigurationRequest.Builder to
create a request.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateDefaultMailDomainRequest - MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateDefaultMailDomainRequest.builder()
updateDefaultMailDomainRequest - A Consumer that will call methods on UpdateDefaultMailDomainRequest.Builder to create a
request.MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateImpersonationRoleResponse updateImpersonationRole(UpdateImpersonationRoleRequest updateImpersonationRoleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, ResourceNotFoundException, EntityNotFoundException, EntityStateException, LimitExceededException, AwsServiceException, SdkClientException, WorkMailException
Updates an impersonation role for the given WorkMail organization.
updateImpersonationRoleRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateImpersonationRoleRequest.builder()
updateImpersonationRoleRequest - A Consumer that will call methods on UpdateImpersonationRoleRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.ResourceNotFoundException - The resource cannot be found.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.LimitExceededException - The request exceeds the limit of the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateMailboxQuotaRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateMailboxQuotaRequest.builder()
updateMailboxQuotaRequest - A Consumer that will call methods on UpdateMailboxQuotaRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMobileDeviceAccessRuleResponse updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest) throws InvalidParameterException, EntityNotFoundException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Updates a mobile device access rule for the specified WorkMail organization.
updateMobileDeviceAccessRuleRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateMobileDeviceAccessRuleRequest.builder()
updateMobileDeviceAccessRuleRequest - A Consumer that will call methods on UpdateMobileDeviceAccessRuleRequest.Builder to create
a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updatePrimaryEmailAddressRequest - DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 via UpdatePrimaryEmailAddressRequest.builder()
updatePrimaryEmailAddressRequest - A Consumer that will call methods on UpdatePrimaryEmailAddressRequest.Builder to create a
request.DirectoryServiceAuthenticationFailedException - The directory service doesn't recognize the credentials supplied by WorkMail.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException, EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, 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.
updateResourceRequest - DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidConfigurationException - The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests
or have at least one delegate associated that can do so on its behalf.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException, EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, 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 via UpdateResourceRequest.builder()
updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request.DirectoryUnavailableException - The directory is unavailable. It might be located in another Region or deleted.EntityNotFoundException - The identifier supplied for the user, group, or resource does not exist in your organization.EntityStateException - You are performing an operation on a user, group, or resource that isn't in the expected state, such as
trying to delete an active user.InvalidConfigurationException - The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests
or have at least one delegate associated that can do so on its behalf.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.MailDomainNotFoundException - The domain specified is not found in your organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.NameAvailabilityException - The user, group, or resource name isn't unique in WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic WorkMailClient create()
WorkMailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static WorkMailClientBuilder builder()
WorkMailClient.static ServiceMetadata serviceMetadata()
default WorkMailServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.