使用亚马逊的 WorkMail 示例 Amazon CLI - Amazon Command Line Interface
操作
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用亚马逊的 WorkMail 示例 Amazon CLI

以下代码示例向您展示如何在 Amazon 中使用来执行操作和实现常见场景 WorkMail。 Amazon Command Line Interface

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

场景是展示如何通过在同一服务中调用多个函数来完成特定任务任务的代码示例。

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

主题

操作

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

Amazon 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。

Amazon 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。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考CreateAlias中的。

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

Amazon CLI

创建新群组

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

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

输出：

{
    "GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444"
}

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考CreateGroup中的。

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

Amazon CLI

创建新资源

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

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

输出：

{
    "ResourceId": "r-7afe0efbade843a58cdc10251fce992c"
}

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考CreateResource中的。

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

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考CreateUser中的。

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

Amazon CLI

删除访问控制规则

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

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

此命令不生成任何输出。

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

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

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考DeleteAlias中的。

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

Amazon CLI

删除现有群组

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

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

此命令不生成任何输出。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考DeleteGroup中的。

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

Amazon 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。

Amazon CLI

删除现有资源

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

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

此命令不生成任何输出。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考DeleteResource中的。

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

Amazon CLI

删除用户

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

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

此命令不生成任何输出。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考DeleteUser中的。

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

Amazon 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。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考DescribeGroup中的。

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

Amazon 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。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考DescribeResource中的。

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

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考DescribeUser中的。

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

Amazon 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。

Amazon 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。

Amazon 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。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考GetMailboxDetails中的。

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

Amazon 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。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考ListAliases中的。

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

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考ListGroupMembers中的。

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

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考ListGroups中的。

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

Amazon 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。

Amazon CLI

检索组织列表

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

aws workmail list-organizations

输出：

{
    "OrganizationSummaries": [
        {
            "OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27",
            "Alias": "exampleAlias",
            "State": "Active"
        }
    ]
}

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考ListOrganizations中的。

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

Amazon 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。

Amazon CLI

检索资源列表

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

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

输出：

{
    "Resources": [
        {
            "Id": "r-7afe0efbade843a58cdc10251fce992c",
            "Name": "exampleRoom1",
            "Type": "ROOM",
            "State": "ENABLED"
        }
    ]
}

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考ListResources中的。

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

Amazon 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。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考ListUsers中的。

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

Amazon 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。

Amazon 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。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考RegisterToWorkMail中的。

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

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考ResetPassword中的。

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

Amazon CLI

对资源应用标签

以下tag-resource示例将密钥为 “priority” 且值为 “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 的详细信息，请参阅Amazon CLI 命令参考TagResource中的。

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

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考UntagResource中的。

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

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考UpdateMailboxQuota中的。

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

Amazon 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。

Amazon CLI

更新资源

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

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

此命令不生成任何输出。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考UpdateResource中的。