Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aws-workmail: add page #9058

Merged
merged 3 commits into from
Oct 16, 2022
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions pages/common/aws-workmail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# aws workmail

> All Amazon WorkMail API operations using the CLI.
> More information: <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/index.html>.

- List all WorkMail organizations:

`aws workmail list-organizations`

- List all users of a specific organization:

`aws workmail list-users --organization-id {{organization_id}}`

- Create a WorkMail user in a specific organization:

`aws workmail create-user --name {{username}} --display-name {{name}} --password {{password}} --organization-id {{organization_id}}`

- Register and enable a group/user to WorkMail:

`aws workmail register-to-work-mail --entity-id {{entity_id}} --email {{email}} --organization-id {{organization_id}}`

- Create a WorkMail group in a specific organization:

`aws workmail create-group --name {{group_name}} --organization-id {{organization_id}}`

- Associate a member to a specific group:

`aws workmail associate-member-to-group --group-id {{group_id}} --member-id {{member_id}} --organization-id {{organization_id}}`

- Deregister and disable a user/group from WorkMail:

`aws workmail deregister-from-work-mail --entity-id {{entity_id}} --organization-id {{organization_id}}`

- Delete a user from an organization:

`aws workmail delete-user --user-id {{user_id}} --organization-id {{organization_id}}`