使用 AWS CLI 的 Amazon WorkMail 示例 - AWS Command Line Interface

使用 AWS CLI 的 Amazon WorkMail 示例

以下代码示例演示了如何通过将 AWS Command Line Interface与 Amazon WorkMail 结合使用,来执行操作和实现常见场景。

操作是大型程序的代码摘录,必须在上下文中运行。您可以通过操作了解如何调用单个服务函数,还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接,您可以从中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

以下代码示例演示了如何使用 associate-delegate-to-resource

AWS CLI

添加资源委托

以下 associate-delegate-to-resource 命令为资源添加委托。

aws workmail associate-delegate-to-resource \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --resource-id r-68bf2d3b1c0244aab7264c24b9217443 \ --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

此命令不生成任何输出。

以下代码示例演示了如何使用 associate-member-to-group

AWS CLI

向组中添加成员

以下 associate-member-to-group 命令将指定成员添加到组中。

aws workmail associate-member-to-group \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --group-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ --member-id S-1-1-11-1111111111-2222222222-3333333333-3333

此命令不生成任何输出。

以下代码示例演示了如何使用 create-alias

AWS CLI

创建别名

以下 create-alias 命令为指定实体(用户或组)创建别名。

aws workmail create-alias \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ --alias exampleAlias@site.awsapps.com

此命令不生成任何输出。

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 CreateAlias

以下代码示例演示了如何使用 create-group

AWS CLI

创建新组

以下 create-group 命令为指定组织创建新组。

aws workmail create-group \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --name exampleGroup1

输出:

{ "GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444" }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 CreateGroup

以下代码示例演示了如何使用 create-resource

AWS CLI

创建新资源

以下 create-resource 命令为指定组织创建新资源(会议室)。

aws workmail create-resource \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --name exampleRoom1 \ --type ROOM

输出:

{ "ResourceId": "r-7afe0efbade843a58cdc10251fce992c" }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 CreateResource

以下代码示例演示了如何使用 create-user

AWS CLI

创建新用户

以下 create-user 命令创建一个新用户。

aws workmail create-user \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --name exampleName \ --display-name exampleDisplayName \ --password examplePa$$w0rd

输出:

{ "UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333" }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 CreateUser

以下代码示例演示了如何使用 delete-access-control-rule

AWS CLI

删除访问控制规则

以下 delete-access-control-rule 示例从指定 Amazon WorkMail 组织中删除指定的访问控制规则。

aws workmail delete-access-control-rule \ --organization-id m-n1pq2345678r901st2u3vx45x6789yza \ --name "myRule"

此命令不生成任何输出。

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的使用访问控制规则

以下代码示例演示了如何使用 delete-alias

AWS CLI

删除别名

以下 delete-alias 命令删除指定实体(用户或组)的别名。

aws workmail delete-alias \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ --alias exampleAlias@site.awsapps.com

此命令不生成任何输出。

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 DeleteAlias

以下代码示例演示了如何使用 delete-group

AWS CLI

删除现有组

以下 delete-group 命令从 Amazon WorkMail 中删除现有组。

aws workmail delete-group \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --group-id S-1-1-11-1122222222-2222233333-3333334444-4444

此命令不生成任何输出。

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 DeleteGroup

以下代码示例演示了如何使用 delete-mailbox-permissions

AWS CLI

删除邮箱权限

以下 delete-mailbox-permissions 命令删除先前授予用户或组的邮箱权限。实体代表拥有邮箱的用户,被授权者代表要删除其权限的用户或组。

aws workmail delete-mailbox-permissions \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ --grantee-id S-1-1-11-1111111111-2222222222-3333333333-3333

此命令不生成任何输出。

以下代码示例演示了如何使用 delete-resource

AWS CLI

删除现有资源

以下 delete-resource 命令从 Amazon WorkMail 中删除现有资源。

aws workmail delete-resource \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --resource-id r-7afe0efbade843a58cdc10251fce992c

此命令不生成任何输出。

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 DeleteResource

以下代码示例演示了如何使用 delete-user

AWS CLI

删除用户

以下 delete-user 命令从 Amazon WorkMail 和所有后续系统中删除指定用户。

aws workmail delete-user \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --user-id S-1-1-11-1111111111-2222222222-3333333333-3333

此命令不生成任何输出。

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 DeleteUser

以下代码示例演示了如何使用 deregister-from-work-mail

AWS CLI

禁用现有实体

以下 deregister-from-work-mail 命令禁止现有实体(用户、组或资源)使用 Amazon WorkMail。

aws workmail deregister-from-work-mail \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

此命令不生成任何输出。

以下代码示例演示了如何使用 describe-group

AWS CLI

检索组信息

以下 describe-group 命令检索有关指定组的信息。

aws workmail describe-group \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --group-id S-1-1-11-1122222222-2222233333-3333334444-4444

输出:

{ "GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444", "Name": "exampleGroup1", "State": "ENABLED" }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 DescribeGroup

以下代码示例演示了如何使用 describe-organization

AWS CLI

检索组织信息

以下 describe-organization 命令检索指定 Amazon WorkMail 组织的相关信息。

aws workmail describe-organization \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27

输出:

{ "OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27", "Alias": "alias", "State": "Active", "DirectoryId": "d-926726012c", "DirectoryType": "VpcDirectory", "DefaultMailDomain": "site.awsapps.com", "CompletedDate": 1522693605.468, "ARN": "arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza" }

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的使用组织

以下代码示例演示了如何使用 describe-resource

AWS CLI

检索资源信息

以下 describe-resource 命令检索有关指定资源的信息。

aws workmail describe-resource \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --resource-id r-7afe0efbade843a58cdc10251fce992c

输出:

{ "ResourceId": "r-7afe0efbade843a58cdc10251fce992c", "Name": "exampleRoom1", "Type": "ROOM", "BookingOptions": { "AutoAcceptRequests": true, "AutoDeclineRecurringRequests": false, "AutoDeclineConflictingRequests": true }, "State": "ENABLED" }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 DescribeResource

以下代码示例演示了如何使用 describe-user

AWS CLI

检索用户信息

以下 describe-user 命令检索有关指定用户的信息。

aws workmail describe-user \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --user-id S-1-1-11-1111111111-2222222222-3333333333-3333

输出:

{ "UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333", "Name": "exampleUser1", "Email": "exampleUser1@site.awsapps.com", "DisplayName": "", "State": "ENABLED", "UserRole": "USER", "EnabledDate": 1532459261.827 }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 DescribeUser

以下代码示例演示了如何使用 disassociate-delegate-from-resource

AWS CLI

从资源中删除标签

以下 disassociate-delegate-from-resource 命令从资源中移除指定成员。

ws workmail disassociate-delegate-from-resource \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --resource-id r-68bf2d3b1c0244aab7264c24b9217443 \ --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

此命令不生成任何输出。

以下代码示例演示了如何使用 disassociate-member-from-group

AWS CLI

从组中删除成员

以下 disassociate-member-from-group 命令从组中删除指定成员。

aws workmail disassociate-member-from-group \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --group-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ --member-id S-1-1-11-1111111111-2222222222-3333333333-3333

此命令不生成任何输出。

以下代码示例演示了如何使用 get-access-control-effect

AWS CLI

获得访问控制规则的效果

以下 get-access-control-effect 示例检索指定 Amazon WorkMail 组织的访问控制规则应用于指定 IP 地址、访问协议操作和用户 ID 时的效果。

aws workmail get-access-control-effect \ --organization-id m-n1pq2345678r901st2u3vx45x6789yza \ --ip-address "192.0.2.0" \ --action "WindowsOutlook" \ --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333"

输出:

{ "Effect": "DENY", "MatchedRules": [ "myRule" ] }

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的使用访问控制规则

以下代码示例演示了如何使用 get-mailbox-details

AWS CLI

获取用户的邮箱详细信息

以下 get-mailbox-details 命令检索有关指定用户邮箱的详细信息。

aws workmail get-mailbox-details \ --organization-id m-n1pq2345678r901st2u3vx45x6789yza \ --user-id S-1-1-11-1111111111-2222222222-3333333333-3333

输出:

{ "MailboxQuota": 51200, "MailboxSize": 0.03890800476074219 }

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的管理用户账户

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 GetMailboxDetails

以下代码示例演示了如何使用 list-access-control-rules

AWS CLI

列出访问控制规则

以下 list-access-control-rules 示例列出指定 Amazon WorkMail 组织的访问控制规则。

aws workmail list-access-control-rules \ --organization-id m-n1pq2345678r901st2u3vx45x6789yza

输出:

{ "Rules": [ { "Name": "default", "Effect": "ALLOW", "Description": "Default WorkMail Rule", "DateCreated": 0.0, "DateModified": 0.0 }, { "Name": "myRule", "Effect": "DENY", "Description": "my rule", "UserIds": [ "S-1-1-11-1111111111-2222222222-3333333333-3333" ], "DateCreated": 1581635628.0, "DateModified": 1581635628.0 } ] }

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的使用访问控制规则

以下代码示例演示了如何使用 list-aliases

AWS CLI

列出成员的别名

以下 list-aliases 命令列出指定成员(用户或组)的别名。

aws workmail list-aliases \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

输出:

{ "Aliases": [ "exampleAlias@site.awsapps.com", "exampleAlias1@site.awsapps.com" ] }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 ListAliases

以下代码示例演示了如何使用 list-group-members

AWS CLI

列出组成员

以下 list-group-members 命令列出指定组的成员。

aws workmail list-group-members \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --group-id S-1-1-11-1122222222-2222233333-3333334444-4444

输出:

{ "Members": [ { "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333", "Name": "exampleUser1", "Type": "USER", "State": "ENABLED", "EnabledDate": 1532459261.827 } ] }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 ListGroupMembers

以下代码示例演示了如何使用 list-groups

AWS CLI

检索组列表

以下 list-groups 命令检索指定组织中组的摘要。

aws workmail list-groups \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27

输出:

{ "Groups": [ { "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444", "Name": "exampleGroup1", "State": "DISABLED" }, { "Id": "S-4-4-44-1122222222-2222233333-3333334444-4444", "Name": "exampleGroup2", "State": "ENABLED" } ] }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 ListGroups

以下代码示例演示了如何使用 list-mailbox-permissions

AWS CLI

删除邮箱权限

以下 list-mailbox-permissions 命令检索与指定实体的邮箱关联的邮箱权限。

aws workmail list-mailbox-permissions \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333

输出:

{ "Permissions": [ { "GranteeId": "S-1-1-11-1122222222-2222233333-3333334444-4444", "GranteeType": "USER", "PermissionValues": [ "FULL_ACCESS" ] } ] }

以下代码示例演示了如何使用 list-organizations

AWS CLI

检索组织列表

以下 list-organizations 命令检索未删除组织的摘要。

aws workmail list-organizations

输出:

{ "OrganizationSummaries": [ { "OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27", "Alias": "exampleAlias", "State": "Active" } ] }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 ListOrganizations

以下代码示例演示了如何使用 list-resource-delegates

AWS CLI

列出资源委托

以下 list-resource-delegates 命令检索与指定资源关联的委托。

aws workmail list-resource-delegates \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --resource-id r-68bf2d3b1c0244aab7264c24b9217443

输出:

{ "Delegates": [ { "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333", "Type": "USER" } ] }

以下代码示例演示了如何使用 list-resources

AWS CLI

检索资源列表

以下 list-resources 命令检索指定组织的资源的摘要。

aws workmail list-resources \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27

输出:

{ "Resources": [ { "Id": "r-7afe0efbade843a58cdc10251fce992c", "Name": "exampleRoom1", "Type": "ROOM", "State": "ENABLED" } ] }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 ListResources

以下代码示例演示了如何使用 list-tags-for-resource

AWS CLI

列出资源标签

以下 list-tags-for-resource 示例列出指定 Amazon WorkMail 组织的标签。

aws workmail list-tags-for-resource \ --resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza

输出:

{ "Tags": [ { "Key": "priority", "Value": "1" } ] }

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的标记组织

以下代码示例演示了如何使用 list-users

AWS CLI

如何检索用户列表

以下 list-users 命令检索指定组织中用户的摘要。

aws workmail list-users \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27

输出:

{ "Users": [ { "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333", "Email": "exampleUser1@site.awsapps.com", "Name": "exampleUser1", "State": "ENABLED", "UserRole": "USER", "EnabledDate": 1532459261.827 }, { "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444", "Name": "exampleGuestUser", "State": "DISABLED", "UserRole": "SYSTEM_USER" } ] }
  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 ListUsers

以下代码示例演示了如何使用 put-access-control-rule

AWS CLI

创建新的访问控制规则

以下 put-access-control-rule 示例拒绝指定用户访问指定的 Amazon WorkMail 组织。

aws workmail put-access-control-rule \ --name "myRule" \ --effect "DENY" \ --description "my rule" \ --user-ids "S-1-1-11-1111111111-2222222222-3333333333-3333" \ --organization-id m-n1pq2345678r901st2u3vx45x6789yza

此命令不生成任何输出。

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的使用访问控制规则

以下代码示例演示了如何使用 put-mailbox-permissions

AWS CLI

设置邮箱权限

以下 put-mailbox-permissions 命令为指定的被授权者(用户或组)设置完全访问权限。实体代表邮箱的所有者。

aws workmail put-mailbox-permissions \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 \ --grantee-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ --permission-values FULL_ACCESS

此命令不生成任何输出。

以下代码示例演示了如何使用 register-to-work-mail

AWS CLI

注册现有或已禁用的实体

以下 register-to-work-mail 命令允许指定的现有实体(用户、组或资源)使用 Amazon WorkMail。

aws workmail register-to-work-mail \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ --email exampleGroup1@site.awsapps.com

此命令不生成任何输出。

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 RegisterToWorkMail

以下代码示例演示了如何使用 reset-password

AWS CLI

重置用户密码

以下 reset-password 命令重置指定用户的密码。

aws workmail reset-password \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \ --password examplePa$$w0rd

此命令不生成任何输出。

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 ResetPassword

以下代码示例演示了如何使用 tag-resource

AWS CLI

将标签添加到资源中

以下 tag-resource 示例将键为 “优先级” 且值为 “1” 的标签应用于指定的 Amazon WorkMail 组织。

aws workmail tag-resource \ --resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza \ --tags "Key=priority,Value=1"

此命令不生成任何输出。

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的标记组织

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 TagResource

以下代码示例演示了如何使用 untag-resource

AWS CLI

取消标记资源

以下 untag-resource 示例从指定 Amazon WorkMail 组织中移除指定的标签。

aws workmail untag-resource \ --resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza \ --tag-keys "priority"

此命令不生成任何输出。

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的标记组织

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 UntagResource

以下代码示例演示了如何使用 update-mailbox-quota

AWS CLI

更新用户的邮箱配额

以下 update-mailbox-quota 命令更改指定用户的邮箱配额。

aws workmail update-mailbox-quota \ --organization-id m-n1pq2345678r901st2u3vx45x6789yza \ --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \ --mailbox-quota 40000

此命令不生成任何输出。

有关更多信息,请参阅《Amazon WorkMail 管理员指南》中的管理用户账户

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 UpdateMailboxQuota

以下代码示例演示了如何使用 update-primary-email-address

AWS CLI

更新主电子邮件地址

以下 update-primary-email-address 命令更新指定实体(用户、组或资源)的主电子邮件地址。

aws workmail update-primary-email-address \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 \ --email exampleUser2@site.awsapps.com

此命令不生成任何输出。

以下代码示例演示了如何使用 update-resource

AWS CLI

更新资源

以下 update-resource 命令更新指定资源的名称。

aws workmail update-resource \ --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ --resource-id r-7afe0efbade843a58cdc10251fce992c \ --name exampleRoom2

此命令不生成任何输出。

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 UpdateResource