Serialized Form (AWS Java SDK for Amazon WorkMail 1.12.592 API)

Package com.amazonaws.services.workmail.model
- Class com.amazonaws.services.workmail.model.AccessControlRule extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The rule name.
    - effect
```
String effect
```
      The rule effect.
    - description
```
String description
```
      The rule description.
    - ipRanges
```
List<E> ipRanges
```
      IPv4 CIDR ranges to include in the rule.
    - notIpRanges
```
List<E> notIpRanges
```
      IPv4 CIDR ranges to exclude from the rule.
    - actions
```
List<E> actions
```
      Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    - notActions
```
List<E> notActions
```
      Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    - userIds
```
List<E> userIds
```
      User IDs to include in the rule.
    - notUserIds
```
List<E> notUserIds
```
      User IDs to exclude from the rule.
    - dateCreated
```
Date dateCreated
```
      The date that the rule was created.
    - dateModified
```
Date dateModified
```
      The date that the rule was modified.
    - impersonationRoleIds
```
List<E> impersonationRoleIds
```
      Impersonation role IDs to include in the rule.
    - notImpersonationRoleIds
```
List<E> notImpersonationRoleIds
```
      Impersonation role IDs to exclude from the rule.
- Class com.amazonaws.services.workmail.model.AmazonWorkMailException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.workmail.model.AssociateDelegateToResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization under which the resource exists.
    - resourceId
```
String resourceId
```
      The resource for which members (users or groups) are associated.
      
      The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
      
      Resource ID: r-0123456789a0123456789b0123456789
      
      Email address: resource@domain.tld
      
      Resource name: resource
    - entityId
```
String entityId
```
      The member (user or group) to associate to the resource.
      
      The entity ID can accept UserId or GroupID, Username or Groupname, or email.
      
      Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: entity@domain.tld
      
      Entity: entity
- Class com.amazonaws.services.workmail.model.AssociateDelegateToResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.AssociateMemberToGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization under which the group exists.
    - groupId
```
String groupId
```
      The group to which the member (user or group) is associated.
      
      The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
      
      Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: group@domain.tld
      
      Group name: group
    - memberId
```
String memberId
```
      The member (user or group) to associate to the group.
      
      The member ID can accept UserID or GroupId, Username or Groupname, or email.
      
      Member: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: member@domain.tld
      
      Member name: member
- Class com.amazonaws.services.workmail.model.AssociateMemberToGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.AssumeImpersonationRoleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The WorkMail organization under which the impersonation role will be assumed.
    - impersonationRoleId
```
String impersonationRoleId
```
      The impersonation role ID to assume.
- Class com.amazonaws.services.workmail.model.AssumeImpersonationRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - token
```
String token
```
      The authentication token for the impersonation role.
    - expiresIn
```
Long expiresIn
```
      The authentication token's validity, in seconds.
- Class com.amazonaws.services.workmail.model.AvailabilityConfiguration extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Displays the domain to which the provider applies.
    - providerType
```
String providerType
```
      Displays the provider type that applies to this domain.
    - ewsProvider
```
RedactedEwsAvailabilityProvider ewsProvider
```
      If ProviderType is EWS, then this field contains RedactedEwsAvailabilityProvider. Otherwise, it is not required.
    - lambdaProvider
```
LambdaAvailabilityProvider lambdaProvider
```
      If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. Otherwise, it is not required.
    - dateCreated
```
Date dateCreated
```
      The date and time at which the availability configuration was created.
    - dateModified
```
Date dateModified
```
      The date and time at which the availability configuration was last modified.
- Class com.amazonaws.services.workmail.model.BookingOptions extends Object implements Serializable
  - Serialized Fields
    - autoAcceptRequests
```
Boolean autoAcceptRequests
```
      The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.
    - autoDeclineRecurringRequests
```
Boolean autoDeclineRecurringRequests
```
      The resource's ability to automatically decline any recurring requests.
    - autoDeclineConflictingRequests
```
Boolean autoDeclineConflictingRequests
```
      The resource's ability to automatically decline any conflicting requests.
- Class com.amazonaws.services.workmail.model.CancelMailboxExportJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      The idempotency token for the client request.
    - jobId
```
String jobId
```
      The job ID.
    - organizationId
```
String organizationId
```
      The organization ID.
- Class com.amazonaws.services.workmail.model.CancelMailboxExportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization under which the member (user or group) exists.
    - entityId
```
String entityId
```
      The member (user or group) to which this alias is added.
    - alias
```
String alias
```
      The alias to add to the member set.
- Class com.amazonaws.services.workmail.model.CreateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.CreateAvailabilityConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      An idempotent token that ensures that an API request is executed only once.
    - organizationId
```
String organizationId
```
      The WorkMail organization for which the AvailabilityConfiguration will be created.
    - domainName
```
String domainName
```
      The domain to which the provider applies.
    - ewsProvider
```
EwsAvailabilityProvider ewsProvider
```
      Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
    - lambdaProvider
```
LambdaAvailabilityProvider lambdaProvider
```
      Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
- Class com.amazonaws.services.workmail.model.CreateAvailabilityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.CreateGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization under which the group is to be created.
    - name
```
String name
```
      The name of the group.
    - hiddenFromGlobalAddressList
```
Boolean hiddenFromGlobalAddressList
```
      If this parameter is enabled, the group will be hidden from the address book.
- Class com.amazonaws.services.workmail.model.CreateGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - groupId
```
String groupId
```
      The identifier of the group.
- Class com.amazonaws.services.workmail.model.CreateImpersonationRoleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      The idempotency token for the client request.
    - organizationId
```
String organizationId
```
      The WorkMail organization to create the new impersonation role within.
    - name
```
String name
```
      The name of the new impersonation role.
    - type
```
String type
```
      The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.
    - description
```
String description
```
      The description of the new impersonation role.
    - rules
```
List<E> rules
```
      The list of rules for the impersonation role.
- Class com.amazonaws.services.workmail.model.CreateImpersonationRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - impersonationRoleId
```
String impersonationRoleId
```
      The new impersonation role ID.
- Class com.amazonaws.services.workmail.model.CreateMobileDeviceAccessRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The WorkMail organization under which the rule will be created.
    - clientToken
```
String clientToken
```
      The idempotency token for the client request.
    - name
```
String name
```
      The rule name.
    - description
```
String description
```
      The rule description.
    - effect
```
String effect
```
      The effect of the rule when it matches. Allowed values are ALLOW or DENY.
    - deviceTypes
```
List<E> deviceTypes
```
      Device types that the rule will match.
    - notDeviceTypes
```
List<E> notDeviceTypes
```
      Device types that the rule will not match. All other device types will match.
    - deviceModels
```
List<E> deviceModels
```
      Device models that the rule will match.
    - notDeviceModels
```
List<E> notDeviceModels
```
      Device models that the rule will not match. All other device models will match.
    - deviceOperatingSystems
```
List<E> deviceOperatingSystems
```
      Device operating systems that the rule will match.
    - notDeviceOperatingSystems
```
List<E> notDeviceOperatingSystems
```
      Device operating systems that the rule will not match. All other device operating systems will match.
    - deviceUserAgents
```
List<E> deviceUserAgents
```
      Device user agents that the rule will match.
    - notDeviceUserAgents
```
List<E> notDeviceUserAgents
```
      Device user agents that the rule will not match. All other device user agents will match.
- Class com.amazonaws.services.workmail.model.CreateMobileDeviceAccessRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - mobileDeviceAccessRuleId
```
String mobileDeviceAccessRuleId
```
      The identifier for the newly created mobile device access rule.
- Class com.amazonaws.services.workmail.model.CreateOrganizationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The AWS Directory Service directory ID.
    - alias
```
String alias
```
      The organization alias.
    - clientToken
```
String clientToken
```
      The idempotency token associated with the request.
    - domains
```
List<E> domains
```
      The email domains to associate with the organization.
    - kmsKeyArn
```
String kmsKeyArn
```
      The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
    - enableInteroperability
```
Boolean enableInteroperability
```
      When true, allows organization interoperability between WorkMail and Microsoft Exchange. If true, you must include a AD Connector directory ID in the request.
- Class com.amazonaws.services.workmail.model.CreateOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization ID.
- Class com.amazonaws.services.workmail.model.CreateResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier associated with the organization for which the resource is created.
    - name
```
String name
```
      The name of the new resource.
    - type
```
String type
```
      The type of the new resource. The available types are equipment and room.
    - description
```
String description
```
      Resource description.
    - hiddenFromGlobalAddressList
```
Boolean hiddenFromGlobalAddressList
```
      If this parameter is enabled, the resource will be hidden from the address book.
- Class com.amazonaws.services.workmail.model.CreateResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The identifier of the new resource.
- Class com.amazonaws.services.workmail.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier of the organization for which the user is created.
    - name
```
String name
```
      The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.
    - displayName
```
String displayName
```
      The display name for the new user.
    - password
```
String password
```
      The password for the new user.
    - role
```
String role
```
      The role of the new user.
      
      You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.
    - firstName
```
String firstName
```
      The first name of the new user.
    - lastName
```
String lastName
```
      The last name of the new user.
    - hiddenFromGlobalAddressList
```
Boolean hiddenFromGlobalAddressList
```
      If this parameter is enabled, the user will be hidden from the address book.
- Class com.amazonaws.services.workmail.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userId
```
String userId
```
      The identifier for the new user.
- Class com.amazonaws.services.workmail.model.Delegate extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the user or group associated as the resource's delegate.
    - type
```
String type
```
      The type of the delegate: user or group.
- Class com.amazonaws.services.workmail.model.DeleteAccessControlRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization.
    - name
```
String name
```
      The name of the access control rule.
- Class com.amazonaws.services.workmail.model.DeleteAccessControlRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization under which the user exists.
    - entityId
```
String entityId
```
      The identifier for the member (user or group) from which to have the aliases removed.
    - alias
```
String alias
```
      The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).
- Class com.amazonaws.services.workmail.model.DeleteAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteAvailabilityConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The WorkMail organization for which the AvailabilityConfiguration will be deleted.
    - domainName
```
String domainName
```
      The domain for which the AvailabilityConfiguration will be deleted.
- Class com.amazonaws.services.workmail.model.DeleteAvailabilityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteEmailMonitoringConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The ID of the organization from which the email monitoring configuration is deleted.
- Class com.amazonaws.services.workmail.model.DeleteEmailMonitoringConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization that contains the group.
    - groupId
```
String groupId
```
      The identifier of the group to be deleted.
      
      The identifier can be the GroupId, or Groupname. The following identity formats are available:
      
      Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Group name: group
- Class com.amazonaws.services.workmail.model.DeleteGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteImpersonationRoleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The WorkMail organization from which to delete the impersonation role.
    - impersonationRoleId
```
String impersonationRoleId
```
      The ID of the impersonation role to delete.
- Class com.amazonaws.services.workmail.model.DeleteImpersonationRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteMailboxPermissionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier of the organization under which the member (user or group) exists.
    - entityId
```
String entityId
```
      The identifier of the entity that owns the mailbox.
      
      The identifier can be UserId or Group Id, Username or Groupname, or email.
      
      Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: entity@domain.tld
      
      Entity name: entity
    - granteeId
```
String granteeId
```
      The identifier of the entity for which to delete granted permissions.
      
      The identifier can be UserId, ResourceID, or Group Id, Username or Groupname, or email.
      
      Grantee ID: 12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: grantee@domain.tld
      
      Grantee name: grantee
- Class com.amazonaws.services.workmail.model.DeleteMailboxPermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteMobileDeviceAccessOverrideRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The WorkMail organization for which the access override will be deleted.
    - userId
```
String userId
```
      The WorkMail user for which you want to delete the override. Accepts the following types of user identities:
      
      User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: user@domain.tld
      
      User name: user
    - deviceId
```
String deviceId
```
      The mobile device for which you delete the override. DeviceId is case insensitive.
- Class com.amazonaws.services.workmail.model.DeleteMobileDeviceAccessOverrideResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteMobileDeviceAccessRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The WorkMail organization under which the rule will be deleted.
    - mobileDeviceAccessRuleId
```
String mobileDeviceAccessRuleId
```
      The identifier of the rule to be deleted.
- Class com.amazonaws.services.workmail.model.DeleteMobileDeviceAccessRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteOrganizationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      The idempotency token associated with the request.
    - organizationId
```
String organizationId
```
      The organization ID.
    - deleteDirectory
```
Boolean deleteDirectory
```
      If true, deletes the AWS Directory Service directory associated with the organization.
    - forceDelete
```
Boolean forceDelete
```
      Deletes a WorkMail organization even if the organization has enabled users.
- Class com.amazonaws.services.workmail.model.DeleteOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization ID.
    - state
```
String state
```
      The state of the organization.
- Class com.amazonaws.services.workmail.model.DeleteResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier associated with the organization from which the resource is deleted.
    - resourceId
```
String resourceId
```
      The identifier of the resource to be deleted.
      
      The identifier can accept ResourceId, or Resourcename. The following identity formats are available:
      
      Resource ID: r-0123456789a0123456789b0123456789
      
      Resource name: resource
- Class com.amazonaws.services.workmail.model.DeleteResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteRetentionPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization ID.
    - id
```
String id
```
      The retention policy ID.
- Class com.amazonaws.services.workmail.model.DeleteRetentionPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization that contains the user to be deleted.
    - userId
```
String userId
```
      The identifier of the user to be deleted.
      
      The identifier can be the UserId or Username. The following identity formats are available:
      
      User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      User name: user
- Class com.amazonaws.services.workmail.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeregisterFromWorkMailRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization under which the WorkMail entity exists.
    - entityId
```
String entityId
```
      The identifier for the member to be updated.
      
      The identifier can be UserId, ResourceId, or Group Id, Username, Resourcename, or Groupname, or email.
      
      Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: entity@domain.tld
      
      Entity name: entity
- Class com.amazonaws.services.workmail.model.DeregisterFromWorkMailResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DeregisterMailDomainRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The WorkMail organization for which the domain will be deregistered.
    - domainName
```
String domainName
```
      The domain to deregister in WorkMail and SES.
- Class com.amazonaws.services.workmail.model.DeregisterMailDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DescribeEmailMonitoringConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The ID of the organization for which the email monitoring configuration is described.
- Class com.amazonaws.services.workmail.model.DescribeEmailMonitoringConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
    - logGroupArn
```
String logGroupArn
```
      The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
- Class com.amazonaws.services.workmail.model.DescribeEntityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization under which the entity exists.
    - email
```
String email
```
      The email under which the entity exists.
- Class com.amazonaws.services.workmail.model.DescribeEntityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entityId
```
String entityId
```
      The entity ID under which the entity exists.
    - name
```
String name
```
      Username, GroupName, or ResourceName based on entity type.
    - type
```
String type
```
      Entity type.
- Class com.amazonaws.services.workmail.model.DescribeGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization under which the group exists.
    - groupId
```
String groupId
```
      The identifier for the group to be described.
      
      The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
      
      Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: group@domain.tld
      
      Group name: group
- Class com.amazonaws.services.workmail.model.DescribeGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - groupId
```
String groupId
```
      The identifier of the described group.
    - name
```
String name
```
      The name of the described group.
    - email
```
String email
```
      The email of the described group.
    - state
```
String state
```
      The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
    - enabledDate
```
Date enabledDate
```
      The date and time when a user was registered to WorkMail, in UNIX epoch time format.
    - disabledDate
```
Date disabledDate
```
      The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.
    - hiddenFromGlobalAddressList
```
Boolean hiddenFromGlobalAddressList
```
      If the value is set to true, the group is hidden from the address book.
- Class com.amazonaws.services.workmail.model.DescribeInboundDmarcSettingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      Lists the ID of the given organization.
- Class com.amazonaws.services.workmail.model.DescribeInboundDmarcSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - enforced
```
Boolean enforced
```
      Lists the enforcement setting of the applied policy.
- Class com.amazonaws.services.workmail.model.DescribeMailboxExportJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The mailbox export job ID.
    - organizationId
```
String organizationId
```
      The organization ID.
- Class com.amazonaws.services.workmail.model.DescribeMailboxExportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entityId
```
String entityId
```
      The identifier of the user or resource associated with the mailbox.
    - description
```
String description
```
      The mailbox export job description.
    - roleArn
```
String roleArn
```
      The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.
    - kmsKeyArn
```
String kmsKeyArn
```
      The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
    - s3BucketName
```
String s3BucketName
```
      The name of the S3 bucket.
    - s3Prefix
```
String s3Prefix
```
      The S3 bucket prefix.
    - s3Path
```
String s3Path
```
      The path to the S3 bucket and file that the mailbox export job is exporting to.
    - estimatedProgress
```
Integer estimatedProgress
```
      The estimated progress of the mailbox export job, in percentage points.
    - state
```
String state
```
      The state of the mailbox export job.
    - errorInfo
```
String errorInfo
```
      Error information for failed mailbox export jobs.
    - startTime
```
Date startTime
```
      The mailbox export job start timestamp.
    - endTime
```
Date endTime
```
      The mailbox export job end timestamp.
- Class com.amazonaws.services.workmail.model.DescribeOrganizationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization to be described.
- Class com.amazonaws.services.workmail.model.DescribeOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier of an organization.
    - alias
```
String alias
```
      The alias for an organization.
    - state
```
String state
```
      The state of an organization.
    - directoryId
```
String directoryId
```
      The identifier for the directory associated with an WorkMail organization.
    - directoryType
```
String directoryType
```
      The type of directory associated with the WorkMail organization.
    - defaultMailDomain
```
String defaultMailDomain
```
      The default mail domain associated with the organization.
    - completedDate
```
Date completedDate
```
      The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.
    - errorMessage
```
String errorMessage
```
      (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.
    - aRN
```
String aRN
```
      The Amazon Resource Name (ARN) of the organization.
    - migrationAdmin
```
String migrationAdmin
```
      The user ID of the migration admin if migration is enabled for the organization.
    - interoperabilityEnabled
```
Boolean interoperabilityEnabled
```
      Indicates if interoperability is enabled for this organization.
- Class com.amazonaws.services.workmail.model.DescribeResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier associated with the organization for which the resource is described.
    - resourceId
```
String resourceId
```
      The identifier of the resource to be described.
      
      The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
      
      Resource ID: r-0123456789a0123456789b0123456789
      
      Email address: resource@domain.tld
      
      Resource name: resource
- Class com.amazonaws.services.workmail.model.DescribeResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The identifier of the described resource.
    - email
```
String email
```
      The email of the described resource.
    - name
```
String name
```
      The name of the described resource.
    - type
```
String type
```
      The type of the described resource.
    - bookingOptions
```
BookingOptions bookingOptions
```
      The booking options for the described resource.
    - state
```
String state
```
      The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
    - enabledDate
```
Date enabledDate
```
      The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
    - disabledDate
```
Date disabledDate
```
      The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
    - description
```
String description
```
      Description of the resource.
    - hiddenFromGlobalAddressList
```
Boolean hiddenFromGlobalAddressList
```
      If enabled, the resource is hidden from the global address list.
- Class com.amazonaws.services.workmail.model.DescribeUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization under which the user exists.
    - userId
```
String userId
```
      The identifier for the user to be described.
      
      The identifier can be the UserId, Username, or email. The following identity formats are available:
      
      User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: user@domain.tld
      
      User name: user
- Class com.amazonaws.services.workmail.model.DescribeUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userId
```
String userId
```
      The identifier for the described user.
    - name
```
String name
```
      The name for the user.
    - email
```
String email
```
      The email of the user.
    - displayName
```
String displayName
```
      The display name of the user.
    - state
```
String state
```
      The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
    - userRole
```
String userRole
```
      In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.
    - enabledDate
```
Date enabledDate
```
      The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.
    - disabledDate
```
Date disabledDate
```
      The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.
    - mailboxProvisionedDate
```
Date mailboxProvisionedDate
```
      The date when the mailbox was created for the user.
    - mailboxDeprovisionedDate
```
Date mailboxDeprovisionedDate
```
      The date when the mailbox was removed for the user.
    - firstName
```
String firstName
```
      First name of the user.
    - lastName
```
String lastName
```
      Last name of the user.
    - hiddenFromGlobalAddressList
```
Boolean hiddenFromGlobalAddressList
```
      If enabled, the user is hidden from the global address list.
    - initials
```
String initials
```
      Initials of the user.
    - telephone
```
String telephone
```
      User's contact number.
    - street
```
String street
```
      Street where the user is located.
    - jobTitle
```
String jobTitle
```
      Job title of the user.
    - city
```
String city
```
      City where the user is located.
    - company
```
String company
```
      Company of the user.
    - zipCode
```
String zipCode
```
      Zip code of the user.
    - department
```
String department
```
      Department of the user.
    - country
```
String country
```
      Country where the user is located.
    - office
```
String office
```
      Office where the user is located.
- Class com.amazonaws.services.workmail.model.DirectoryInUseException extends AmazonWorkMailException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.workmail.model.DirectoryServiceAuthenticationFailedException extends AmazonWorkMailException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.workmail.model.DirectoryUnavailableException extends AmazonWorkMailException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.workmail.model.DisassociateDelegateFromResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization under which the resource exists.
    - resourceId
```
String resourceId
```
      The identifier of the resource from which delegates' set members are removed.
      
      The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
      
      Resource ID: r-0123456789a0123456789b0123456789
      
      Email address: resource@domain.tld
      
      Resource name: resource
    - entityId
```
String entityId
```
      The identifier for the member (user, group) to be removed from the resource's delegates.
      
      The entity ID can accept UserId or GroupID, Username or Groupname, or email.
      
      Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: entity@domain.tld
      
      Entity: entity
- Class com.amazonaws.services.workmail.model.DisassociateDelegateFromResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DisassociateMemberFromGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization under which the group exists.
    - groupId
```
String groupId
```
      The identifier for the group from which members are removed.
      
      The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
      
      Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: group@domain.tld
      
      Group name: group
    - memberId
```
String memberId
```
      The identifier for the member to be removed from the group.
      
      The member ID can accept UserID or GroupId, Username or Groupname, or email.
      
      Member ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: member@domain.tld
      
      Member name: member
- Class com.amazonaws.services.workmail.model.DisassociateMemberFromGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.workmail.model.DnsRecord extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The RFC 1035 record type. Possible values: CNAME, A, MX.
    - hostname
```
String hostname
```
      The DNS hostname.- For example, domain.example.com.
    - value
```
String value
```
      The value returned by the DNS for a query to that hostname and record type.
- Class com.amazonaws.services.workmail.model.Domain extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The fully qualified domain name.
    - hostedZoneId
```
String hostedZoneId
```
      The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.
- Class com.amazonaws.services.workmail.model.EmailAddressInUseException extends AmazonWorkMailException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.workmail.model.EntityAlreadyRegisteredException extends AmazonWorkMailException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.workmail.model.EntityNotFoundException extends AmazonWorkMailException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.workmail.model.EntityStateException extends AmazonWorkMailException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.workmail.model.EwsAvailabilityProvider extends Object implements Serializable
  - Serialized Fields
    - ewsEndpoint
```
String ewsEndpoint
```
      The endpoint of the remote EWS server.
    - ewsUsername
```
String ewsUsername
```
      The username used to authenticate the remote EWS server.
    - ewsPassword
```
String ewsPassword
```
      The password used to authenticate the remote EWS server.
- Class com.amazonaws.services.workmail.model.FolderConfiguration extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The folder name.
    - action
```
String action
```
      The action to take on the folder contents at the end of the folder configuration period.
    - period
```
Integer period
```
      The number of days for which the folder-configuration action applies.
- Class com.amazonaws.services.workmail.model.GetAccessControlEffectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The identifier for the organization.
    - ipAddress
```
String ipAddress
```
      The IPv4 address.
    - action
```
String action
```
      The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    - userId
```
String userId
```
      The user ID.
    - impersonationRoleId
```
String impersonationRoleId
```
      The impersonation role ID.
- Class com.amazonaws.services.workmail.model.GetAccessControlEffectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - effect
```
String effect
```
      The rule effect.
    - matchedRules
```
List<E> matchedRules
```
      The rules that match the given parameters, resulting in an effect.
- Class com.amazonaws.services.workmail.model.GetDefaultRetentionPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The organization ID.
- Class com.amazonaws.services.workmail.model.GetDefaultRetentionPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The retention policy ID.
    - name
```
String name
```
      The retention policy name.
    - description
```
String description
```
      The retention policy description.
    - folderConfigurations
```
List<E> folderConfigurations
```
      The retention policy folder configurations.
- Class com.amazonaws.services.workmail.model.GetImpersonationRoleEffectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationId
```
String organizationId
```
      The WorkMail organization where the impersonation role is defined.
    - impersonationRoleId
```
String impersonationRoleId
```
      The impersonation role ID to test.
    - targetUser
```
String targetUser
```
      The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:
      
      User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
      
      Email address: user@domain.tld
      
      User name: user
- Class com.amazonaws.services.workmail.model.GetImpersonationRoleEffectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The impersonation role type.
    - effect
```
String effect
```
      Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

Serialized Form

Package com.amazonaws.services.workmail.model

Class com.amazonaws.services.workmail.model.AccessControlRule extends Object implements Serializable

Serialized Fields

name

effect

description

ipRanges

notIpRanges

actions

notActions

userIds

notUserIds

dateCreated

dateModified

impersonationRoleIds

notImpersonationRoleIds

Class com.amazonaws.services.workmail.model.AmazonWorkMailException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.workmail.model.AssociateDelegateToResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

organizationId

resourceId

entityId

Class com.amazonaws.services.workmail.model.AssociateDelegateToResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.workmail.model.AssociateMemberToGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

organizationId

groupId

memberId

Class com.amazonaws.services.workmail.model.AssociateMemberToGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.workmail.model.AssumeImpersonationRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

organizationId

impersonationRoleId

Class com.amazonaws.services.workmail.model.AssumeImpersonationRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

token

expiresIn

Class com.amazonaws.services.workmail.model.AvailabilityConfiguration extends Object implements Serializable

Serialized Fields

domainName

providerType

ewsProvider

lambdaProvider

dateCreated

dateModified

Class com.amazonaws.services.workmail.model.BookingOptions extends Object implements Serializable

Serialized Fields

autoAcceptRequests

autoDeclineRecurringRequests

autoDeclineConflictingRequests

Class com.amazonaws.services.workmail.model.CancelMailboxExportJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

jobId

organizationId

Class com.amazonaws.services.workmail.model.CancelMailboxExportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.workmail.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

organizationId

entityId

alias

Class com.amazonaws.services.workmail.model.CreateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.workmail.model.CreateAvailabilityConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

organizationId

domainName

ewsProvider

lambdaProvider

Class com.amazonaws.services.workmail.model.CreateAvailabilityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.workmail.model.CreateGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

organizationId

name

hiddenFromGlobalAddressList

Class com.amazonaws.services.workmail.model.CreateGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

groupId

Class com.amazonaws.services.workmail.model.CreateImpersonationRoleRequest extends AmazonWebServiceRequest implements Serializable