@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface WorkMailClient extends SdkClient
builder() method.
Amazon 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.
|
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 Amazon WorkMail.
|
default CreateAliasResponse |
createAlias(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
|
default CreateGroupResponse |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CreateGroupResponse |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CreateMobileDeviceAccessRuleResponse |
createMobileDeviceAccessRule(Consumer<CreateMobileDeviceAccessRuleRequest.Builder> createMobileDeviceAccessRuleRequest)
Creates a new mobile device access rule for the specified Amazon WorkMail organization.
|
default CreateMobileDeviceAccessRuleResponse |
createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest)
Creates a new mobile device access rule for the specified Amazon WorkMail organization.
|
default CreateOrganizationResponse |
createOrganization(Consumer<CreateOrganizationRequest.Builder> createOrganizationRequest)
Creates a new Amazon WorkMail organization.
|
default CreateOrganizationResponse |
createOrganization(CreateOrganizationRequest createOrganizationRequest)
Creates a new Amazon WorkMail organization.
|
default CreateResourceResponse |
createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
Creates a new Amazon WorkMail resource.
|
default CreateResourceResponse |
createResource(CreateResourceRequest createResourceRequest)
Creates a new Amazon WorkMail resource.
|
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a user who can be used in Amazon 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 DeleteGroupResponse |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group from Amazon WorkMail.
|
default DeleteGroupResponse |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group from Amazon WorkMail.
|
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 DeleteMobileDeviceAccessRuleResponse |
deleteMobileDeviceAccessRule(Consumer<DeleteMobileDeviceAccessRuleRequest.Builder> deleteMobileDeviceAccessRuleRequest)
Deletes a mobile device access rule for the specified Amazon WorkMail organization.
|
default DeleteMobileDeviceAccessRuleResponse |
deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest)
Deletes a mobile device access rule for the specified Amazon WorkMail organization.
|
default DeleteOrganizationResponse |
deleteOrganization(Consumer<DeleteOrganizationRequest.Builder> deleteOrganizationRequest)
Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of
the organization.
|
default DeleteOrganizationResponse |
deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest)
Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon 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 Amazon WorkMail and all subsequent systems.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from Amazon WorkMail and all subsequent systems.
|
default DeregisterFromWorkMailResponse |
deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
default DeregisterFromWorkMailResponse |
deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
default DescribeGroupResponse |
describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
Returns the data available for the group.
|
default DescribeGroupResponse |
describeGroup(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
|
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, or user 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, or user 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 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 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 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 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 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 ListMobileDeviceAccessRulesResponse |
listMobileDeviceAccessRules(Consumer<ListMobileDeviceAccessRulesRequest.Builder> listMobileDeviceAccessRulesRequest)
Lists the mobile device access rules for the specified Amazon WorkMail organization.
|
default ListMobileDeviceAccessRulesResponse |
listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest)
Lists the mobile device access rules for the specified Amazon 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 Amazon WorkMail organization resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to an Amazon 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 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 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 RegisterToWorkMailResponse |
registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and
calendaring capabilities.
|
default RegisterToWorkMailResponse |
registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource for Amazon 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.
|
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 Amazon WorkMail organization resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Applies the specified tags to the specified Amazon WorkMail organization resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untags the specified tags from the specified Amazon WorkMail organization resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Untags the specified tags from the specified Amazon WorkMail organization resource.
|
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 Amazon WorkMail organization.
|
default UpdateMobileDeviceAccessRuleResponse |
updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest)
Updates a mobile device access rule for the specified Amazon 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.static WorkMailClient create()
WorkMailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static WorkMailClientBuilder builder()
WorkMailClient.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 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 Amazon 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 - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
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 Amazon 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 - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
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 CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a group that can be used in Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 CreateMobileDeviceAccessRuleResponse createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest) throws InvalidParameterException, LimitExceededException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a new mobile device access rule for the specified Amazon 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 Amazon 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 Amazon 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 Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then set your default email domain from the Amazon 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 Amazon WorkMail Administrator Guide.
Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master 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 Amazon 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 Amazon 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 Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then set your default email domain from the Amazon 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 Amazon WorkMail Administrator Guide.
Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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.
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.
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 DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes a group from Amazon 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 Amazon 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 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 DeleteMobileDeviceAccessRuleResponse deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes a mobile device access rule for the specified Amazon WorkMail organization.
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 Amazon WorkMail organization.
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 Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the Amazon 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 Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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 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 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, 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, or user ID.
getAccessControlEffectRequest - 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 GetAccessControlEffectResponse getAccessControlEffect(Consumer<GetAccessControlEffectRequest.Builder> getAccessControlEffectRequest) throws EntityNotFoundException, 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, or user ID.
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.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related 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 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 Amazon 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 Amazon 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 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 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 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 ListMobileDeviceAccessRulesResponse listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the mobile device access rules for the specified Amazon 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 Amazon 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() 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 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 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 Amazon 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 Amazon 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, 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, and user 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.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related 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, 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, and user 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.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state to perform certain operations on the organization or its
members.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related 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 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 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 Amazon 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 - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
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 Amazon 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 - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
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 Amazon 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 Amazon 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 Amazon WorkMail organization 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 Amazon WorkMail organization 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 UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Untags the specified tags from the specified Amazon 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 Amazon 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 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 Amazon 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 Amazon 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 - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
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 - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
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 - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
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 Amazon 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 - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
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 Amazon 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 ServiceMetadata serviceMetadata()
Copyright © 2021. All rights reserved.