aws workmail
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. AWS CLI reference
92 commands Its page in the AWS CLI reference
Commands
associate-delegate-to-resourceAdds a member (user or group) to the resource's set of delegates.associate-member-to-groupAdds a member (user or group) to the group's set.assume-impersonation-roleAssumes an impersonation role for the given WorkMail organization.cancel-mailbox-export-jobCancels a mailbox export job.create-aliasAdds an alias to the set of a given member (user or group) of WorkMail.create-availability-configurationCreates an AvailabilityConfiguration for the given WorkMail organization and domain.create-groupCreates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.create-identity-center-applicationCreates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration.create-impersonation-roleCreates an impersonation role for the given WorkMail organization.create-mobile-device-access-ruleCreates a new mobile device access rule for the specified WorkMail organization.create-organizationCreates a new WorkMail organization.create-resourceCreates a new WorkMail resource.create-userCreates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.delete-access-control-ruleDeletes an access control rule for the specified WorkMail organization.delete-aliasRemove one or more specified aliases from a set of aliases for a given user.delete-availability-configurationDeletes the AvailabilityConfiguration for the given WorkMail organization and domain.delete-email-monitoring-configurationDeletes the email monitoring configuration for a specified organization.delete-groupDeletes a group from WorkMail.delete-identity-center-applicationDeletes the IAM Identity Center application from WorkMail.delete-identity-provider-configurationDisables the integration between IdC and WorkMail.delete-impersonation-roleDeletes an impersonation role for the given WorkMail organization.delete-mailbox-permissionsDeletes permissions granted to a member (user or group).delete-mobile-device-access-overrideDeletes the mobile device access override for the given WorkMail organization, user, and device.delete-mobile-device-access-ruleDeletes a mobile device access rule for the specified WorkMail organization.delete-organizationDeletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization.delete-personal-access-tokenDeletes the Personal Access Token from the provided WorkMail Organization.delete-resourceDeletes the specified resource.delete-retention-policyDeletes the specified retention policy from the specified organization.delete-userDeletes a user from WorkMail and all subsequent systems.deregister-from-work-mailMark a user, group, or resource as no longer used in WorkMail.deregister-mail-domainRemoves a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use.describe-email-monitoring-configurationDescribes the current email monitoring configuration for a specified organization.describe-entityReturns basic details about an entity in WorkMail.describe-groupReturns the data available for the group.describe-identity-provider-configurationReturns detailed information on the current IdC setup for the WorkMail organization.describe-inbound-dmarc-settingsLists the settings in a DMARC policy for a specified organization.describe-mailbox-export-jobDescribes the current status of a mailbox export job.describe-organizationProvides more information regarding a given organization based on its identifier.describe-resourceReturns the data available for the resource.describe-userProvides information regarding the user.disassociate-delegate-from-resourceRemoves a member from the resource's set of delegates.disassociate-member-from-groupRemoves a member from a group.get-access-control-effectGets 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.get-default-retention-policyGets the default retention policy details for the specified organization.get-impersonation-roleGets the impersonation role details for the given WorkMail organization.get-impersonation-role-effectTests whether the given impersonation role can impersonate a target user.get-mail-domainGets details for a mail domain, including domain records required to configure your domain with recommended security.get-mailbox-detailsRequests a user's mailbox details for a specified organization and user.get-mobile-device-access-effectSimulates the effect of the mobile device access rules for the given attributes of a sample access event.get-mobile-device-access-overrideGets the mobile device access override for the given WorkMail organization, user, and device.get-personal-access-token-metadataRequests details of a specific Personal Access Token within the WorkMail organization.list-access-control-rulesLists the access control rules for the specified organization.list-aliasesCreates a paginated call to list the aliases associated with a given entity.list-availability-configurationsList all the AvailabilityConfiguration's for the given WorkMail organization.list-group-membersReturns an overview of the members of a group.list-groupsReturns summaries of the organization's groups.list-groups-for-entityReturns all the groups to which an entity belongs.list-impersonation-rolesLists all the impersonation roles for the given WorkMail organization.list-mail-domainsLists the mail domains in a given WorkMail organization.list-mailbox-export-jobsLists the mailbox export jobs started for the specified organization within the last seven days.list-mailbox-permissionsLists the mailbox permissions associated with a user, group, or resource mailbox.list-mobile-device-access-overridesLists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.list-mobile-device-access-rulesLists the mobile device access rules for the specified WorkMail organization.list-organizationsReturns summaries of the customer's organizations.list-personal-access-tokensReturns a summary of your Personal Access Tokens.list-resource-delegatesLists the delegates associated with a resource.list-resourcesReturns summaries of the organization's resources.list-tags-for-resourceLists the tags applied to an WorkMail organization resource.list-usersReturns summaries of the organization's users.put-access-control-ruleAdds a new access control rule for the specified organization.put-email-monitoring-configurationCreates or updates the email monitoring configuration for a specified organization.put-identity-provider-configurationEnables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users.put-inbound-dmarc-settingsEnables or disables a DMARC policy for a given organization.put-mailbox-permissionsSets permissions for a user, group, or resource.put-mobile-device-access-overrideCreates or updates a mobile device access override for the given WorkMail organization, user, and device.put-retention-policyPuts a retention policy to the specified organization.register-mail-domainRegisters a new domain in WorkMail and SES, and configures it for use by WorkMail.register-to-work-mailRegisters an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities.reset-passwordAllows the administrator to reset the password for a user.start-mailbox-export-jobStarts 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.tag-resourceApplies the specified tags to the specified WorkMailorganization resource.test-availability-configurationPerforms a test on an availability provider to ensure that access is allowed.untag-resourceUntags the specified tags from the specified WorkMail organization resource.update-availability-configurationUpdates an existing AvailabilityConfiguration for the given WorkMail organization and domain.update-default-mail-domainUpdates the default mail domain for an organization.update-groupUpdates attributes in a group.update-impersonation-roleUpdates an impersonation role for the given WorkMail organization.update-mailbox-quotaUpdates a user's current mailbox quota for a specified organization and user.update-mobile-device-access-ruleUpdates a mobile device access rule for the specified WorkMail organization.update-primary-email-addressUpdates the primary email for a user, group, or resource.update-resourceUpdates data for the resource.update-userUpdates data for the user.