@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface WorkMailAsyncClient extends AwsClient
builder()
method.
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The WorkMail API is designed for the following scenarios:
Listing and describing organizations
Managing users
Managing groups
Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateDelegateToResourceResponse> |
associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member (user or group) to the resource's set of delegates.
|
default CompletableFuture<AssociateDelegateToResourceResponse> |
associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest)
Adds a member (user or group) to the resource's set of delegates.
|
default CompletableFuture<AssociateMemberToGroupResponse> |
associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member (user or group) to the group's set.
|
default CompletableFuture<AssociateMemberToGroupResponse> |
associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest)
Adds a member (user or group) to the group's set.
|
default CompletableFuture<AssumeImpersonationRoleResponse> |
assumeImpersonationRole(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest)
Assumes an impersonation role for the given WorkMail organization.
|
default CompletableFuture<AssumeImpersonationRoleResponse> |
assumeImpersonationRole(Consumer<AssumeImpersonationRoleRequest.Builder> assumeImpersonationRoleRequest)
Assumes an impersonation role for the given WorkMail organization.
|
static WorkMailAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
WorkMailAsyncClient. |
default CompletableFuture<CancelMailboxExportJobResponse> |
cancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest)
Cancels a mailbox export job.
|
default CompletableFuture<CancelMailboxExportJobResponse> |
cancelMailboxExportJob(Consumer<CancelMailboxExportJobRequest.Builder> cancelMailboxExportJobRequest)
Cancels a mailbox export job.
|
static WorkMailAsyncClient |
create()
Create a
WorkMailAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateAliasResponse> |
createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Adds an alias to the set of a given member (user or group) of WorkMail.
|
default CompletableFuture<CreateAliasResponse> |
createAlias(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member (user or group) of WorkMail.
|
default CompletableFuture<CreateAvailabilityConfigurationResponse> |
createAvailabilityConfiguration(Consumer<CreateAvailabilityConfigurationRequest.Builder> createAvailabilityConfigurationRequest)
Creates an
AvailabilityConfiguration for the given WorkMail organization and domain. |
default CompletableFuture<CreateAvailabilityConfigurationResponse> |
createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest)
Creates an
AvailabilityConfiguration for the given WorkMail organization and domain. |
default CompletableFuture<CreateGroupResponse> |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
|
default CompletableFuture<CreateImpersonationRoleResponse> |
createImpersonationRole(Consumer<CreateImpersonationRoleRequest.Builder> createImpersonationRoleRequest)
Creates an impersonation role for the given WorkMail organization.
|
default CompletableFuture<CreateImpersonationRoleResponse> |
createImpersonationRole(CreateImpersonationRoleRequest createImpersonationRoleRequest)
Creates an impersonation role for the given WorkMail organization.
|
default CompletableFuture<CreateMobileDeviceAccessRuleResponse> |
createMobileDeviceAccessRule(Consumer<CreateMobileDeviceAccessRuleRequest.Builder> createMobileDeviceAccessRuleRequest)
Creates a new mobile device access rule for the specified WorkMail organization.
|
default CompletableFuture<CreateMobileDeviceAccessRuleResponse> |
createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest)
Creates a new mobile device access rule for the specified WorkMail organization.
|
default CompletableFuture<CreateOrganizationResponse> |
createOrganization(Consumer<CreateOrganizationRequest.Builder> createOrganizationRequest)
Creates a new WorkMail organization.
|
default CompletableFuture<CreateOrganizationResponse> |
createOrganization(CreateOrganizationRequest createOrganizationRequest)
Creates a new WorkMail organization.
|
default CompletableFuture<CreateResourceResponse> |
createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
Creates a new WorkMail resource.
|
default CompletableFuture<CreateResourceResponse> |
createResource(CreateResourceRequest createResourceRequest)
Creates a new WorkMail resource.
|
default CompletableFuture<CreateUserResponse> |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
|
default CompletableFuture<CreateUserResponse> |
createUser(CreateUserRequest createUserRequest)
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
|
default CompletableFuture<DeleteAccessControlRuleResponse> |
deleteAccessControlRule(Consumer<DeleteAccessControlRuleRequest.Builder> deleteAccessControlRuleRequest)
Deletes an access control rule for the specified WorkMail organization.
|
default CompletableFuture<DeleteAccessControlRuleResponse> |
deleteAccessControlRule(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest)
Deletes an access control rule for the specified WorkMail organization.
|
default CompletableFuture<DeleteAliasResponse> |
deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Remove one or more specified aliases from a set of aliases for a given user.
|
default CompletableFuture<DeleteAliasResponse> |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Remove one or more specified aliases from a set of aliases for a given user.
|
default CompletableFuture<DeleteAvailabilityConfigurationResponse> |
deleteAvailabilityConfiguration(Consumer<DeleteAvailabilityConfigurationRequest.Builder> deleteAvailabilityConfigurationRequest)
Deletes the
AvailabilityConfiguration for the given WorkMail organization and domain. |
default CompletableFuture<DeleteAvailabilityConfigurationResponse> |
deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest)
Deletes the
AvailabilityConfiguration for the given WorkMail organization and domain. |
default CompletableFuture<DeleteEmailMonitoringConfigurationResponse> |
deleteEmailMonitoringConfiguration(Consumer<DeleteEmailMonitoringConfigurationRequest.Builder> deleteEmailMonitoringConfigurationRequest)
Deletes the email monitoring configuration for a specified organization.
|
default CompletableFuture<DeleteEmailMonitoringConfigurationResponse> |
deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest)
Deletes the email monitoring configuration for a specified organization.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group from WorkMail.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group from WorkMail.
|
default CompletableFuture<DeleteImpersonationRoleResponse> |
deleteImpersonationRole(Consumer<DeleteImpersonationRoleRequest.Builder> deleteImpersonationRoleRequest)
Deletes an impersonation role for the given WorkMail organization.
|
default CompletableFuture<DeleteImpersonationRoleResponse> |
deleteImpersonationRole(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest)
Deletes an impersonation role for the given WorkMail organization.
|
default CompletableFuture<DeleteMailboxPermissionsResponse> |
deleteMailboxPermissions(Consumer<DeleteMailboxPermissionsRequest.Builder> deleteMailboxPermissionsRequest)
Deletes permissions granted to a member (user or group).
|
default CompletableFuture<DeleteMailboxPermissionsResponse> |
deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest)
Deletes permissions granted to a member (user or group).
|
default CompletableFuture<DeleteMobileDeviceAccessOverrideResponse> |
deleteMobileDeviceAccessOverride(Consumer<DeleteMobileDeviceAccessOverrideRequest.Builder> deleteMobileDeviceAccessOverrideRequest)
Deletes the mobile device access override for the given WorkMail organization, user, and device.
|
default CompletableFuture<DeleteMobileDeviceAccessOverrideResponse> |
deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest)
Deletes the mobile device access override for the given WorkMail organization, user, and device.
|
default CompletableFuture<DeleteMobileDeviceAccessRuleResponse> |
deleteMobileDeviceAccessRule(Consumer<DeleteMobileDeviceAccessRuleRequest.Builder> deleteMobileDeviceAccessRuleRequest)
Deletes a mobile device access rule for the specified WorkMail organization.
|
default CompletableFuture<DeleteMobileDeviceAccessRuleResponse> |
deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest)
Deletes a mobile device access rule for the specified WorkMail organization.
|
default CompletableFuture<DeleteOrganizationResponse> |
deleteOrganization(Consumer<DeleteOrganizationRequest.Builder> deleteOrganizationRequest)
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the
organization.
|
default CompletableFuture<DeleteOrganizationResponse> |
deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest)
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the
organization.
|
default CompletableFuture<DeleteResourceResponse> |
deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)
Deletes the specified resource.
|
default CompletableFuture<DeleteResourceResponse> |
deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
|
default CompletableFuture<DeleteRetentionPolicyResponse> |
deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest)
Deletes the specified retention policy from the specified organization.
|
default CompletableFuture<DeleteRetentionPolicyResponse> |
deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
Deletes the specified retention policy from the specified organization.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user from WorkMail and all subsequent systems.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from WorkMail and all subsequent systems.
|
default CompletableFuture<DeregisterFromWorkMailResponse> |
deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in WorkMail.
|
default CompletableFuture<DeregisterFromWorkMailResponse> |
deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in WorkMail.
|
default CompletableFuture<DeregisterMailDomainResponse> |
deregisterMailDomain(Consumer<DeregisterMailDomainRequest.Builder> deregisterMailDomainRequest)
Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail
use.
|
default CompletableFuture<DeregisterMailDomainResponse> |
deregisterMailDomain(DeregisterMailDomainRequest deregisterMailDomainRequest)
Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail
use.
|
default CompletableFuture<DescribeEmailMonitoringConfigurationResponse> |
describeEmailMonitoringConfiguration(Consumer<DescribeEmailMonitoringConfigurationRequest.Builder> describeEmailMonitoringConfigurationRequest)
Describes the current email monitoring configuration for a specified organization.
|
default CompletableFuture<DescribeEmailMonitoringConfigurationResponse> |
describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest)
Describes the current email monitoring configuration for a specified organization.
|
default CompletableFuture<DescribeGroupResponse> |
describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
Returns the data available for the group.
|
default CompletableFuture<DescribeGroupResponse> |
describeGroup(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
|
default CompletableFuture<DescribeInboundDmarcSettingsResponse> |
describeInboundDmarcSettings(Consumer<DescribeInboundDmarcSettingsRequest.Builder> describeInboundDmarcSettingsRequest)
Lists the settings in a DMARC policy for a specified organization.
|
default CompletableFuture<DescribeInboundDmarcSettingsResponse> |
describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest)
Lists the settings in a DMARC policy for a specified organization.
|
default CompletableFuture<DescribeMailboxExportJobResponse> |
describeMailboxExportJob(Consumer<DescribeMailboxExportJobRequest.Builder> describeMailboxExportJobRequest)
Describes the current status of a mailbox export job.
|
default CompletableFuture<DescribeMailboxExportJobResponse> |
describeMailboxExportJob(DescribeMailboxExportJobRequest describeMailboxExportJobRequest)
Describes the current status of a mailbox export job.
|
default CompletableFuture<DescribeOrganizationResponse> |
describeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
|
default CompletableFuture<DescribeOrganizationResponse> |
describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
|
default CompletableFuture<DescribeResourceResponse> |
describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Returns the data available for the resource.
|
default CompletableFuture<DescribeResourceResponse> |
describeResource(DescribeResourceRequest describeResourceRequest)
Returns the data available for the resource.
|
default CompletableFuture<DescribeUserResponse> |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Provides information regarding the user.
|
default CompletableFuture<DescribeUserResponse> |
describeUser(DescribeUserRequest describeUserRequest)
Provides information regarding the user.
|
default CompletableFuture<DisassociateDelegateFromResourceResponse> |
disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
|
default CompletableFuture<DisassociateDelegateFromResourceResponse> |
disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
|
default CompletableFuture<DisassociateMemberFromGroupResponse> |
disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest)
Removes a member from a group.
|
default CompletableFuture<DisassociateMemberFromGroupResponse> |
disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
Removes a member from a group.
|
default CompletableFuture<GetAccessControlEffectResponse> |
getAccessControlEffect(Consumer<GetAccessControlEffectRequest.Builder> getAccessControlEffectRequest)
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access
protocol action, and user ID or impersonation role ID.
|
default CompletableFuture<GetAccessControlEffectResponse> |
getAccessControlEffect(GetAccessControlEffectRequest getAccessControlEffectRequest)
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access
protocol action, and user ID or impersonation role ID.
|
default CompletableFuture<GetDefaultRetentionPolicyResponse> |
getDefaultRetentionPolicy(Consumer<GetDefaultRetentionPolicyRequest.Builder> getDefaultRetentionPolicyRequest)
Gets the default retention policy details for the specified organization.
|
default CompletableFuture<GetDefaultRetentionPolicyResponse> |
getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest)
Gets the default retention policy details for the specified organization.
|
default CompletableFuture<GetImpersonationRoleResponse> |
getImpersonationRole(Consumer<GetImpersonationRoleRequest.Builder> getImpersonationRoleRequest)
Gets the impersonation role details for the given WorkMail organization.
|
default CompletableFuture<GetImpersonationRoleResponse> |
getImpersonationRole(GetImpersonationRoleRequest getImpersonationRoleRequest)
Gets the impersonation role details for the given WorkMail organization.
|
default CompletableFuture<GetImpersonationRoleEffectResponse> |
getImpersonationRoleEffect(Consumer<GetImpersonationRoleEffectRequest.Builder> getImpersonationRoleEffectRequest)
Tests whether the given impersonation role can impersonate a target user.
|
default CompletableFuture<GetImpersonationRoleEffectResponse> |
getImpersonationRoleEffect(GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest)
Tests whether the given impersonation role can impersonate a target user.
|
default CompletableFuture<GetMailboxDetailsResponse> |
getMailboxDetails(Consumer<GetMailboxDetailsRequest.Builder> getMailboxDetailsRequest)
Requests a user's mailbox details for a specified organization and user.
|
default CompletableFuture<GetMailboxDetailsResponse> |
getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest)
Requests a user's mailbox details for a specified organization and user.
|
default CompletableFuture<GetMailDomainResponse> |
getMailDomain(Consumer<GetMailDomainRequest.Builder> getMailDomainRequest)
Gets details for a mail domain, including domain records required to configure your domain with recommended
security.
|
default CompletableFuture<GetMailDomainResponse> |
getMailDomain(GetMailDomainRequest getMailDomainRequest)
Gets details for a mail domain, including domain records required to configure your domain with recommended
security.
|
default CompletableFuture<GetMobileDeviceAccessEffectResponse> |
getMobileDeviceAccessEffect(Consumer<GetMobileDeviceAccessEffectRequest.Builder> getMobileDeviceAccessEffectRequest)
Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
|
default CompletableFuture<GetMobileDeviceAccessEffectResponse> |
getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest)
Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
|
default CompletableFuture<GetMobileDeviceAccessOverrideResponse> |
getMobileDeviceAccessOverride(Consumer<GetMobileDeviceAccessOverrideRequest.Builder> getMobileDeviceAccessOverrideRequest)
Gets the mobile device access override for the given WorkMail organization, user, and device.
|
default CompletableFuture<GetMobileDeviceAccessOverrideResponse> |
getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest)
Gets the mobile device access override for the given WorkMail organization, user, and device.
|
default CompletableFuture<ListAccessControlRulesResponse> |
listAccessControlRules(Consumer<ListAccessControlRulesRequest.Builder> listAccessControlRulesRequest)
Lists the access control rules for the specified organization.
|
default CompletableFuture<ListAccessControlRulesResponse> |
listAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest)
Lists the access control rules for the specified organization.
|
default CompletableFuture<ListAliasesResponse> |
listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default CompletableFuture<ListAliasesResponse> |
listAliases(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListAliasesPublisher |
listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListAliasesPublisher |
listAliasesPaginator(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default CompletableFuture<ListAvailabilityConfigurationsResponse> |
listAvailabilityConfigurations(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
default CompletableFuture<ListAvailabilityConfigurationsResponse> |
listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
default ListAvailabilityConfigurationsPublisher |
listAvailabilityConfigurationsPaginator(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
default ListAvailabilityConfigurationsPublisher |
listAvailabilityConfigurationsPaginator(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
default CompletableFuture<ListGroupMembersResponse> |
listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group.
|
default CompletableFuture<ListGroupMembersResponse> |
listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
|
default ListGroupMembersPublisher |
listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group.
|
default ListGroupMembersPublisher |
listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
|
default ListGroupsPublisher |
listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
|
default ListGroupsPublisher |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
|
default CompletableFuture<ListImpersonationRolesResponse> |
listImpersonationRoles(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
|
default CompletableFuture<ListImpersonationRolesResponse> |
listImpersonationRoles(ListImpersonationRolesRequest listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
|
default ListImpersonationRolesPublisher |
listImpersonationRolesPaginator(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
|
default ListImpersonationRolesPublisher |
listImpersonationRolesPaginator(ListImpersonationRolesRequest listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
|
default CompletableFuture<ListMailboxExportJobsResponse> |
listMailboxExportJobs(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest)
Lists the mailbox export jobs started for the specified organization within the last seven days.
|
default CompletableFuture<ListMailboxExportJobsResponse> |
listMailboxExportJobs(ListMailboxExportJobsRequest listMailboxExportJobsRequest)
Lists the mailbox export jobs started for the specified organization within the last seven days.
|
default ListMailboxExportJobsPublisher |
listMailboxExportJobsPaginator(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest)
Lists the mailbox export jobs started for the specified organization within the last seven days.
|
default ListMailboxExportJobsPublisher |
listMailboxExportJobsPaginator(ListMailboxExportJobsRequest listMailboxExportJobsRequest)
Lists the mailbox export jobs started for the specified organization within the last seven days.
|
default CompletableFuture<ListMailboxPermissionsResponse> |
listMailboxPermissions(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
default CompletableFuture<ListMailboxPermissionsResponse> |
listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
default ListMailboxPermissionsPublisher |
listMailboxPermissionsPaginator(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
default ListMailboxPermissionsPublisher |
listMailboxPermissionsPaginator(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
default CompletableFuture<ListMailDomainsResponse> |
listMailDomains(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
|
default CompletableFuture<ListMailDomainsResponse> |
listMailDomains(ListMailDomainsRequest listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
|
default ListMailDomainsPublisher |
listMailDomainsPaginator(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
|
default ListMailDomainsPublisher |
listMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
|
default CompletableFuture<ListMobileDeviceAccessOverridesResponse> |
listMobileDeviceAccessOverrides(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
default CompletableFuture<ListMobileDeviceAccessOverridesResponse> |
listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
default ListMobileDeviceAccessOverridesPublisher |
listMobileDeviceAccessOverridesPaginator(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
default ListMobileDeviceAccessOverridesPublisher |
listMobileDeviceAccessOverridesPaginator(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
default CompletableFuture<ListMobileDeviceAccessRulesResponse> |
listMobileDeviceAccessRules(Consumer<ListMobileDeviceAccessRulesRequest.Builder> listMobileDeviceAccessRulesRequest)
Lists the mobile device access rules for the specified WorkMail organization.
|
default CompletableFuture<ListMobileDeviceAccessRulesResponse> |
listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest)
Lists the mobile device access rules for the specified WorkMail organization.
|
default CompletableFuture<ListOrganizationsResponse> |
listOrganizations()
Returns summaries of the customer's organizations.
|
default CompletableFuture<ListOrganizationsResponse> |
listOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
Returns summaries of the customer's organizations.
|
default CompletableFuture<ListOrganizationsResponse> |
listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's organizations.
|
default ListOrganizationsPublisher |
listOrganizationsPaginator()
Returns summaries of the customer's organizations.
|
default ListOrganizationsPublisher |
listOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
Returns summaries of the customer's organizations.
|
default ListOrganizationsPublisher |
listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's organizations.
|
default CompletableFuture<ListResourceDelegatesResponse> |
listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
default CompletableFuture<ListResourceDelegatesResponse> |
listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
default ListResourceDelegatesPublisher |
listResourceDelegatesPaginator(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
default ListResourceDelegatesPublisher |
listResourceDelegatesPaginator(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
default CompletableFuture<ListResourcesResponse> |
listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns summaries of the organization's resources.
|
default CompletableFuture<ListResourcesResponse> |
listResources(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
|
default ListResourcesPublisher |
listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns summaries of the organization's resources.
|
default ListResourcesPublisher |
listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags applied to an WorkMail organization resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to an WorkMail organization resource.
|
default CompletableFuture<ListUsersResponse> |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns summaries of the organization's users.
|
default CompletableFuture<ListUsersResponse> |
listUsers(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
|
default ListUsersPublisher |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns summaries of the organization's users.
|
default ListUsersPublisher |
listUsersPaginator(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
|
default CompletableFuture<PutAccessControlRuleResponse> |
putAccessControlRule(Consumer<PutAccessControlRuleRequest.Builder> putAccessControlRuleRequest)
Adds a new access control rule for the specified organization.
|
default CompletableFuture<PutAccessControlRuleResponse> |
putAccessControlRule(PutAccessControlRuleRequest putAccessControlRuleRequest)
Adds a new access control rule for the specified organization.
|
default CompletableFuture<PutEmailMonitoringConfigurationResponse> |
putEmailMonitoringConfiguration(Consumer<PutEmailMonitoringConfigurationRequest.Builder> putEmailMonitoringConfigurationRequest)
Creates or updates the email monitoring configuration for a specified organization.
|
default CompletableFuture<PutEmailMonitoringConfigurationResponse> |
putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest)
Creates or updates the email monitoring configuration for a specified organization.
|
default CompletableFuture<PutInboundDmarcSettingsResponse> |
putInboundDmarcSettings(Consumer<PutInboundDmarcSettingsRequest.Builder> putInboundDmarcSettingsRequest)
Enables or disables a DMARC policy for a given organization.
|
default CompletableFuture<PutInboundDmarcSettingsResponse> |
putInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest)
Enables or disables a DMARC policy for a given organization.
|
default CompletableFuture<PutMailboxPermissionsResponse> |
putMailboxPermissions(Consumer<PutMailboxPermissionsRequest.Builder> putMailboxPermissionsRequest)
Sets permissions for a user, group, or resource.
|
default CompletableFuture<PutMailboxPermissionsResponse> |
putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest)
Sets permissions for a user, group, or resource.
|
default CompletableFuture<PutMobileDeviceAccessOverrideResponse> |
putMobileDeviceAccessOverride(Consumer<PutMobileDeviceAccessOverrideRequest.Builder> putMobileDeviceAccessOverrideRequest)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
|
default CompletableFuture<PutMobileDeviceAccessOverrideResponse> |
putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
|
default CompletableFuture<PutRetentionPolicyResponse> |
putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest)
Puts a retention policy to the specified organization.
|
default CompletableFuture<PutRetentionPolicyResponse> |
putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)
Puts a retention policy to the specified organization.
|
default CompletableFuture<RegisterMailDomainResponse> |
registerMailDomain(Consumer<RegisterMailDomainRequest.Builder> registerMailDomainRequest)
Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.
|
default CompletableFuture<RegisterMailDomainResponse> |
registerMailDomain(RegisterMailDomainRequest registerMailDomainRequest)
Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.
|
default CompletableFuture<RegisterToWorkMailResponse> |
registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and
calendaring capabilities.
|
default CompletableFuture<RegisterToWorkMailResponse> |
registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and
calendaring capabilities.
|
default CompletableFuture<ResetPasswordResponse> |
resetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest)
Allows the administrator to reset the password for a user.
|
default CompletableFuture<ResetPasswordResponse> |
resetPassword(ResetPasswordRequest resetPasswordRequest)
Allows the administrator to reset the password for a user.
|
default WorkMailServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartMailboxExportJobResponse> |
startMailboxExportJob(Consumer<StartMailboxExportJobRequest.Builder> startMailboxExportJobRequest)
Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to
the specified Amazon Simple Storage Service (Amazon S3) bucket.
|
default CompletableFuture<StartMailboxExportJobResponse> |
startMailboxExportJob(StartMailboxExportJobRequest startMailboxExportJobRequest)
Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to
the specified Amazon Simple Storage Service (Amazon S3) bucket.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies the specified tags to the specified WorkMailorganization resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Applies the specified tags to the specified WorkMailorganization resource.
|
default CompletableFuture<TestAvailabilityConfigurationResponse> |
testAvailabilityConfiguration(Consumer<TestAvailabilityConfigurationRequest.Builder> testAvailabilityConfigurationRequest)
Performs a test on an availability provider to ensure that access is allowed.
|
default CompletableFuture<TestAvailabilityConfigurationResponse> |
testAvailabilityConfiguration(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest)
Performs a test on an availability provider to ensure that access is allowed.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untags the specified tags from the specified WorkMail organization resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Untags the specified tags from the specified WorkMail organization resource.
|
default CompletableFuture<UpdateAvailabilityConfigurationResponse> |
updateAvailabilityConfiguration(Consumer<UpdateAvailabilityConfigurationRequest.Builder> updateAvailabilityConfigurationRequest)
Updates an existing
AvailabilityConfiguration for the given WorkMail organization and domain. |
default CompletableFuture<UpdateAvailabilityConfigurationResponse> |
updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest)
Updates an existing
AvailabilityConfiguration for the given WorkMail organization and domain. |
default CompletableFuture<UpdateDefaultMailDomainResponse> |
updateDefaultMailDomain(Consumer<UpdateDefaultMailDomainRequest.Builder> updateDefaultMailDomainRequest)
Updates the default mail domain for an organization.
|
default CompletableFuture<UpdateDefaultMailDomainResponse> |
updateDefaultMailDomain(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest)
Updates the default mail domain for an organization.
|
default CompletableFuture<UpdateImpersonationRoleResponse> |
updateImpersonationRole(Consumer<UpdateImpersonationRoleRequest.Builder> updateImpersonationRoleRequest)
Updates an impersonation role for the given WorkMail organization.
|
default CompletableFuture<UpdateImpersonationRoleResponse> |
updateImpersonationRole(UpdateImpersonationRoleRequest updateImpersonationRoleRequest)
Updates an impersonation role for the given WorkMail organization.
|
default CompletableFuture<UpdateMailboxQuotaResponse> |
updateMailboxQuota(Consumer<UpdateMailboxQuotaRequest.Builder> updateMailboxQuotaRequest)
Updates a user's current mailbox quota for a specified organization and user.
|
default CompletableFuture<UpdateMailboxQuotaResponse> |
updateMailboxQuota(UpdateMailboxQuotaRequest updateMailboxQuotaRequest)
Updates a user's current mailbox quota for a specified organization and user.
|
default CompletableFuture<UpdateMobileDeviceAccessRuleResponse> |
updateMobileDeviceAccessRule(Consumer<UpdateMobileDeviceAccessRuleRequest.Builder> updateMobileDeviceAccessRuleRequest)
Updates a mobile device access rule for the specified WorkMail organization.
|
default CompletableFuture<UpdateMobileDeviceAccessRuleResponse> |
updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest)
Updates a mobile device access rule for the specified WorkMail organization.
|
default CompletableFuture<UpdatePrimaryEmailAddressResponse> |
updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest)
Updates the primary email for a user, group, or resource.
|
default CompletableFuture<UpdatePrimaryEmailAddressResponse> |
updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
Updates the primary email for a user, group, or resource.
|
default CompletableFuture<UpdateResourceResponse> |
updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Updates data for the resource.
|
default CompletableFuture<UpdateResourceResponse> |
updateResource(UpdateResourceRequest updateResourceRequest)
Updates data for the resource.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AssociateDelegateToResourceResponse> associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member (user or group) to the resource's set of delegates.
associateDelegateToResourceRequest - default CompletableFuture<AssociateDelegateToResourceResponse> associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest)
Adds a member (user or group) to the resource's set of delegates.
This is a convenience which creates an instance of the AssociateDelegateToResourceRequest.Builder
avoiding the need to create one manually via AssociateDelegateToResourceRequest.builder()
associateDelegateToResourceRequest - A Consumer that will call methods on AssociateDelegateToResourceRequest.Builder to create
a request.default CompletableFuture<AssociateMemberToGroupResponse> associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member (user or group) to the group's set.
associateMemberToGroupRequest - default CompletableFuture<AssociateMemberToGroupResponse> associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest)
Adds a member (user or group) to the group's set.
This is a convenience which creates an instance of the AssociateMemberToGroupRequest.Builder avoiding the
need to create one manually via AssociateMemberToGroupRequest.builder()
associateMemberToGroupRequest - A Consumer that will call methods on AssociateMemberToGroupRequest.Builder to create a
request.default CompletableFuture<AssumeImpersonationRoleResponse> assumeImpersonationRole(AssumeImpersonationRoleRequest assumeImpersonationRoleRequest)
Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
assumeImpersonationRoleRequest - default CompletableFuture<AssumeImpersonationRoleResponse> assumeImpersonationRole(Consumer<AssumeImpersonationRoleRequest.Builder> assumeImpersonationRoleRequest)
Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
This is a convenience which creates an instance of the AssumeImpersonationRoleRequest.Builder avoiding
the need to create one manually via AssumeImpersonationRoleRequest.builder()
assumeImpersonationRoleRequest - A Consumer that will call methods on AssumeImpersonationRoleRequest.Builder to create a
request.default CompletableFuture<CancelMailboxExportJobResponse> cancelMailboxExportJob(CancelMailboxExportJobRequest cancelMailboxExportJobRequest)
Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
cancelMailboxExportJobRequest - default CompletableFuture<CancelMailboxExportJobResponse> cancelMailboxExportJob(Consumer<CancelMailboxExportJobRequest.Builder> cancelMailboxExportJobRequest)
Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
This is a convenience which creates an instance of the CancelMailboxExportJobRequest.Builder avoiding the
need to create one manually via CancelMailboxExportJobRequest.builder()
cancelMailboxExportJobRequest - A Consumer that will call methods on CancelMailboxExportJobRequest.Builder to create a
request.default CompletableFuture<CreateAliasResponse> createAlias(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member (user or group) of WorkMail.
createAliasRequest - default CompletableFuture<CreateAliasResponse> createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Adds an alias to the set of a given member (user or group) of WorkMail.
This is a convenience which creates an instance of the CreateAliasRequest.Builder avoiding the need to
create one manually via CreateAliasRequest.builder()
createAliasRequest - A Consumer that will call methods on CreateAliasRequest.Builder to create a request.default CompletableFuture<CreateAvailabilityConfigurationResponse> createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest createAvailabilityConfigurationRequest)
Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
createAvailabilityConfigurationRequest - default CompletableFuture<CreateAvailabilityConfigurationResponse> createAvailabilityConfiguration(Consumer<CreateAvailabilityConfigurationRequest.Builder> createAvailabilityConfigurationRequest)
Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
This is a convenience which creates an instance of the CreateAvailabilityConfigurationRequest.Builder
avoiding the need to create one manually via CreateAvailabilityConfigurationRequest.builder()
createAvailabilityConfigurationRequest - A Consumer that will call methods on CreateAvailabilityConfigurationRequest.Builder to
create a request.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
createGroupRequest - default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.default CompletableFuture<CreateImpersonationRoleResponse> createImpersonationRole(CreateImpersonationRoleRequest createImpersonationRoleRequest)
Creates an impersonation role for the given WorkMail organization.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.
createImpersonationRoleRequest - default CompletableFuture<CreateImpersonationRoleResponse> createImpersonationRole(Consumer<CreateImpersonationRoleRequest.Builder> createImpersonationRoleRequest)
Creates an impersonation role for the given WorkMail organization.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.
This is a convenience which creates an instance of the CreateImpersonationRoleRequest.Builder avoiding
the need to create one manually via CreateImpersonationRoleRequest.builder()
createImpersonationRoleRequest - A Consumer that will call methods on CreateImpersonationRoleRequest.Builder to create a
request.default CompletableFuture<CreateMobileDeviceAccessRuleResponse> createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest createMobileDeviceAccessRuleRequest)
Creates a new mobile device access rule for the specified WorkMail organization.
createMobileDeviceAccessRuleRequest - default CompletableFuture<CreateMobileDeviceAccessRuleResponse> createMobileDeviceAccessRule(Consumer<CreateMobileDeviceAccessRuleRequest.Builder> createMobileDeviceAccessRuleRequest)
Creates a new mobile device access rule for the specified WorkMail organization.
This is a convenience which creates an instance of the CreateMobileDeviceAccessRuleRequest.Builder
avoiding the need to create one manually via CreateMobileDeviceAccessRuleRequest.builder()
createMobileDeviceAccessRuleRequest - A Consumer that will call methods on CreateMobileDeviceAccessRuleRequest.Builder to create
a request.default CompletableFuture<CreateOrganizationResponse> createOrganization(CreateOrganizationRequest createOrganizationRequest)
Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide.
Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
createOrganizationRequest - default CompletableFuture<CreateOrganizationResponse> createOrganization(Consumer<CreateOrganizationRequest.Builder> createOrganizationRequest)
Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide.
Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
This is a convenience which creates an instance of the CreateOrganizationRequest.Builder avoiding the
need to create one manually via CreateOrganizationRequest.builder()
createOrganizationRequest - A Consumer that will call methods on CreateOrganizationRequest.Builder to create a
request.default CompletableFuture<CreateResourceResponse> createResource(CreateResourceRequest createResourceRequest)
Creates a new WorkMail resource.
createResourceRequest - default CompletableFuture<CreateResourceResponse> createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
Creates a new WorkMail resource.
This is a convenience which creates an instance of the CreateResourceRequest.Builder avoiding the need to
create one manually via CreateResourceRequest.builder()
createResourceRequest - A Consumer that will call methods on CreateResourceRequest.Builder to create a request.default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
createUserRequest - default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.default CompletableFuture<DeleteAccessControlRuleResponse> deleteAccessControlRule(DeleteAccessControlRuleRequest deleteAccessControlRuleRequest)
Deletes an access control rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
deleteAccessControlRuleRequest - default CompletableFuture<DeleteAccessControlRuleResponse> deleteAccessControlRule(Consumer<DeleteAccessControlRuleRequest.Builder> deleteAccessControlRuleRequest)
Deletes an access control rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
This is a convenience which creates an instance of the DeleteAccessControlRuleRequest.Builder avoiding
the need to create one manually via DeleteAccessControlRuleRequest.builder()
deleteAccessControlRuleRequest - A Consumer that will call methods on DeleteAccessControlRuleRequest.Builder to create a
request.default CompletableFuture<DeleteAliasResponse> deleteAlias(DeleteAliasRequest deleteAliasRequest)
Remove one or more specified aliases from a set of aliases for a given user.
deleteAliasRequest - default CompletableFuture<DeleteAliasResponse> deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Remove one or more specified aliases from a set of aliases for a given user.
This is a convenience which creates an instance of the DeleteAliasRequest.Builder avoiding the need to
create one manually via DeleteAliasRequest.builder()
deleteAliasRequest - A Consumer that will call methods on DeleteAliasRequest.Builder to create a request.default CompletableFuture<DeleteAvailabilityConfigurationResponse> deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest deleteAvailabilityConfigurationRequest)
Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
deleteAvailabilityConfigurationRequest - default CompletableFuture<DeleteAvailabilityConfigurationResponse> deleteAvailabilityConfiguration(Consumer<DeleteAvailabilityConfigurationRequest.Builder> deleteAvailabilityConfigurationRequest)
Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
This is a convenience which creates an instance of the DeleteAvailabilityConfigurationRequest.Builder
avoiding the need to create one manually via DeleteAvailabilityConfigurationRequest.builder()
deleteAvailabilityConfigurationRequest - A Consumer that will call methods on DeleteAvailabilityConfigurationRequest.Builder to
create a request.default CompletableFuture<DeleteEmailMonitoringConfigurationResponse> deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest deleteEmailMonitoringConfigurationRequest)
Deletes the email monitoring configuration for a specified organization.
deleteEmailMonitoringConfigurationRequest - default CompletableFuture<DeleteEmailMonitoringConfigurationResponse> deleteEmailMonitoringConfiguration(Consumer<DeleteEmailMonitoringConfigurationRequest.Builder> deleteEmailMonitoringConfigurationRequest)
Deletes the email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the DeleteEmailMonitoringConfigurationRequest.Builder
avoiding the need to create one manually via DeleteEmailMonitoringConfigurationRequest.builder()
deleteEmailMonitoringConfigurationRequest - A Consumer that will call methods on DeleteEmailMonitoringConfigurationRequest.Builder to
create a request.default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group from WorkMail.
deleteGroupRequest - default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group from WorkMail.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.default CompletableFuture<DeleteImpersonationRoleResponse> deleteImpersonationRole(DeleteImpersonationRoleRequest deleteImpersonationRoleRequest)
Deletes an impersonation role for the given WorkMail organization.
deleteImpersonationRoleRequest - default CompletableFuture<DeleteImpersonationRoleResponse> deleteImpersonationRole(Consumer<DeleteImpersonationRoleRequest.Builder> deleteImpersonationRoleRequest)
Deletes an impersonation role for the given WorkMail organization.
This is a convenience which creates an instance of the DeleteImpersonationRoleRequest.Builder avoiding
the need to create one manually via DeleteImpersonationRoleRequest.builder()
deleteImpersonationRoleRequest - A Consumer that will call methods on DeleteImpersonationRoleRequest.Builder to create a
request.default CompletableFuture<DeleteMailboxPermissionsResponse> deleteMailboxPermissions(DeleteMailboxPermissionsRequest deleteMailboxPermissionsRequest)
Deletes permissions granted to a member (user or group).
deleteMailboxPermissionsRequest - default CompletableFuture<DeleteMailboxPermissionsResponse> deleteMailboxPermissions(Consumer<DeleteMailboxPermissionsRequest.Builder> deleteMailboxPermissionsRequest)
Deletes permissions granted to a member (user or group).
This is a convenience which creates an instance of the DeleteMailboxPermissionsRequest.Builder avoiding
the need to create one manually via DeleteMailboxPermissionsRequest.builder()
deleteMailboxPermissionsRequest - A Consumer that will call methods on DeleteMailboxPermissionsRequest.Builder to create a
request.default CompletableFuture<DeleteMobileDeviceAccessOverrideResponse> deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest deleteMobileDeviceAccessOverrideRequest)
Deletes the mobile device access override for the given WorkMail organization, user, and device.
Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
deleteMobileDeviceAccessOverrideRequest - default CompletableFuture<DeleteMobileDeviceAccessOverrideResponse> deleteMobileDeviceAccessOverride(Consumer<DeleteMobileDeviceAccessOverrideRequest.Builder> deleteMobileDeviceAccessOverrideRequest)
Deletes the mobile device access override for the given WorkMail organization, user, and device.
Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
This is a convenience which creates an instance of the DeleteMobileDeviceAccessOverrideRequest.Builder
avoiding the need to create one manually via DeleteMobileDeviceAccessOverrideRequest.builder()
deleteMobileDeviceAccessOverrideRequest - A Consumer that will call methods on DeleteMobileDeviceAccessOverrideRequest.Builder to
create a request.default CompletableFuture<DeleteMobileDeviceAccessRuleResponse> deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest deleteMobileDeviceAccessRuleRequest)
Deletes a mobile device access rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
deleteMobileDeviceAccessRuleRequest - default CompletableFuture<DeleteMobileDeviceAccessRuleResponse> deleteMobileDeviceAccessRule(Consumer<DeleteMobileDeviceAccessRuleRequest.Builder> deleteMobileDeviceAccessRuleRequest)
Deletes a mobile device access rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
This is a convenience which creates an instance of the DeleteMobileDeviceAccessRuleRequest.Builder
avoiding the need to create one manually via DeleteMobileDeviceAccessRuleRequest.builder()
deleteMobileDeviceAccessRuleRequest - A Consumer that will call methods on DeleteMobileDeviceAccessRuleRequest.Builder to create
a request.default CompletableFuture<DeleteOrganizationResponse> deleteOrganization(DeleteOrganizationRequest deleteOrganizationRequest)
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.
deleteOrganizationRequest - default CompletableFuture<DeleteOrganizationResponse> deleteOrganization(Consumer<DeleteOrganizationRequest.Builder> deleteOrganizationRequest)
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.
This is a convenience which creates an instance of the DeleteOrganizationRequest.Builder avoiding the
need to create one manually via DeleteOrganizationRequest.builder()
deleteOrganizationRequest - A Consumer that will call methods on DeleteOrganizationRequest.Builder to create a
request.default CompletableFuture<DeleteResourceResponse> deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
deleteResourceRequest - default CompletableFuture<DeleteResourceResponse> deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)
Deletes the specified resource.
This is a convenience which creates an instance of the DeleteResourceRequest.Builder avoiding the need to
create one manually via DeleteResourceRequest.builder()
deleteResourceRequest - A Consumer that will call methods on DeleteResourceRequest.Builder to create a request.default CompletableFuture<DeleteRetentionPolicyResponse> deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
Deletes the specified retention policy from the specified organization.
deleteRetentionPolicyRequest - default CompletableFuture<DeleteRetentionPolicyResponse> deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest)
Deletes the specified retention policy from the specified organization.
This is a convenience which creates an instance of the DeleteRetentionPolicyRequest.Builder avoiding the
need to create one manually via DeleteRetentionPolicyRequest.builder()
deleteRetentionPolicyRequest - A Consumer that will call methods on DeleteRetentionPolicyRequest.Builder to create a
request.default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be
DISABLED. Use the DescribeUser action to confirm the user state.
Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
deleteUserRequest - default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be
DISABLED. Use the DescribeUser action to confirm the user state.
Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.default CompletableFuture<DeregisterFromWorkMailResponse> deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
deregisterFromWorkMailRequest - default CompletableFuture<DeregisterFromWorkMailResponse> deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
This is a convenience which creates an instance of the DeregisterFromWorkMailRequest.Builder avoiding the
need to create one manually via DeregisterFromWorkMailRequest.builder()
deregisterFromWorkMailRequest - A Consumer that will call methods on DeregisterFromWorkMailRequest.Builder to create a
request.default CompletableFuture<DeregisterMailDomainResponse> deregisterMailDomain(DeregisterMailDomainRequest deregisterMailDomainRequest)
Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
deregisterMailDomainRequest - default CompletableFuture<DeregisterMailDomainResponse> deregisterMailDomain(Consumer<DeregisterMailDomainRequest.Builder> deregisterMailDomainRequest)
Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
This is a convenience which creates an instance of the DeregisterMailDomainRequest.Builder avoiding the
need to create one manually via DeregisterMailDomainRequest.builder()
deregisterMailDomainRequest - A Consumer that will call methods on DeregisterMailDomainRequest.Builder to create a
request.default CompletableFuture<DescribeEmailMonitoringConfigurationResponse> describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest describeEmailMonitoringConfigurationRequest)
Describes the current email monitoring configuration for a specified organization.
describeEmailMonitoringConfigurationRequest - default CompletableFuture<DescribeEmailMonitoringConfigurationResponse> describeEmailMonitoringConfiguration(Consumer<DescribeEmailMonitoringConfigurationRequest.Builder> describeEmailMonitoringConfigurationRequest)
Describes the current email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the
DescribeEmailMonitoringConfigurationRequest.Builder avoiding the need to create one manually via
DescribeEmailMonitoringConfigurationRequest.builder()
describeEmailMonitoringConfigurationRequest - A Consumer that will call methods on DescribeEmailMonitoringConfigurationRequest.Builder
to create a request.default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
describeGroupRequest - default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
Returns the data available for the group.
This is a convenience which creates an instance of the DescribeGroupRequest.Builder avoiding the need to
create one manually via DescribeGroupRequest.builder()
describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.default CompletableFuture<DescribeInboundDmarcSettingsResponse> describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest describeInboundDmarcSettingsRequest)
Lists the settings in a DMARC policy for a specified organization.
describeInboundDmarcSettingsRequest - default CompletableFuture<DescribeInboundDmarcSettingsResponse> describeInboundDmarcSettings(Consumer<DescribeInboundDmarcSettingsRequest.Builder> describeInboundDmarcSettingsRequest)
Lists the settings in a DMARC policy for a specified organization.
This is a convenience which creates an instance of the DescribeInboundDmarcSettingsRequest.Builder
avoiding the need to create one manually via DescribeInboundDmarcSettingsRequest.builder()
describeInboundDmarcSettingsRequest - A Consumer that will call methods on DescribeInboundDmarcSettingsRequest.Builder to create
a request.default CompletableFuture<DescribeMailboxExportJobResponse> describeMailboxExportJob(DescribeMailboxExportJobRequest describeMailboxExportJobRequest)
Describes the current status of a mailbox export job.
describeMailboxExportJobRequest - default CompletableFuture<DescribeMailboxExportJobResponse> describeMailboxExportJob(Consumer<DescribeMailboxExportJobRequest.Builder> describeMailboxExportJobRequest)
Describes the current status of a mailbox export job.
This is a convenience which creates an instance of the DescribeMailboxExportJobRequest.Builder avoiding
the need to create one manually via DescribeMailboxExportJobRequest.builder()
describeMailboxExportJobRequest - A Consumer that will call methods on DescribeMailboxExportJobRequest.Builder to create a
request.default CompletableFuture<DescribeOrganizationResponse> describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
describeOrganizationRequest - default CompletableFuture<DescribeOrganizationResponse> describeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
This is a convenience which creates an instance of the DescribeOrganizationRequest.Builder avoiding the
need to create one manually via DescribeOrganizationRequest.builder()
describeOrganizationRequest - A Consumer that will call methods on DescribeOrganizationRequest.Builder to create a
request.default CompletableFuture<DescribeResourceResponse> describeResource(DescribeResourceRequest describeResourceRequest)
Returns the data available for the resource.
describeResourceRequest - default CompletableFuture<DescribeResourceResponse> describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Returns the data available for the resource.
This is a convenience which creates an instance of the DescribeResourceRequest.Builder avoiding the need
to create one manually via DescribeResourceRequest.builder()
describeResourceRequest - A Consumer that will call methods on DescribeResourceRequest.Builder to create a request.default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)
Provides information regarding the user.
describeUserRequest - default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Provides information regarding the user.
This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.default CompletableFuture<DisassociateDelegateFromResourceResponse> disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
disassociateDelegateFromResourceRequest - default CompletableFuture<DisassociateDelegateFromResourceResponse> disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
This is a convenience which creates an instance of the DisassociateDelegateFromResourceRequest.Builder
avoiding the need to create one manually via DisassociateDelegateFromResourceRequest.builder()
disassociateDelegateFromResourceRequest - A Consumer that will call methods on DisassociateDelegateFromResourceRequest.Builder to
create a request.default CompletableFuture<DisassociateMemberFromGroupResponse> disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
Removes a member from a group.
disassociateMemberFromGroupRequest - default CompletableFuture<DisassociateMemberFromGroupResponse> disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest)
Removes a member from a group.
This is a convenience which creates an instance of the DisassociateMemberFromGroupRequest.Builder
avoiding the need to create one manually via DisassociateMemberFromGroupRequest.builder()
disassociateMemberFromGroupRequest - A Consumer that will call methods on DisassociateMemberFromGroupRequest.Builder to create
a request.default CompletableFuture<GetAccessControlEffectResponse> getAccessControlEffect(GetAccessControlEffectRequest getAccessControlEffectRequest)
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
getAccessControlEffectRequest - default CompletableFuture<GetAccessControlEffectResponse> getAccessControlEffect(Consumer<GetAccessControlEffectRequest.Builder> getAccessControlEffectRequest)
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
This is a convenience which creates an instance of the GetAccessControlEffectRequest.Builder avoiding the
need to create one manually via GetAccessControlEffectRequest.builder()
getAccessControlEffectRequest - A Consumer that will call methods on GetAccessControlEffectRequest.Builder to create a
request.default CompletableFuture<GetDefaultRetentionPolicyResponse> getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest getDefaultRetentionPolicyRequest)
Gets the default retention policy details for the specified organization.
getDefaultRetentionPolicyRequest - default CompletableFuture<GetDefaultRetentionPolicyResponse> getDefaultRetentionPolicy(Consumer<GetDefaultRetentionPolicyRequest.Builder> getDefaultRetentionPolicyRequest)
Gets the default retention policy details for the specified organization.
This is a convenience which creates an instance of the GetDefaultRetentionPolicyRequest.Builder avoiding
the need to create one manually via GetDefaultRetentionPolicyRequest.builder()
getDefaultRetentionPolicyRequest - A Consumer that will call methods on GetDefaultRetentionPolicyRequest.Builder to create a
request.default CompletableFuture<GetImpersonationRoleResponse> getImpersonationRole(GetImpersonationRoleRequest getImpersonationRoleRequest)
Gets the impersonation role details for the given WorkMail organization.
getImpersonationRoleRequest - default CompletableFuture<GetImpersonationRoleResponse> getImpersonationRole(Consumer<GetImpersonationRoleRequest.Builder> getImpersonationRoleRequest)
Gets the impersonation role details for the given WorkMail organization.
This is a convenience which creates an instance of the GetImpersonationRoleRequest.Builder avoiding the
need to create one manually via GetImpersonationRoleRequest.builder()
getImpersonationRoleRequest - A Consumer that will call methods on GetImpersonationRoleRequest.Builder to create a
request.default CompletableFuture<GetImpersonationRoleEffectResponse> getImpersonationRoleEffect(GetImpersonationRoleEffectRequest getImpersonationRoleEffectRequest)
Tests whether the given impersonation role can impersonate a target user.
getImpersonationRoleEffectRequest - default CompletableFuture<GetImpersonationRoleEffectResponse> getImpersonationRoleEffect(Consumer<GetImpersonationRoleEffectRequest.Builder> getImpersonationRoleEffectRequest)
Tests whether the given impersonation role can impersonate a target user.
This is a convenience which creates an instance of the GetImpersonationRoleEffectRequest.Builder avoiding
the need to create one manually via GetImpersonationRoleEffectRequest.builder()
getImpersonationRoleEffectRequest - A Consumer that will call methods on GetImpersonationRoleEffectRequest.Builder to create a
request.default CompletableFuture<GetMailDomainResponse> getMailDomain(GetMailDomainRequest getMailDomainRequest)
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
getMailDomainRequest - default CompletableFuture<GetMailDomainResponse> getMailDomain(Consumer<GetMailDomainRequest.Builder> getMailDomainRequest)
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
This is a convenience which creates an instance of the GetMailDomainRequest.Builder avoiding the need to
create one manually via GetMailDomainRequest.builder()
getMailDomainRequest - A Consumer that will call methods on GetMailDomainRequest.Builder to create a request.default CompletableFuture<GetMailboxDetailsResponse> getMailboxDetails(GetMailboxDetailsRequest getMailboxDetailsRequest)
Requests a user's mailbox details for a specified organization and user.
getMailboxDetailsRequest - default CompletableFuture<GetMailboxDetailsResponse> getMailboxDetails(Consumer<GetMailboxDetailsRequest.Builder> getMailboxDetailsRequest)
Requests a user's mailbox details for a specified organization and user.
This is a convenience which creates an instance of the GetMailboxDetailsRequest.Builder avoiding the need
to create one manually via GetMailboxDetailsRequest.builder()
getMailboxDetailsRequest - A Consumer that will call methods on GetMailboxDetailsRequest.Builder to create a request.default CompletableFuture<GetMobileDeviceAccessEffectResponse> getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest getMobileDeviceAccessEffectRequest)
Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
getMobileDeviceAccessEffectRequest - default CompletableFuture<GetMobileDeviceAccessEffectResponse> getMobileDeviceAccessEffect(Consumer<GetMobileDeviceAccessEffectRequest.Builder> getMobileDeviceAccessEffectRequest)
Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
This is a convenience which creates an instance of the GetMobileDeviceAccessEffectRequest.Builder
avoiding the need to create one manually via GetMobileDeviceAccessEffectRequest.builder()
getMobileDeviceAccessEffectRequest - A Consumer that will call methods on GetMobileDeviceAccessEffectRequest.Builder to create
a request.default CompletableFuture<GetMobileDeviceAccessOverrideResponse> getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest getMobileDeviceAccessOverrideRequest)
Gets the mobile device access override for the given WorkMail organization, user, and device.
getMobileDeviceAccessOverrideRequest - default CompletableFuture<GetMobileDeviceAccessOverrideResponse> getMobileDeviceAccessOverride(Consumer<GetMobileDeviceAccessOverrideRequest.Builder> getMobileDeviceAccessOverrideRequest)
Gets the mobile device access override for the given WorkMail organization, user, and device.
This is a convenience which creates an instance of the GetMobileDeviceAccessOverrideRequest.Builder
avoiding the need to create one manually via GetMobileDeviceAccessOverrideRequest.builder()
getMobileDeviceAccessOverrideRequest - A Consumer that will call methods on GetMobileDeviceAccessOverrideRequest.Builder to
create a request.default CompletableFuture<ListAccessControlRulesResponse> listAccessControlRules(ListAccessControlRulesRequest listAccessControlRulesRequest)
Lists the access control rules for the specified organization.
listAccessControlRulesRequest - default CompletableFuture<ListAccessControlRulesResponse> listAccessControlRules(Consumer<ListAccessControlRulesRequest.Builder> listAccessControlRulesRequest)
Lists the access control rules for the specified organization.
This is a convenience which creates an instance of the ListAccessControlRulesRequest.Builder avoiding the
need to create one manually via ListAccessControlRulesRequest.builder()
listAccessControlRulesRequest - A Consumer that will call methods on ListAccessControlRulesRequest.Builder to create a
request.default CompletableFuture<ListAliasesResponse> listAliases(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
listAliasesRequest - default CompletableFuture<ListAliasesResponse> listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
This is a convenience which creates an instance of the ListAliasesRequest.Builder avoiding the need to
create one manually via ListAliasesRequest.builder()
listAliasesRequest - A Consumer that will call methods on ListAliasesRequest.Builder to create a request.default ListAliasesPublisher listAliasesPaginator(ListAliasesRequest listAliasesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListAliasesPublisher listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListAvailabilityConfigurationsResponse> listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)
List all the AvailabilityConfiguration's for the given WorkMail organization.
listAvailabilityConfigurationsRequest - default CompletableFuture<ListAvailabilityConfigurationsResponse> listAvailabilityConfigurations(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest)
List all the AvailabilityConfiguration's for the given WorkMail organization.
This is a convenience which creates an instance of the ListAvailabilityConfigurationsRequest.Builder
avoiding the need to create one manually via ListAvailabilityConfigurationsRequest.builder()
listAvailabilityConfigurationsRequest - A Consumer that will call methods on ListAvailabilityConfigurationsRequest.Builder to
create a request.default ListAvailabilityConfigurationsPublisher listAvailabilityConfigurationsPaginator(ListAvailabilityConfigurationsRequest listAvailabilityConfigurationsRequest)
List all the AvailabilityConfiguration's for the given WorkMail organization.
This is a variant of
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation.
listAvailabilityConfigurationsRequest - default ListAvailabilityConfigurationsPublisher listAvailabilityConfigurationsPaginator(Consumer<ListAvailabilityConfigurationsRequest.Builder> listAvailabilityConfigurationsRequest)
List all the AvailabilityConfiguration's for the given WorkMail organization.
This is a variant of
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListAvailabilityConfigurationsPublisher publisher = client.listAvailabilityConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAvailabilityConfigurations(software.amazon.awssdk.services.workmail.model.ListAvailabilityConfigurationsRequest)
operation.
This is a convenience which creates an instance of the ListAvailabilityConfigurationsRequest.Builder
avoiding the need to create one manually via ListAvailabilityConfigurationsRequest.builder()
listAvailabilityConfigurationsRequest - A Consumer that will call methods on ListAvailabilityConfigurationsRequest.Builder to
create a request.default CompletableFuture<ListGroupMembersResponse> listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group. Users and groups can be members of a group.
listGroupMembersRequest - default CompletableFuture<ListGroupMembersResponse> listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group. Users and groups can be members of a group.
This is a convenience which creates an instance of the ListGroupMembersRequest.Builder avoiding the need
to create one manually via ListGroupMembersRequest.builder()
listGroupMembersRequest - A Consumer that will call methods on ListGroupMembersRequest.Builder to create a request.default ListGroupMembersPublisher listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListGroupMembersPublisher listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group. Users and groups can be members of a group.
This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
listGroupsRequest - default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListImpersonationRolesResponse> listImpersonationRoles(ListImpersonationRolesRequest listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
listImpersonationRolesRequest - default CompletableFuture<ListImpersonationRolesResponse> listImpersonationRoles(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
This is a convenience which creates an instance of the ListImpersonationRolesRequest.Builder avoiding the
need to create one manually via ListImpersonationRolesRequest.builder()
listImpersonationRolesRequest - A Consumer that will call methods on ListImpersonationRolesRequest.Builder to create a
request.default ListImpersonationRolesPublisher listImpersonationRolesPaginator(ListImpersonationRolesRequest listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
This is a variant of
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation.
listImpersonationRolesRequest - default ListImpersonationRolesPublisher listImpersonationRolesPaginator(Consumer<ListImpersonationRolesRequest.Builder> listImpersonationRolesRequest)
Lists all the impersonation roles for the given WorkMail organization.
This is a variant of
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListImpersonationRolesPublisher publisher = client.listImpersonationRolesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImpersonationRoles(software.amazon.awssdk.services.workmail.model.ListImpersonationRolesRequest)
operation.
This is a convenience which creates an instance of the ListImpersonationRolesRequest.Builder avoiding the
need to create one manually via ListImpersonationRolesRequest.builder()
listImpersonationRolesRequest - A Consumer that will call methods on ListImpersonationRolesRequest.Builder to create a
request.default CompletableFuture<ListMailDomainsResponse> listMailDomains(ListMailDomainsRequest listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
listMailDomainsRequest - default CompletableFuture<ListMailDomainsResponse> listMailDomains(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
This is a convenience which creates an instance of the ListMailDomainsRequest.Builder avoiding the need
to create one manually via ListMailDomainsRequest.builder()
listMailDomainsRequest - A Consumer that will call methods on ListMailDomainsRequest.Builder to create a request.default ListMailDomainsPublisher listMailDomainsPaginator(ListMailDomainsRequest listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
This is a variant of
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest) operation.
listMailDomainsRequest - default ListMailDomainsPublisher listMailDomainsPaginator(Consumer<ListMailDomainsRequest.Builder> listMailDomainsRequest)
Lists the mail domains in a given WorkMail organization.
This is a variant of
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListMailDomainsPublisher publisher = client.listMailDomainsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListMailDomainsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMailDomains(software.amazon.awssdk.services.workmail.model.ListMailDomainsRequest) operation.
This is a convenience which creates an instance of the ListMailDomainsRequest.Builder avoiding the need
to create one manually via ListMailDomainsRequest.builder()
listMailDomainsRequest - A Consumer that will call methods on ListMailDomainsRequest.Builder to create a request.default CompletableFuture<ListMailboxExportJobsResponse> listMailboxExportJobs(ListMailboxExportJobsRequest listMailboxExportJobsRequest)
Lists the mailbox export jobs started for the specified organization within the last seven days.
listMailboxExportJobsRequest - default CompletableFuture<ListMailboxExportJobsResponse> listMailboxExportJobs(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest)
Lists the mailbox export jobs started for the specified organization within the last seven days.
This is a convenience which creates an instance of the ListMailboxExportJobsRequest.Builder avoiding the
need to create one manually via ListMailboxExportJobsRequest.builder()
listMailboxExportJobsRequest - A Consumer that will call methods on ListMailboxExportJobsRequest.Builder to create a
request.default ListMailboxExportJobsPublisher listMailboxExportJobsPaginator(ListMailboxExportJobsRequest listMailboxExportJobsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListMailboxExportJobsPublisher listMailboxExportJobsPaginator(Consumer<ListMailboxExportJobsRequest.Builder> listMailboxExportJobsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListMailboxExportJobsPublisher publisher = client.listMailboxExportJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxExportJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListMailboxPermissionsResponse> listMailboxPermissions(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
listMailboxPermissionsRequest - default CompletableFuture<ListMailboxPermissionsResponse> listMailboxPermissions(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
This is a convenience which creates an instance of the ListMailboxPermissionsRequest.Builder avoiding the
need to create one manually via ListMailboxPermissionsRequest.builder()
listMailboxPermissionsRequest - A Consumer that will call methods on ListMailboxPermissionsRequest.Builder to create a
request.default ListMailboxPermissionsPublisher listMailboxPermissionsPaginator(ListMailboxPermissionsRequest listMailboxPermissionsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListMailboxPermissionsPublisher listMailboxPermissionsPaginator(Consumer<ListMailboxPermissionsRequest.Builder> listMailboxPermissionsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListMailboxPermissionsPublisher publisher = client.listMailboxPermissionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListMailboxPermissionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListMobileDeviceAccessOverridesResponse> listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
listMobileDeviceAccessOverridesRequest - default CompletableFuture<ListMobileDeviceAccessOverridesResponse> listMobileDeviceAccessOverrides(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
This is a convenience which creates an instance of the ListMobileDeviceAccessOverridesRequest.Builder
avoiding the need to create one manually via ListMobileDeviceAccessOverridesRequest.builder()
listMobileDeviceAccessOverridesRequest - A Consumer that will call methods on ListMobileDeviceAccessOverridesRequest.Builder to
create a request.default ListMobileDeviceAccessOverridesPublisher listMobileDeviceAccessOverridesPaginator(ListMobileDeviceAccessOverridesRequest listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
This is a variant of
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation.
listMobileDeviceAccessOverridesRequest - default ListMobileDeviceAccessOverridesPublisher listMobileDeviceAccessOverridesPaginator(Consumer<ListMobileDeviceAccessOverridesRequest.Builder> listMobileDeviceAccessOverridesRequest)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
This is a variant of
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListMobileDeviceAccessOverridesPublisher publisher = client.listMobileDeviceAccessOverridesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMobileDeviceAccessOverrides(software.amazon.awssdk.services.workmail.model.ListMobileDeviceAccessOverridesRequest)
operation.
This is a convenience which creates an instance of the ListMobileDeviceAccessOverridesRequest.Builder
avoiding the need to create one manually via ListMobileDeviceAccessOverridesRequest.builder()
listMobileDeviceAccessOverridesRequest - A Consumer that will call methods on ListMobileDeviceAccessOverridesRequest.Builder to
create a request.default CompletableFuture<ListMobileDeviceAccessRulesResponse> listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest listMobileDeviceAccessRulesRequest)
Lists the mobile device access rules for the specified WorkMail organization.
listMobileDeviceAccessRulesRequest - default CompletableFuture<ListMobileDeviceAccessRulesResponse> listMobileDeviceAccessRules(Consumer<ListMobileDeviceAccessRulesRequest.Builder> listMobileDeviceAccessRulesRequest)
Lists the mobile device access rules for the specified WorkMail organization.
This is a convenience which creates an instance of the ListMobileDeviceAccessRulesRequest.Builder
avoiding the need to create one manually via ListMobileDeviceAccessRulesRequest.builder()
listMobileDeviceAccessRulesRequest - A Consumer that will call methods on ListMobileDeviceAccessRulesRequest.Builder to create
a request.default CompletableFuture<ListOrganizationsResponse> listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's organizations.
listOrganizationsRequest - default CompletableFuture<ListOrganizationsResponse> listOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
Returns summaries of the customer's organizations.
This is a convenience which creates an instance of the ListOrganizationsRequest.Builder avoiding the need
to create one manually via ListOrganizationsRequest.builder()
listOrganizationsRequest - A Consumer that will call methods on ListOrganizationsRequest.Builder to create a request.default CompletableFuture<ListOrganizationsResponse> listOrganizations()
Returns summaries of the customer's organizations.
default ListOrganizationsPublisher listOrganizationsPaginator()
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
default ListOrganizationsPublisher listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListOrganizationsPublisher listOrganizationsPaginator(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsPublisher publisher = client.listOrganizationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListResourceDelegatesResponse> listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegatesRequest - default CompletableFuture<ListResourceDelegatesResponse> listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
This is a convenience which creates an instance of the ListResourceDelegatesRequest.Builder avoiding the
need to create one manually via ListResourceDelegatesRequest.builder()
listResourceDelegatesRequest - A Consumer that will call methods on ListResourceDelegatesRequest.Builder to create a
request.default ListResourceDelegatesPublisher listResourceDelegatesPaginator(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
This is a variant of
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListResourceDelegatesPublisher listResourceDelegatesPaginator(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest)
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
This is a variant of
listResourceDelegates(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListResourceDelegatesPublisher publisher = client.listResourceDelegatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListResourceDelegatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
listResourcesRequest - default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns summaries of the organization's resources.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.default ListResourcesPublisher listResourcesPaginator(ListResourcesRequest listResourcesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListResourcesPublisher listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to an WorkMail organization resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags applied to an WorkMail organization resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
listUsersRequest - default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns summaries of the organization's users.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workmail.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workmail.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workmail.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<PutAccessControlRuleResponse> putAccessControlRule(PutAccessControlRuleRequest putAccessControlRuleRequest)
Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
putAccessControlRuleRequest - default CompletableFuture<PutAccessControlRuleResponse> putAccessControlRule(Consumer<PutAccessControlRuleRequest.Builder> putAccessControlRuleRequest)
Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
This is a convenience which creates an instance of the PutAccessControlRuleRequest.Builder avoiding the
need to create one manually via PutAccessControlRuleRequest.builder()
putAccessControlRuleRequest - A Consumer that will call methods on PutAccessControlRuleRequest.Builder to create a
request.default CompletableFuture<PutEmailMonitoringConfigurationResponse> putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest putEmailMonitoringConfigurationRequest)
Creates or updates the email monitoring configuration for a specified organization.
putEmailMonitoringConfigurationRequest - default CompletableFuture<PutEmailMonitoringConfigurationResponse> putEmailMonitoringConfiguration(Consumer<PutEmailMonitoringConfigurationRequest.Builder> putEmailMonitoringConfigurationRequest)
Creates or updates the email monitoring configuration for a specified organization.
This is a convenience which creates an instance of the PutEmailMonitoringConfigurationRequest.Builder
avoiding the need to create one manually via PutEmailMonitoringConfigurationRequest.builder()
putEmailMonitoringConfigurationRequest - A Consumer that will call methods on PutEmailMonitoringConfigurationRequest.Builder to
create a request.default CompletableFuture<PutInboundDmarcSettingsResponse> putInboundDmarcSettings(PutInboundDmarcSettingsRequest putInboundDmarcSettingsRequest)
Enables or disables a DMARC policy for a given organization.
putInboundDmarcSettingsRequest - default CompletableFuture<PutInboundDmarcSettingsResponse> putInboundDmarcSettings(Consumer<PutInboundDmarcSettingsRequest.Builder> putInboundDmarcSettingsRequest)
Enables or disables a DMARC policy for a given organization.
This is a convenience which creates an instance of the PutInboundDmarcSettingsRequest.Builder avoiding
the need to create one manually via PutInboundDmarcSettingsRequest.builder()
putInboundDmarcSettingsRequest - A Consumer that will call methods on PutInboundDmarcSettingsRequest.Builder to create a
request.default CompletableFuture<PutMailboxPermissionsResponse> putMailboxPermissions(PutMailboxPermissionsRequest putMailboxPermissionsRequest)
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
putMailboxPermissionsRequest - default CompletableFuture<PutMailboxPermissionsResponse> putMailboxPermissions(Consumer<PutMailboxPermissionsRequest.Builder> putMailboxPermissionsRequest)
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
This is a convenience which creates an instance of the PutMailboxPermissionsRequest.Builder avoiding the
need to create one manually via PutMailboxPermissionsRequest.builder()
putMailboxPermissionsRequest - A Consumer that will call methods on PutMailboxPermissionsRequest.Builder to create a
request.default CompletableFuture<PutMobileDeviceAccessOverrideResponse> putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest putMobileDeviceAccessOverrideRequest)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
putMobileDeviceAccessOverrideRequest - default CompletableFuture<PutMobileDeviceAccessOverrideResponse> putMobileDeviceAccessOverride(Consumer<PutMobileDeviceAccessOverrideRequest.Builder> putMobileDeviceAccessOverrideRequest)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
This is a convenience which creates an instance of the PutMobileDeviceAccessOverrideRequest.Builder
avoiding the need to create one manually via PutMobileDeviceAccessOverrideRequest.builder()
putMobileDeviceAccessOverrideRequest - A Consumer that will call methods on PutMobileDeviceAccessOverrideRequest.Builder to
create a request.default CompletableFuture<PutRetentionPolicyResponse> putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)
Puts a retention policy to the specified organization.
putRetentionPolicyRequest - default CompletableFuture<PutRetentionPolicyResponse> putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest)
Puts a retention policy to the specified organization.
This is a convenience which creates an instance of the PutRetentionPolicyRequest.Builder avoiding the
need to create one manually via PutRetentionPolicyRequest.builder()
putRetentionPolicyRequest - A Consumer that will call methods on PutRetentionPolicyRequest.Builder to create a
request.default CompletableFuture<RegisterMailDomainResponse> registerMailDomain(RegisterMailDomainRequest registerMailDomainRequest)
Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
registerMailDomainRequest - default CompletableFuture<RegisterMailDomainResponse> registerMailDomain(Consumer<RegisterMailDomainRequest.Builder> registerMailDomainRequest)
Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
This is a convenience which creates an instance of the RegisterMailDomainRequest.Builder avoiding the
need to create one manually via RegisterMailDomainRequest.builder()
registerMailDomainRequest - A Consumer that will call methods on RegisterMailDomainRequest.Builder to create a
request.default CompletableFuture<RegisterToWorkMailResponse> registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
registerToWorkMailRequest - default CompletableFuture<RegisterToWorkMailResponse> registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
This is a convenience which creates an instance of the RegisterToWorkMailRequest.Builder avoiding the
need to create one manually via RegisterToWorkMailRequest.builder()
registerToWorkMailRequest - A Consumer that will call methods on RegisterToWorkMailRequest.Builder to create a
request.default CompletableFuture<ResetPasswordResponse> resetPassword(ResetPasswordRequest resetPasswordRequest)
Allows the administrator to reset the password for a user.
resetPasswordRequest - default CompletableFuture<ResetPasswordResponse> resetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest)
Allows the administrator to reset the password for a user.
This is a convenience which creates an instance of the ResetPasswordRequest.Builder avoiding the need to
create one manually via ResetPasswordRequest.builder()
resetPasswordRequest - A Consumer that will call methods on ResetPasswordRequest.Builder to create a request.default CompletableFuture<StartMailboxExportJobResponse> startMailboxExportJob(StartMailboxExportJobRequest startMailboxExportJobRequest)
Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
startMailboxExportJobRequest - default CompletableFuture<StartMailboxExportJobResponse> startMailboxExportJob(Consumer<StartMailboxExportJobRequest.Builder> startMailboxExportJobRequest)
Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
This is a convenience which creates an instance of the StartMailboxExportJobRequest.Builder avoiding the
need to create one manually via StartMailboxExportJobRequest.builder()
startMailboxExportJobRequest - A Consumer that will call methods on StartMailboxExportJobRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Applies the specified tags to the specified WorkMailorganization resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies the specified tags to the specified WorkMailorganization resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<TestAvailabilityConfigurationResponse> testAvailabilityConfiguration(TestAvailabilityConfigurationRequest testAvailabilityConfigurationRequest)
Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided
credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked
and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done
without providing either a SourceArn or SourceAccount header.
The request must contain either one provider definition (EwsProvider or LambdaProvider)
or the DomainName parameter. If the DomainName parameter is provided, the configuration
stored under the DomainName will be tested.
testAvailabilityConfigurationRequest - default CompletableFuture<TestAvailabilityConfigurationResponse> testAvailabilityConfiguration(Consumer<TestAvailabilityConfigurationRequest.Builder> testAvailabilityConfigurationRequest)
Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided
credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked
and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done
without providing either a SourceArn or SourceAccount header.
The request must contain either one provider definition (EwsProvider or LambdaProvider)
or the DomainName parameter. If the DomainName parameter is provided, the configuration
stored under the DomainName will be tested.
This is a convenience which creates an instance of the TestAvailabilityConfigurationRequest.Builder
avoiding the need to create one manually via TestAvailabilityConfigurationRequest.builder()
testAvailabilityConfigurationRequest - A Consumer that will call methods on TestAvailabilityConfigurationRequest.Builder to
create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Untags the specified tags from the specified WorkMail organization resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untags the specified tags from the specified WorkMail organization resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateAvailabilityConfigurationResponse> updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest updateAvailabilityConfigurationRequest)
Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
updateAvailabilityConfigurationRequest - default CompletableFuture<UpdateAvailabilityConfigurationResponse> updateAvailabilityConfiguration(Consumer<UpdateAvailabilityConfigurationRequest.Builder> updateAvailabilityConfigurationRequest)
Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
This is a convenience which creates an instance of the UpdateAvailabilityConfigurationRequest.Builder
avoiding the need to create one manually via UpdateAvailabilityConfigurationRequest.builder()
updateAvailabilityConfigurationRequest - A Consumer that will call methods on UpdateAvailabilityConfigurationRequest.Builder to
create a request.default CompletableFuture<UpdateDefaultMailDomainResponse> updateDefaultMailDomain(UpdateDefaultMailDomainRequest updateDefaultMailDomainRequest)
Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
updateDefaultMailDomainRequest - default CompletableFuture<UpdateDefaultMailDomainResponse> updateDefaultMailDomain(Consumer<UpdateDefaultMailDomainRequest.Builder> updateDefaultMailDomainRequest)
Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
This is a convenience which creates an instance of the UpdateDefaultMailDomainRequest.Builder avoiding
the need to create one manually via UpdateDefaultMailDomainRequest.builder()
updateDefaultMailDomainRequest - A Consumer that will call methods on UpdateDefaultMailDomainRequest.Builder to create a
request.default CompletableFuture<UpdateImpersonationRoleResponse> updateImpersonationRole(UpdateImpersonationRoleRequest updateImpersonationRoleRequest)
Updates an impersonation role for the given WorkMail organization.
updateImpersonationRoleRequest - default CompletableFuture<UpdateImpersonationRoleResponse> updateImpersonationRole(Consumer<UpdateImpersonationRoleRequest.Builder> updateImpersonationRoleRequest)
Updates an impersonation role for the given WorkMail organization.
This is a convenience which creates an instance of the UpdateImpersonationRoleRequest.Builder avoiding
the need to create one manually via UpdateImpersonationRoleRequest.builder()
updateImpersonationRoleRequest - A Consumer that will call methods on UpdateImpersonationRoleRequest.Builder to create a
request.default CompletableFuture<UpdateMailboxQuotaResponse> updateMailboxQuota(UpdateMailboxQuotaRequest updateMailboxQuotaRequest)
Updates a user's current mailbox quota for a specified organization and user.
updateMailboxQuotaRequest - default CompletableFuture<UpdateMailboxQuotaResponse> updateMailboxQuota(Consumer<UpdateMailboxQuotaRequest.Builder> updateMailboxQuotaRequest)
Updates a user's current mailbox quota for a specified organization and user.
This is a convenience which creates an instance of the UpdateMailboxQuotaRequest.Builder avoiding the
need to create one manually via UpdateMailboxQuotaRequest.builder()
updateMailboxQuotaRequest - A Consumer that will call methods on UpdateMailboxQuotaRequest.Builder to create a
request.default CompletableFuture<UpdateMobileDeviceAccessRuleResponse> updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest updateMobileDeviceAccessRuleRequest)
Updates a mobile device access rule for the specified WorkMail organization.
updateMobileDeviceAccessRuleRequest - default CompletableFuture<UpdateMobileDeviceAccessRuleResponse> updateMobileDeviceAccessRule(Consumer<UpdateMobileDeviceAccessRuleRequest.Builder> updateMobileDeviceAccessRuleRequest)
Updates a mobile device access rule for the specified WorkMail organization.
This is a convenience which creates an instance of the UpdateMobileDeviceAccessRuleRequest.Builder
avoiding the need to create one manually via UpdateMobileDeviceAccessRuleRequest.builder()
updateMobileDeviceAccessRuleRequest - A Consumer that will call methods on UpdateMobileDeviceAccessRuleRequest.Builder to create
a request.default CompletableFuture<UpdatePrimaryEmailAddressResponse> updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
updatePrimaryEmailAddressRequest - default CompletableFuture<UpdatePrimaryEmailAddressResponse> updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest)
Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
This is a convenience which creates an instance of the UpdatePrimaryEmailAddressRequest.Builder avoiding
the need to create one manually via UpdatePrimaryEmailAddressRequest.builder()
updatePrimaryEmailAddressRequest - A Consumer that will call methods on UpdatePrimaryEmailAddressRequest.Builder to create a
request.default CompletableFuture<UpdateResourceResponse> updateResource(UpdateResourceRequest updateResourceRequest)
Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource
call. The dataset in the request should be the one expected when performing another DescribeResource
call.
updateResourceRequest - default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource
call. The dataset in the request should be the one expected when performing another DescribeResource
call.
This is a convenience which creates an instance of the UpdateResourceRequest.Builder avoiding the need to
create one manually via UpdateResourceRequest.builder()
updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request.default WorkMailServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic WorkMailAsyncClient create()
WorkMailAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static WorkMailAsyncClientBuilder builder()
WorkMailAsyncClient.Copyright © 2023. All rights reserved.