Smaws_Client_WorkMailWorkMail client library built on EIO.
val service : Smaws_Lib.Service.descriptorYou can't perform a write operation against a read-only directory.
The organization must have a valid state to perform certain operations on the organization or its members.
An operation received a valid organization identifier that either doesn't belong or exist in the system.
One or more of the input parameters don't match the service's restrictions.
You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
The identifier supplied for the user, group, or resource does not exist in your organization.
The directory is unavailable. It might be located in another Region or deleted.
The directory service doesn't recognize the credentials supplied by WorkMail.
type nonrec update_user_request = {office : string option;Updates the user's office.
*)country : string option;Updates the user's country.
*)department : string option;Updates the user's department.
*)zip_code : string option;Updates the user's zipcode.
*)company : string option;Updates the user's company.
*)city : string option;Updates the user's city.
*)job_title : string option;Updates the user's job title.
*)street : string option;Updates the user's street address.
*)telephone : string option;Updates the user's contact details.
*)initials : string option;Updates the user's initials.
*)last_name : string option;Updates the user's last name.
*)first_name : string option;Updates the user's first name.
*)display_name : string option;Updates the display name of the user.
*)role : user_role option;Updates the user role.
You cannot pass SYSTEM_USER or RESOURCE.
*)user_id : string;The identifier for the user to be updated.
The identifier can be the UserId, Username, or email. The following identity formats are available:
organization_id : string;The identifier for the organization under which the user exists.
*)}The user, group, or resource name isn't unique in WorkMail.
After a domain has been added to the organization, it must be verified. The domain is not yet verified.
The domain specified is not found in your organization.
The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.
The email address that you're trying to assign is already created for a different user, group, or resource.
type nonrec booking_options = {auto_decline_conflicting_requests : bool option;The resource's ability to automatically decline any conflicting requests.
*)auto_decline_recurring_requests : bool option;The resource's ability to automatically decline any recurring requests.
*)auto_accept_requests : bool option;The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.
*)}At least one delegate must be associated to the resource to disable automatic replies from the resource.
type nonrec update_resource_request = {type_ : resource_type option;Updates the resource type.
*)description : string option;Updates the resource description.
*)booking_options : booking_options option;The resource's booking options to be updated.
*)name : string option;The name of the resource to be updated.
*)resource_id : string;The identifier of the resource to be updated.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
organization_id : string;The identifier associated with the organization for which the resource is updated.
*)}type nonrec update_primary_email_address_request = {email : string;The value of the email to be updated as primary.
*)entity_id : string;The user, group, or resource to update.
The identifier can accept UseriD, ResourceId, or GroupId, Username, Resourcename, or Groupname, or email. The following identity formats are available:
organization_id : string;The organization that contains the user, group, or resource to update.
*)}type nonrec update_mobile_device_access_rule_request = {not_device_user_agents : string list option;User agents that the updated rule will not match. All other user agents will match.
*)device_user_agents : string list option;User agents that the updated rule will match.
*)not_device_operating_systems : string list option;Device operating systems that the updated rule will not match. All other device operating systems will match.
*)device_operating_systems : string list option;Device operating systems that the updated rule will match.
*)not_device_models : string list option;Device models that the updated rule will not match. All other device models will match.
*)device_models : string list option;Device models that the updated rule will match.
*)not_device_types : string list option;Device types that the updated rule will not match. All other device types will match.
*)device_types : string list option;Device types that the updated rule will match.
*)effect_ : mobile_device_access_rule_effect;The effect of the rule when it matches. Allowed values are ALLOW or DENY.
description : string option;The updated rule description.
*)name : string;The updated rule name.
*)mobile_device_access_rule_id : string;The identifier of the rule to be updated.
*)organization_id : string;The WorkMail organization under which the rule will be updated.
*)}type nonrec update_mailbox_quota_request = {mailbox_quota : int;The updated mailbox quota, in MB, for the specified user.
*)user_id : string;The identifer for the user for whom to update the mailbox quota.
The identifier can be the UserId, Username, or email. The following identity formats are available:
organization_id : string;The identifier for the organization that contains the user for whom to update the mailbox quota.
*)}The request exceeds the limit of the resource.
type nonrec impersonation_rule = {not_target_users : string list option;A list of user IDs that don't match the rule.
*)target_users : string list option;A list of user IDs that match the rule.
*)effect_ : access_effect;The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
description : string option;The rule description.
*)name : string option;The rule name.
*)impersonation_rule_id : string;The identifier of the rule.
*)}The rules for the given impersonation role.
type nonrec update_impersonation_role_request = {rules : impersonation_rule list;The updated list of rules.
*)description : string option;The updated impersonation role description.
*)type_ : impersonation_role_type;The updated impersonation role type.
*)name : string;The updated impersonation role name.
*)impersonation_role_id : string;The ID of the impersonation role to update.
*)organization_id : string;The WorkMail organization that contains the impersonation role to update.
*)}type nonrec update_group_request = {group_id : string;The identifier for the group to be updated.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
organization_id : string;The identifier for the organization under which the group exists.
*)}type nonrec ews_availability_provider = {ews_password : string;The password used to authenticate the remote EWS server.
*)ews_username : string;The username used to authenticate the remote EWS server.
*)ews_endpoint : string;The endpoint of the remote EWS server.
*)}Describes an EWS based availability provider. This is only used as input to the service.
type nonrec lambda_availability_provider = {lambda_arn : string;The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.
*)}Describes a Lambda based availability provider.
type nonrec update_availability_configuration_request = {lambda_provider : lambda_availability_provider option;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.
ews_provider : ews_availability_provider option;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.
domain_name : string;The domain to which the provider applies the availability configuration.
*)organization_id : string;The WorkMail organization for which the AvailabilityConfiguration will be updated.
}type nonrec test_availability_configuration_request = {lambda_provider : lambda_availability_provider option;ews_provider : ews_availability_provider option;domain_name : string option;The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.
*)organization_id : string;The WorkMail organization where the availability provider will be tested.
*)}Describes a tag applied to a resource.
type nonrec start_mailbox_export_job_request = {s3_prefix : string;The S3 bucket prefix.
*)s3_bucket_name : string;The name of the S3 bucket.
*)kms_key_arn : string;The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
*)role_arn : string;The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
*)description : string option;The mailbox export job description.
*)entity_id : string;The identifier of the user or resource associated with the mailbox.
The identifier can accept UserId or ResourceId, Username or Resourcename, or email. The following identity formats are available:
organization_id : string;The identifier associated with the organization.
*)client_token : string;The idempotency token for the client request.
*)}The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
The user, group, or resource that you're trying to register is already registered.
type nonrec register_to_work_mail_request = {email : string;The email for the user, group, or resource to be updated.
*)entity_id : string;The identifier for the user, group, or resource to be updated.
The identifier can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or Groupname. The following identity formats are available:
organization_id : string;The identifier for the organization under which the user, group, or resource exists.
*)}The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
type nonrec register_mail_domain_request = {domain_name : string;The name of the mail domain to create in WorkMail and SES.
*)organization_id : string;The WorkMail organization under which you're creating the domain.
*)client_token : string option;Idempotency token used when retrying requests.
*)}type nonrec folder_configuration = {period : int option;The number of days for which the folder-configuration action applies.
*)action : retention_action;The action to take on the folder contents at the end of the folder configuration period.
*)name : folder_name;The folder name.
*)}The configuration applied to an organization's folders by its retention policy.
type nonrec put_retention_policy_request = {folder_configurations : folder_configuration list;The retention policy folder configurations.
*)description : string option;The retention policy description.
*)name : string;The retention policy name.
*)id : string option;The retention policy ID.
*)organization_id : string;The organization ID.
*)}type nonrec put_mobile_device_access_override_request = {description : string option;A description of the override.
*)effect_ : mobile_device_access_rule_effect;The effect of the override, ALLOW or DENY.
device_id : string;The mobile device for which you create the override. DeviceId is case insensitive.
user_id : string;The WorkMail user for which you create the override. Accepts the following types of user identities:
12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234user@domain.tlduserorganization_id : string;Identifies the WorkMail organization for which you create the override.
*)}type nonrec put_mailbox_permissions_request = {permission_values : permission_type list;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.
*)grantee_id : string;The identifier of the user, group, or resource to which to grant the permissions.
The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.
entity_id : string;The identifier of the user or resource for which to update mailbox permissions.
The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.
organization_id : string;The identifier of the organization under which the user, group, or resource exists.
*)}type nonrec put_email_monitoring_configuration_request = {log_group_arn : string;The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
*)role_arn : string;The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
*)organization_id : string;The ID of the organization for which the email monitoring configuration is set.
*)}type nonrec put_access_control_rule_request = {not_impersonation_role_ids : string list option;Impersonation role IDs to exclude from the rule.
*)impersonation_role_ids : string list option;Impersonation role IDs to include in the rule.
*)organization_id : string;The identifier of the organization.
*)not_user_ids : string list option;User IDs to exclude from the rule.
*)user_ids : string list option;User IDs to include in the rule.
*)not_actions : string list option;Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
actions : string list option;Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
not_ip_ranges : string list option;IPv4 CIDR ranges to exclude from the rule.
*)ip_ranges : string list option;IPv4 CIDR ranges to include in the rule.
*)description : string;The rule description.
*)effect_ : access_control_rule_effect;The rule effect.
*)name : string;The rule name.
*)}type nonrec user = {disabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date indicating when the user was disabled from WorkMail use.
*)enabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date indicating when the user was enabled for WorkMail use.
*)user_role : user_role option;The role of the user.
*)state : entity_state option;The state of the user, which can be ENABLED, DISABLED, or DELETED.
*)display_name : string option;The display name of the user.
*)name : string option;The name of the user.
*)email : string option;The email of the user.
*)id : string option;The identifier of the user.
*)}The representation of an WorkMail user.
type nonrec list_users_response = {next_token : string option;The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.
*)users : user list option;The overview of users for an organization.
*)}type nonrec list_users_filters = {state : entity_state option;Filters only users with the provided state.
*)primary_email_prefix : string option;Filters only users with the provided email prefix.
*)display_name_prefix : string option;Filters only users with the provided display name prefix.
*)username_prefix : string option;Filters only users with the provided username prefix.
*)}Filtering options for ListUsers operation. This is only used as input to Operation.
type nonrec list_users_request = {filters : list_users_filters option;Limit the user search results based on the filter criteria. You can only use one filter per request.
*)max_results : int option;The maximum number of results to return in a single call.
*)next_token : string option;The token to use to retrieve the next page of results. The first call does not contain any tokens.
*)organization_id : string;The identifier for the organization under which the users exist.
*)}type nonrec resource = {description : string option;Resource description.
*)disabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date indicating when the resource was disabled from WorkMail use.
*)enabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date indicating when the resource was enabled for WorkMail use.
*)state : entity_state option;The state of the resource, which can be ENABLED, DISABLED, or DELETED.
*)type_ : resource_type option;The type of the resource: equipment or room.
*)name : string option;The name of the resource.
*)email : string option;The email of the resource.
*)id : string option;The identifier of the resource.
*)}The representation of a resource.
type nonrec list_resources_response = {next_token : string option;The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.
*)resources : resource list option;One page of the organization's resource representation.
*)}type nonrec list_resources_filters = {state : entity_state option;Filters only resource with the provided state.
*)primary_email_prefix : string option;Filters only resource with the provided primary email prefix.
*)name_prefix : string option;Filters only resource that start with the entered name prefix .
*)}Filtering options for ListResources operation. This is only used as input to Operation.
type nonrec list_resources_request = {filters : list_resources_filters option;Limit the resource search results based on the filter criteria. You can only use one filter per request.
*)max_results : int option;The maximum number of results to return in a single call.
*)next_token : string option;The token to use to retrieve the next page of results. The first call does not contain any tokens.
*)organization_id : string;The identifier for the organization under which the resources exist.
*)}type nonrec delegate = {type_ : member_type;The type of the delegate: user or group.
*)id : string;The identifier for the user or group associated as the resource's delegate.
*)}The name of the attribute, which is one of the values defined in the UserAttribute enumeration.
type nonrec list_resource_delegates_response = {next_token : string option;The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.
*)delegates : delegate list option;One page of the resource's delegates.
*)}type nonrec list_resource_delegates_request = {max_results : int option;The number of maximum results in a page.
*)next_token : string option;The token used to paginate through the delegates associated with a resource.
*)resource_id : string;The identifier for the resource whose delegates are listed.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
organization_id : string;The identifier for the organization that contains the resource for which delegates are listed.
*)}type nonrec organization_summary = {state : string option;The state associated with the organization.
*)error_message : string option;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.
*)default_mail_domain : string option;The default email domain associated with the organization.
*)alias : string option;The alias associated with the organization.
*)organization_id : string option;The identifier associated with the organization.
*)}The representation of an organization.
type nonrec list_organizations_response = {next_token : string option;The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
*)organization_summaries : organization_summary list option;The overview of owned organizations presented as a list of organization summaries.
*)}type nonrec mobile_device_access_rule = {date_modified : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time at which an access rule was modified.
*)date_created : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time at which an access rule was created.
*)not_device_user_agents : string list option;Device user agents that a rule will not match. All other device user agents will match.
*)device_user_agents : string list option;Device user agents that a rule will match.
*)not_device_operating_systems : string list option;Device operating systems that a rule will not match. All other device types will match.
*)device_operating_systems : string list option;Device operating systems that a rule will match.
*)not_device_models : string list option;Device models that a rule will not match. All other device models will match.
*)device_models : string list option;Device models that a rule will match.
*)not_device_types : string list option;Device types that a rule will not match. All other device types will match.
*)device_types : string list option;Device types that a rule will match.
*)effect_ : mobile_device_access_rule_effect option;The effect of the rule when it matches. Allowed values are ALLOW or DENY.
description : string option;The description of a mobile access rule.
*)name : string option;The name of a mobile access rule.
*)mobile_device_access_rule_id : string option;The ID assigned to a mobile access rule.
*)}A rule that controls access to mobile devices for an WorkMail group.
type nonrec list_mobile_device_access_rules_response = {rules : mobile_device_access_rule list option;The list of mobile device access rules that exist under the specified WorkMail organization.
*)}type nonrec mobile_device_access_override = {date_modified : Smaws_Lib.CoreTypes.Timestamp.t option;The date the override was last modified.
*)date_created : Smaws_Lib.CoreTypes.Timestamp.t option;The date the override was first created.
*)description : string option;A description of the override.
*)effect_ : mobile_device_access_rule_effect option;The effect of the override, ALLOW or DENY.
device_id : string option;The device to which the override applies.
*)user_id : string option;The WorkMail user to which the access override applies.
*)}The override object.
type nonrec list_mobile_device_access_overrides_response = {next_token : string option;The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.
*)overrides : mobile_device_access_override list option;The list of mobile device access overrides that exist for the specified WorkMail organization and user.
*)}type nonrec list_mobile_device_access_overrides_request = {max_results : int option;The maximum number of results to return in a single call.
*)next_token : string option;The token to use to retrieve the next page of results. The first call does not require a token.
*)device_id : string option;The mobile device to which the access override applies.
*)user_id : string option;The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities:
12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234user@domain.tlduserorganization_id : string;The WorkMail organization under which to list mobile device access overrides.
*)}type nonrec mail_domain_summary = {default_domain : bool option;Whether the domain is default or not.
*)domain_name : string option;The domain name.
*)}The data for a given domain.
type nonrec list_mail_domains_response = {next_token : string option;The token to use to retrieve the next page of results. The value becomes null when there are no more results to return.
mail_domains : mail_domain_summary list option;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.
*)}type nonrec list_mail_domains_request = {next_token : string option;The token to use to retrieve the next page of results. The first call does not require a token.
*)max_results : int option;The maximum number of results to return in a single call.
*)organization_id : string;The WorkMail organization for which to list domains.
*)}type nonrec permission = {permission_values : permission_type list;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.
*)grantee_type : member_type;The type of user, group, or resource referred to in GranteeId.
*)grantee_id : string;The identifier of the user, group, or resource to which the permissions are granted.
*)}Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.
type nonrec list_mailbox_permissions_response = {next_token : string option;The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
*)permissions : permission list option;One page of the user, group, or resource mailbox permissions.
*)}type nonrec list_mailbox_permissions_request = {max_results : int option;The maximum number of results to return in a single call.
*)next_token : string option;The token to use to retrieve the next page of results. The first call does not contain any tokens.
*)entity_id : string;The identifier of the user, or resource for which to list mailbox permissions.
The entity ID can accept UserId or ResourceId, Username or Resourcename, or email.
organization_id : string;The identifier of the organization under which the user, group, or resource exists.
*)}type nonrec mailbox_export_job = {end_time : Smaws_Lib.CoreTypes.Timestamp.t option;The mailbox export job end timestamp.
*)start_time : Smaws_Lib.CoreTypes.Timestamp.t option;The mailbox export job start timestamp.
*)state : mailbox_export_job_state option;The state of the mailbox export job.
*)estimated_progress : int option;The estimated progress of the mailbox export job, in percentage points.
*)s3_path : string option;The path to the S3 bucket and file that the mailbox export job exports to.
*)s3_bucket_name : string option;The name of the S3 bucket.
*)description : string option;The mailbox export job description.
*)entity_id : string option;The identifier of the user or resource associated with the mailbox.
*)job_id : string option;The identifier of the mailbox export job.
*)}The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.
type nonrec list_mailbox_export_jobs_response = {next_token : string option;The token to use to retrieve the next page of results.
*)jobs : mailbox_export_job list option;The mailbox export job details.
*)}type nonrec impersonation_role = {date_modified : Smaws_Lib.CoreTypes.Timestamp.t option;The date when the impersonation role was last modified.
*)date_created : Smaws_Lib.CoreTypes.Timestamp.t option;The date when the impersonation role was created.
*)type_ : impersonation_role_type option;The impersonation role type.
*)name : string option;The impersonation role name.
*)impersonation_role_id : string option;The identifier of the impersonation role.
*)}An impersonation role for the given WorkMail organization.
type nonrec list_impersonation_roles_response = {next_token : string option;The token to retrieve the next page of results. The value is null when there are no results to return.
roles : impersonation_role list option;The list of impersonation roles under the given WorkMail organization.
*)}type nonrec list_impersonation_roles_request = {max_results : int option;The maximum number of results returned in a single call.
*)next_token : string option;The token used to retrieve the next page of results. The first call doesn't require a token.
*)organization_id : string;The WorkMail organization to which the listed impersonation roles belong.
*)}type nonrec group_identifier = {group_name : string option;Group name that matched the group.
*)group_id : string option;Group ID that matched the group.
*)}The identifier that contains the Group ID and name of a group.
type nonrec list_groups_for_entity_response = {next_token : string option;The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.
*)groups : group_identifier list option;The overview of groups in an organization.
*)}type nonrec list_groups_for_entity_filters = {group_name_prefix : string option;Filters only group names that start with the provided name prefix.
*)}Filtering options for ListGroupsForEntity operation. This is only used as input to Operation.
type nonrec list_groups_for_entity_request = {max_results : int option;The maximum number of results to return in a single call.
*)next_token : string option;The token to use to retrieve the next page of results. The first call does not contain any tokens.
*)filters : list_groups_for_entity_filters option;Limit the search results based on the filter criteria.
*)entity_id : string;The identifier for the entity.
The entity ID can accept UserId or GroupID, Username or Groupname, or email.
organization_id : string;The identifier for the organization under which the entity exists.
*)}type nonrec group = {disabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date indicating when the group was disabled from WorkMail use.
*)enabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date indicating when the group was enabled for WorkMail use.
*)state : entity_state option;The state of the group, which can be ENABLED, DISABLED, or DELETED.
*)name : string option;The name of the group.
*)email : string option;The email of the group.
*)id : string option;The identifier of the group.
*)}The representation of an WorkMail group.
type nonrec list_groups_response = {next_token : string option;The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
*)groups : group list option;The overview of groups for an organization.
*)}type nonrec list_groups_filters = {state : entity_state option;Filters only groups with the provided state.
*)primary_email_prefix : string option;Filters only groups with the provided primary email prefix.
*)name_prefix : string option;Filters only groups with the provided name prefix.
*)}Filtering options for ListGroups operation. This is only used as input to Operation.
type nonrec list_groups_request = {filters : list_groups_filters option;Limit the search results based on the filter criteria. Only one filter per request is supported.
*)max_results : int option;The maximum number of results to return in a single call.
*)next_token : string option;The token to use to retrieve the next page of results. The first call does not contain any tokens.
*)organization_id : string;The identifier for the organization under which the groups exist.
*)}type nonrec member = {disabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date indicating when the member was disabled from WorkMail use.
*)enabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date indicating when the member was enabled for WorkMail use.
*)state : entity_state option;The state of the member, which can be ENABLED, DISABLED, or DELETED.
*)type_ : member_type option;A member can be a user or group.
*)name : string option;The name of the member.
*)id : string option;The identifier of the member.
*)}The representation of a user or group.
type nonrec list_group_members_response = {next_token : string option;The token to use to retrieve the next page of results. The first call does not contain any tokens.
*)members : member list option;The members associated to the group.
*)}type nonrec list_group_members_request = {max_results : int option;The maximum number of results to return in a single call.
*)next_token : string option;The token to use to retrieve the next page of results. The first call does not contain any tokens.
*)group_id : string;The identifier for the group to which the members (users or groups) are associated.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
organization_id : string;The identifier for the organization under which the group exists.
*)}type nonrec redacted_ews_availability_provider = {ews_username : string option;The username used to authenticate the remote EWS server.
*)ews_endpoint : string option;The endpoint of the remote EWS server.
*)}Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.
type nonrec availability_configuration = {date_modified : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time at which the availability configuration was last modified.
*)date_created : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time at which the availability configuration was created.
*)lambda_provider : lambda_availability_provider option;If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. Otherwise, it is not required.
ews_provider : redacted_ews_availability_provider option;If ProviderType is EWS, then this field contains RedactedEwsAvailabilityProvider. Otherwise, it is not required.
provider_type : availability_provider_type option;Displays the provider type that applies to this domain.
*)domain_name : string option;Displays the domain to which the provider applies.
*)}List all the AvailabilityConfiguration's for the given WorkMail organization.
type nonrec list_availability_configurations_response = {next_token : string option;The token to use to retrieve the next page of results. The value is null when there are no further results to return.
availability_configurations : availability_configuration list option;The list of AvailabilityConfiguration's that exist for the specified WorkMail organization.
}type nonrec list_availability_configurations_request = {next_token : string option;The token to use to retrieve the next page of results. The first call does not require a token.
*)max_results : int option;The maximum number of results to return in a single call.
*)organization_id : string;The WorkMail organization for which the AvailabilityConfiguration's will be listed.
}type nonrec list_aliases_request = {max_results : int option;The maximum number of results to return in a single call.
*)next_token : string option;The token to use to retrieve the next page of results. The first call does not contain any tokens.
*)entity_id : string;The identifier for the entity for which to list the aliases.
*)organization_id : string;The identifier for the organization under which the entity exists.
*)}type nonrec access_control_rule = {not_impersonation_role_ids : string list option;Impersonation role IDs to exclude from the rule.
*)impersonation_role_ids : string list option;Impersonation role IDs to include in the rule.
*)date_modified : Smaws_Lib.CoreTypes.Timestamp.t option;The date that the rule was modified.
*)date_created : Smaws_Lib.CoreTypes.Timestamp.t option;The date that the rule was created.
*)not_user_ids : string list option;User IDs to exclude from the rule.
*)user_ids : string list option;User IDs to include in the rule.
*)not_actions : string list option;Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
actions : string list option;Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
not_ip_ranges : string list option;IPv4 CIDR ranges to exclude from the rule.
*)ip_ranges : string list option;IPv4 CIDR ranges to include in the rule.
*)description : string option;The rule description.
*)effect_ : access_control_rule_effect option;The rule effect.
*)name : string option;The rule name.
*)}A rule that controls access to an WorkMail organization.
type nonrec list_access_control_rules_response = {rules : access_control_rule list option;The access control rules.
*)}type nonrec get_mobile_device_access_override_response = {date_modified : Smaws_Lib.CoreTypes.Timestamp.t option;The date the description was last modified.
*)date_created : Smaws_Lib.CoreTypes.Timestamp.t option;The date the override was first created.
*)description : string option;A description of the override.
*)effect_ : mobile_device_access_rule_effect option;The effect of the override, ALLOW or DENY.
device_id : string option;The device to which the access override applies.
*)user_id : string option;The WorkMail user to which the access override applies.
*)}type nonrec get_mobile_device_access_override_request = {device_id : string;The mobile device to which the override applies. DeviceId is case insensitive.
user_id : string;Identifies the WorkMail user for the override. Accepts the following types of user identities:
12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234user@domain.tlduserorganization_id : string;The WorkMail organization to which you want to apply the override.
*)}type nonrec mobile_device_access_matched_rule = {name : string option;Name of a rule that a simulated user matches.
*)mobile_device_access_rule_id : string option;Identifier of the rule that a simulated user matches.
*)}The rule that a simulated user matches.
type nonrec get_mobile_device_access_effect_response = {matched_rules : mobile_device_access_matched_rule list option;A list of the rules which matched the simulated user input and produced the effect.
*)effect_ : mobile_device_access_rule_effect option;The effect of the simulated access, ALLOW or DENY, after evaluating mobile device access rules in the WorkMail organization for the simulated user parameters.
}type nonrec get_mobile_device_access_effect_request = {device_user_agent : string option;Device user agent the simulated user will report.
*)device_operating_system : string option;Device operating system the simulated user will report.
*)device_model : string option;Device model the simulated user will report.
*)device_type : string option;Device type the simulated user will report.
*)organization_id : string;The WorkMail organization to simulate the access effect for.
*)}type nonrec dns_record = {value : string option;The value returned by the DNS for a query to that hostname and record type.
*)hostname : string option;The DNS hostname.- For example, domain.example.com.
type_ : string option;The RFC 1035 record type. Possible values: CNAME, A, MX.
}A DNS record uploaded to your DNS provider.
type nonrec get_mail_domain_response = {dkim_verification_status : dns_record_verification_status option;Indicates the status of a DKIM verification.
*)ownership_verification_status : dns_record_verification_status option;Indicates the status of the domain ownership verification.
*)is_default : bool option;Specifies whether the domain is the default domain for your organization.
*)is_test_domain : bool option;Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.
*)records : dns_record list option;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.
*)}type nonrec get_mailbox_details_request = {user_id : string;The identifier for the user whose mailbox details are being requested.
The identifier can be the UserId, Username, or email. The following identity formats are available:
organization_id : string;The identifier for the organization that contains the user whose mailbox details are being requested.
*)}type nonrec impersonation_matched_rule = {name : string option;The name of the rule that matched the input.
*)impersonation_rule_id : string option;The ID of the rule that matched the input
*)}The impersonation rule that matched the input.
type nonrec get_impersonation_role_effect_response = {matched_rules : impersonation_matched_rule list option;A list of the rules that match the input and produce the configured effect.
*)effect_ : access_effect option;Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.
type_ : impersonation_role_type option;The impersonation role type.
*)}type nonrec get_impersonation_role_effect_request = {target_user : string;The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:
12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234user@domain.tlduserimpersonation_role_id : string;The impersonation role ID to test.
*)organization_id : string;The WorkMail organization where the impersonation role is defined.
*)}type nonrec get_impersonation_role_response = {date_modified : Smaws_Lib.CoreTypes.Timestamp.t option;The date when the impersonation role was last modified.
*)date_created : Smaws_Lib.CoreTypes.Timestamp.t option;The date when the impersonation role was created.
*)rules : impersonation_rule list option;The list of rules for the given impersonation role.
*)description : string option;The impersonation role description.
*)type_ : impersonation_role_type option;The impersonation role type.
*)name : string option;The impersonation role name.
*)impersonation_role_id : string option;The impersonation role ID.
*)}type nonrec get_default_retention_policy_response = {folder_configurations : folder_configuration list option;The retention policy folder configurations.
*)description : string option;The retention policy description.
*)name : string option;The retention policy name.
*)id : string option;The retention policy ID.
*)}type nonrec get_access_control_effect_response = {matched_rules : string list option;The rules that match the given parameters, resulting in an effect.
*)effect_ : access_control_rule_effect option;The rule effect.
*)}type nonrec get_access_control_effect_request = {impersonation_role_id : string option;The impersonation role ID.
*)user_id : string option;The user ID.
*)action : string;The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
ip_address : string;The IPv4 address.
*)organization_id : string;The identifier for the organization.
*)}type nonrec disassociate_member_from_group_request = {member_id : string;The identifier for the member to be removed from the group.
The member ID can accept UserID or GroupId, Username or Groupname, or email.
group_id : string;The identifier for the group from which members are removed.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
organization_id : string;The identifier for the organization under which the group exists.
*)}type nonrec disassociate_delegate_from_resource_request = {entity_id : string;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.
resource_id : string;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:
organization_id : string;The identifier for the organization under which the resource exists.
*)}type nonrec describe_user_response = {office : string option;Office where the user is located.
*)country : string option;Country where the user is located.
*)department : string option;Department of the user.
*)zip_code : string option;Zip code of the user.
*)company : string option;Company of the user.
*)city : string option;City where the user is located.
*)job_title : string option;Job title of the user.
*)street : string option;Street where the user is located.
*)telephone : string option;User's contact number.
*)initials : string option;Initials of the user.
*)last_name : string option;Last name of the user.
*)first_name : string option;First name of the user.
*)mailbox_deprovisioned_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date when the mailbox was removed for the user.
*)mailbox_provisioned_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date when the mailbox was created for the user.
*)disabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.
*)enabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.
*)user_role : user_role option;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.
*)state : entity_state option;The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
*)display_name : string option;The display name of the user.
*)email : string option;The email of the user.
*)name : string option;The name for the user.
*)user_id : string option;The identifier for the described user.
*)}type nonrec describe_user_request = {user_id : string;The identifier for the user to be described.
The identifier can be the UserId, Username, or email. The following identity formats are available:
organization_id : string;The identifier for the organization under which the user exists.
*)}type nonrec describe_resource_response = {description : string option;Description of the resource.
*)disabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
*)enabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
*)state : entity_state option;The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
*)booking_options : booking_options option;The booking options for the described resource.
*)type_ : resource_type option;The type of the described resource.
*)name : string option;The name of the described resource.
*)email : string option;The email of the described resource.
*)resource_id : string option;The identifier of the described resource.
*)}type nonrec describe_resource_request = {resource_id : string;The identifier of the resource to be described.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
organization_id : string;The identifier associated with the organization for which the resource is described.
*)}type nonrec describe_organization_response = {interoperability_enabled : bool option;Indicates if interoperability is enabled for this organization.
*)migration_admin : string option;The user ID of the migration admin if migration is enabled for the organization.
*)ar_n : string option;The Amazon Resource Name (ARN) of the organization.
*)error_message : string option;(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.
*)completed_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.
*)default_mail_domain : string option;The default mail domain associated with the organization.
*)directory_type : string option;The type of directory associated with the WorkMail organization.
*)directory_id : string option;The identifier for the directory associated with an WorkMail organization.
*)state : string option;The state of an organization.
*)alias : string option;The alias for an organization.
*)organization_id : string option;The identifier of an organization.
*)}type nonrec describe_mailbox_export_job_response = {end_time : Smaws_Lib.CoreTypes.Timestamp.t option;The mailbox export job end timestamp.
*)start_time : Smaws_Lib.CoreTypes.Timestamp.t option;The mailbox export job start timestamp.
*)error_info : string option;Error information for failed mailbox export jobs.
*)state : mailbox_export_job_state option;The state of the mailbox export job.
*)estimated_progress : int option;The estimated progress of the mailbox export job, in percentage points.
*)s3_path : string option;The path to the S3 bucket and file that the mailbox export job is exporting to.
*)s3_prefix : string option;The S3 bucket prefix.
*)s3_bucket_name : string option;The name of the S3 bucket.
*)kms_key_arn : string option;The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
*)role_arn : string option;The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.
*)description : string option;The mailbox export job description.
*)entity_id : string option;The identifier of the user or resource associated with the mailbox.
*)}type nonrec describe_group_response = {disabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.
*)enabled_date : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when a user was registered to WorkMail, in UNIX epoch time format.
*)state : entity_state option;The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
*)email : string option;The email of the described group.
*)name : string option;The name of the described group.
*)group_id : string option;The identifier of the described group.
*)}type nonrec describe_group_request = {group_id : string;The identifier for the group to be described.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
organization_id : string;The identifier for the organization under which the group exists.
*)}type nonrec describe_entity_response = {type_ : entity_type option;Entity type.
*)name : string option;Username, GroupName, or ResourceName based on entity type.
*)entity_id : string option;The entity ID under which the entity exists.
*)}type nonrec describe_email_monitoring_configuration_response = {log_group_arn : string option;The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
*)role_arn : string option;The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
*)}You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
type nonrec deregister_from_work_mail_request = {entity_id : string;The identifier for the member to be updated.
The identifier can be UserId, ResourceId, or Group Id, Username, Resourcename, or Groupname, or email.
organization_id : string;The identifier for the organization under which the WorkMail entity exists.
*)}type nonrec delete_user_request = {user_id : string;The identifier of the user to be deleted.
The identifier can be the UserId or Username. The following identity formats are available:
organization_id : string;The organization that contains the user to be deleted.
*)}type nonrec delete_resource_request = {resource_id : string;The identifier of the resource to be deleted.
The identifier can accept ResourceId, or Resourcename. The following identity formats are available:
organization_id : string;The identifier associated with the organization from which the resource is deleted.
*)}type nonrec delete_organization_request = {force_delete : bool option;Deletes a WorkMail organization even if the organization has enabled users.
*)delete_directory : bool;If true, deletes the AWS Directory Service directory associated with the organization.
*)organization_id : string;The organization ID.
*)client_token : string option;The idempotency token associated with the request.
*)}type nonrec delete_mobile_device_access_override_request = {device_id : string;The mobile device for which you delete the override. DeviceId is case insensitive.
user_id : string;The WorkMail user for which you want to delete the override. Accepts the following types of user identities:
12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234user@domain.tlduserorganization_id : string;The WorkMail organization for which the access override will be deleted.
*)}type nonrec delete_mailbox_permissions_request = {grantee_id : string;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.
entity_id : string;The identifier of the entity that owns the mailbox.
The identifier can be UserId or Group Id, Username or Groupname, or email.
organization_id : string;The identifier of the organization under which the member (user or group) exists.
*)}type nonrec delete_group_request = {group_id : string;The identifier of the group to be deleted.
The identifier can be the GroupId, or Groupname. The following identity formats are available:
organization_id : string;The organization that contains the group.
*)}type nonrec delete_alias_request = {alias : string;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).
*)entity_id : string;The identifier for the member (user or group) from which to have the aliases removed.
*)organization_id : string;The identifier for the organization under which the user exists.
*)}This user, group, or resource name is not allowed in WorkMail.
type nonrec create_user_request = {last_name : string option;The last name of the new user.
*)first_name : string option;The first name of the new user.
*)role : user_role option;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.
*)password : string option;The password for the new user.
*)display_name : string;The display name for the new user.
*)name : string;The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.
*)organization_id : string;The identifier of the organization for which the user is created.
*)}type nonrec create_resource_request = {description : string option;Resource description.
*)type_ : resource_type;The type of the new resource. The available types are equipment and room.
name : string;The name of the new resource.
*)organization_id : string;The identifier associated with the organization for which the resource is created.
*)}The directory is already in use by another WorkMail organization in the same account and Region.
type nonrec domain = {hosted_zone_id : string option;The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.
*)domain_name : string;The fully qualified domain name.
*)}The domain to associate with an WorkMail organization.
When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide.
type nonrec create_organization_request = {enable_interoperability : bool option;When true, allows organization interoperability between WorkMail and Microsoft Exchange. If true, you must include a AD Connector directory ID in the request.
kms_key_arn : string option;The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
*)domains : domain list option;The email domains to associate with the organization.
*)client_token : string option;The idempotency token associated with the request.
*)alias : string;The organization alias.
*)directory_id : string option;The AWS Directory Service directory ID.
*)}type nonrec create_mobile_device_access_rule_request = {not_device_user_agents : string list option;Device user agents that the rule will not match. All other device user agents will match.
*)device_user_agents : string list option;Device user agents that the rule will match.
*)not_device_operating_systems : string list option;Device operating systems that the rule will not match. All other device operating systems will match.
*)device_operating_systems : string list option;Device operating systems that the rule will match.
*)not_device_models : string list option;Device models that the rule will not match. All other device models will match.
*)device_models : string list option;Device models that the rule will match.
*)not_device_types : string list option;Device types that the rule will not match. All other device types will match.
*)device_types : string list option;Device types that the rule will match.
*)effect_ : mobile_device_access_rule_effect;The effect of the rule when it matches. Allowed values are ALLOW or DENY.
description : string option;The rule description.
*)name : string;The rule name.
*)client_token : string option;The idempotency token for the client request.
*)organization_id : string;The WorkMail organization under which the rule will be created.
*)}type nonrec create_impersonation_role_request = {rules : impersonation_rule list;The list of rules for the impersonation role.
*)description : string option;The description of the new impersonation role.
*)type_ : impersonation_role_type;The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.
name : string;The name of the new impersonation role.
*)organization_id : string;The WorkMail organization to create the new impersonation role within.
*)client_token : string option;The idempotency token for the client request.
*)}type nonrec create_availability_configuration_request = {lambda_provider : lambda_availability_provider option;Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
ews_provider : ews_availability_provider option;Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
domain_name : string;The domain to which the provider applies.
*)organization_id : string;The WorkMail organization for which the AvailabilityConfiguration will be created.
client_token : string option;An idempotent token that ensures that an API request is executed only once.
*)}type nonrec associate_member_to_group_request = {member_id : string;The member (user or group) to associate to the group.
The member ID can accept UserID or GroupId, Username or Groupname, or email.
group_id : string;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:
organization_id : string;The organization under which the group exists.
*)}type nonrec associate_delegate_to_resource_request = {entity_id : string;The member (user or group) to associate to the resource.
The entity ID can accept UserId or GroupID, Username or Groupname, or email.
resource_id : string;The resource for which members (users or groups) are associated.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
organization_id : string;The organization under which the resource exists.
*)}Builders
val make_update_user_request :
?office:string ->
?country:string ->
?department:string ->
?zip_code:string ->
?company:string ->
?city:string ->
?job_title:string ->
?street:string ->
?telephone:string ->
?initials:string ->
?hidden_from_global_address_list:bool ->
?last_name:string ->
?first_name:string ->
?display_name:string ->
?role:user_role ->
user_id:string ->
organization_id:string ->
unit ->
update_user_requestval make_booking_options :
?auto_decline_conflicting_requests:bool ->
?auto_decline_recurring_requests:bool ->
?auto_accept_requests:bool ->
unit ->
booking_optionsval make_update_resource_request :
?hidden_from_global_address_list:bool ->
?type_:resource_type ->
?description:string ->
?booking_options:booking_options ->
?name:string ->
resource_id:string ->
organization_id:string ->
unit ->
update_resource_requestval make_update_primary_email_address_request :
email:string ->
entity_id:string ->
organization_id:string ->
unit ->
update_primary_email_address_requestval make_update_mobile_device_access_rule_request :
?not_device_user_agents:string list ->
?device_user_agents:string list ->
?not_device_operating_systems:string list ->
?device_operating_systems:string list ->
?not_device_models:string list ->
?device_models:string list ->
?not_device_types:string list ->
?device_types:string list ->
?description:string ->
effect_:mobile_device_access_rule_effect ->
name:string ->
mobile_device_access_rule_id:string ->
organization_id:string ->
unit ->
update_mobile_device_access_rule_requestval make_update_mailbox_quota_request :
mailbox_quota:int ->
user_id:string ->
organization_id:string ->
unit ->
update_mailbox_quota_requestval make_impersonation_rule :
?not_target_users:string list ->
?target_users:string list ->
?description:string ->
?name:string ->
effect_:access_effect ->
impersonation_rule_id:string ->
unit ->
impersonation_ruleval make_update_impersonation_role_request :
?description:string ->
rules:impersonation_rule list ->
type_:impersonation_role_type ->
name:string ->
impersonation_role_id:string ->
organization_id:string ->
unit ->
update_impersonation_role_requestval make_update_group_request :
?hidden_from_global_address_list:bool ->
group_id:string ->
organization_id:string ->
unit ->
update_group_requestval make_update_default_mail_domain_request :
domain_name:string ->
organization_id:string ->
unit ->
update_default_mail_domain_requestval make_ews_availability_provider :
ews_password:string ->
ews_username:string ->
ews_endpoint:string ->
unit ->
ews_availability_providerval make_lambda_availability_provider :
lambda_arn:string ->
unit ->
lambda_availability_providerval make_update_availability_configuration_request :
?lambda_provider:lambda_availability_provider ->
?ews_provider:ews_availability_provider ->
domain_name:string ->
organization_id:string ->
unit ->
update_availability_configuration_requestval make_untag_resource_request :
tag_keys:string list ->
resource_ar_n:string ->
unit ->
untag_resource_requestval make_test_availability_configuration_response :
?failure_reason:string ->
?test_passed:bool ->
unit ->
test_availability_configuration_responseval make_test_availability_configuration_request :
?lambda_provider:lambda_availability_provider ->
?ews_provider:ews_availability_provider ->
?domain_name:string ->
organization_id:string ->
unit ->
test_availability_configuration_requestval make_tag : value:string -> key:string -> unit -> tagval make_tag_resource_request :
tags:tag list ->
resource_ar_n:string ->
unit ->
tag_resource_requestval make_start_mailbox_export_job_response :
?job_id:string ->
unit ->
start_mailbox_export_job_responseval make_start_mailbox_export_job_request :
?description:string ->
s3_prefix:string ->
s3_bucket_name:string ->
kms_key_arn:string ->
role_arn:string ->
entity_id:string ->
organization_id:string ->
client_token:string ->
unit ->
start_mailbox_export_job_requestval make_reset_password_request :
password:string ->
user_id:string ->
organization_id:string ->
unit ->
reset_password_requestval make_register_to_work_mail_request :
email:string ->
entity_id:string ->
organization_id:string ->
unit ->
register_to_work_mail_requestval make_register_mail_domain_request :
?client_token:string ->
domain_name:string ->
organization_id:string ->
unit ->
register_mail_domain_requestval make_folder_configuration :
?period:int ->
action:retention_action ->
name:folder_name ->
unit ->
folder_configurationval make_put_retention_policy_request :
?description:string ->
?id:string ->
folder_configurations:folder_configuration list ->
name:string ->
organization_id:string ->
unit ->
put_retention_policy_requestval make_put_mobile_device_access_override_request :
?description:string ->
effect_:mobile_device_access_rule_effect ->
device_id:string ->
user_id:string ->
organization_id:string ->
unit ->
put_mobile_device_access_override_requestval make_put_mailbox_permissions_request :
permission_values:permission_type list ->
grantee_id:string ->
entity_id:string ->
organization_id:string ->
unit ->
put_mailbox_permissions_requestval make_put_inbound_dmarc_settings_request :
enforced:bool ->
organization_id:string ->
unit ->
put_inbound_dmarc_settings_requestval make_put_email_monitoring_configuration_request :
log_group_arn:string ->
role_arn:string ->
organization_id:string ->
unit ->
put_email_monitoring_configuration_requestval make_put_access_control_rule_request :
?not_impersonation_role_ids:string list ->
?impersonation_role_ids:string list ->
?not_user_ids:string list ->
?user_ids:string list ->
?not_actions:string list ->
?actions:string list ->
?not_ip_ranges:string list ->
?ip_ranges:string list ->
organization_id:string ->
description:string ->
effect_:access_control_rule_effect ->
name:string ->
unit ->
put_access_control_rule_requestval make_user :
?disabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?enabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?user_role:user_role ->
?state:entity_state ->
?display_name:string ->
?name:string ->
?email:string ->
?id:string ->
unit ->
userval make_list_users_response :
?next_token:string ->
?users:user list ->
unit ->
list_users_responseval make_list_users_filters :
?state:entity_state ->
?primary_email_prefix:string ->
?display_name_prefix:string ->
?username_prefix:string ->
unit ->
list_users_filtersval make_list_users_request :
?filters:list_users_filters ->
?max_results:int ->
?next_token:string ->
organization_id:string ->
unit ->
list_users_requestval make_list_tags_for_resource_response :
?tags:tag list ->
unit ->
list_tags_for_resource_responseval make_list_tags_for_resource_request :
resource_ar_n:string ->
unit ->
list_tags_for_resource_requestval make_resource :
?description:string ->
?disabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?enabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?state:entity_state ->
?type_:resource_type ->
?name:string ->
?email:string ->
?id:string ->
unit ->
resourceval make_list_resources_response :
?next_token:string ->
?resources:resource list ->
unit ->
list_resources_responseval make_list_resources_filters :
?state:entity_state ->
?primary_email_prefix:string ->
?name_prefix:string ->
unit ->
list_resources_filtersval make_list_resources_request :
?filters:list_resources_filters ->
?max_results:int ->
?next_token:string ->
organization_id:string ->
unit ->
list_resources_requestval make_delegate : type_:member_type -> id:string -> unit -> delegateval make_list_resource_delegates_response :
?next_token:string ->
?delegates:delegate list ->
unit ->
list_resource_delegates_responseval make_list_resource_delegates_request :
?max_results:int ->
?next_token:string ->
resource_id:string ->
organization_id:string ->
unit ->
list_resource_delegates_requestval make_organization_summary :
?state:string ->
?error_message:string ->
?default_mail_domain:string ->
?alias:string ->
?organization_id:string ->
unit ->
organization_summaryval make_list_organizations_response :
?next_token:string ->
?organization_summaries:organization_summary list ->
unit ->
list_organizations_responseval make_list_organizations_request :
?max_results:int ->
?next_token:string ->
unit ->
list_organizations_requestval make_mobile_device_access_rule :
?date_modified:Smaws_Lib.CoreTypes.Timestamp.t ->
?date_created:Smaws_Lib.CoreTypes.Timestamp.t ->
?not_device_user_agents:string list ->
?device_user_agents:string list ->
?not_device_operating_systems:string list ->
?device_operating_systems:string list ->
?not_device_models:string list ->
?device_models:string list ->
?not_device_types:string list ->
?device_types:string list ->
?effect_:mobile_device_access_rule_effect ->
?description:string ->
?name:string ->
?mobile_device_access_rule_id:string ->
unit ->
mobile_device_access_ruleval make_list_mobile_device_access_rules_response :
?rules:mobile_device_access_rule list ->
unit ->
list_mobile_device_access_rules_responseval make_list_mobile_device_access_rules_request :
organization_id:string ->
unit ->
list_mobile_device_access_rules_requestval make_mobile_device_access_override :
?date_modified:Smaws_Lib.CoreTypes.Timestamp.t ->
?date_created:Smaws_Lib.CoreTypes.Timestamp.t ->
?description:string ->
?effect_:mobile_device_access_rule_effect ->
?device_id:string ->
?user_id:string ->
unit ->
mobile_device_access_overrideval make_list_mobile_device_access_overrides_response :
?next_token:string ->
?overrides:mobile_device_access_override list ->
unit ->
list_mobile_device_access_overrides_responseval make_list_mobile_device_access_overrides_request :
?max_results:int ->
?next_token:string ->
?device_id:string ->
?user_id:string ->
organization_id:string ->
unit ->
list_mobile_device_access_overrides_requestval make_mail_domain_summary :
?default_domain:bool ->
?domain_name:string ->
unit ->
mail_domain_summaryval make_list_mail_domains_response :
?next_token:string ->
?mail_domains:mail_domain_summary list ->
unit ->
list_mail_domains_responseval make_list_mail_domains_request :
?next_token:string ->
?max_results:int ->
organization_id:string ->
unit ->
list_mail_domains_requestval make_permission :
permission_values:permission_type list ->
grantee_type:member_type ->
grantee_id:string ->
unit ->
permissionval make_list_mailbox_permissions_response :
?next_token:string ->
?permissions:permission list ->
unit ->
list_mailbox_permissions_responseval make_list_mailbox_permissions_request :
?max_results:int ->
?next_token:string ->
entity_id:string ->
organization_id:string ->
unit ->
list_mailbox_permissions_requestval make_mailbox_export_job :
?end_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?start_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?state:mailbox_export_job_state ->
?estimated_progress:int ->
?s3_path:string ->
?s3_bucket_name:string ->
?description:string ->
?entity_id:string ->
?job_id:string ->
unit ->
mailbox_export_jobval make_list_mailbox_export_jobs_response :
?next_token:string ->
?jobs:mailbox_export_job list ->
unit ->
list_mailbox_export_jobs_responseval make_list_mailbox_export_jobs_request :
?max_results:int ->
?next_token:string ->
organization_id:string ->
unit ->
list_mailbox_export_jobs_requestval make_impersonation_role :
?date_modified:Smaws_Lib.CoreTypes.Timestamp.t ->
?date_created:Smaws_Lib.CoreTypes.Timestamp.t ->
?type_:impersonation_role_type ->
?name:string ->
?impersonation_role_id:string ->
unit ->
impersonation_roleval make_list_impersonation_roles_response :
?next_token:string ->
?roles:impersonation_role list ->
unit ->
list_impersonation_roles_responseval make_list_impersonation_roles_request :
?max_results:int ->
?next_token:string ->
organization_id:string ->
unit ->
list_impersonation_roles_requestval make_group_identifier :
?group_name:string ->
?group_id:string ->
unit ->
group_identifierval make_list_groups_for_entity_response :
?next_token:string ->
?groups:group_identifier list ->
unit ->
list_groups_for_entity_responseval make_list_groups_for_entity_filters :
?group_name_prefix:string ->
unit ->
list_groups_for_entity_filtersval make_list_groups_for_entity_request :
?max_results:int ->
?next_token:string ->
?filters:list_groups_for_entity_filters ->
entity_id:string ->
organization_id:string ->
unit ->
list_groups_for_entity_requestval make_group :
?disabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?enabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?state:entity_state ->
?name:string ->
?email:string ->
?id:string ->
unit ->
groupval make_list_groups_response :
?next_token:string ->
?groups:group list ->
unit ->
list_groups_responseval make_list_groups_filters :
?state:entity_state ->
?primary_email_prefix:string ->
?name_prefix:string ->
unit ->
list_groups_filtersval make_list_groups_request :
?filters:list_groups_filters ->
?max_results:int ->
?next_token:string ->
organization_id:string ->
unit ->
list_groups_requestval make_member :
?disabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?enabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?state:entity_state ->
?type_:member_type ->
?name:string ->
?id:string ->
unit ->
memberval make_list_group_members_response :
?next_token:string ->
?members:member list ->
unit ->
list_group_members_responseval make_list_group_members_request :
?max_results:int ->
?next_token:string ->
group_id:string ->
organization_id:string ->
unit ->
list_group_members_requestval make_redacted_ews_availability_provider :
?ews_username:string ->
?ews_endpoint:string ->
unit ->
redacted_ews_availability_providerval make_availability_configuration :
?date_modified:Smaws_Lib.CoreTypes.Timestamp.t ->
?date_created:Smaws_Lib.CoreTypes.Timestamp.t ->
?lambda_provider:lambda_availability_provider ->
?ews_provider:redacted_ews_availability_provider ->
?provider_type:availability_provider_type ->
?domain_name:string ->
unit ->
availability_configurationval make_list_availability_configurations_response :
?next_token:string ->
?availability_configurations:availability_configuration list ->
unit ->
list_availability_configurations_responseval make_list_availability_configurations_request :
?next_token:string ->
?max_results:int ->
organization_id:string ->
unit ->
list_availability_configurations_requestval make_list_aliases_response :
?next_token:string ->
?aliases:string list ->
unit ->
list_aliases_responseval make_list_aliases_request :
?max_results:int ->
?next_token:string ->
entity_id:string ->
organization_id:string ->
unit ->
list_aliases_requestval make_access_control_rule :
?not_impersonation_role_ids:string list ->
?impersonation_role_ids:string list ->
?date_modified:Smaws_Lib.CoreTypes.Timestamp.t ->
?date_created:Smaws_Lib.CoreTypes.Timestamp.t ->
?not_user_ids:string list ->
?user_ids:string list ->
?not_actions:string list ->
?actions:string list ->
?not_ip_ranges:string list ->
?ip_ranges:string list ->
?description:string ->
?effect_:access_control_rule_effect ->
?name:string ->
unit ->
access_control_ruleval make_list_access_control_rules_response :
?rules:access_control_rule list ->
unit ->
list_access_control_rules_responseval make_list_access_control_rules_request :
organization_id:string ->
unit ->
list_access_control_rules_requestval make_get_mobile_device_access_override_response :
?date_modified:Smaws_Lib.CoreTypes.Timestamp.t ->
?date_created:Smaws_Lib.CoreTypes.Timestamp.t ->
?description:string ->
?effect_:mobile_device_access_rule_effect ->
?device_id:string ->
?user_id:string ->
unit ->
get_mobile_device_access_override_responseval make_get_mobile_device_access_override_request :
device_id:string ->
user_id:string ->
organization_id:string ->
unit ->
get_mobile_device_access_override_requestval make_mobile_device_access_matched_rule :
?name:string ->
?mobile_device_access_rule_id:string ->
unit ->
mobile_device_access_matched_ruleval make_get_mobile_device_access_effect_response :
?matched_rules:mobile_device_access_matched_rule list ->
?effect_:mobile_device_access_rule_effect ->
unit ->
get_mobile_device_access_effect_responseval make_get_mobile_device_access_effect_request :
?device_user_agent:string ->
?device_operating_system:string ->
?device_model:string ->
?device_type:string ->
organization_id:string ->
unit ->
get_mobile_device_access_effect_requestval make_dns_record :
?value:string ->
?hostname:string ->
?type_:string ->
unit ->
dns_recordval make_get_mail_domain_response :
?dkim_verification_status:dns_record_verification_status ->
?ownership_verification_status:dns_record_verification_status ->
?is_default:bool ->
?is_test_domain:bool ->
?records:dns_record list ->
unit ->
get_mail_domain_responseval make_get_mail_domain_request :
domain_name:string ->
organization_id:string ->
unit ->
get_mail_domain_requestval make_get_mailbox_details_response :
?mailbox_size:float ->
?mailbox_quota:int ->
unit ->
get_mailbox_details_responseval make_get_mailbox_details_request :
user_id:string ->
organization_id:string ->
unit ->
get_mailbox_details_requestval make_impersonation_matched_rule :
?name:string ->
?impersonation_rule_id:string ->
unit ->
impersonation_matched_ruleval make_get_impersonation_role_effect_response :
?matched_rules:impersonation_matched_rule list ->
?effect_:access_effect ->
?type_:impersonation_role_type ->
unit ->
get_impersonation_role_effect_responseval make_get_impersonation_role_effect_request :
target_user:string ->
impersonation_role_id:string ->
organization_id:string ->
unit ->
get_impersonation_role_effect_requestval make_get_impersonation_role_response :
?date_modified:Smaws_Lib.CoreTypes.Timestamp.t ->
?date_created:Smaws_Lib.CoreTypes.Timestamp.t ->
?rules:impersonation_rule list ->
?description:string ->
?type_:impersonation_role_type ->
?name:string ->
?impersonation_role_id:string ->
unit ->
get_impersonation_role_responseval make_get_impersonation_role_request :
impersonation_role_id:string ->
organization_id:string ->
unit ->
get_impersonation_role_requestval make_get_default_retention_policy_response :
?folder_configurations:folder_configuration list ->
?description:string ->
?name:string ->
?id:string ->
unit ->
get_default_retention_policy_responseval make_get_default_retention_policy_request :
organization_id:string ->
unit ->
get_default_retention_policy_requestval make_get_access_control_effect_response :
?matched_rules:string list ->
?effect_:access_control_rule_effect ->
unit ->
get_access_control_effect_responseval make_get_access_control_effect_request :
?impersonation_role_id:string ->
?user_id:string ->
action:string ->
ip_address:string ->
organization_id:string ->
unit ->
get_access_control_effect_requestval make_disassociate_member_from_group_request :
member_id:string ->
group_id:string ->
organization_id:string ->
unit ->
disassociate_member_from_group_requestval make_disassociate_delegate_from_resource_request :
entity_id:string ->
resource_id:string ->
organization_id:string ->
unit ->
disassociate_delegate_from_resource_requestval make_describe_user_response :
?office:string ->
?country:string ->
?department:string ->
?zip_code:string ->
?company:string ->
?city:string ->
?job_title:string ->
?street:string ->
?telephone:string ->
?initials:string ->
?hidden_from_global_address_list:bool ->
?last_name:string ->
?first_name:string ->
?mailbox_deprovisioned_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?mailbox_provisioned_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?disabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?enabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?user_role:user_role ->
?state:entity_state ->
?display_name:string ->
?email:string ->
?name:string ->
?user_id:string ->
unit ->
describe_user_responseval make_describe_user_request :
user_id:string ->
organization_id:string ->
unit ->
describe_user_requestval make_describe_resource_response :
?hidden_from_global_address_list:bool ->
?description:string ->
?disabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?enabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?state:entity_state ->
?booking_options:booking_options ->
?type_:resource_type ->
?name:string ->
?email:string ->
?resource_id:string ->
unit ->
describe_resource_responseval make_describe_resource_request :
resource_id:string ->
organization_id:string ->
unit ->
describe_resource_requestval make_describe_organization_response :
?interoperability_enabled:bool ->
?migration_admin:string ->
?ar_n:string ->
?error_message:string ->
?completed_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?default_mail_domain:string ->
?directory_type:string ->
?directory_id:string ->
?state:string ->
?alias:string ->
?organization_id:string ->
unit ->
describe_organization_responseval make_describe_organization_request :
organization_id:string ->
unit ->
describe_organization_requestval make_describe_mailbox_export_job_response :
?end_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?start_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?error_info:string ->
?state:mailbox_export_job_state ->
?estimated_progress:int ->
?s3_path:string ->
?s3_prefix:string ->
?s3_bucket_name:string ->
?kms_key_arn:string ->
?role_arn:string ->
?description:string ->
?entity_id:string ->
unit ->
describe_mailbox_export_job_responseval make_describe_mailbox_export_job_request :
organization_id:string ->
job_id:string ->
unit ->
describe_mailbox_export_job_requestval make_describe_inbound_dmarc_settings_response :
?enforced:bool ->
unit ->
describe_inbound_dmarc_settings_responseval make_describe_inbound_dmarc_settings_request :
organization_id:string ->
unit ->
describe_inbound_dmarc_settings_requestval make_describe_group_response :
?hidden_from_global_address_list:bool ->
?disabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?enabled_date:Smaws_Lib.CoreTypes.Timestamp.t ->
?state:entity_state ->
?email:string ->
?name:string ->
?group_id:string ->
unit ->
describe_group_responseval make_describe_group_request :
group_id:string ->
organization_id:string ->
unit ->
describe_group_requestval make_describe_entity_response :
?type_:entity_type ->
?name:string ->
?entity_id:string ->
unit ->
describe_entity_responseval make_describe_entity_request :
email:string ->
organization_id:string ->
unit ->
describe_entity_requestval make_describe_email_monitoring_configuration_response :
?log_group_arn:string ->
?role_arn:string ->
unit ->
describe_email_monitoring_configuration_responseval make_describe_email_monitoring_configuration_request :
organization_id:string ->
unit ->
describe_email_monitoring_configuration_requestval make_deregister_mail_domain_request :
domain_name:string ->
organization_id:string ->
unit ->
deregister_mail_domain_requestval make_deregister_from_work_mail_request :
entity_id:string ->
organization_id:string ->
unit ->
deregister_from_work_mail_requestval make_delete_user_request :
user_id:string ->
organization_id:string ->
unit ->
delete_user_requestval make_delete_retention_policy_request :
id:string ->
organization_id:string ->
unit ->
delete_retention_policy_requestval make_delete_resource_request :
resource_id:string ->
organization_id:string ->
unit ->
delete_resource_requestval make_delete_organization_response :
?state:string ->
?organization_id:string ->
unit ->
delete_organization_responseval make_delete_organization_request :
?force_delete:bool ->
?client_token:string ->
delete_directory:bool ->
organization_id:string ->
unit ->
delete_organization_requestval make_delete_mobile_device_access_rule_request :
mobile_device_access_rule_id:string ->
organization_id:string ->
unit ->
delete_mobile_device_access_rule_requestval make_delete_mobile_device_access_override_request :
device_id:string ->
user_id:string ->
organization_id:string ->
unit ->
delete_mobile_device_access_override_requestval make_delete_mailbox_permissions_request :
grantee_id:string ->
entity_id:string ->
organization_id:string ->
unit ->
delete_mailbox_permissions_requestval make_delete_impersonation_role_request :
impersonation_role_id:string ->
organization_id:string ->
unit ->
delete_impersonation_role_requestval make_delete_group_request :
group_id:string ->
organization_id:string ->
unit ->
delete_group_requestval make_delete_email_monitoring_configuration_request :
organization_id:string ->
unit ->
delete_email_monitoring_configuration_requestval make_delete_availability_configuration_request :
domain_name:string ->
organization_id:string ->
unit ->
delete_availability_configuration_requestval make_delete_alias_request :
alias:string ->
entity_id:string ->
organization_id:string ->
unit ->
delete_alias_requestval make_delete_access_control_rule_request :
name:string ->
organization_id:string ->
unit ->
delete_access_control_rule_requestval make_create_user_response : ?user_id:string -> unit -> create_user_responseval make_create_user_request :
?hidden_from_global_address_list:bool ->
?last_name:string ->
?first_name:string ->
?role:user_role ->
?password:string ->
display_name:string ->
name:string ->
organization_id:string ->
unit ->
create_user_requestval make_create_resource_response :
?resource_id:string ->
unit ->
create_resource_responseval make_create_resource_request :
?hidden_from_global_address_list:bool ->
?description:string ->
type_:resource_type ->
name:string ->
organization_id:string ->
unit ->
create_resource_requestval make_create_organization_response :
?organization_id:string ->
unit ->
create_organization_responseval make_domain :
?hosted_zone_id:string ->
domain_name:string ->
unit ->
domainval make_create_organization_request :
?enable_interoperability:bool ->
?kms_key_arn:string ->
?domains:domain list ->
?client_token:string ->
?directory_id:string ->
alias:string ->
unit ->
create_organization_requestval make_create_mobile_device_access_rule_response :
?mobile_device_access_rule_id:string ->
unit ->
create_mobile_device_access_rule_responseval make_create_mobile_device_access_rule_request :
?not_device_user_agents:string list ->
?device_user_agents:string list ->
?not_device_operating_systems:string list ->
?device_operating_systems:string list ->
?not_device_models:string list ->
?device_models:string list ->
?not_device_types:string list ->
?device_types:string list ->
?description:string ->
?client_token:string ->
effect_:mobile_device_access_rule_effect ->
name:string ->
organization_id:string ->
unit ->
create_mobile_device_access_rule_requestval make_create_impersonation_role_response :
?impersonation_role_id:string ->
unit ->
create_impersonation_role_responseval make_create_impersonation_role_request :
?description:string ->
?client_token:string ->
rules:impersonation_rule list ->
type_:impersonation_role_type ->
name:string ->
organization_id:string ->
unit ->
create_impersonation_role_requestval make_create_group_response :
?group_id:string ->
unit ->
create_group_responseval make_create_group_request :
?hidden_from_global_address_list:bool ->
name:string ->
organization_id:string ->
unit ->
create_group_requestval make_create_availability_configuration_request :
?lambda_provider:lambda_availability_provider ->
?ews_provider:ews_availability_provider ->
?client_token:string ->
domain_name:string ->
organization_id:string ->
unit ->
create_availability_configuration_requestval make_create_alias_request :
alias:string ->
entity_id:string ->
organization_id:string ->
unit ->
create_alias_requestval make_cancel_mailbox_export_job_request :
organization_id:string ->
job_id:string ->
client_token:string ->
unit ->
cancel_mailbox_export_job_requestval make_assume_impersonation_role_response :
?expires_in:int ->
?token:string ->
unit ->
assume_impersonation_role_responseval make_assume_impersonation_role_request :
impersonation_role_id:string ->
organization_id:string ->
unit ->
assume_impersonation_role_requestval make_associate_member_to_group_request :
member_id:string ->
group_id:string ->
organization_id:string ->
unit ->
associate_member_to_group_requestval make_associate_delegate_to_resource_request :
entity_id:string ->
resource_id:string ->
organization_id:string ->
unit ->
associate_delegate_to_resource_requestOperations
module AssociateDelegateToResource : sig ... endAdds a member (user or group) to the resource's set of delegates.
module AssociateMemberToGroup : sig ... endAdds a member (user or group) to the group's set.
module AssumeImpersonationRole : sig ... endAssumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
module CancelMailboxExportJob : sig ... endCancels a mailbox export job.
module CreateAlias : sig ... endAdds an alias to the set of a given member (user or group) of WorkMail.
module CreateAvailabilityConfiguration : sig ... endCreates an AvailabilityConfiguration for the given WorkMail organization and domain.
module CreateGroup : sig ... endCreates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
module CreateImpersonationRole : sig ... endCreates an impersonation role for the given WorkMail organization.
module CreateMobileDeviceAccessRule : sig ... endCreates a new mobile device access rule for the specified WorkMail organization.
module CreateOrganization : sig ... endCreates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
module CreateResource : sig ... endCreates a new WorkMail resource.
module CreateUser : sig ... endCreates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
module DeleteAccessControlRule : sig ... endDeletes an access control rule for the specified WorkMail organization.
module DeleteAlias : sig ... endRemove one or more specified aliases from a set of aliases for a given user.
module DeleteAvailabilityConfiguration : sig ... endDeletes the AvailabilityConfiguration for the given WorkMail organization and domain.
module DeleteEmailMonitoringConfiguration : sig ... endDeletes the email monitoring configuration for a specified organization.
module DeleteGroup : sig ... endDeletes a group from WorkMail.
module DeleteImpersonationRole : sig ... endDeletes an impersonation role for the given WorkMail organization.
module DeleteMailboxPermissions : sig ... endDeletes permissions granted to a member (user or group).
module DeleteMobileDeviceAccessOverride : sig ... endDeletes the mobile device access override for the given WorkMail organization, user, and device.
module DeleteMobileDeviceAccessRule : sig ... endDeletes a mobile device access rule for the specified WorkMail organization.
module DeleteOrganization : sig ... endDeletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.
module DeleteResource : sig ... endDeletes the specified resource.
module DeleteRetentionPolicy : sig ... endDeletes the specified retention policy from the specified organization.
module DeleteUser : sig ... endDeletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.
module DeregisterFromWorkMail : sig ... endMark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.
module DeregisterMailDomain : sig ... endRemoves a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
module DescribeEmailMonitoringConfiguration : sig ... endDescribes the current email monitoring configuration for a specified organization.
module DescribeEntity : sig ... endReturns basic details about an entity in WorkMail.
module DescribeGroup : sig ... endReturns the data available for the group.
module DescribeInboundDmarcSettings : sig ... endLists the settings in a DMARC policy for a specified organization.
module DescribeMailboxExportJob : sig ... endDescribes the current status of a mailbox export job.
module DescribeOrganization : sig ... endProvides more information regarding a given organization based on its identifier.
module DescribeResource : sig ... endReturns the data available for the resource.
module DescribeUser : sig ... endProvides information regarding the user.
module DisassociateDelegateFromResource : sig ... endRemoves a member from the resource's set of delegates.
module DisassociateMemberFromGroup : sig ... endRemoves a member from a group.
module GetAccessControlEffect : sig ... endGets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
module GetDefaultRetentionPolicy : sig ... endGets the default retention policy details for the specified organization.
module GetImpersonationRole : sig ... endGets the impersonation role details for the given WorkMail organization.
module GetImpersonationRoleEffect : sig ... endTests whether the given impersonation role can impersonate a target user.
module GetMailboxDetails : sig ... endRequests a user's mailbox details for a specified organization and user.
module GetMailDomain : sig ... endGets details for a mail domain, including domain records required to configure your domain with recommended security.
module GetMobileDeviceAccessEffect : sig ... endSimulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
module GetMobileDeviceAccessOverride : sig ... endGets the mobile device access override for the given WorkMail organization, user, and device.
module ListAccessControlRules : sig ... endLists the access control rules for the specified organization.
module ListAliases : sig ... endCreates a paginated call to list the aliases associated with a given entity.
module ListAvailabilityConfigurations : sig ... endList all the AvailabilityConfiguration's for the given WorkMail organization.
module ListGroupMembers : sig ... endReturns an overview of the members of a group. Users and groups can be members of a group.
module ListGroups : sig ... endReturns summaries of the organization's groups.
module ListGroupsForEntity : sig ... endReturns all the groups to which an entity belongs.
module ListImpersonationRoles : sig ... endLists all the impersonation roles for the given WorkMail organization.
module ListMailboxExportJobs : sig ... endLists the mailbox export jobs started for the specified organization within the last seven days.
module ListMailboxPermissions : sig ... endLists the mailbox permissions associated with a user, group, or resource mailbox.
module ListMailDomains : sig ... endLists the mail domains in a given WorkMail organization.
module ListMobileDeviceAccessOverrides : sig ... endLists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
module ListMobileDeviceAccessRules : sig ... endLists the mobile device access rules for the specified WorkMail organization.
module ListOrganizations : sig ... endReturns summaries of the customer's organizations.
module ListResourceDelegates : sig ... endLists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
module ListResources : sig ... endReturns summaries of the organization's resources.
module ListTagsForResource : sig ... endLists the tags applied to an WorkMail organization resource.
module ListUsers : sig ... endReturns summaries of the organization's users.
module PutAccessControlRule : sig ... endAdds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
module PutEmailMonitoringConfiguration : sig ... endCreates or updates the email monitoring configuration for a specified organization.
module PutInboundDmarcSettings : sig ... endEnables or disables a DMARC policy for a given organization.
module PutMailboxPermissions : sig ... endSets permissions for a user, group, or resource. This replaces any pre-existing permissions.
module PutMobileDeviceAccessOverride : sig ... endCreates or updates a mobile device access override for the given WorkMail organization, user, and device.
module PutRetentionPolicy : sig ... endPuts a retention policy to the specified organization.
module RegisterMailDomain : sig ... endRegisters a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
module RegisterToWorkMail : sig ... endRegisters an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.
module ResetPassword : sig ... endAllows the administrator to reset the password for a user.
module StartMailboxExportJob : sig ... endStarts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
module TagResource : sig ... endApplies the specified tags to the specified WorkMailorganization resource.
module TestAvailabilityConfiguration : sig ... endPerforms a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.
module UntagResource : sig ... endUntags the specified tags from the specified WorkMail organization resource.
module UpdateAvailabilityConfiguration : sig ... endUpdates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
module UpdateDefaultMailDomain : sig ... endUpdates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
module UpdateGroup : sig ... endUpdates attibutes in a group.
module UpdateImpersonationRole : sig ... endUpdates an impersonation role for the given WorkMail organization.
module UpdateMailboxQuota : sig ... endUpdates a user's current mailbox quota for a specified organization and user.
module UpdateMobileDeviceAccessRule : sig ... endUpdates a mobile device access rule for the specified WorkMail organization.
module UpdatePrimaryEmailAddress : sig ... endUpdates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.
module UpdateResource : sig ... endUpdates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.
module UpdateUser : sig ... endUpdates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.