View a markdown version of this page

テナントレベルの抑制の設定 - Amazon Simple Email Service
前提条件テナントレベルの抑制の有効化新しいテナントの抑制の設定設定セットによる上書きテナントレベルの抑制を無効にする現在のサプレッション設定の表示トラブルシューティング関連リソース

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

テナントレベルの抑制の設定

テナントレベルの抑制設定を設定して、Amazon Simple Email Service (Amazon SES) が個々のテナントのバウンスと苦情を処理する方法を制御します。デフォルトでは、テナントはアカウントレベルのサプレッションリストを使用します。テナントレベルのサプレッションを有効にすると、SES はテナントごとに個別のサプレッションリストを維持します。これにより、E メールの配信性能をきめ細かく制御できます。

このトピックでは、 を使用してテナントレベルのサプレッション設定を有効化、変更、無効化、表示する手順について説明します AWS CLI。

重要

テナントレベルのサプレッションを無効にしても、テナントのサプレッションリストから既存のエントリは削除されません。後でテナントレベルのサプレッションを再度有効にしても、それらのエントリはアクティブのままです。

前提条件

テナントレベルの抑制を設定する前に、次の要件を満たしていることを確認してください。

  • マルチテナンシーは SES アカウントで有効になっています。

  • アカウントに少なくとも 1 つのテナントが存在するか、この手順の一部としてテナントを作成する予定です。

  • AWS CLI バージョン 2 がインストールされ、適切なアクセス許可で設定されます。詳細については、「AWS Command Line Interface ユーザーガイド」を参照してください。

  • アカウントレベルの抑制の概念に精通している。詳細については、「Amazon SES アカウントレベルのサプレッションリストの使用」を参照してください。

既存のテナントのテナントレベルの抑制を有効にする

PutTenantSuppressionAttributes API オペレーションを使用して、既存のテナントのテナントレベルの抑制を有効にします。このオペレーションはべき等であるため、副作用なしで同じパラメータで複数回呼び出すことができます。

テナントレベルの抑制を有効にするには

  1. コマンドラインで次のput-tenant-suppression-attributesコマンドを実行して、バウンスと苦情の両方に対してテナントレベルのサプレッションを有効にします。

    Linux, macOS, or Unix
    aws sesv2 put-tenant-suppression-attributes \
--tenant-name MyTenant \
--suppression-scope TENANT \
--suppressed-reasons BOUNCE COMPLAINT
    Windows
    aws sesv2 put-tenant-suppression-attributes `
--tenant-name MyTenant `
--suppression-scope TENANT `
--suppressed-reasons BOUNCE COMPLAINT

    MyTenant をテナントの名前に置き換えます。

  2. コマンドが出力を返さないことを確認します。リクエストが成功すると、本文なしで HTTP 200 レスポンスが返されます。

  3. 次のコマンドを実行して設定を確認します。

    aws sesv2 get-tenant --tenant-name MyTenant

テナントは、バウンスと苦情の両方に独自のサプレッションリストを使用するようになりました。

1 つの理由タイプに対して抑制を設定することもできます。次の例は、バウンスのみまたは苦情のみの抑制を有効にする方法を示しています。

次のコマンドは、バウンスのみを抑えます。

Linux, macOS, or Unix
aws sesv2 put-tenant-suppression-attributes \
--tenant-name MyTenant \
--suppression-scope TENANT \
--suppressed-reasons BOUNCE
Windows
aws sesv2 put-tenant-suppression-attributes `
--tenant-name MyTenant `
--suppression-scope TENANT `
--suppressed-reasons BOUNCE

次のコマンドは、苦情のみを抑制します。

Linux, macOS, or Unix
aws sesv2 put-tenant-suppression-attributes \
--tenant-name MyTenant \
--suppression-scope TENANT \
--suppressed-reasons COMPLAINT
Windows
aws sesv2 put-tenant-suppression-attributes `
--tenant-name MyTenant `
--suppression-scope TENANT `
--suppressed-reasons COMPLAINT
注記

--suppression-scope と を--suppressed-reasons一緒に指定する必要があります。一方を他方なしで指定すると、 が返されますInvalidParameterValueException。

新しいテナントの作成時の抑制の設定

SuppressionAttributes パラメータを指定して CreateTenant API オペレーションを使用して、テナントレベルの抑制を最初から有効にしたテナントを作成します。

テナントレベルの抑制を使用してテナントを作成するには

  1. コマンドラインで、次のcreate-tenantコマンドを実行します。

    Linux, macOS, or Unix
    aws sesv2 create-tenant \
--tenant-name MyNewTenant \
--suppression-attributes '{"SuppressionScope":"TENANT","SuppressedReasons":["BOUNCE","COMPLAINT"]}'
    Windows
    aws sesv2 create-tenant `
--tenant-name MyNewTenant `
--suppression-attributes '{"SuppressionScope":"TENANT","SuppressedReasons":["BOUNCE","COMPLAINT"]}'

    MyNewTenant を新しいテナントの名前に置き換えます。

  2. レスポンスにテナント ID が含まれていることを確認します。

    {
    "TenantId": "tn-abc123def456"
}

テナントは、バウンスと苦情の両方でテナントレベルの抑制を有効にして作成されます。

注記

を省略すると--suppression-attributes、テナントはデフォルトでACCOUNTスコープを設定し、アカウントレベルのサプレッションリストを使用します。

設定セットによるテナント抑制の上書き

設定セットの SuppressionScopeに を追加することで、テナントの抑制設定を上書きできますSuppressionOptions。この設定セットを使用して E メールを送信する場合、設定セットの抑制設定がテナントの設定よりも優先されます。スコープのみ、理由のみ、またはその両方を個別に上書きできます。

テナントスコープオーバーライドを使用して設定セットを作成するには

  1. コマンドラインで、次のcreate-configuration-setコマンドを実行します。

    Linux, macOS, or Unix
    aws sesv2 create-configuration-set \
--configuration-set-name my-config-set \
--suppression-options '{"SuppressionScope":"TENANT","SuppressedReasons":["BOUNCE"]}'
    Windows
    aws sesv2 create-configuration-set `
--configuration-set-name my-config-set `
--suppression-options '{"SuppressionScope":"TENANT","SuppressedReasons":["BOUNCE"]}'

    my-config-set を設定セットの名前に置き換えます。

  2. コマンドが出力を返さないことを確認します。リクエストが成功すると、HTTP 200 レスポンスが返されます。

抑制オプションを使用して既存の設定セットを更新するには

  1. コマンドラインで、次のput-configuration-set-suppression-optionsコマンドを実行します。

    Linux, macOS, or Unix
    aws sesv2 put-configuration-set-suppression-options \
--configuration-set-name my-config-set \
--suppression-scope TENANT \
--suppressed-reasons BOUNCE
    Windows
    aws sesv2 put-configuration-set-suppression-options `
--configuration-set-name my-config-set `
--suppression-scope TENANT `
--suppressed-reasons BOUNCE

    my-config-set を設定セットの名前に置き換えます。

  2. コマンドが出力を返さないことを確認します。リクエストが成功すると、HTTP 200 レスポンスが返されます。

テナントレベルの抑制を無効にする

テナントをアカウントレベルのサプレッションに戻すには、スコープを に設定するACCOUNTか、すべてのサプレッション設定をクリアします。

テナントをアカウントレベルのサプレッションに設定するには

  1. コマンドラインで次のコマンドを実行して、スコープを明示的に に設定しますACCOUNT。

    Linux, macOS, or Unix
    aws sesv2 put-tenant-suppression-attributes \
--tenant-name MyTenant \
--suppression-scope ACCOUNT \
--suppressed-reasons BOUNCE COMPLAINT
    Windows
    aws sesv2 put-tenant-suppression-attributes `
--tenant-name MyTenant `
--suppression-scope ACCOUNT `
--suppressed-reasons BOUNCE COMPLAINT

    MyTenant をテナントの名前に置き換えます。

  2. コマンドが出力を返さないことを確認します。

すべての抑制設定をクリアするには

  1. コマンドラインで、スコープや理由を指定せずに次のコマンドを実行します。

    aws sesv2 put-tenant-suppression-attributes --tenant-name MyTenant

    MyTenant をテナントの名前に置き換えます。

  2. コマンドが出力を返さないことを確認します。

注記

--suppression-scope と の両方を省略すると--suppressed-reasons、SES はテナントの抑制設定をクリアします。テナントはアカウントレベルの抑制動作に戻ります。

重要

テナントレベルのサプレッションを無効にしても、テナントのサプレッションリストから既存のエントリは削除されません。後でテナントレベルのサプレッションを再度有効にしても、それらのエントリはアクティブのままです。

現在のサプレッション設定の表示

GetTenant API オペレーションを使用して、テナントの現在の抑制設定を確認します。

テナントの抑制設定を表示するには

  1. コマンドラインで、次のget-tenantコマンドを実行します。

    aws sesv2 get-tenant --tenant-name MyTenant

    MyTenant をテナントの名前に置き換えます。

  2. 応答を確認します。次の例は、テナントレベルの抑制が有効になっているテナントを示しています。

    {
    "Tenant": {
        "TenantName": "MyTenant",
        "TenantId": "tn-abc123def456",
        "TenantArn": "arn:aws:ses:us-east-1:123456789012:tenant/MyTenant/tn-abc123def456",
        "SendingStatus": "ENABLED",
        "CreatedTimestamp": 1705312800,
        "UpdateTimestamp": 1705762800,
        "SuppressionAttributes": {
            "SuppressionScope": "TENANT",
            "SuppressedReasons": ["BOUNCE", "COMPLAINT"]
        }
    }
}

次の表に、 SuppressionAttributes オブジェクトのキーフィールドを示します。

フィールド 説明
SuppressionScope テナントの抑制範囲。の値は、テナントが独自のサプレッションリストを使用するTENANTことを意味します。の値は、テナントがアカウントレベルのサプレッションリストを使用するACCOUNTことを意味します。
SuppressedReasons テナントに対してアクティブな抑制理由。指定できる値は、BOUNCE、COMPLAINT、またはその両方です。

SuppressionAttributes レスポンスに がないか null の場合、テナントはアカウントレベルの抑制を使用します。

トラブルシューティング

以下は、テナントレベルのサプレッションを設定するときに発生する可能性がある一般的なエラーです。

InvalidParameterValueException: SuppressedReasons cannot be null when SuppressionScope is provided

  • 原因 – --suppression-scopeなしで を指定しました--suppressed-reasons。

  • 修正 – 両方のパラメータを一緒に指定するか、両方を省略して設定をクリアします。

InvalidParameterValueException: SuppressionScope is required when SuppressedReasons are provided

  • 原因 – --suppressed-reasonsなしで を指定しました--suppression-scope。

  • 修正 – 両方のパラメータを一緒に指定します。

NotFoundException

  • 原因 – 指定したテナント名が存在しません。

  • 修正 – 次のコマンドを実行してテナント名を確認します。

    aws sesv2 list-tenants