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

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Amazon WorkMail 示例使用 AWS CLI

下列程式碼範例說明如何透過 AWS Command Line Interface 搭配 Amazon 使用來執行動作和實作常見案例 WorkMail。

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境和跨服務範例中查看內容中的動作。

Scenarios (案例) 是向您展示如何呼叫相同服務中的多個函數來完成特定任務的程式碼範例。

每個範例都包含一個連結 GitHub,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例會示範如何使用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 管理員指南中的使用 Organizations

下列程式碼範例會示範如何使用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範例會針對指定的 IP 位址、存取通訊協定動作和使用者 ID 擷取指定 Amazon WorkMail 組織存取控制規則的影響。

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 員指南中的管理使用者帳戶

下列程式碼範例會示範如何使用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" } ] }

下列程式碼範例會示範如何使用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

此命令不會產生輸出。

下列程式碼範例會示範如何使用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 員指南中的管理使用者帳戶

下列程式碼範例會示範如何使用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中的。