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

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

使用 的 Amazon WorkMail 範例 AWS CLI

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

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

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

主題

動作

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

  • 如需 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範例會將索引鍵為 "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 詳細資訊,請參閱《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