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> [options] [parameters]

Examples of common subcommands:
  aws workmail list-organizations
  aws workmail create-user --organization-id <id> --name <name> --display-name <display-name> --password <password>
  aws workmail describe-users --organization-id <id>

--output <format>
    Specifies the output format. Common formats include json, text, and table.

--region <region>
    Specifies the AWS region to send the request to (e.g., us-east-1).

--profile <profile-name>
    Uses a specific profile from your credential file.

--endpoint-url <url>
    Overrides the default endpoint URL for the service.

--no-cli-pager
    Disables the CLI pager for commands that typically use one.

[subcommand-specific parameters]
    Each workmail subcommand has its own unique set of parameters and arguments required to perform its specific operation (e.g., --organization-id, --user-id, --name, --password).

aws-workmail is not a standalone Linux command. Instead, it refers to the interaction with Amazon WorkMail, a managed and secure business email and calendaring service, through the AWS Command Line Interface (CLI). The `aws workmail` command is used to programmatically manage various aspects of your WorkMail organizations, users, groups, and resources directly from your terminal. This allows for automation of tasks such as creating users, managing mailboxes, configuring organizations, and integrating with other AWS services. It is an essential tool for administrators who need to manage their WorkMail environment without using the AWS Management Console, enabling scripting and integration into CI/CD pipelines or operational workflows. The `aws workmail` command namespace encompasses a wide array of subcommands, each dedicated to a specific WorkMail API operation, providing comprehensive control over the service.

• Requires the AWS CLI to be installed and configured with appropriate IAM credentials.
• Internet connectivity is essential to interact with the AWS WorkMail service.
• Users must have the necessary AWS Identity and Access Management (IAM) permissions to perform WorkMail operations.
• Costs may be incurred based on your AWS WorkMail usage and AWS pricing policies.
• The syntax and available subcommands are dependent on the AWS CLI version and the AWS WorkMail API version.

It is crucial to understand that 'aws-workmail' is not a direct executable or a standalone command. Instead, it refers to the 'workmail' service module within the broader AWS CLI framework. All interactions begin with the `aws` command, followed by the service name (`workmail`), and then the specific operation (subcommand) you wish to perform.

The `aws workmail` command is frequently used for:

• Automated provisioning and de-provisioning of users and groups.
• Managing email domains and aliases.
• Migrating mailboxes.
• Monitoring organization status and resource utilization.
• Scripting routine administrative tasks for scalability and efficiency.

Amazon WorkMail was launched by AWS in 2015, providing a secure, managed email and calendaring service for businesses. Concurrently, the AWS CLI has evolved significantly since its initial release, becoming the primary command-line tool for interacting with virtually all AWS services, including WorkMail. The `aws workmail` commands directly reflect the WorkMail API, allowing developers and administrators to manage WorkMail resources programmatically as the service matured and added new features.

aws(1)