aws-workmail
Manage Amazon WorkMail organizations, users, and groups
TLDR
List all WorkMail organizations
List all users of a specific organization
Create a WorkMail user in a specific organization
Register and enable a group/user to WorkMail
Create a WorkMail group in a specific organization
Associate a member to a specific group
Deregister and disable a user/group from WorkMail
Delete a user from an organization
SYNOPSIS
aws workmail
PARAMETERS
associate-delegate-to-resource
Associates a user or group with a resource.
associate-member-to-group
Adds a user or group to a group's membership.
cancel-mailbox-export-job
Cancels a mailbox export job.
create-alias
Adds an alias to the set of aliases that refer to a specified user, group, or resource.
create-group
Creates a group.
create-mobile-device-access-rule
Creates a new mobile device access rule for the specified organization.
create-organization
Creates an Amazon WorkMail organization.
create-resource
Creates a resource.
create-user
Creates a user.
delete-alias
Removes an alias from a user, group, or resource.
delete-group
Deletes a group.
delete-mailbox-permissions
Deletes permissions granted to a user or group for the specified mailbox.
delete-mobile-device-access-rule
Deletes a mobile device access rule.
delete-organization
Deletes an Amazon WorkMail organization.
delete-resource
Deletes a resource.
delete-user
Deletes a user.
describe-group
Returns the data available for the group.
describe-mailbox-export-job
Describes the details of a mailbox export job.
describe-organization
Provides the details of the organization that you requested.
describe-resource
Returns the data available for the resource.
describe-user
Returns the data available for the user that you requested.
disassociate-delegate-from-resource
Removes a user or group's delegate access from a resource.
disassociate-member-from-group
Removes a member from a group.
get-access-control-effect
Gets the effects of an organization's access control rules as they apply to a specified email address, IP address, and user agent.
get-default-retention-policy
Gets the default retention policy details for the specified organization.
get-mailbox-details
Retrieves mailbox details for a specific user.
get-mailbox-permissions
Gets the mailbox permissions for a specified user or group.
get-mobile-device-access-effect
Simulates the effect of the mobile device access rules for the given attributes of the device, and determines whether the device is allowed or blocked.
get-mobile-device-access-override
Gets the mobile device access override for the given device ID from the user's mail box.
list-access-control-rules
Lists the access control rules for the specified organization.
list-aliases
Lists the aliases that refer to a specified group.
list-group-members
Returns all the group members associated with the group.
list-groups
Returns summaries of the organization's groups.
list-mailbox-export-jobs
Lists mailbox export jobs.
list-mailbox-permissions
Lists the mailbox permissions associated with a user, group, or resource mailbox.
list-mobile-device-access-overrides
Lists all the mobile device access overrides for any given combination of user, device, or both.
list-mobile-device-access-rules
Lists the mobile device access rules for the specified organization.
list-organizations
Lists the Amazon WorkMail organizations under your AWS account.
list-resource-delegates
Lists the delegates who have access to meet with a resource.
list-resources
Returns summaries of the organization's resources.
list-users
Returns summaries of the organization's users.
put-access-control-rule
Puts an access control rule for the specified organization.
put-default-retention-policy
Puts a retention policy for the specified organization.
put-mailbox-permissions
Sets permissions for a user or group on the specified mailbox.
put-mobile-device-access-override
Creates or updates the mobile device access override for the given device ID.
register-to-workmail
Registers a domain to an Amazon WorkMail organization.
reset-password
Resets the password for a user.
start-mailbox-export-job
Starts a mailbox export job to export all messages from a specified user's mailbox and saves them into an .mbox file.
tag-resource
Applies the specified tags to the specified Amazon WorkMail organization resource.
test-availability
Performs a availability test for an organization
untag-resource
Removes the specified tags from the specified Amazon WorkMail organization resource.
update-default-mail-domain
Updates the default mail domain for an organization.
update-group
Updates the details of a group.
update-mailbox
Updates the details of the mailbox.
update-mobile-device-access-rule
Updates an existing mobile device access rule.
update-primary-email-address
Updates the primary email address of a user.
update-resource
Updates data for the resource.
update-user
Updates the details of the user.
DESCRIPTION
The `aws-workmail` command is a command-line interface (CLI) tool provided by the AWS Command Line Interface (AWS CLI) that allows you to manage and configure Amazon WorkMail resources. It provides functionalities to create, modify, and delete WorkMail organizations, users, groups, mailboxes, and resource policies. You can also use it to manage mobile device access and perform other administrative tasks. Using the `aws-workmail` command requires having the AWS CLI installed and configured with appropriate credentials and permissions to access Amazon WorkMail resources. The command is typically used by administrators to automate WorkMail management tasks and integrate them into scripting or automation workflows.
CAVEATS
Requires AWS CLI to be installed and configured. Authentication and authorization are managed via IAM roles and policies.
AUTHENTICATION AND AUTHORIZATION
The `aws-workmail` command relies on the AWS CLI's authentication mechanisms. This typically involves configuring credentials using `aws configure`, environment variables, or IAM roles. Ensure that the configured credentials have the necessary permissions to perform the desired WorkMail actions.
EXAMPLES
Example: Create a WorkMail Organization:
`aws workmail create-organization --directory-id d-xxxx --alias exampleorg --region us-east-1`
Example: List Users in an Organization:
`aws workmail list-users --organization-id m-xxxx --region us-east-1`
HISTORY
The `aws-workmail` command is part of the AWS CLI, which is actively developed and maintained by Amazon Web Services. It has evolved over time with new features and updates to support the growing functionality of Amazon WorkMail. The CLI aims to provide a programmatic way to manage WorkMail resources, simplifying automation and integration with other AWS services.