aws-workmail

List all WorkMail organizations

$ aws workmail list-organizations

$ aws workmail list-users --organization-id [organization_id]

$ aws workmail create-user --name [username] --display-name [name] --password [password] --organization-id [organization_id]

$ aws workmail register-to-work-mail --entity-id [entity_id] --email [email] --organization-id [organization_id]

$ aws workmail create-group --name [group_name] --organization-id [organization_id]

$ aws workmail associate-member-to-group --group-id [group_id] --member-id [member_id] --organization-id [organization_id]

$ aws workmail deregister-from-work-mail --entity-id [entity_id] --organization-id [organization_id]

$ aws workmail delete-user --user-id [user_id] --organization-id [organization_id]

aws workmail subcommand [--organization-id value] [--max-results value] [--next-token value] [global-options]

--organization-id
    ID of the WorkMail organization (required for most subcommands).

--user-id
    ID of the user entity.

--entity-id
    ID of user, group, or resource.

--max-results
    Maximum results per page (1-100).

--next-token
    Pagination token from prior response.

--region
    AWS region (e.g., us-east-1).

--output
    Output format: json|text|table.

--profile
    Named profile from credentials file.

--debug
    Enable debug logging.

--help
    Show command help.

The aws workmail command is a subcommand of the AWS Command Line Interface (CLI) for managing Amazon WorkMail, a secure, managed business email and calendaring service. It allows programmatic control over WorkMail organizations, users, groups, resources, aliases, domains, and mobile device policies.

Administrators use it to automate tasks like creating/deleting users, listing entities, associating domains, setting permissions, and generating reports. Operations are scoped to an organization ID and support pagination with --max-results and --next-token. Outputs are in JSON, text, or table format via --output.

Requires AWS CLI installed (v1.11+ or v2), configured credentials (IAM policies like WorkMailFullAccess), and appropriate regional endpoint. Integrates with AWS services like IAM, Directory Service, and Lambda for advanced workflows. Ideal for scripting user lifecycle management, compliance audits, and migrations from on-premises email systems.

Always verify permissions to avoid errors like AccessDeniedException.

Requires AWS CLI and valid credentials; regional availability varies; rate limits apply; some actions irreversible (e.g., delete-user); idempotency tokens recommended for creates.

list-organizations, create-user, list-users, delete-user, create-group, associate-domain, list-mailbox-permissions, put-mailbox-permission.
Use aws workmail help for details.

aws workmail list-users --organization-id m-1234567890abcdef0 --max-results 10
Retrieves up to 10 users in the organization.

Added to AWS CLI v1.11.36 (2016) post-WorkMail launch; enhanced in v2 with better JSON handling and async support; regular updates track service features like hybrid deployments.

aws(1), aws-ses(1), aws-directoryservice(1)