Module Awso_workmail_syncSource

include module type of struct include Awso_workmail.Values end
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
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule PersonalAccessTokenScope = Awso_workmail.Values.PersonalAccessTokenScope
Sourcemodule ImpersonationRuleDescription = Awso_workmail.Values.ImpersonationRuleDescription
Sourcemodule IdentityProviderIdentityStoreId = Awso_workmail.Values.IdentityProviderIdentityStoreId
Sourcemodule PersonalAccessTokenScopeList = Awso_workmail.Values.PersonalAccessTokenScopeList
Sourcemodule DeviceOperatingSystemList = Awso_workmail.Values.DeviceOperatingSystemList
Sourcemodule MobileDeviceAccessRuleDescription = Awso_workmail.Values.MobileDeviceAccessRuleDescription
Sourcemodule MobileDeviceAccessRuleEffect = Awso_workmail.Values.MobileDeviceAccessRuleEffect
Sourcemodule MobileDeviceAccessRuleId = Awso_workmail.Values.MobileDeviceAccessRuleId
Sourcemodule MobileDeviceAccessRuleName = Awso_workmail.Values.MobileDeviceAccessRuleName
Sourcemodule AvailabilityProviderType = Awso_workmail.Values.AvailabilityProviderType
Sourcemodule LambdaAvailabilityProvider = Awso_workmail.Values.LambdaAvailabilityProvider

Describes a Lambda based availability provider.

Sourcemodule RedactedEwsAvailabilityProvider = Awso_workmail.Values.RedactedEwsAvailabilityProvider

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

Sourcemodule AccessControlRuleDescription = Awso_workmail.Values.AccessControlRuleDescription

The rules for the given impersonation role.

Describes a tag applied to a resource.

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

Sourcemodule PersonalAccessTokenConfigurationStatus = Awso_workmail.Values.PersonalAccessTokenConfigurationStatus
Sourcemodule PersonalAccessTokenLifetimeInDays = Awso_workmail.Values.PersonalAccessTokenLifetimeInDays

The representation of an WorkMail user.

Sourcemodule IdentityProviderUserIdPrefix = Awso_workmail.Values.IdentityProviderUserIdPrefix

The representation of a resource.

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

Sourcemodule PersonalAccessTokenSummary = Awso_workmail.Values.PersonalAccessTokenSummary

The summary of the Personal Access Token.

The representation of an organization.

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

Sourcemodule MobileDeviceAccessOverride = Awso_workmail.Values.MobileDeviceAccessOverride

The override object.

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

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.

The data for a given domain.

An impersonation role for the given WorkMail organization.

The representation of an WorkMail group.

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

The representation of a user or group.

Sourcemodule AvailabilityConfiguration = Awso_workmail.Values.AvailabilityConfiguration

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

A rule that controls access to an WorkMail organization.

Sourcemodule MobileDeviceAccessMatchedRule = Awso_workmail.Values.MobileDeviceAccessMatchedRule

The rule that a simulated user matches.

A DNS record uploaded to your DNS provider.

Sourcemodule ImpersonationMatchedRule = Awso_workmail.Values.ImpersonationMatchedRule

The impersonation rule that matched the input.

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 = Awso_workmail.Values.DirectoryServiceAuthenticationFailedException

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

Sourcemodule DirectoryUnavailableException = Awso_workmail.Values.DirectoryUnavailableException

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

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

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 = Awso_workmail.Values.InvalidParameterException

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

Sourcemodule OrganizationNotFoundException = Awso_workmail.Values.OrganizationNotFoundException

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

Sourcemodule OrganizationStateException = Awso_workmail.Values.OrganizationStateException

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

Sourcemodule UnsupportedOperationException = Awso_workmail.Values.UnsupportedOperationException

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

Sourcemodule IdentityProviderUserIdForUpdate = Awso_workmail.Values.IdentityProviderUserIdForUpdate
Sourcemodule EmailAddressInUseException = Awso_workmail.Values.EmailAddressInUseException

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

Sourcemodule InvalidConfigurationException = Awso_workmail.Values.InvalidConfigurationException

The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.

Sourcemodule MailDomainNotFoundException = Awso_workmail.Values.MailDomainNotFoundException

The domain specified is not found in your organization.

Sourcemodule MailDomainStateException = Awso_workmail.Values.MailDomainStateException

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

Sourcemodule NameAvailabilityException = Awso_workmail.Values.NameAvailabilityException

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

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

The request exceeds the limit of the resource.

Sourcemodule ResourceNotFoundException = Awso_workmail.Values.ResourceNotFoundException

The resource cannot be found.

Sourcemodule ImpersonationRoleDescription = Awso_workmail.Values.ImpersonationRoleDescription

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

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

Sourcemodule InvalidPasswordException = Awso_workmail.Values.InvalidPasswordException

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

Sourcemodule EntityAlreadyRegisteredException = Awso_workmail.Values.EntityAlreadyRegisteredException

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

Sourcemodule MailDomainInUseException = Awso_workmail.Values.MailDomainInUseException

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 IdentityCenterConfiguration = Awso_workmail.Values.IdentityCenterConfiguration

The IAM Identity Center configuration.

Sourcemodule IdentityProviderAuthenticationMode = Awso_workmail.Values.IdentityProviderAuthenticationMode
Sourcemodule PersonalAccessTokenConfiguration = Awso_workmail.Values.PersonalAccessTokenConfiguration

Displays the Personal Access Token status.

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

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

Sourcemodule PersonalAccessTokenSummaryList = Awso_workmail.Values.PersonalAccessTokenSummaryList
Sourcemodule MobileDeviceAccessRulesList = Awso_workmail.Values.MobileDeviceAccessRulesList
Sourcemodule MobileDeviceAccessOverridesList = Awso_workmail.Values.MobileDeviceAccessOverridesList

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

Sourcemodule ListGroupsForEntityFilters = Awso_workmail.Values.ListGroupsForEntityFilters

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

Sourcemodule AvailabilityConfigurationList = Awso_workmail.Values.AvailabilityConfigurationList
Sourcemodule MobileDeviceAccessMatchedRuleList = Awso_workmail.Values.MobileDeviceAccessMatchedRuleList
Sourcemodule DnsRecordVerificationStatus = Awso_workmail.Values.DnsRecordVerificationStatus
Sourcemodule ImpersonationMatchedRuleList = Awso_workmail.Values.ImpersonationMatchedRuleList
Sourcemodule AccessControlRuleNameList = Awso_workmail.Values.AccessControlRuleNameList
Sourcemodule InvalidCustomSesConfigurationException = Awso_workmail.Values.InvalidCustomSesConfigurationException

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

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

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

Sourcemodule IdentityCenterApplicationName = Awso_workmail.Values.IdentityCenterApplicationName

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.

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.

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.

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 = Awso_workmail.Values.UpdatePrimaryEmailAddressResponse

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 = Awso_workmail.Values.UpdatePrimaryEmailAddressRequest

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 = Awso_workmail.Values.UpdateMobileDeviceAccessRuleResponse

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

Sourcemodule UpdateMobileDeviceAccessRuleRequest = Awso_workmail.Values.UpdateMobileDeviceAccessRuleRequest

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

Sourcemodule UpdateMailboxQuotaResponse = Awso_workmail.Values.UpdateMailboxQuotaResponse

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

Sourcemodule UpdateMailboxQuotaRequest = Awso_workmail.Values.UpdateMailboxQuotaRequest

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

Sourcemodule UpdateImpersonationRoleResponse = Awso_workmail.Values.UpdateImpersonationRoleResponse

Updates an impersonation role for the given WorkMail organization.

Sourcemodule UpdateImpersonationRoleRequest = Awso_workmail.Values.UpdateImpersonationRoleRequest

Updates an impersonation role for the given WorkMail organization.

Updates attributes in a group.

Updates attributes in a group.

Sourcemodule UpdateDefaultMailDomainResponse = Awso_workmail.Values.UpdateDefaultMailDomainResponse

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 = Awso_workmail.Values.UpdateDefaultMailDomainRequest

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 = Awso_workmail.Values.UpdateAvailabilityConfigurationResponse

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

Sourcemodule UpdateAvailabilityConfigurationRequest = Awso_workmail.Values.UpdateAvailabilityConfigurationRequest

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

Untags the specified tags from the specified WorkMail organization resource.

Untags the specified tags from the specified WorkMail organization resource.

Sourcemodule TestAvailabilityConfigurationResponse = Awso_workmail.Values.TestAvailabilityConfigurationResponse

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 = Awso_workmail.Values.TestAvailabilityConfigurationRequest

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.

Applies the specified tags to the specified WorkMailorganization resource.

Applies the specified tags to the specified WorkMailorganization resource.

Sourcemodule StartMailboxExportJobResponse = Awso_workmail.Values.StartMailboxExportJobResponse

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 = Awso_workmail.Values.StartMailboxExportJobRequest

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.

Allows the administrator to reset the password for a user.

Allows the administrator to reset the password for a user.

Sourcemodule RegisterToWorkMailResponse = Awso_workmail.Values.RegisterToWorkMailResponse

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 = Awso_workmail.Values.RegisterToWorkMailRequest

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 = Awso_workmail.Values.RegisterMailDomainResponse

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 = Awso_workmail.Values.RegisterMailDomainRequest

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 = Awso_workmail.Values.PutRetentionPolicyResponse

Puts a retention policy to the specified organization.

Sourcemodule PutRetentionPolicyRequest = Awso_workmail.Values.PutRetentionPolicyRequest

Puts a retention policy to the specified organization.

Sourcemodule PutMobileDeviceAccessOverrideResponse = Awso_workmail.Values.PutMobileDeviceAccessOverrideResponse

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

Sourcemodule PutMobileDeviceAccessOverrideRequest = Awso_workmail.Values.PutMobileDeviceAccessOverrideRequest

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

Sourcemodule PutMailboxPermissionsResponse = Awso_workmail.Values.PutMailboxPermissionsResponse

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

Sourcemodule PutMailboxPermissionsRequest = Awso_workmail.Values.PutMailboxPermissionsRequest

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

Sourcemodule PutInboundDmarcSettingsResponse = Awso_workmail.Values.PutInboundDmarcSettingsResponse

Enables or disables a DMARC policy for a given organization.

Sourcemodule PutInboundDmarcSettingsRequest = Awso_workmail.Values.PutInboundDmarcSettingsRequest

Enables or disables a DMARC policy for a given organization.

Sourcemodule PutIdentityProviderConfigurationResponse = Awso_workmail.Values.PutIdentityProviderConfigurationResponse

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 = Awso_workmail.Values.PutIdentityProviderConfigurationRequest

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 = Awso_workmail.Values.PutEmailMonitoringConfigurationResponse

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

Sourcemodule PutEmailMonitoringConfigurationRequest = Awso_workmail.Values.PutEmailMonitoringConfigurationRequest

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

Sourcemodule PutAccessControlRuleResponse = Awso_workmail.Values.PutAccessControlRuleResponse

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 = Awso_workmail.Values.PutAccessControlRuleRequest

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.

Returns summaries of the organization's users.

Returns summaries of the organization's users.

Sourcemodule ListTagsForResourceResponse = Awso_workmail.Values.ListTagsForResourceResponse

Lists the tags applied to an WorkMail organization resource.

Sourcemodule ListTagsForResourceRequest = Awso_workmail.Values.ListTagsForResourceRequest

Lists the tags applied to an WorkMail organization resource.

Returns summaries of the organization's resources.

Returns summaries of the organization's resources.

Sourcemodule ListResourceDelegatesResponse = Awso_workmail.Values.ListResourceDelegatesResponse

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

Sourcemodule ListResourceDelegatesRequest = Awso_workmail.Values.ListResourceDelegatesRequest

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

Sourcemodule ListPersonalAccessTokensResponse = Awso_workmail.Values.ListPersonalAccessTokensResponse

Returns a summary of your Personal Access Tokens.

Sourcemodule ListPersonalAccessTokensRequest = Awso_workmail.Values.ListPersonalAccessTokensRequest

Returns a summary of your Personal Access Tokens.

Sourcemodule ListOrganizationsResponse = Awso_workmail.Values.ListOrganizationsResponse

Returns summaries of the customer's organizations.

Sourcemodule ListOrganizationsRequest = Awso_workmail.Values.ListOrganizationsRequest

Returns summaries of the customer's organizations.

Sourcemodule ListMobileDeviceAccessRulesResponse = Awso_workmail.Values.ListMobileDeviceAccessRulesResponse

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

Sourcemodule ListMobileDeviceAccessRulesRequest = Awso_workmail.Values.ListMobileDeviceAccessRulesRequest

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

Sourcemodule ListMobileDeviceAccessOverridesResponse = Awso_workmail.Values.ListMobileDeviceAccessOverridesResponse

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

Sourcemodule ListMobileDeviceAccessOverridesRequest = Awso_workmail.Values.ListMobileDeviceAccessOverridesRequest

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

Sourcemodule ListMailboxPermissionsResponse = Awso_workmail.Values.ListMailboxPermissionsResponse

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

Sourcemodule ListMailboxPermissionsRequest = Awso_workmail.Values.ListMailboxPermissionsRequest

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

Sourcemodule ListMailboxExportJobsResponse = Awso_workmail.Values.ListMailboxExportJobsResponse

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

Sourcemodule ListMailboxExportJobsRequest = Awso_workmail.Values.ListMailboxExportJobsRequest

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

Lists the mail domains in a given WorkMail organization.

Lists the mail domains in a given WorkMail organization.

Sourcemodule ListImpersonationRolesResponse = Awso_workmail.Values.ListImpersonationRolesResponse

Lists all the impersonation roles for the given WorkMail organization.

Sourcemodule ListImpersonationRolesRequest = Awso_workmail.Values.ListImpersonationRolesRequest

Lists all the impersonation roles for the given WorkMail organization.

Returns summaries of the organization's groups.

Returns summaries of the organization's groups.

Sourcemodule ListGroupsForEntityResponse = Awso_workmail.Values.ListGroupsForEntityResponse

Returns all the groups to which an entity belongs.

Sourcemodule ListGroupsForEntityRequest = Awso_workmail.Values.ListGroupsForEntityRequest

Returns all the groups to which an entity belongs.

Sourcemodule ListGroupMembersResponse = Awso_workmail.Values.ListGroupMembersResponse

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

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

Sourcemodule ListAvailabilityConfigurationsResponse = Awso_workmail.Values.ListAvailabilityConfigurationsResponse

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

Sourcemodule ListAvailabilityConfigurationsRequest = Awso_workmail.Values.ListAvailabilityConfigurationsRequest

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

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

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

Sourcemodule ListAccessControlRulesResponse = Awso_workmail.Values.ListAccessControlRulesResponse

Lists the access control rules for the specified organization.

Sourcemodule ListAccessControlRulesRequest = Awso_workmail.Values.ListAccessControlRulesRequest

Lists the access control rules for the specified organization.

Sourcemodule GetPersonalAccessTokenMetadataResponse = Awso_workmail.Values.GetPersonalAccessTokenMetadataResponse

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

Sourcemodule GetPersonalAccessTokenMetadataRequest = Awso_workmail.Values.GetPersonalAccessTokenMetadataRequest

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

Sourcemodule GetMobileDeviceAccessOverrideResponse = Awso_workmail.Values.GetMobileDeviceAccessOverrideResponse

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

Sourcemodule GetMobileDeviceAccessOverrideRequest = Awso_workmail.Values.GetMobileDeviceAccessOverrideRequest

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

Sourcemodule GetMobileDeviceAccessEffectResponse = Awso_workmail.Values.GetMobileDeviceAccessEffectResponse

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 = Awso_workmail.Values.GetMobileDeviceAccessEffectRequest

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 = Awso_workmail.Values.GetMailboxDetailsResponse

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

Sourcemodule GetMailboxDetailsRequest = Awso_workmail.Values.GetMailboxDetailsRequest

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

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

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

Sourcemodule GetImpersonationRoleResponse = Awso_workmail.Values.GetImpersonationRoleResponse

Gets the impersonation role details for the given WorkMail organization.

Sourcemodule GetImpersonationRoleRequest = Awso_workmail.Values.GetImpersonationRoleRequest

Gets the impersonation role details for the given WorkMail organization.

Sourcemodule GetImpersonationRoleEffectResponse = Awso_workmail.Values.GetImpersonationRoleEffectResponse

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

Sourcemodule GetImpersonationRoleEffectRequest = Awso_workmail.Values.GetImpersonationRoleEffectRequest

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

Sourcemodule GetDefaultRetentionPolicyResponse = Awso_workmail.Values.GetDefaultRetentionPolicyResponse

Gets the default retention policy details for the specified organization.

Sourcemodule GetDefaultRetentionPolicyRequest = Awso_workmail.Values.GetDefaultRetentionPolicyRequest

Gets the default retention policy details for the specified organization.

Sourcemodule GetAccessControlEffectResponse = Awso_workmail.Values.GetAccessControlEffectResponse

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 = Awso_workmail.Values.GetAccessControlEffectRequest

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 = Awso_workmail.Values.DisassociateMemberFromGroupResponse

Removes a member from a group.

Sourcemodule DisassociateMemberFromGroupRequest = Awso_workmail.Values.DisassociateMemberFromGroupRequest

Removes a member from a group.

Sourcemodule DisassociateDelegateFromResourceResponse = Awso_workmail.Values.DisassociateDelegateFromResourceResponse

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

Sourcemodule DisassociateDelegateFromResourceRequest = Awso_workmail.Values.DisassociateDelegateFromResourceRequest

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

Provides information regarding the user.

Provides information regarding the user.

Sourcemodule DescribeResourceResponse = Awso_workmail.Values.DescribeResourceResponse

Returns the data available for the resource.

Returns the data available for the resource.

Sourcemodule DescribeOrganizationResponse = Awso_workmail.Values.DescribeOrganizationResponse

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

Sourcemodule DescribeOrganizationRequest = Awso_workmail.Values.DescribeOrganizationRequest

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

Sourcemodule DescribeMailboxExportJobResponse = Awso_workmail.Values.DescribeMailboxExportJobResponse

Describes the current status of a mailbox export job.

Sourcemodule DescribeMailboxExportJobRequest = Awso_workmail.Values.DescribeMailboxExportJobRequest

Describes the current status of a mailbox export job.

Sourcemodule DescribeInboundDmarcSettingsResponse = Awso_workmail.Values.DescribeInboundDmarcSettingsResponse

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

Sourcemodule DescribeInboundDmarcSettingsRequest = Awso_workmail.Values.DescribeInboundDmarcSettingsRequest

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

Sourcemodule DescribeIdentityProviderConfigurationResponse = Awso_workmail.Values.DescribeIdentityProviderConfigurationResponse

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

Sourcemodule DescribeIdentityProviderConfigurationRequest = Awso_workmail.Values.DescribeIdentityProviderConfigurationRequest

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

Returns the data available for the group.

Returns the data available for the group.

Returns basic details about an entity in WorkMail.

Returns basic details about an entity in WorkMail.

Sourcemodule DescribeEmailMonitoringConfigurationResponse = Awso_workmail.Values.DescribeEmailMonitoringConfigurationResponse

Describes the current email monitoring configuration for a specified organization.

Sourcemodule DescribeEmailMonitoringConfigurationRequest = Awso_workmail.Values.DescribeEmailMonitoringConfigurationRequest

Describes the current email monitoring configuration for a specified organization.

Sourcemodule DeregisterMailDomainResponse = Awso_workmail.Values.DeregisterMailDomainResponse

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 = Awso_workmail.Values.DeregisterMailDomainRequest

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 = Awso_workmail.Values.DeregisterFromWorkMailResponse

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 = Awso_workmail.Values.DeregisterFromWorkMailRequest

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.

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.

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 = Awso_workmail.Values.DeleteRetentionPolicyResponse

Deletes the specified retention policy from the specified organization.

Sourcemodule DeleteRetentionPolicyRequest = Awso_workmail.Values.DeleteRetentionPolicyRequest

Deletes the specified retention policy from the specified organization.

Deletes the specified resource.

Deletes the specified resource.

Sourcemodule DeletePersonalAccessTokenResponse = Awso_workmail.Values.DeletePersonalAccessTokenResponse

Deletes the Personal Access Token from the provided WorkMail Organization.

Sourcemodule DeletePersonalAccessTokenRequest = Awso_workmail.Values.DeletePersonalAccessTokenRequest

Deletes the Personal Access Token from the provided WorkMail Organization.

Sourcemodule DeleteOrganizationResponse = Awso_workmail.Values.DeleteOrganizationResponse

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 = Awso_workmail.Values.DeleteOrganizationRequest

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 = Awso_workmail.Values.DeleteMobileDeviceAccessRuleResponse

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 = Awso_workmail.Values.DeleteMobileDeviceAccessRuleRequest

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 = Awso_workmail.Values.DeleteMobileDeviceAccessOverrideResponse

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 = Awso_workmail.Values.DeleteMobileDeviceAccessOverrideRequest

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 = Awso_workmail.Values.DeleteMailboxPermissionsResponse

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

Sourcemodule DeleteMailboxPermissionsRequest = Awso_workmail.Values.DeleteMailboxPermissionsRequest

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

Sourcemodule DeleteImpersonationRoleResponse = Awso_workmail.Values.DeleteImpersonationRoleResponse

Deletes an impersonation role for the given WorkMail organization.

Sourcemodule DeleteImpersonationRoleRequest = Awso_workmail.Values.DeleteImpersonationRoleRequest

Deletes an impersonation role for the given WorkMail organization.

Sourcemodule DeleteIdentityProviderConfigurationResponse = Awso_workmail.Values.DeleteIdentityProviderConfigurationResponse

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 = Awso_workmail.Values.DeleteIdentityProviderConfigurationRequest

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 = Awso_workmail.Values.DeleteIdentityCenterApplicationResponse

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

Sourcemodule DeleteIdentityCenterApplicationRequest = Awso_workmail.Values.DeleteIdentityCenterApplicationRequest

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

Deletes a group from WorkMail.

Deletes a group from WorkMail.

Sourcemodule DeleteEmailMonitoringConfigurationResponse = Awso_workmail.Values.DeleteEmailMonitoringConfigurationResponse

Deletes the email monitoring configuration for a specified organization.

Sourcemodule DeleteEmailMonitoringConfigurationRequest = Awso_workmail.Values.DeleteEmailMonitoringConfigurationRequest

Deletes the email monitoring configuration for a specified organization.

Sourcemodule DeleteAvailabilityConfigurationResponse = Awso_workmail.Values.DeleteAvailabilityConfigurationResponse

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

Sourcemodule DeleteAvailabilityConfigurationRequest = Awso_workmail.Values.DeleteAvailabilityConfigurationRequest

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

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

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

Sourcemodule DeleteAccessControlRuleResponse = Awso_workmail.Values.DeleteAccessControlRuleResponse

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 = Awso_workmail.Values.DeleteAccessControlRuleRequest

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.

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

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

Creates a new WorkMail resource.

Creates a new WorkMail resource.

Sourcemodule CreateOrganizationResponse = Awso_workmail.Values.CreateOrganizationResponse

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 = Awso_workmail.Values.CreateOrganizationRequest

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 = Awso_workmail.Values.CreateMobileDeviceAccessRuleResponse

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

Sourcemodule CreateMobileDeviceAccessRuleRequest = Awso_workmail.Values.CreateMobileDeviceAccessRuleRequest

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

Sourcemodule CreateImpersonationRoleResponse = Awso_workmail.Values.CreateImpersonationRoleResponse

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 = Awso_workmail.Values.CreateImpersonationRoleRequest

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 = Awso_workmail.Values.CreateIdentityCenterApplicationResponse

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 = Awso_workmail.Values.CreateIdentityCenterApplicationRequest

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.

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

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

Sourcemodule CreateAvailabilityConfigurationResponse = Awso_workmail.Values.CreateAvailabilityConfigurationResponse

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

Sourcemodule CreateAvailabilityConfigurationRequest = Awso_workmail.Values.CreateAvailabilityConfigurationRequest

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

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

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

Sourcemodule CancelMailboxExportJobResponse = Awso_workmail.Values.CancelMailboxExportJobResponse

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

Sourcemodule CancelMailboxExportJobRequest = Awso_workmail.Values.CancelMailboxExportJobRequest

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

Sourcemodule AssumeImpersonationRoleResponse = Awso_workmail.Values.AssumeImpersonationRoleResponse

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

Sourcemodule AssumeImpersonationRoleRequest = Awso_workmail.Values.AssumeImpersonationRoleRequest

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

Sourcemodule AssociateMemberToGroupResponse = Awso_workmail.Values.AssociateMemberToGroupResponse

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

Sourcemodule AssociateMemberToGroupRequest = Awso_workmail.Values.AssociateMemberToGroupRequest

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

Sourcemodule AssociateDelegateToResourceResponse = Awso_workmail.Values.AssociateDelegateToResourceResponse

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

Sourcemodule AssociateDelegateToResourceRequest = Awso_workmail.Values.AssociateDelegateToResourceRequest

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