AWS CLI を使用した Amazon WorkMail の例

リソースに委任を追加するには

次の 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 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 workmail create-alias \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
    --alias exampleAlias@site.awsapps.com

このコマンドでは何も出力されません。

新しいグループを作成するには

次の create-group コマンドを実行して、指定された組織に新しいグループを作成します。

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

出力:

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

新しいリソースを作成するには

次の create-resource コマンドを実行して、指定された組織に新しいリソース (会議室) を作成します。

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

出力:

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

新しいユーザーを作成するには

次の 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"
}

アクセスコントロールルールを削除するには

次の delete-access-control-rule の例では、指定された Amazon WorkMail 組織から指定されたアクセスコントロールルールを削除します。

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

このコマンドでは何も出力されません。

詳細については、「Amazon WorkMail 管理ガイド」の「アクセスコントロールルールの使用」を参照してください。

エイリアスを削除するには

次の 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

このコマンドでは何も出力されません。

既存のグループを削除するには

次の delete-group コマンドは、Amazon WorkMail から既存のグループを削除します。

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

このコマンドでは何も出力されません。

メールボックスのアクセス許可を削除するには

次の 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 WorkMail から既存のリソースを削除します。

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

このコマンドでは何も出力されません。

ユーザーを削除するには

次の delete-user コマンドは、Amazon WorkMail および後続のすべてのシステムから指定されたユーザーを削除します。

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

このコマンドでは何も出力されません。

既存のエンティティを無効にするには

次の 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 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"
}

組織の情報を取得するには

次の 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 管理ガイド」の「Working with Organizations」を参照してください。

リソースの情報を取得するには

次の 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"
}

ユーザー情報を取得するには

次の 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
}

リソースからタグを削除するには

次の 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 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 例では、指定された 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 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 の例では、指定された 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 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"
    ]
}

グループメンバーを一覧表示するには

次の 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
        }
    ]
}

グループのリストを取得するには

次の 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"
        }
    ]
}

メールボックスのアクセス許可を取得するには

次の 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"
            ]
        }
    ]
}

Organizations のリストを取得するには

次の list-organizations コマンドは、お客様の組織の概要を取得します。

aws workmail list-organizations

出力:

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

リソースの委任を一覧表示するには

次の 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 workmail list-resources \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27

出力:

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

リソースのタグを一覧表示するには

次の 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 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"
        }
    ]
}

新しいアクセスコントロールルールを配置するには

次の 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 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 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 workmail reset-password \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
    --password examplePa$$w0rd

このコマンドでは何も出力されません。

リソースにタグを適用するには

次の 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 管理者ガイド」の「組織のタグ付け」を参照してください。

リソースのタグを削除するには

次の 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 管理者ガイド」の「組織のタグ付け」を参照してください。

ユーザーのメールボックスクォータを更新するには

次の 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 管理者ガイド」の「ユーザーアカウントの管理」を参照してください。

プライマリ E メールアドレスを更新するには

次の update-primary-email-address コマンドは、指定されたエンティティ (ユーザー、グループ、またはリソース) のプライマリ E メールアドレスを更新します。

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 workmail update-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-7afe0efbade843a58cdc10251fce992c \
    --name exampleRoom2

このコマンドでは何も出力されません。