String name
The rule name.
String effect
The rule effect.
String description
The rule description.
List<E> ipRanges
IPv4 CIDR ranges to include in the rule.
List<E> notIpRanges
IPv4 CIDR ranges to exclude from the rule.
List<E> actions
Access protocol actions to include in the rule. Valid values include ActiveSync,
AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook,
and WebMail.
List<E> notActions
Access protocol actions to exclude from the rule. Valid values include ActiveSync,
AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook,
and WebMail.
List<E> userIds
User IDs to include in the rule.
List<E> notUserIds
User IDs to exclude from the rule.
Date dateCreated
The date that the rule was created.
Date dateModified
The date that the rule was modified.
List<E> impersonationRoleIds
Impersonation role IDs to include in the rule.
List<E> notImpersonationRoleIds
Impersonation role IDs to exclude from the rule.
String domainName
Displays the domain to which the provider applies.
String providerType
Displays the provider type that applies to this domain.
RedactedEwsAvailabilityProvider ewsProvider
If ProviderType is EWS, then this field contains
RedactedEwsAvailabilityProvider. Otherwise, it is not required.
LambdaAvailabilityProvider lambdaProvider
If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider.
Otherwise, it is not required.
Date dateCreated
The date and time at which the availability configuration was created.
Date dateModified
The date and time at which the availability configuration was last modified.
Boolean autoAcceptRequests
The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.
Boolean autoDeclineRecurringRequests
The resource's ability to automatically decline any recurring requests.
Boolean autoDeclineConflictingRequests
The resource's ability to automatically decline any conflicting requests.
String clientToken
An idempotent token that ensures that an API request is executed only once.
String organizationId
The WorkMail organization for which the AvailabilityConfiguration will be created.
String domainName
The domain to which the provider applies.
EwsAvailabilityProvider ewsProvider
Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider
definition, either EwsProvider or LambdaProvider.
LambdaAvailabilityProvider lambdaProvider
Lambda availability provider definition. The request must contain exactly one provider definition, either
EwsProvider or LambdaProvider.
String groupId
The identifier of the group.
String clientToken
The idempotency token for the client request.
String organizationId
The WorkMail organization to create the new impersonation role within.
String name
The name of the new impersonation role.
String type
The impersonation role's type. The available impersonation role types are READ_ONLY or
FULL_ACCESS.
String description
The description of the new impersonation role.
List<E> rules
The list of rules for the impersonation role.
String impersonationRoleId
The new impersonation role ID.
String organizationId
The WorkMail organization under which the rule will be created.
String clientToken
The idempotency token for the client request.
String name
The rule name.
String description
The rule description.
String effect
The effect of the rule when it matches. Allowed values are ALLOW or DENY.
List<E> deviceTypes
Device types that the rule will match.
List<E> notDeviceTypes
Device types that the rule will not match. All other device types will match.
List<E> deviceModels
Device models that the rule will match.
List<E> notDeviceModels
Device models that the rule will not match. All other device models will match.
List<E> deviceOperatingSystems
Device operating systems that the rule will match.
List<E> notDeviceOperatingSystems
Device operating systems that the rule will not match. All other device operating systems will match.
List<E> deviceUserAgents
Device user agents that the rule will match.
List<E> notDeviceUserAgents
Device user agents that the rule will not match. All other device user agents will match.
String mobileDeviceAccessRuleId
The identifier for the newly created mobile device access rule.
String directoryId
The AWS Directory Service directory ID.
String alias
The organization alias.
String clientToken
The idempotency token associated with the request.
List<E> domains
The email domains to associate with the organization.
String kmsKeyArn
The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
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.
String organizationId
The organization ID.
String resourceId
The identifier of the new resource.
String organizationId
The identifier of the organization for which the user is created.
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.
String displayName
The display name for the new user.
String password
The password for the new user.
String userId
The identifier for the new user.
String organizationId
The identifier for the organization under which the user exists.
String entityId
The identifier for the member (user or group) from which to have the aliases removed.
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).
String organizationId
The ID of the organization from which the email monitoring configuration is deleted.
String organizationId
The identifier of the organization under which the member (user or group) exists.
String entityId
The identifier of the member (user or group) that owns the mailbox.
String granteeId
The identifier of the member (user or group) for which to delete granted permissions.
String organizationId
The WorkMail organization for which the access override will be deleted.
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
String deviceId
The mobile device for which you delete the override. DeviceId is case insensitive.
String organizationId
The ID of the organization for which the email monitoring configuration is described.
String groupId
The identifier of the described group.
String name
The name of the described group.
String email
The email of the described group.
String state
The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
Date enabledDate
The date and time when a user was registered to WorkMail, in UNIX epoch time format.
Date disabledDate
The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.
String organizationId
Lists the ID of the given organization.
Boolean enforced
Lists the enforcement setting of the applied policy.
String entityId
The identifier of the user or resource associated with the mailbox.
String description
The mailbox export job description.
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.
String kmsKeyArn
The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
String s3BucketName
The name of the S3 bucket.
String s3Prefix
The S3 bucket prefix.
String s3Path
The path to the S3 bucket and file that the mailbox export job is exporting to.
Integer estimatedProgress
The estimated progress of the mailbox export job, in percentage points.
String state
The state of the mailbox export job.
String errorInfo
Error information for failed mailbox export jobs.
Date startTime
The mailbox export job start timestamp.
Date endTime
The mailbox export job end timestamp.
String organizationId
The identifier for the organization to be described.
String organizationId
The identifier of an organization.
String alias
The alias for an organization.
String state
The state of an organization.
String directoryId
The identifier for the directory associated with an WorkMail organization.
String directoryType
The type of directory associated with the WorkMail organization.
String defaultMailDomain
The default mail domain associated with the organization.
Date completedDate
The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.
String errorMessage
(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.
String aRN
The Amazon Resource Name (ARN) of the organization.
String resourceId
The identifier of the described resource.
String email
The email of the described resource.
String name
The name of the described resource.
String type
The type of the described resource.
BookingOptions bookingOptions
The booking options for the described resource.
String state
The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
Date enabledDate
The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
Date disabledDate
The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
String userId
The identifier for the described user.
String name
The name for the user.
String email
The email of the user.
String displayName
The display name of the user.
String state
The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
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, and SYSTEM_USER.
Date enabledDate
The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.
Date disabledDate
The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.
String organizationId
The identifier for the organization under which the resource exists.
String resourceId
The identifier of the resource from which delegates' set members are removed.
String entityId
The identifier for the member (user, group) to be removed from the resource's delegates.
String organizationId
The identifier for the organization.
String ipAddress
The IPv4 address.
String action
The access protocol action. Valid values include ActiveSync, AutoDiscover,
EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
String userId
The user ID.
String impersonationRoleId
The impersonation role ID.
String organizationId
The organization ID.
String organizationId
The WorkMail organization where the impersonation role is defined.
String impersonationRoleId
The impersonation role ID to test.
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
String impersonationRoleId
The impersonation role ID.
String name
The impersonation role name.
String type
The impersonation role type.
String description
The impersonation role description.
List<E> rules
The list of rules for the given impersonation role.
Date dateCreated
The date when the impersonation role was created.
Date dateModified
The date when the impersonation role was last modified.
List<E> records
A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.
Boolean isTestDomain
Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.
Boolean isDefault
Specifies whether the domain is the default domain for your organization.
String ownershipVerificationStatus
Indicates the status of the domain ownership verification.
String dkimVerificationStatus
Indicates the status of a DKIM verification.
String organizationId
The WorkMail organization to simulate the access effect for.
String deviceType
Device type the simulated user will report.
String deviceModel
Device model the simulated user will report.
String deviceOperatingSystem
Device operating system the simulated user will report.
String deviceUserAgent
Device user agent the simulated user will report.
String organizationId
The WorkMail organization to which you want to apply the override.
String userId
Identifies the WorkMail user for 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
String deviceId
The mobile device to which the override applies. DeviceId is case insensitive.
String userId
The WorkMail user to which the access override applies.
String deviceId
The device to which the access override applies.
String effect
The effect of the override, ALLOW or DENY.
String description
A description of the override.
Date dateCreated
The date the override was first created.
Date dateModified
The date the description was last modified.
String id
The identifier of the group.
String email
The email of the group.
String name
The name of the group.
String state
The state of the group, which can be ENABLED, DISABLED, or DELETED.
Date enabledDate
The date indicating when the group was enabled for WorkMail use.
Date disabledDate
The date indicating when the group was disabled from WorkMail use.
String impersonationRoleId
The identifier of the impersonation role.
String name
The impersonation role name.
String type
The impersonation role type.
Date dateCreated
The date when the impersonation role was created.
Date dateModified
The date when the impersonation role was last modified.
String impersonationRuleId
The identifier of the rule.
String name
The rule name.
String description
The rule description.
String effect
The effect of the rule when it matches the input. Allowed effect values are ALLOW or
DENY.
List<E> targetUsers
A list of user IDs that match the rule.
List<E> notTargetUsers
A list of user IDs that don't match the rule.
String lambdaArn
The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.
String organizationId
The identifier for the organization.
String organizationId
The identifier for the organization under which the entity exists.
String entityId
The identifier for the entity for which to list the aliases.
String nextToken
The token to use to retrieve the next page of results. The first call does not contain any tokens.
Integer maxResults
The maximum number of results to return in a single call.
String organizationId
The WorkMail organization for which the AvailabilityConfiguration's will be listed.
Integer maxResults
The maximum number of results to return in a single call.
String nextToken
The token to use to retrieve the next page of results. The first call does not require a token.
String organizationId
The identifier for the organization under which the group exists.
String groupId
The identifier for the group to which the members (users or groups) are associated.
String nextToken
The token to use to retrieve the next page of results. The first call does not contain any tokens.
Integer maxResults
The maximum number of results to return in a single call.
String organizationId
The identifier for the organization under which the groups exist.
String nextToken
The token to use to retrieve the next page of results. The first call does not contain any tokens.
Integer maxResults
The maximum number of results to return in a single call.
String organizationId
The WorkMail organization to which the listed impersonation roles belong.
String nextToken
The token used to retrieve the next page of results. The first call doesn't require a token.
Integer maxResults
The maximum number of results returned in a single call.
String organizationId
The identifier of the organization under which the user, group, or resource exists.
String entityId
The identifier of the user, group, or resource for which to list mailbox permissions.
String nextToken
The token to use to retrieve the next page of results. The first call does not contain any tokens.
Integer maxResults
The maximum number of results to return in a single call.
String organizationId
The WorkMail organization for which to list domains.
Integer maxResults
The maximum number of results to return in a single call.
String nextToken
The token to use to retrieve the next page of results. The first call does not require a token.
List<E> mailDomains
The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn't the default.
String nextToken
The token to use to retrieve the next page of results. The value becomes null when there are no more
results to return.
String organizationId
The WorkMail organization under which to list mobile device access overrides.
String userId
The WorkMail user under which you list the mobile device access overrides. 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
String deviceId
The mobile device to which the access override applies.
String nextToken
The token to use to retrieve the next page of results. The first call does not require a token.
Integer maxResults
The maximum number of results to return in a single call.
String organizationId
The WorkMail organization for which to list the rules.
String organizationId
The identifier for the organization that contains the resource for which delegates are listed.
String resourceId
The identifier for the resource whose delegates are listed.
String nextToken
The token used to paginate through the delegates associated with a resource.
Integer maxResults
The number of maximum results in a page.
String organizationId
The identifier for the organization under which the resources exist.
String nextToken
The token to use to retrieve the next page of results. The first call does not contain any tokens.
Integer maxResults
The maximum number of results to return in a single call.
String resourceARN
The resource ARN.
String organizationId
The identifier for the organization under which the users exist.
String nextToken
The token to use to retrieve the next page of results. The first call does not contain any tokens.
Integer maxResults
The maximum number of results to return in a single call.
String jobId
The identifier of the mailbox export job.
String entityId
The identifier of the user or resource associated with the mailbox.
String description
The mailbox export job description.
String s3BucketName
The name of the S3 bucket.
String s3Path
The path to the S3 bucket and file that the mailbox export job exports to.
Integer estimatedProgress
The estimated progress of the mailbox export job, in percentage points.
String state
The state of the mailbox export job.
Date startTime
The mailbox export job start timestamp.
Date endTime
The mailbox export job end timestamp.
String id
The identifier of the member.
String name
The name of the member.
String type
A member can be a user or group.
String state
The state of the member, which can be ENABLED, DISABLED, or DELETED.
Date enabledDate
The date indicating when the member was enabled for WorkMail use.
Date disabledDate
The date indicating when the member was disabled from WorkMail use.
String userId
The WorkMail user to which the access override applies.
String deviceId
The device to which the override applies.
String effect
The effect of the override, ALLOW or DENY.
String description
A description of the override.
Date dateCreated
The date the override was first created.
Date dateModified
The date the override was last modified.
String mobileDeviceAccessRuleId
The ID assigned to a mobile access rule.
String name
The name of a mobile access rule.
String description
The description of a mobile access rule.
String effect
The effect of the rule when it matches. Allowed values are ALLOW or DENY.
List<E> deviceTypes
Device types that a rule will match.
List<E> notDeviceTypes
Device types that a rule will not match. All other device types will match.
List<E> deviceModels
Device models that a rule will match.
List<E> notDeviceModels
Device models that a rule will not match. All other device models will match.
List<E> deviceOperatingSystems
Device operating systems that a rule will match.
List<E> notDeviceOperatingSystems
Device operating systems that a rule will not match. All other device types will match.
List<E> deviceUserAgents
Device user agents that a rule will match.
List<E> notDeviceUserAgents
Device user agents that a rule will not match. All other device user agents will match.
Date dateCreated
The date and time at which an access rule was created.
Date dateModified
The date and time at which an access rule was modified.
String organizationId
The identifier associated with the organization.
String alias
The alias associated with the organization.
String defaultMailDomain
The default email domain associated with the organization.
String errorMessage
The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.
String state
The state associated with the organization.
String granteeId
The identifier of the user, group, or resource to which the permissions are granted.
String granteeType
The type of user, group, or resource referred to in GranteeId.
List<E> permissionValues
The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
String name
The rule name.
String effect
The rule effect.
String description
The rule description.
List<E> ipRanges
IPv4 CIDR ranges to include in the rule.
List<E> notIpRanges
IPv4 CIDR ranges to exclude from the rule.
List<E> actions
Access protocol actions to include in the rule. Valid values include ActiveSync,
AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook,
and WebMail.
List<E> notActions
Access protocol actions to exclude from the rule. Valid values include ActiveSync,
AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook,
and WebMail.
List<E> userIds
User IDs to include in the rule.
List<E> notUserIds
User IDs to exclude from the rule.
String organizationId
The identifier of the organization.
List<E> impersonationRoleIds
Impersonation role IDs to include in the rule.
List<E> notImpersonationRoleIds
Impersonation role IDs to exclude from the rule.
String organizationId
The ID of the organization for which the email monitoring configuration is set.
String roleArn
The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
String logGroupArn
The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
String organizationId
The identifier of the organization under which the user, group, or resource exists.
String entityId
The identifier of the user, group, or resource for which to update mailbox permissions.
String granteeId
The identifier of the user, group, or resource to which to grant the permissions.
List<E> permissionValues
The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
String organizationId
Identifies the WorkMail organization for which you create the override.
String userId
The WorkMail user for which you create 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
String deviceId
The mobile device for which you create the override. DeviceId is case insensitive.
String effect
The effect of the override, ALLOW or DENY.
String description
A description of the override.
String id
The identifier of the resource.
String email
The email of the resource.
String name
The name of the resource.
String type
The type of the resource: equipment or room.
String state
The state of the resource, which can be ENABLED, DISABLED, or DELETED.
Date enabledDate
The date indicating when the resource was enabled for WorkMail use.
Date disabledDate
The date indicating when the resource was disabled from WorkMail use.
String clientToken
The idempotency token for the client request.
String organizationId
The identifier associated with the organization.
String entityId
The identifier of the user or resource associated with the mailbox.
String description
The mailbox export job description.
String roleArn
The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
String kmsKeyArn
The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
String s3BucketName
The name of the S3 bucket.
String s3Prefix
The S3 bucket prefix.
String jobId
The job ID.
String organizationId
The WorkMail organization where the availability provider will be tested.
String domainName
The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.
EwsAvailabilityProvider ewsProvider
LambdaAvailabilityProvider lambdaProvider
String organizationId
The WorkMail organization for which the AvailabilityConfiguration will be updated.
String domainName
The domain to which the provider applies the availability configuration.
EwsAvailabilityProvider ewsProvider
The EWS availability provider definition. The request must contain exactly one provider definition, either
EwsProvider or LambdaProvider. The previously stored provider will be overridden by the
one provided.
LambdaAvailabilityProvider lambdaProvider
The Lambda availability provider definition. The request must contain exactly one provider definition, either
EwsProvider or LambdaProvider. The previously stored provider will be overridden by the
one provided.
String organizationId
The WorkMail organization that contains the impersonation role to update.
String impersonationRoleId
The ID of the impersonation role to update.
String name
The updated impersonation role name.
String type
The updated impersonation role type.
String description
The updated impersonation role description.
List<E> rules
The updated list of rules.
String organizationId
The identifier for the organization that contains the user for whom to update the mailbox quota.
String userId
The identifer for the user for whom to update the mailbox quota.
Integer mailboxQuota
The updated mailbox quota, in MB, for the specified user.
String organizationId
The WorkMail organization under which the rule will be updated.
String mobileDeviceAccessRuleId
The identifier of the rule to be updated.
String name
The updated rule name.
String description
The updated rule description.
String effect
The effect of the rule when it matches. Allowed values are ALLOW or DENY.
List<E> deviceTypes
Device types that the updated rule will match.
List<E> notDeviceTypes
Device types that the updated rule will not match. All other device types will match.
List<E> deviceModels
Device models that the updated rule will match.
List<E> notDeviceModels
Device models that the updated rule will not match. All other device models will match.
List<E> deviceOperatingSystems
Device operating systems that the updated rule will match.
List<E> notDeviceOperatingSystems
Device operating systems that the updated rule will not match. All other device operating systems will match.
List<E> deviceUserAgents
User agents that the updated rule will match.
List<E> notDeviceUserAgents
User agents that the updated rule will not match. All other user agents will match.
String organizationId
The identifier associated with the organization for which the resource is updated.
String resourceId
The identifier of the resource to be updated.
String name
The name of the resource to be updated.
BookingOptions bookingOptions
The resource's booking options to be updated.
String id
The identifier of the user.
String email
The email of the user.
String name
The name of the user.
String displayName
The display name of the user.
String state
The state of the user, which can be ENABLED, DISABLED, or DELETED.
String userRole
The role of the user.
Date enabledDate
The date indicating when the user was enabled for WorkMail use.
Date disabledDate
The date indicating when the user was disabled from WorkMail use.
Copyright © 2022. All rights reserved.