Values (p.awso.0.9.1.doc.awso.workmail.Awso

Sourceval service : Awso.Service.t

Sourceval apiVersion : string

Sourceval endpointPrefix : string

Sourceval serviceFullName : string

Sourceval signatureVersion : string

Sourceval protocol : string

Sourceval globalEndpoint : string

Sourceval targetPrefix : string

Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule EntityIdentifier : sig ... end

Sourcemodule PersonalAccessTokenScope : sig ... end

Sourcemodule DeviceModel : sig ... end

Sourcemodule DeviceOperatingSystem : sig ... end

Sourcemodule DeviceType : sig ... end

Sourcemodule DeviceUserAgent : sig ... end

Sourcemodule PermissionType : sig ... end

Sourcemodule LambdaArn : sig ... end

Sourcemodule ExternalUserName : sig ... end

Sourcemodule Url : sig ... end

Sourcemodule AccessControlRuleAction : sig ... end

Sourcemodule ImpersonationRoleId : sig ... end

Sourcemodule IpRange : sig ... end

Sourcemodule WorkMailIdentifier : sig ... end

Sourcemodule AccessEffect : sig ... end

Sourcemodule ImpersonationRuleDescription : sig ... end

Sourcemodule ImpersonationRuleId : sig ... end

Sourcemodule ImpersonationRuleName : sig ... end

Sourcemodule TargetUsers : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule FolderName : sig ... end

Sourcemodule RetentionAction : sig ... end

Sourcemodule RetentionPeriod : sig ... end

Sourcemodule EmailAddress : sig ... end

Sourcemodule EntityState : sig ... end

Sourcemodule IdentityProviderIdentityStoreId : sig ... end

Sourcemodule IdentityProviderUserId : sig ... end

Sourcemodule String_ : sig ... end

Sourcemodule Timestamp : sig ... end

Sourcemodule UserName : sig ... end

Sourcemodule UserRole : sig ... end

Sourcemodule ResourceDescription : sig ... end

Sourcemodule ResourceName : sig ... end

Sourcemodule ResourceType : sig ... end

Sourcemodule MemberType : sig ... end

Sourcemodule PersonalAccessTokenId : sig ... end

Sourcemodule PersonalAccessTokenName : sig ... end

Sourcemodule PersonalAccessTokenScopeList : sig ... end

Sourcemodule DomainName : sig ... end

Sourcemodule OrganizationId : sig ... end

Sourcemodule OrganizationName : sig ... end

Sourcemodule DeviceModelList : sig ... end

Sourcemodule DeviceOperatingSystemList : sig ... end

Sourcemodule DeviceTypeList : sig ... end

Sourcemodule DeviceUserAgentList : sig ... end

Sourcemodule MobileDeviceAccessRuleDescription : sig ... end

Sourcemodule MobileDeviceAccessRuleEffect : sig ... end

Sourcemodule MobileDeviceAccessRuleId : sig ... end

Sourcemodule MobileDeviceAccessRuleName : sig ... end

Sourcemodule DeviceId : sig ... end

Sourcemodule PermissionValues : sig ... end

Sourcemodule Description : sig ... end

Sourcemodule MailboxExportJobId : sig ... end

Sourcemodule MailboxExportJobState : sig ... end

Sourcemodule Percentage : sig ... end

Sourcemodule S3BucketName : sig ... end

Sourcemodule S3ObjectKey : sig ... end

Sourcemodule Boolean : sig ... end

Sourcemodule ImpersonationRoleName : sig ... end

Sourcemodule ImpersonationRoleType : sig ... end

Sourcemodule GroupName : sig ... end

Sourcemodule AvailabilityProviderType : sig ... end

Sourcemodule LambdaAvailabilityProvider : sig ... end

Describes a Lambda based availability provider.

Sourcemodule RedactedEwsAvailabilityProvider : sig ... end

Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.

Sourcemodule AccessControlRuleDescription : sig ... end

Sourcemodule AccessControlRuleEffect : sig ... end

Sourcemodule AccessControlRuleName : sig ... end

Sourcemodule ActionsList : sig ... end

Sourcemodule ImpersonationRoleIdList : sig ... end

Sourcemodule IpRangeList : sig ... end

Sourcemodule UserIdList : sig ... end

Sourcemodule HostedZoneId : sig ... end

Sourcemodule ImpersonationRule : sig ... end

The rules for the given impersonation role.

Sourcemodule Password : sig ... end

Sourcemodule Tag : sig ... end

Describes a tag applied to a resource.

Sourcemodule FolderConfiguration : sig ... end

The configuration applied to an organization's folders by its retention policy.

Sourcemodule ApplicationArn : sig ... end

Sourcemodule InstanceArn : sig ... end

Sourcemodule PersonalAccessTokenConfigurationStatus : sig ... end

Sourcemodule PersonalAccessTokenLifetimeInDays : sig ... end

Sourcemodule User : sig ... end

The representation of an WorkMail user.

Sourcemodule IdentityProviderUserIdPrefix : sig ... end

Sourcemodule UserAttribute : sig ... end

Sourcemodule Resource : sig ... end

The representation of a resource.

Sourcemodule Delegate : sig ... end

The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

Sourcemodule PersonalAccessTokenSummary : sig ... end

The summary of the Personal Access Token.

Sourcemodule OrganizationSummary : sig ... end

The representation of an organization.

Sourcemodule MobileDeviceAccessRule : sig ... end

A rule that controls access to mobile devices for an WorkMail group.

Sourcemodule MobileDeviceAccessOverride : sig ... end

The override object.

Sourcemodule Permission : sig ... end

Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

Sourcemodule MailboxExportJob : sig ... end

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.

Sourcemodule MailDomainSummary : sig ... end

The data for a given domain.

Sourcemodule ImpersonationRole : sig ... end

An impersonation role for the given WorkMail organization.

Sourcemodule Group : sig ... end

The representation of an WorkMail group.

Sourcemodule GroupIdentifier : sig ... end

The identifier that contains the Group ID and name of a group.

Sourcemodule Member : sig ... end

The representation of a user or group.

Sourcemodule AvailabilityConfiguration : sig ... end

List all the AvailabilityConfiguration's for the given WorkMail organization.

Sourcemodule AccessControlRule : sig ... end

A rule that controls access to an WorkMail organization.

Sourcemodule MobileDeviceAccessMatchedRule : sig ... end

The rule that a simulated user matches.

Sourcemodule DnsRecord : sig ... end

A DNS record uploaded to your DNS provider.

Sourcemodule ImpersonationMatchedRule : sig ... end

The impersonation rule that matched the input.

Sourcemodule Domain : sig ... end

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.

Sourcemodule DirectoryServiceAuthenticationFailedException : sig ... end

The directory service doesn't recognize the credentials supplied by WorkMail.

Sourcemodule DirectoryUnavailableException : sig ... end

The directory is unavailable. It might be located in another Region or deleted.

Sourcemodule EntityNotFoundException : sig ... end

The identifier supplied for the user, group, or resource does not exist in your organization.

Sourcemodule EntityStateException : sig ... end

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.

Sourcemodule InvalidParameterException : sig ... end

One or more of the input parameters don't match the service's restrictions.

Sourcemodule OrganizationNotFoundException : sig ... end

An operation received a valid organization identifier that either doesn't belong or exist in the system.

Sourcemodule OrganizationStateException : sig ... end

The organization must have a valid state to perform certain operations on the organization or its members.

Sourcemodule UnsupportedOperationException : sig ... end

You can't perform a write operation against a read-only directory.

Sourcemodule BooleanObject : sig ... end

Sourcemodule IdentityProviderUserIdForUpdate : sig ... end

Sourcemodule EmailAddressInUseException : sig ... end

The email address that you're trying to assign is already created for a different user, group, or resource.

Sourcemodule InvalidConfigurationException : sig ... end

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.

Sourcemodule MailDomainNotFoundException : sig ... end

The domain specified is not found in your organization.

Sourcemodule MailDomainStateException : sig ... end

After a domain has been added to the organization, it must be verified. The domain is not yet verified.

Sourcemodule NameAvailabilityException : sig ... end

The user, group, or resource name isn't unique in WorkMail.

Sourcemodule BookingOptions : sig ... end

At least one delegate must be associated to the resource to disable automatic replies from the resource.

Sourcemodule NewResourceDescription : sig ... end

Sourcemodule MailboxQuota : sig ... end

Sourcemodule LimitExceededException : sig ... end

The request exceeds the limit of the resource.

Sourcemodule ResourceNotFoundException : sig ... end

The resource cannot be found.

Sourcemodule ImpersonationRoleDescription : sig ... end

Sourcemodule ImpersonationRuleList : sig ... end

Sourcemodule WorkMailDomainName : sig ... end

Sourcemodule EwsAvailabilityProvider : sig ... end

Describes an EWS based availability provider. This is only used as input to the service.

Sourcemodule AmazonResourceName : sig ... end

Sourcemodule TagKeyList : sig ... end

Sourcemodule TooManyTagsException : sig ... end

The resource can have up to 50 user-applied tags.

Sourcemodule TagList : sig ... end

Sourcemodule IdempotencyClientToken : sig ... end

Sourcemodule KmsKeyArn : sig ... end

Sourcemodule RoleArn : sig ... end

Sourcemodule InvalidPasswordException : sig ... end

The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

Sourcemodule EntityAlreadyRegisteredException : sig ... end

The user, group, or resource that you're trying to register is already registered.

Sourcemodule MailDomainInUseException : sig ... end

The domain you're trying to change is in use by another user or organization in your account. See the error message for details.

Sourcemodule FolderConfigurations : sig ... end

Sourcemodule PolicyDescription : sig ... end

Sourcemodule ShortString : sig ... end

Sourcemodule IdentityCenterConfiguration : sig ... end

The IAM Identity Center configuration.

Sourcemodule IdentityProviderAuthenticationMode : sig ... end

Sourcemodule PersonalAccessTokenConfiguration : sig ... end

Displays the Personal Access Token status.

Sourcemodule LogGroupArn : sig ... end

Sourcemodule NextToken : sig ... end

Sourcemodule Users : sig ... end

Sourcemodule ListUsersFilters : sig ... end

Filtering options for ListUsers operation. This is only used as input to Operation.

Sourcemodule MaxResults : sig ... end

Sourcemodule Resources : sig ... end

Sourcemodule ListResourcesFilters : sig ... end

Filtering options for ListResources operation. This is only used as input to Operation.

Sourcemodule ResourceDelegates : sig ... end

Sourcemodule PersonalAccessTokenSummaryList : sig ... end

Sourcemodule OrganizationSummaries : sig ... end

Sourcemodule MobileDeviceAccessRulesList : sig ... end

Sourcemodule MobileDeviceAccessOverridesList : sig ... end

Sourcemodule Permissions : sig ... end

Sourcemodule Jobs : sig ... end

Sourcemodule MailDomains : sig ... end

Sourcemodule ImpersonationRoleList : sig ... end

Sourcemodule Groups : sig ... end

Sourcemodule ListGroupsFilters : sig ... end

Filtering options for ListGroups operation. This is only used as input to Operation.

Sourcemodule GroupIdentifiers : sig ... end

Sourcemodule ListGroupsForEntityFilters : sig ... end

Filtering options for ListGroupsForEntity operation. This is only used as input to Operation.

Sourcemodule Members : sig ... end

Sourcemodule AvailabilityConfigurationList : sig ... end

Sourcemodule Aliases : sig ... end

Sourcemodule AccessControlRulesList : sig ... end

Sourcemodule MobileDeviceAccessMatchedRuleList : sig ... end

Sourcemodule MailboxSize : sig ... end

Sourcemodule DnsRecordVerificationStatus : sig ... end

Sourcemodule DnsRecords : sig ... end

Sourcemodule ImpersonationMatchedRuleList : sig ... end

Sourcemodule AccessControlRuleNameList : sig ... end

Sourcemodule IpAddress : sig ... end

Sourcemodule ResourceId : sig ... end

Sourcemodule MailboxExportErrorInfo : sig ... end

Sourcemodule EntityType : sig ... end

Sourcemodule InvalidCustomSesConfigurationException : sig ... end

You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.

Sourcemodule ReservedNameException : sig ... end

This user, group, or resource name is not allowed in WorkMail.

Sourcemodule DirectoryInUseException : sig ... end

The directory is already in use by another WorkMail organization in the same account and Region.

Sourcemodule DirectoryId : sig ... end

Sourcemodule Domains : sig ... end

Sourcemodule IdentityCenterApplicationName : sig ... end

Sourcemodule ExpiresIn : sig ... end

Sourcemodule ImpersonationToken : sig ... end

Sourcemodule UpdateUserResponse : sig ... end

Updates 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.

Sourcemodule UpdateUserRequest : sig ... end

Updates 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.

Sourcemodule UpdateResourceResponse : sig ... end

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

Sourcemodule UpdateResourceRequest : sig ... end

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

Sourcemodule UpdatePrimaryEmailAddressResponse : sig ... end

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

Sourcemodule UpdatePrimaryEmailAddressRequest : sig ... end

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

Sourcemodule UpdateMobileDeviceAccessRuleResponse : sig ... end

Updates a mobile device access rule for the specified WorkMail organization.

Sourcemodule UpdateMobileDeviceAccessRuleRequest : sig ... end

Updates a mobile device access rule for the specified WorkMail organization.

Sourcemodule UpdateMailboxQuotaResponse : sig ... end

Updates a user's current mailbox quota for a specified organization and user.

Sourcemodule UpdateMailboxQuotaRequest : sig ... end

Updates a user's current mailbox quota for a specified organization and user.

Sourcemodule UpdateImpersonationRoleResponse : sig ... end

Updates an impersonation role for the given WorkMail organization.

Sourcemodule UpdateImpersonationRoleRequest : sig ... end

Updates an impersonation role for the given WorkMail organization.

Sourcemodule UpdateGroupResponse : sig ... end

Updates attributes in a group.

Sourcemodule UpdateGroupRequest : sig ... end

Updates attributes in a group.

Sourcemodule UpdateDefaultMailDomainResponse : sig ... end

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

Sourcemodule UpdateDefaultMailDomainRequest : sig ... end

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

Sourcemodule UpdateAvailabilityConfigurationResponse : sig ... end

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

Sourcemodule UpdateAvailabilityConfigurationRequest : sig ... end

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

Sourcemodule UntagResourceResponse : sig ... end

Untags the specified tags from the specified WorkMail organization resource.

Sourcemodule UntagResourceRequest : sig ... end

Untags the specified tags from the specified WorkMail organization resource.

Sourcemodule TestAvailabilityConfigurationResponse : sig ... end

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header. The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.

Sourcemodule TestAvailabilityConfigurationRequest : sig ... end

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header. The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.

Sourcemodule TagResourceResponse : sig ... end

Applies the specified tags to the specified WorkMailorganization resource.

Sourcemodule TagResourceRequest : sig ... end

Applies the specified tags to the specified WorkMailorganization resource.

Sourcemodule StartMailboxExportJobResponse : sig ... end

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.

Sourcemodule StartMailboxExportJobRequest : sig ... end

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.

Sourcemodule ResetPasswordResponse : sig ... end

Allows the administrator to reset the password for a user.

Sourcemodule ResetPasswordRequest : sig ... end

Allows the administrator to reset the password for a user.

Sourcemodule RegisterToWorkMailResponse : sig ... end

Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

Sourcemodule RegisterToWorkMailRequest : sig ... end

Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

Sourcemodule RegisterMailDomainResponse : sig ... end

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.

Sourcemodule RegisterMailDomainRequest : sig ... end

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.

Sourcemodule PutRetentionPolicyResponse : sig ... end

Puts a retention policy to the specified organization.

Sourcemodule PutRetentionPolicyRequest : sig ... end

Puts a retention policy to the specified organization.

Sourcemodule PutMobileDeviceAccessOverrideResponse : sig ... end

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

Sourcemodule PutMobileDeviceAccessOverrideRequest : sig ... end

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

Sourcemodule PutMailboxPermissionsResponse : sig ... end

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

Sourcemodule PutMailboxPermissionsRequest : sig ... end

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

Sourcemodule PutInboundDmarcSettingsResponse : sig ... end

Enables or disables a DMARC policy for a given organization.

Sourcemodule PutInboundDmarcSettingsRequest : sig ... end

Enables or disables a DMARC policy for a given organization.

Sourcemodule PutIdentityProviderConfigurationResponse : sig ... end

Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and Personal Access Tokens.

Sourcemodule PutIdentityProviderConfigurationRequest : sig ... end

Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and Personal Access Tokens.

Sourcemodule PutEmailMonitoringConfigurationResponse : sig ... end

Creates or updates the email monitoring configuration for a specified organization.

Sourcemodule PutEmailMonitoringConfigurationRequest : sig ... end

Creates or updates the email monitoring configuration for a specified organization.

Sourcemodule PutAccessControlRuleResponse : sig ... end

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

Sourcemodule PutAccessControlRuleRequest : sig ... end

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

Sourcemodule ListUsersResponse : sig ... end

Returns summaries of the organization's users.

Sourcemodule ListUsersRequest : sig ... end

Returns summaries of the organization's users.

Sourcemodule ListTagsForResourceResponse : sig ... end

Lists the tags applied to an WorkMail organization resource.

Sourcemodule ListTagsForResourceRequest : sig ... end

Lists the tags applied to an WorkMail organization resource.

Sourcemodule ListResourcesResponse : sig ... end

Returns summaries of the organization's resources.

Sourcemodule ListResourcesRequest : sig ... end

Returns summaries of the organization's resources.

Sourcemodule ListResourceDelegatesResponse : sig ... end

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

Sourcemodule ListResourceDelegatesRequest : sig ... end

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

Sourcemodule ListPersonalAccessTokensResponse : sig ... end

Returns a summary of your Personal Access Tokens.

Sourcemodule ListPersonalAccessTokensRequest : sig ... end

Returns a summary of your Personal Access Tokens.

Sourcemodule ListOrganizationsResponse : sig ... end

Returns summaries of the customer's organizations.

Sourcemodule ListOrganizationsRequest : sig ... end

Returns summaries of the customer's organizations.

Sourcemodule ListMobileDeviceAccessRulesResponse : sig ... end

Lists the mobile device access rules for the specified WorkMail organization.

Sourcemodule ListMobileDeviceAccessRulesRequest : sig ... end

Lists the mobile device access rules for the specified WorkMail organization.

Sourcemodule ListMobileDeviceAccessOverridesResponse : sig ... end

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

Sourcemodule ListMobileDeviceAccessOverridesRequest : sig ... end

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

Sourcemodule ListMailboxPermissionsResponse : sig ... end

Lists the mailbox permissions associated with a user, group, or resource mailbox.

Sourcemodule ListMailboxPermissionsRequest : sig ... end

Lists the mailbox permissions associated with a user, group, or resource mailbox.

Sourcemodule ListMailboxExportJobsResponse : sig ... end

Lists the mailbox export jobs started for the specified organization within the last seven days.

Sourcemodule ListMailboxExportJobsRequest : sig ... end

Lists the mailbox export jobs started for the specified organization within the last seven days.

Sourcemodule ListMailDomainsResponse : sig ... end

Lists the mail domains in a given WorkMail organization.

Sourcemodule ListMailDomainsRequest : sig ... end

Lists the mail domains in a given WorkMail organization.

Sourcemodule ListImpersonationRolesResponse : sig ... end

Lists all the impersonation roles for the given WorkMail organization.

Sourcemodule ListImpersonationRolesRequest : sig ... end

Lists all the impersonation roles for the given WorkMail organization.

Sourcemodule ListGroupsResponse : sig ... end

Returns summaries of the organization's groups.

Sourcemodule ListGroupsRequest : sig ... end

Returns summaries of the organization's groups.

Sourcemodule ListGroupsForEntityResponse : sig ... end

Returns all the groups to which an entity belongs.

Sourcemodule ListGroupsForEntityRequest : sig ... end

Returns all the groups to which an entity belongs.

Sourcemodule ListGroupMembersResponse : sig ... end

Returns an overview of the members of a group. Users and groups can be members of a group.

Sourcemodule ListGroupMembersRequest : sig ... end

Returns an overview of the members of a group. Users and groups can be members of a group.

Sourcemodule ListAvailabilityConfigurationsResponse : sig ... end

List all the AvailabilityConfiguration's for the given WorkMail organization.

Sourcemodule ListAvailabilityConfigurationsRequest : sig ... end

List all the AvailabilityConfiguration's for the given WorkMail organization.

Sourcemodule ListAliasesResponse : sig ... end

Creates a paginated call to list the aliases associated with a given entity.

Sourcemodule ListAliasesRequest : sig ... end

Creates a paginated call to list the aliases associated with a given entity.

Sourcemodule ListAccessControlRulesResponse : sig ... end

Lists the access control rules for the specified organization.

Sourcemodule ListAccessControlRulesRequest : sig ... end

Lists the access control rules for the specified organization.

Sourcemodule GetPersonalAccessTokenMetadataResponse : sig ... end

Requests details of a specific Personal Access Token within the WorkMail organization.

Sourcemodule GetPersonalAccessTokenMetadataRequest : sig ... end

Requests details of a specific Personal Access Token within the WorkMail organization.

Sourcemodule GetMobileDeviceAccessOverrideResponse : sig ... end

Gets the mobile device access override for the given WorkMail organization, user, and device.

Sourcemodule GetMobileDeviceAccessOverrideRequest : sig ... end

Gets the mobile device access override for the given WorkMail organization, user, and device.

Sourcemodule GetMobileDeviceAccessEffectResponse : sig ... end

Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.

Sourcemodule GetMobileDeviceAccessEffectRequest : sig ... end

Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.

Sourcemodule GetMailboxDetailsResponse : sig ... end

Requests a user's mailbox details for a specified organization and user.

Sourcemodule GetMailboxDetailsRequest : sig ... end

Requests a user's mailbox details for a specified organization and user.

Sourcemodule GetMailDomainResponse : sig ... end

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

Sourcemodule GetMailDomainRequest : sig ... end

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

Sourcemodule GetImpersonationRoleResponse : sig ... end

Gets the impersonation role details for the given WorkMail organization.

Sourcemodule GetImpersonationRoleRequest : sig ... end

Gets the impersonation role details for the given WorkMail organization.

Sourcemodule GetImpersonationRoleEffectResponse : sig ... end

Tests whether the given impersonation role can impersonate a target user.

Sourcemodule GetImpersonationRoleEffectRequest : sig ... end

Tests whether the given impersonation role can impersonate a target user.

Sourcemodule GetDefaultRetentionPolicyResponse : sig ... end

Gets the default retention policy details for the specified organization.

Sourcemodule GetDefaultRetentionPolicyRequest : sig ... end

Gets the default retention policy details for the specified organization.

Sourcemodule GetAccessControlEffectResponse : sig ... end

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.

Sourcemodule GetAccessControlEffectRequest : sig ... end

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.

Sourcemodule DisassociateMemberFromGroupResponse : sig ... end

Removes a member from a group.

Sourcemodule DisassociateMemberFromGroupRequest : sig ... end

Removes a member from a group.

Sourcemodule DisassociateDelegateFromResourceResponse : sig ... end

Removes a member from the resource's set of delegates.

Sourcemodule DisassociateDelegateFromResourceRequest : sig ... end

Removes a member from the resource's set of delegates.

Sourcemodule DescribeUserResponse : sig ... end

Provides information regarding the user.

Sourcemodule DescribeUserRequest : sig ... end

Provides information regarding the user.

Sourcemodule DescribeResourceResponse : sig ... end

Returns the data available for the resource.

Sourcemodule DescribeResourceRequest : sig ... end

Returns the data available for the resource.

Sourcemodule DescribeOrganizationResponse : sig ... end

Provides more information regarding a given organization based on its identifier.

Sourcemodule DescribeOrganizationRequest : sig ... end

Provides more information regarding a given organization based on its identifier.

Sourcemodule DescribeMailboxExportJobResponse : sig ... end

Describes the current status of a mailbox export job.

Sourcemodule DescribeMailboxExportJobRequest : sig ... end

Describes the current status of a mailbox export job.

Sourcemodule DescribeInboundDmarcSettingsResponse : sig ... end

Lists the settings in a DMARC policy for a specified organization.

Sourcemodule DescribeInboundDmarcSettingsRequest : sig ... end

Lists the settings in a DMARC policy for a specified organization.

Sourcemodule DescribeIdentityProviderConfigurationResponse : sig ... end

Returns detailed information on the current IdC setup for the WorkMail organization.

Sourcemodule DescribeIdentityProviderConfigurationRequest : sig ... end

Returns detailed information on the current IdC setup for the WorkMail organization.

Sourcemodule DescribeGroupResponse : sig ... end

Returns the data available for the group.

Sourcemodule DescribeGroupRequest : sig ... end

Returns the data available for the group.

Sourcemodule DescribeEntityResponse : sig ... end

Returns basic details about an entity in WorkMail.

Sourcemodule DescribeEntityRequest : sig ... end

Returns basic details about an entity in WorkMail.

Sourcemodule DescribeEmailMonitoringConfigurationResponse : sig ... end

Describes the current email monitoring configuration for a specified organization.

Sourcemodule DescribeEmailMonitoringConfigurationRequest : sig ... end

Describes the current email monitoring configuration for a specified organization.

Sourcemodule DeregisterMailDomainResponse : sig ... end

Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.

Sourcemodule DeregisterMailDomainRequest : sig ... end

Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.

Sourcemodule DeregisterFromWorkMailResponse : sig ... end

Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

Sourcemodule DeregisterFromWorkMailRequest : sig ... end

Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

Sourcemodule DeleteUserResponse : sig ... end

Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state. Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

Sourcemodule DeleteUserRequest : sig ... end

Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state. Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

Sourcemodule DeleteRetentionPolicyResponse : sig ... end

Deletes the specified retention policy from the specified organization.

Sourcemodule DeleteRetentionPolicyRequest : sig ... end

Deletes the specified retention policy from the specified organization.

Sourcemodule DeleteResourceResponse : sig ... end

Deletes the specified resource.

Sourcemodule DeleteResourceRequest : sig ... end

Deletes the specified resource.

Sourcemodule DeletePersonalAccessTokenResponse : sig ... end

Deletes the Personal Access Token from the provided WorkMail Organization.

Sourcemodule DeletePersonalAccessTokenRequest : sig ... end

Deletes the Personal Access Token from the provided WorkMail Organization.

Sourcemodule DeleteOrganizationResponse : sig ... end

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.

Sourcemodule DeleteOrganizationRequest : sig ... end

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.

Sourcemodule DeleteMobileDeviceAccessRuleResponse : sig ... end

Deletes a mobile device access rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Sourcemodule DeleteMobileDeviceAccessRuleRequest : sig ... end

Deletes a mobile device access rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Sourcemodule DeleteMobileDeviceAccessOverrideResponse : sig ... end

Deletes the mobile device access override for the given WorkMail organization, user, and device. Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Sourcemodule DeleteMobileDeviceAccessOverrideRequest : sig ... end

Deletes the mobile device access override for the given WorkMail organization, user, and device. Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Sourcemodule DeleteMailboxPermissionsResponse : sig ... end

Deletes permissions granted to a member (user or group).

Sourcemodule DeleteMailboxPermissionsRequest : sig ... end

Deletes permissions granted to a member (user or group).

Sourcemodule DeleteImpersonationRoleResponse : sig ... end

Deletes an impersonation role for the given WorkMail organization.

Sourcemodule DeleteImpersonationRoleRequest : sig ... end

Deletes an impersonation role for the given WorkMail organization.

Sourcemodule DeleteIdentityProviderConfigurationResponse : sig ... end

Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.

Sourcemodule DeleteIdentityProviderConfigurationRequest : sig ... end

Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.

Sourcemodule DeleteIdentityCenterApplicationResponse : sig ... end

Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations.

Sourcemodule DeleteIdentityCenterApplicationRequest : sig ... end

Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations.

Sourcemodule DeleteGroupResponse : sig ... end

Deletes a group from WorkMail.

Sourcemodule DeleteGroupRequest : sig ... end

Deletes a group from WorkMail.

Sourcemodule DeleteEmailMonitoringConfigurationResponse : sig ... end

Deletes the email monitoring configuration for a specified organization.

Sourcemodule DeleteEmailMonitoringConfigurationRequest : sig ... end

Deletes the email monitoring configuration for a specified organization.

Sourcemodule DeleteAvailabilityConfigurationResponse : sig ... end

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

Sourcemodule DeleteAvailabilityConfigurationRequest : sig ... end

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

Sourcemodule DeleteAliasResponse : sig ... end

Remove one or more specified aliases from a set of aliases for a given user.

Sourcemodule DeleteAliasRequest : sig ... end

Remove one or more specified aliases from a set of aliases for a given user.

Sourcemodule DeleteAccessControlRuleResponse : sig ... end

Deletes an access control rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Sourcemodule DeleteAccessControlRuleRequest : sig ... end

Deletes an access control rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Sourcemodule CreateUserResponse : sig ... end

Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.

Sourcemodule CreateUserRequest : sig ... end

Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.

Sourcemodule CreateResourceResponse : sig ... end

Creates a new WorkMail resource.

Sourcemodule CreateResourceRequest : sig ... end

Creates a new WorkMail resource.

Sourcemodule CreateOrganizationResponse : sig ... end

Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide. You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide. Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.

Sourcemodule CreateOrganizationRequest : sig ... end

Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide. You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide. Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.

Sourcemodule CreateMobileDeviceAccessRuleResponse : sig ... end

Creates a new mobile device access rule for the specified WorkMail organization.

Sourcemodule CreateMobileDeviceAccessRuleRequest : sig ... end

Creates a new mobile device access rule for the specified WorkMail organization.

Sourcemodule CreateImpersonationRoleResponse : sig ... end

Creates an impersonation role for the given WorkMail organization. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.

Sourcemodule CreateImpersonationRoleRequest : sig ... end

Creates an impersonation role for the given WorkMail organization. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.

Sourcemodule CreateIdentityCenterApplicationResponse : sig ... end

Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication settings for any WorkMail organizations.

Sourcemodule CreateIdentityCenterApplicationRequest : sig ... end

Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication settings for any WorkMail organizations.

Sourcemodule CreateGroupResponse : sig ... end

Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.

Sourcemodule CreateGroupRequest : sig ... end

Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.

Sourcemodule CreateAvailabilityConfigurationResponse : sig ... end

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

Sourcemodule CreateAvailabilityConfigurationRequest : sig ... end

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

Sourcemodule CreateAliasResponse : sig ... end

Adds an alias to the set of a given member (user or group) of WorkMail.

Sourcemodule CreateAliasRequest : sig ... end

Adds an alias to the set of a given member (user or group) of WorkMail.

Sourcemodule CancelMailboxExportJobResponse : sig ... end

Cancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it.

Sourcemodule CancelMailboxExportJobRequest : sig ... end

Cancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it.

Sourcemodule AssumeImpersonationRoleResponse : sig ... end

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.

Sourcemodule AssumeImpersonationRoleRequest : sig ... end

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.

Sourcemodule AssociateMemberToGroupResponse : sig ... end

Adds a member (user or group) to the group's set.

Sourcemodule AssociateMemberToGroupRequest : sig ... end

Adds a member (user or group) to the group's set.

Sourcemodule AssociateDelegateToResourceResponse : sig ... end

Adds a member (user or group) to the resource's set of delegates.

Sourcemodule AssociateDelegateToResourceRequest : sig ... end

Adds a member (user or group) to the resource's set of delegates.