View a markdown version of this page

Configuration de la suppression au niveau du locataire - Amazon Simple Email Service
Conditions préalablesActivation de la suppression au niveau du locataireConfiguration de la suppression pour un nouveau locataireRemplacement par un ensemble de configurationDésactivation de la suppression au niveau du locataireAffichage de la configuration de suppression actuelleRésolution des problèmesRessources connexes

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Configuration de la suppression au niveau du locataire

Configurez les paramètres de suppression au niveau du locataire pour contrôler la manière dont Amazon Simple Email Service (Amazon SES) gère les rebonds et les plaintes des locataires individuels. Par défaut, les locataires utilisent votre liste de suppression au niveau du compte. Lorsque vous activez la suppression au niveau du locataire, SES gère une liste de suppression distincte pour chaque locataire. Cela vous permet de contrôler de manière granulaire la délivrabilité des e-mails.

Cette rubrique décrit les procédures permettant d'activer, de modifier, de désactiver et d'afficher les paramètres de suppression au niveau du locataire à l'aide du. AWS CLI

Important

La désactivation de la suppression au niveau du locataire ne supprime pas les entrées existantes de la liste de suppression du locataire. Si vous réactivez la suppression au niveau du locataire ultérieurement, ces entrées sont toujours actives.

Conditions préalables

Avant de configurer la suppression au niveau du locataire, assurez-vous que vous répondez aux exigences suivantes :

Activation de la suppression au niveau du locataire pour un locataire existant

Utilisez l'opération PutTenantSuppressionAttributes API pour activer la suppression au niveau du locataire pour un locataire existant. Cette opération est idempotente, vous pouvez donc l'appeler plusieurs fois avec les mêmes paramètres sans effets secondaires.

Pour activer la suppression au niveau du locataire

  1. Sur la ligne de commande, exécutez la put-tenant-suppression-attributes commande suivante pour activer la suppression au niveau du locataire à la fois pour les rebonds et les plaintes :

    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

    Remplacez MyTenant par le nom de votre locataire.

  2. Vérifiez que la commande ne renvoie aucune sortie. Une requête réussie renvoie une réponse HTTP 200 sans corps.

  3. Confirmez la configuration en exécutant la commande suivante :

    aws sesv2 get-tenant --tenant-name MyTenant

Le locataire utilise désormais sa propre liste de suppression pour les rebonds et les plaintes.

Vous pouvez également configurer la suppression pour un seul type de raison. Les exemples suivants montrent comment activer la suppression pour les rebonds uniquement ou pour les plaintes uniquement.

La commande suivante supprime uniquement les rebonds :

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

La commande suivante supprime uniquement les plaintes :

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
Note

Vous devez fournir --suppression-scope et --suppressed-reasons ensemble. Fournir l'un sans l'autre renvoie unInvalidParameterValueException.

Configuration de la suppression lors de la création d'un nouveau locataire

Utilisez l'opération CreateTenant API avec le SuppressionAttributes paramètre pour créer un locataire avec la suppression au niveau du locataire activée dès le départ.

Pour créer un locataire avec suppression au niveau du locataire

  1. Sur la ligne de commande, exécutez la create-tenant commande suivante :

    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"]}'

    Remplacez MyNewTenant par le nom de votre nouveau locataire.

  2. Vérifiez que la réponse contient l'ID du locataire :

    {
    "TenantId": "tn-abc123def456"
}

Le locataire est créé avec la suppression au niveau du locataire activée à la fois pour les rebonds et les plaintes.

Note

Si vous omettez--suppression-attributes, le locataire utilise par défaut le ACCOUNT champ d'application et utilise la liste de suppression au niveau du compte.

Remplacer la suppression des locataires par un ensemble de configuration

Vous pouvez annuler les paramètres de suppression d'un locataire en ajoutant ceux SuppressionScope d'un ensemble de SuppressionOptions configuration. Lorsque vous envoyez un e-mail à l'aide de ce jeu de configuration, les paramètres de suppression du jeu de configuration ont priorité sur les paramètres du locataire. Vous pouvez modifier le champ d'application uniquement, les raisons uniquement, ou les deux indépendamment.

Pour créer un ensemble de configuration avec remplacement de l'étendue du locataire

  1. Sur la ligne de commande, exécutez la create-configuration-set commande suivante :

    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-setRemplacez-le par le nom de votre ensemble de configuration.

  2. Vérifiez que la commande ne renvoie aucune sortie. Une requête réussie renvoie une réponse HTTP 200.

Pour mettre à jour un ensemble de configuration existant avec des options de suppression

  1. Sur la ligne de commande, exécutez la put-configuration-set-suppression-options commande suivante :

    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-setRemplacez-le par le nom de votre ensemble de configuration.

  2. Vérifiez que la commande ne renvoie aucune sortie. Une requête réussie renvoie une réponse HTTP 200.

Désactivation de la suppression au niveau du locataire

Pour rétablir la suppression au niveau du compte pour un locataire, vous pouvez définir l'étendue ACCOUNT ou effacer tous les paramètres de suppression.

Pour configurer le locataire pour une suppression au niveau du compte

  1. Sur la ligne de commande, exécutez la commande suivante pour définir explicitement la portée sur 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

    Remplacez MyTenant par le nom de votre locataire.

  2. Vérifiez que la commande ne renvoie aucune sortie.

Pour effacer tous les paramètres de suppression

  1. Sur la ligne de commande, exécutez la commande suivante sans préciser le champ d'application ni les raisons :

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

    Remplacez MyTenant par le nom de votre locataire.

  2. Vérifiez que la commande ne renvoie aucune sortie.

Note

Lorsque vous omettez les deux --suppression-scope et--suppressed-reasons, SES efface les paramètres de suppression du locataire. Le locataire adopte un comportement de suppression au niveau du compte.

Important

La désactivation de la suppression au niveau du locataire ne supprime pas les entrées existantes de la liste de suppression du locataire. Si vous réactivez la suppression au niveau du locataire ultérieurement, ces entrées sont toujours actives.

Affichage de la configuration de suppression actuelle

Utilisez l'opération GetTenant API pour vérifier les paramètres de suppression actuels d'un locataire.

Pour consulter la configuration de suppression d'un locataire

  1. Sur la ligne de commande, exécutez la get-tenant commande suivante :

    aws sesv2 get-tenant --tenant-name MyTenant

    Remplacez MyTenant par le nom de votre locataire.

  2. Passez en revue la réponse. L'exemple suivant montre un locataire pour lequel la suppression au niveau du locataire est activée :

    {
    "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"]
        }
    }
}

Le tableau suivant décrit les principaux champs de l'SuppressionAttributesobjet.

Champ Description
SuppressionScope L'étendue de la suppression pour le locataire. La valeur de TENANT signifie que le locataire utilise sa propre liste de suppression. La valeur de ACCOUNT signifie que le locataire utilise la liste de suppression au niveau du compte.
SuppressedReasons Les raisons de suppression actives pour le locataire. Les valeurs possibles sont BOUNCECOMPLAINT, ou les deux.

En cas SuppressionAttributes d'absence ou de valeur nulle dans la réponse, le locataire utilise la suppression au niveau du compte.

Résolution des problèmes

Les erreurs suivantes sont courantes que vous pouvez rencontrer lors de la configuration de la suppression au niveau du locataire.

InvalidParameterValueException: SuppressedReasons cannot be null when SuppressionScope is provided

  • Cause — Vous avez spécifié --suppression-scope sans--suppressed-reasons.

  • Corriger — Fournissez les deux paramètres ensemble, ou omettez les deux pour effacer les paramètres.

InvalidParameterValueException: SuppressionScope is required when SuppressedReasons are provided

  • Cause — Vous avez spécifié --suppressed-reasons sans--suppression-scope.

  • Corriger — Fournissez les deux paramètres ensemble.

NotFoundException

  • Cause — Le nom du locataire que vous avez spécifié n'existe pas.

  • Correctif — Vérifiez le nom du locataire en exécutant la commande suivante :

    aws sesv2 list-tenants