@Generated(value="software.amazon.awssdk:codegen") public interface WorkMailClient extends SdkClient, SdkAutoCloseable
builder() method.
Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or their native iOS and Android email applications. You can integrate Amazon 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 Amazon WorkMail API is designed for the following scenarios:
Listing and describing organizations
Managing users
Managing groups
Managing resources
All Amazon WorkMail API actions are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkMail site, the IAM user gains full administrative visibility into the entire Amazon 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_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateDelegateToResourceResponse |
associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest)
Adds a member to the resource's set of delegates.
|
default AssociateDelegateToResourceResponse |
associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest)
Adds a member to the resource's set of delegates.
|
default AssociateMemberToGroupResponse |
associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest)
Adds a member to the group's set.
|
default AssociateMemberToGroupResponse |
associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest)
Adds a member to the group's set.
|
static WorkMailClientBuilder |
builder()
Create a builder that can be used to configure and create a
WorkMailClient. |
static WorkMailClient |
create()
Create a
WorkMailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAliasResponse |
createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Adds an alias to the set of a given member of Amazon WorkMail.
|
default CreateAliasResponse |
createAlias(CreateAliasRequest createAliasRequest)
Adds an alias to the set of a given member of Amazon WorkMail.
|
default CreateGroupResponse |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CreateGroupResponse |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CreateResourceResponse |
createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
Creates a new Amazon WorkMail resource.
|
default CreateResourceResponse |
createResource(CreateResourceRequest createResourceRequest)
Creates a new Amazon WorkMail resource.
|
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
default DeleteAliasResponse |
deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Remove the alias from a set of aliases for a given user.
|
default DeleteAliasResponse |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Remove the alias from a set of aliases for a given user.
|
default DeleteGroupResponse |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group from Amazon WorkMail.
|
default DeleteGroupResponse |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group from Amazon WorkMail.
|
default DeleteResourceResponse |
deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)
Deletes the specified resource.
|
default DeleteResourceResponse |
deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes the specified resource.
|
default DeleteUserResponse |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user from Amazon WorkMail and all subsequent systems.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from Amazon WorkMail and all subsequent systems.
|
default DeregisterFromWorkMailResponse |
deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
default DeregisterFromWorkMailResponse |
deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest)
Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
default DescribeGroupResponse |
describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
Returns the data available for the group.
|
default DescribeGroupResponse |
describeGroup(DescribeGroupRequest describeGroupRequest)
Returns the data available for the group.
|
default DescribeOrganizationResponse |
describeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
|
default DescribeOrganizationResponse |
describeOrganization(DescribeOrganizationRequest describeOrganizationRequest)
Provides more information regarding a given organization based on its identifier.
|
default DescribeResourceResponse |
describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Returns the data available for the resource.
|
default DescribeResourceResponse |
describeResource(DescribeResourceRequest describeResourceRequest)
Returns the data available for the resource.
|
default DescribeUserResponse |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Provides information regarding the user.
|
default DescribeUserResponse |
describeUser(DescribeUserRequest describeUserRequest)
Provides information regarding the user.
|
default DisassociateDelegateFromResourceResponse |
disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
|
default DisassociateDelegateFromResourceResponse |
disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest)
Removes a member from the resource's set of delegates.
|
default DisassociateMemberFromGroupResponse |
disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest)
Removes a member from a group.
|
default DisassociateMemberFromGroupResponse |
disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest)
Removes a member from a group.
|
default ListAliasesResponse |
listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListAliasesResponse |
listAliases(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListAliasesIterable |
listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListAliasesIterable |
listAliasesPaginator(ListAliasesRequest listAliasesRequest)
Creates a paginated call to list the aliases associated with a given entity.
|
default ListGroupMembersResponse |
listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group.
|
default ListGroupMembersResponse |
listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
|
default ListGroupMembersIterable |
listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)
Returns an overview of the members of a group.
|
default ListGroupMembersIterable |
listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest)
Returns an overview of the members of a group.
|
default ListGroupsResponse |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
|
default ListGroupsResponse |
listGroups(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
|
default ListGroupsIterable |
listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Returns summaries of the organization's groups.
|
default ListGroupsIterable |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Returns summaries of the organization's groups.
|
default ListOrganizationsResponse |
listOrganizations()
Returns summaries of the customer's non-deleted organizations.
|
default ListOrganizationsResponse |
listOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
|
default ListOrganizationsResponse |
listOrganizations(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
|
default ListOrganizationsIterable |
listOrganizationsPaginator()
Returns summaries of the customer's non-deleted organizations.
|
default ListOrganizationsIterable |
listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest)
Returns summaries of the customer's non-deleted organizations.
|
default ListResourceDelegatesResponse |
listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
default ListResourceDelegatesResponse |
listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest)
Lists the delegates associated with a resource.
|
default ListResourcesResponse |
listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns summaries of the organization's resources.
|
default ListResourcesResponse |
listResources(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
|
default ListResourcesIterable |
listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Returns summaries of the organization's resources.
|
default ListResourcesIterable |
listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Returns summaries of the organization's resources.
|
default ListUsersResponse |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns summaries of the organization's users.
|
default ListUsersResponse |
listUsers(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
|
default ListUsersIterable |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns summaries of the organization's users.
|
default ListUsersIterable |
listUsersPaginator(ListUsersRequest listUsersRequest)
Returns summaries of the organization's users.
|
default RegisterToWorkMailResponse |
registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a
mailbox and calendaring capabilities.
|
default RegisterToWorkMailResponse |
registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest)
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a
mailbox and calendaring capabilities.
|
default ResetPasswordResponse |
resetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest)
Allows the administrator to reset the password for a user.
|
default ResetPasswordResponse |
resetPassword(ResetPasswordRequest resetPasswordRequest)
Allows the administrator to reset the password for a user.
|
static ServiceMetadata |
serviceMetadata() |
default UpdatePrimaryEmailAddressResponse |
updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest)
Updates the primary email for an entity.
|
default UpdatePrimaryEmailAddressResponse |
updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest)
Updates the primary email for an entity.
|
default UpdateResourceResponse |
updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Updates data for the resource.
|
default UpdateResourceResponse |
updateResource(UpdateResourceRequest updateResourceRequest)
Updates data for the resource.
|
serviceNameclosestatic final String SERVICE_NAME
static WorkMailClient create()
WorkMailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static WorkMailClientBuilder builder()
WorkMailClient.default AssociateDelegateToResourceResponse associateDelegateToResource(AssociateDelegateToResourceRequest associateDelegateToResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Adds a member to the resource's set of delegates.
associateDelegateToResourceRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateDelegateToResourceResponse associateDelegateToResource(Consumer<AssociateDelegateToResourceRequest.Builder> associateDelegateToResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Adds a member to the resource's set of delegates.
This is a convenience which creates an instance of the AssociateDelegateToResourceRequest.Builder
avoiding the need to create one manually via AssociateDelegateToResourceRequest.builder()
associateDelegateToResourceRequest - A Consumer that will call methods on AssociateDelegateToResourceRequest.Builder to create
a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateMemberToGroupResponse associateMemberToGroup(AssociateMemberToGroupRequest associateMemberToGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Adds a member to the group's set.
associateMemberToGroupRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault AssociateMemberToGroupResponse associateMemberToGroup(Consumer<AssociateMemberToGroupRequest.Builder> associateMemberToGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Adds a member to the group's set.
This is a convenience which creates an instance of the AssociateMemberToGroupRequest.Builder avoiding the
need to create one manually via AssociateMemberToGroupRequest.builder()
associateMemberToGroupRequest - A Consumer that will call methods on AssociateMemberToGroupRequest.Builder to create a
request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Adds an alias to the set of a given member of Amazon WorkMail.
createAliasRequest - EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAliasResponse createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) throws EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Adds an alias to the set of a given member of Amazon WorkMail.
This is a convenience which creates an instance of the CreateAliasRequest.Builder avoiding the need to
create one manually via CreateAliasRequest.builder()
createAliasRequest - A Consumer that will call methods on CreateAliasRequest.Builder to create a request.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createGroupRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.NameAvailabilityException - The entity (user, group, or user) name isn't unique in Amazon WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.ReservedNameException - This entity name is not allowed in Amazon WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.NameAvailabilityException - The entity (user, group, or user) name isn't unique in Amazon WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.ReservedNameException - This entity name is not allowed in Amazon WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateResourceResponse createResource(CreateResourceRequest createResourceRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, AwsServiceException, SdkClientException, WorkMailException
Creates a new Amazon WorkMail resource. The available types are equipment and room.
createResourceRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.NameAvailabilityException - The entity (user, group, or user) name isn't unique in Amazon WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.ReservedNameException - This entity name is not allowed in Amazon WorkMail.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateResourceResponse createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, AwsServiceException, SdkClientException, WorkMailException
Creates a new Amazon WorkMail resource. The available types are equipment and room.
This is a convenience which creates an instance of the CreateResourceRequest.Builder avoiding the need to
create one manually via CreateResourceRequest.builder()
createResourceRequest - A Consumer that will call methods on CreateResourceRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.NameAvailabilityException - The entity (user, group, or user) name isn't unique in Amazon WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.ReservedNameException - This entity name is not allowed in Amazon WorkMail.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, InvalidPasswordException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createUserRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special
characters.NameAvailabilityException - The entity (user, group, or user) name isn't unique in Amazon WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.ReservedNameException - This entity name is not allowed in Amazon WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, InvalidParameterException, InvalidPasswordException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, ReservedNameException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special
characters.NameAvailabilityException - The entity (user, group, or user) name isn't unique in Amazon WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.ReservedNameException - This entity name is not allowed in Amazon WorkMail.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault DeleteAliasResponse deleteAlias(DeleteAliasRequest deleteAliasRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Remove the alias from a set of aliases for a given user.
deleteAliasRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAliasResponse deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Remove the alias from a set of aliases for a given user.
This is a convenience which creates an instance of the DeleteAliasRequest.Builder avoiding the need to
create one manually via DeleteAliasRequest.builder()
deleteAliasRequest - A Consumer that will call methods on DeleteAliasRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes a group from Amazon WorkMail.
deleteGroupRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes a group from Amazon WorkMail.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest) throws EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the specified resource.
deleteResourceRequest - EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourceResponse deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) throws EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Deletes the specified resource.
This is a convenience which creates an instance of the DeleteResourceRequest.Builder avoiding the need to
create one manually via DeleteResourceRequest.builder()
deleteResourceRequest - A Consumer that will call methods on DeleteResourceRequest.Builder to create a request.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.
deleteUserRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault DeregisterFromWorkMailResponse deregisterFromWorkMail(DeregisterFromWorkMailRequest deregisterFromWorkMailRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. Amazon WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
deregisterFromWorkMailRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterFromWorkMailResponse deregisterFromWorkMail(Consumer<DeregisterFromWorkMailRequest.Builder> deregisterFromWorkMailRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. Amazon WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
This is a convenience which creates an instance of the DeregisterFromWorkMailRequest.Builder avoiding the
need to create one manually via DeregisterFromWorkMailRequest.builder()
deregisterFromWorkMailRequest - A Consumer that will call methods on DeregisterFromWorkMailRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the group.
describeGroupRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the group.
This is a convenience which creates an instance of the DescribeGroupRequest.Builder avoiding the need to
create one manually via DescribeGroupRequest.builder()
describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOrganizationResponse describeOrganization(DescribeOrganizationRequest describeOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Provides more information regarding a given organization based on its identifier.
describeOrganizationRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOrganizationResponse describeOrganization(Consumer<DescribeOrganizationRequest.Builder> describeOrganizationRequest) throws InvalidParameterException, OrganizationNotFoundException, AwsServiceException, SdkClientException, WorkMailException
Provides more information regarding a given organization based on its identifier.
This is a convenience which creates an instance of the DescribeOrganizationRequest.Builder avoiding the
need to create one manually via DescribeOrganizationRequest.builder()
describeOrganizationRequest - A Consumer that will call methods on DescribeOrganizationRequest.Builder to create a
request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourceResponse describeResource(DescribeResourceRequest describeResourceRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the resource.
describeResourceRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourceResponse describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns the data available for the resource.
This is a convenience which creates an instance of the DescribeResourceRequest.Builder avoiding the need
to create one manually via DescribeResourceRequest.builder()
describeResourceRequest - A Consumer that will call methods on DescribeResourceRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Provides information regarding the user.
describeUserRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Provides information regarding the user.
This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest disassociateDelegateFromResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from the resource's set of delegates.
disassociateDelegateFromResourceRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateDelegateFromResourceResponse disassociateDelegateFromResource(Consumer<DisassociateDelegateFromResourceRequest.Builder> disassociateDelegateFromResourceRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from the resource's set of delegates.
This is a convenience which creates an instance of the DisassociateDelegateFromResourceRequest.Builder
avoiding the need to create one manually via DisassociateDelegateFromResourceRequest.builder()
disassociateDelegateFromResourceRequest - A Consumer that will call methods on DisassociateDelegateFromResourceRequest.Builder to
create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateMemberFromGroupResponse disassociateMemberFromGroup(DisassociateMemberFromGroupRequest disassociateMemberFromGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from a group.
disassociateMemberFromGroupRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault DisassociateMemberFromGroupResponse disassociateMemberFromGroup(Consumer<DisassociateMemberFromGroupRequest.Builder> disassociateMemberFromGroupRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Removes a member from a group.
This is a convenience which creates an instance of the DisassociateMemberFromGroupRequest.Builder
avoiding the need to create one manually via DisassociateMemberFromGroupRequest.builder()
disassociateMemberFromGroupRequest - A Consumer that will call methods on DisassociateMemberFromGroupRequest.Builder to create
a request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault ListAliasesResponse listAliases(ListAliasesRequest listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a paginated call to list the aliases associated with a given entity.
listAliasesRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAliasesResponse listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a paginated call to list the aliases associated with a given entity.
This is a convenience which creates an instance of the ListAliasesRequest.Builder avoiding the need to
create one manually via ListAliasesRequest.builder()
listAliasesRequest - A Consumer that will call methods on ListAliasesRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAliasesIterable listAliasesPaginator(ListAliasesRequest listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a paginated call to list the aliases associated with a given entity.
This is a variant of listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest) operation.
listAliasesRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAliasesIterable listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Creates a paginated call to list the aliases associated with a given entity.
This is a variant of listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.workmail.model.ListAliasesRequest) operation.
This is a convenience which creates an instance of the ListAliasesRequest.Builder avoiding the need to
create one manually via ListAliasesRequest.builder()
listAliasesRequest - A Consumer that will call methods on ListAliasesRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembersResponse listGroupMembers(ListGroupMembersRequest listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns an overview of the members of a group.
listGroupMembersRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembersResponse listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns an overview of the members of a group.
This is a convenience which creates an instance of the ListGroupMembersRequest.Builder avoiding the need
to create one manually via ListGroupMembersRequest.builder()
listGroupMembersRequest - A Consumer that will call methods on ListGroupMembersRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembersIterable listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns an overview of the members of a group.
This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client
.listGroupMembersPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest) operation.
listGroupMembersRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembersIterable listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns an overview of the members of a group.
This is a variant of
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client
.listGroupMembersPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListGroupMembersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListGroupMembersIterable responses = client.listGroupMembersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroupMembers(software.amazon.awssdk.services.workmail.model.ListGroupMembersRequest) operation.
This is a convenience which creates an instance of the ListGroupMembersRequest.Builder avoiding the need
to create one manually via ListGroupMembersRequest.builder()
listGroupMembersRequest - A Consumer that will call methods on ListGroupMembersRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's groups.
listGroupsRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's groups.
This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's groups.
This is a variant of listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest) operation.
listGroupsRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws EntityNotFoundException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's groups.
This is a variant of listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.workmail.model.ListGroupsRequest) operation.
This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOrganizationsResponse listOrganizations() throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's non-deleted organizations.
InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistOrganizations(ListOrganizationsRequest),
AWS API
Documentationdefault ListOrganizationsResponse listOrganizations(ListOrganizationsRequest listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's non-deleted organizations.
listOrganizationsRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOrganizationsResponse listOrganizations(Consumer<ListOrganizationsRequest.Builder> listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's non-deleted organizations.
This is a convenience which creates an instance of the ListOrganizationsRequest.Builder avoiding the need
to create one manually via ListOrganizationsRequest.builder()
listOrganizationsRequest - A Consumer that will call methods on ListOrganizationsRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOrganizationsIterable listOrganizationsPaginator(ListOrganizationsRequest listOrganizationsRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's non-deleted organizations.
This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client
.listOrganizationsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
listOrganizationsRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOrganizationsIterable listOrganizationsPaginator() throws InvalidParameterException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the customer's non-deleted organizations.
This is a variant of
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client
.listOrganizationsPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListOrganizationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListOrganizationsIterable responses = client.listOrganizationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listOrganizations(software.amazon.awssdk.services.workmail.model.ListOrganizationsRequest)
operation.
InvalidParameterException - One or more of the input parameters don't match the service's restrictions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistOrganizationsPaginator(ListOrganizationsRequest),
AWS API
Documentationdefault ListResourceDelegatesResponse listResourceDelegates(ListResourceDelegatesRequest listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegatesRequest - EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourceDelegatesResponse listResourceDelegates(Consumer<ListResourceDelegatesRequest.Builder> listResourceDelegatesRequest) throws EntityNotFoundException, EntityStateException, InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
This is a convenience which creates an instance of the ListResourceDelegatesRequest.Builder avoiding the
need to create one manually via ListResourceDelegatesRequest.builder()
listResourceDelegatesRequest - A Consumer that will call methods on ListResourceDelegatesRequest.Builder to create a
request.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's resources.
listResourcesRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's resources.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's resources.
This is a variant of listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest) operation.
listResourcesRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's resources.
This is a variant of listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.workmail.model.ListResourcesRequest) operation.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's users.
listUsersRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's users.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's users.
This is a variant of listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest) operation.
listUsersRequest - InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Returns summaries of the organization's users.
This is a variant of listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
for (software.amazon.awssdk.services.workmail.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workmail.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.workmail.model.ListUsersRequest) operation.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterToWorkMailResponse registerToWorkMail(RegisterToWorkMailRequest registerToWorkMailRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, EntityAlreadyRegisteredException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity 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 or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
registerToWorkMailRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.EntityAlreadyRegisteredException - The user, group, or resource that you're trying to register is already registered.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterToWorkMailResponse registerToWorkMail(Consumer<RegisterToWorkMailRequest.Builder> registerToWorkMailRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, EntityAlreadyRegisteredException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity 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 or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
This is a convenience which creates an instance of the RegisterToWorkMailRequest.Builder avoiding the
need to create one manually via RegisterToWorkMailRequest.builder()
registerToWorkMailRequest - A Consumer that will call methods on RegisterToWorkMailRequest.Builder to create a
request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.EntityAlreadyRegisteredException - The user, group, or resource that you're trying to register is already registered.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetPasswordResponse resetPassword(ResetPasswordRequest resetPasswordRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, InvalidPasswordException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Allows the administrator to reset the password for a user.
resetPasswordRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special
characters.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault ResetPasswordResponse resetPassword(Consumer<ResetPasswordRequest.Builder> resetPasswordRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidParameterException, InvalidPasswordException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Allows the administrator to reset the password for a user.
This is a convenience which creates an instance of the ResetPasswordRequest.Builder avoiding the need to
create one manually via ResetPasswordRequest.builder()
resetPasswordRequest - A Consumer that will call methods on ResetPasswordRequest.Builder to create a request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.InvalidPasswordException - The supplied password doesn't match the minimum security constraints, such as length or use of special
characters.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdatePrimaryEmailAddressResponse updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest updatePrimaryEmailAddressRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Updates the primary email for an entity. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email) and the email provided in the input is promoted as the primary.
updatePrimaryEmailAddressRequest - DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdatePrimaryEmailAddressResponse updatePrimaryEmailAddress(Consumer<UpdatePrimaryEmailAddressRequest.Builder> updatePrimaryEmailAddressRequest) throws DirectoryServiceAuthenticationFailedException, DirectoryUnavailableException, EmailAddressInUseException, EntityNotFoundException, EntityStateException, InvalidParameterException, MailDomainNotFoundException, MailDomainStateException, OrganizationNotFoundException, OrganizationStateException, UnsupportedOperationException, AwsServiceException, SdkClientException, WorkMailException
Updates the primary email for an entity. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email) and the email provided in the input is promoted as the primary.
This is a convenience which creates an instance of the UpdatePrimaryEmailAddressRequest.Builder avoiding
the need to create one manually via UpdatePrimaryEmailAddressRequest.builder()
updatePrimaryEmailAddressRequest - A Consumer that will call methods on UpdatePrimaryEmailAddressRequest.Builder to create a
request.DirectoryServiceAuthenticationFailedException - The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.InvalidParameterException - One or more of the input parameters don't match the service's restrictions.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.UnsupportedOperationException - You can't perform a write operation against a read-only directory.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException, EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.
updateResourceRequest - DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidConfigurationException - The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests
or have at least one delegate associated that can do it on its behalf.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.NameAvailabilityException - The entity (user, group, or user) name isn't unique in Amazon WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) throws DirectoryUnavailableException, EntityNotFoundException, EntityStateException, InvalidConfigurationException, EmailAddressInUseException, MailDomainNotFoundException, MailDomainStateException, NameAvailabilityException, OrganizationNotFoundException, OrganizationStateException, AwsServiceException, SdkClientException, WorkMailException
Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.
This is a convenience which creates an instance of the UpdateResourceRequest.Builder avoiding the need to
create one manually via UpdateResourceRequest.builder()
updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request.DirectoryUnavailableException - The directory that you are trying to perform operations on isn't available.EntityNotFoundException - The identifier supplied for the entity is valid, but it does not exist in your organization.EntityStateException - You are performing an operation on an entity that isn't in the expected state, such as trying to update a
deleted user.InvalidConfigurationException - The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests
or have at least one delegate associated that can do it on its behalf.EmailAddressInUseException - The email address that you're trying to assign is already created for a different user, group, or
resource.MailDomainNotFoundException - For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the
organization.MailDomainStateException - After a domain has been added to the organization, it must be verified. The domain is not yet verified.NameAvailabilityException - The entity (user, group, or user) name isn't unique in Amazon WorkMail.OrganizationNotFoundException - An operation received a valid organization identifier that either doesn't belong or exist in the system.OrganizationStateException - The organization must have a valid state (Active or Synchronizing) to perform certain operations on the
organization or its entities.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkMailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.