Pré-requisitos Habilitando a supressão em nível de inquilino Configurando a supressão para um novo inquilino Substituindo por um conjunto de configurações Desativando a supressão em nível de inquilino Visualizando a configuração de supressão atual Solução de problemas Recursos relacionados

Configurando a supressão em nível de inquilino

Defina as configurações de supressão em nível de inquilino para controlar como o Amazon Simple Email Service (Amazon SES) lida com devoluções e reclamações de inquilinos individuais. Por padrão, os inquilinos usam sua lista de supressão no nível da conta. Quando você ativa a supressão em nível de inquilino, o SES mantém uma lista de supressão separada para cada inquilino. Isso lhe dá controle granular sobre a capacidade de entrega de e-mails.

Este tópico fornece procedimentos para ativar, modificar, desativar e visualizar as configurações de supressão em nível de inquilino usando o. AWS CLI

Importante

Desativar a supressão no nível do inquilino não exclui as entradas existentes da lista de supressão do inquilino. Se você reativar a supressão em nível de inquilino posteriormente, essas entradas ainda estarão ativas.

Pré-requisitos

Antes de configurar a supressão em nível de inquilino, certifique-se de atender aos seguintes requisitos:

Multi-tenancy está habilitado em sua conta SES.
Há pelo menos um inquilino em sua conta, ou você planeja criar um como parte desse procedimento.
AWS CLI a versão 2 é instalada e configurada com as permissões apropriadas. Para obter mais informações, consulte o Guia do usuário do AWS Command Line Interface.
Você está familiarizado com os conceitos de supressão em nível de conta. Para obter mais informações, consulte Como usar a lista de supressão do Amazon SES por conta.

Habilitando a supressão em nível de inquilino para um inquilino existente

Use a operação de PutTenantSuppressionAttributes API para ativar a supressão em nível de inquilino para um inquilino existente. Essa operação é idempotente, então você pode chamá-la várias vezes com os mesmos parâmetros sem efeitos colaterais.

Para ativar a supressão em nível de inquilino

Na linha de comando, execute o put-tenant-suppression-attributes comando a seguir para ativar a supressão em nível de inquilino para devoluções e reclamações:

MyTenantSubstitua pelo nome do seu inquilino.

Verifique se o comando não retorna nenhuma saída. Uma solicitação bem-sucedida retorna uma resposta HTTP 200 sem corpo.
Confirme a configuração executando o seguinte comando:
```
aws sesv2 get-tenant --tenant-name MyTenant
```

O inquilino agora usa sua própria lista de supressão para devoluções e reclamações.

Você também pode configurar a supressão por um único tipo de motivo. Os exemplos a seguir mostram como habilitar a supressão somente para devoluções ou somente para reclamações.

O comando a seguir suprime somente os saltos:

O comando a seguir suprime somente reclamações:

nota

Vocês devem fornecer --suppression-scope e --suppressed-reasons juntos. Fornecer um sem o outro retorna umInvalidParameterValueException.

Configurando a supressão ao criar um novo inquilino

Use a operação de CreateTenant API com o SuppressionAttributes parâmetro para criar um inquilino com a supressão em nível de inquilino ativada desde o início.

Para criar um inquilino com supressão em nível de inquilino

Na linha de comando, execute o seguinte create-tenant comando:

MyNewTenantSubstitua pelo nome do seu novo inquilino.

Verifique se a resposta contém o ID do inquilino:
```
{
    "TenantId": "tn-abc123def456"
}
```

O inquilino é criado com a supressão em nível de inquilino ativada tanto para devoluções quanto para reclamações.

nota

Se você omitir--suppression-attributes, o inquilino usa como padrão o ACCOUNT escopo e usa a lista de supressão no nível da conta.

Substituindo a supressão de inquilinos com um conjunto de configurações

Você pode substituir as configurações de supressão de um inquilino adicionando-as SuppressionScope às de um conjunto de configurações. SuppressionOptions Quando você envia e-mails usando esse conjunto de configurações, as configurações de supressão do conjunto de configurações têm precedência sobre as configurações do locatário. Você pode substituir somente o escopo, somente os motivos ou ambos de forma independente.

Para criar um conjunto de configurações com o escopo do inquilino, substitua

Na linha de comando, execute o seguinte create-configuration-set comando:

my-config-setSubstitua pelo nome do seu conjunto de configurações.

Verifique se o comando não retorna nenhuma saída. Uma solicitação bem-sucedida retorna uma resposta HTTP 200.

Para atualizar um conjunto de configurações existente com opções de supressão

Na linha de comando, execute o seguinte put-configuration-set-suppression-options comando:

my-config-setSubstitua pelo nome do seu conjunto de configurações.

Verifique se o comando não retorna nenhuma saída. Uma solicitação bem-sucedida retorna uma resposta HTTP 200.

Desativando a supressão em nível de inquilino

Para devolver um inquilino à supressão no nível da conta, você pode definir o escopo ACCOUNT ou limpar todas as configurações de supressão.

Para definir a supressão em nível de conta do inquilino

Na linha de comando, execute o comando a seguir para definir explicitamente o escopo como: ACCOUNT

MyTenantSubstitua pelo nome do seu inquilino.

Verifique se o comando não retorna nenhuma saída.

Para limpar todas as configurações de supressão

Na linha de comando, execute o comando a seguir sem especificar o escopo ou os motivos:
```
aws sesv2 put-tenant-suppression-attributes --tenant-name MyTenant
```
MyTenantSubstitua pelo nome do seu inquilino.
Verifique se o comando não retorna nenhuma saída.

nota

Quando você omite ambos --suppression-scope e--suppressed-reasons, o SES limpa as configurações de supressão do inquilino. O inquilino volta ao comportamento de supressão no nível da conta.

Importante

Visualizando a configuração de supressão atual

Use a operação da GetTenant API para verificar as configurações atuais de supressão do inquilino.

Para visualizar a configuração de supressão de um inquilino

Na linha de comando, execute o seguinte get-tenant comando:
```
aws sesv2 get-tenant --tenant-name MyTenant
```
MyTenantSubstitua pelo nome do seu inquilino.

Revise a resposta. O exemplo a seguir mostra um inquilino com a supressão em nível de inquilino ativada:


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

A tabela a seguir descreve os campos-chave no SuppressionAttributes objeto.

Campo	Description
`SuppressionScope`	O escopo de supressão para o inquilino. Um valor de `TENANT` significa que o inquilino usa sua própria lista de supressão. Um valor de `ACCOUNT` significa que o inquilino usa a lista de supressão no nível da conta.
`SuppressedReasons`	Os motivos de supressão que estão ativos para o inquilino. Os valores possíveis são `BOUNCECOMPLAINT`, ou ambos.

Se SuppressionAttributes estiver ausente ou nulo na resposta, o inquilino usa a supressão no nível da conta.

Solução de problemas

A seguir estão os erros comuns que você pode encontrar ao configurar a supressão em nível de inquilino.

InvalidParameterValueException: SuppressedReasons cannot be null when SuppressionScope is provided

Causa — Você especificou --suppression-scope sem--suppressed-reasons.
Correção — Forneça os dois parâmetros juntos ou omita os dois para limpar as configurações.

InvalidParameterValueException: SuppressionScope is required when SuppressedReasons are provided

Causa — Você especificou --suppressed-reasons sem--suppression-scope.
Correção — Forneça os dois parâmetros juntos.

NotFoundException

Causa — O nome do inquilino que você especificou não existe.
Correção — Verifique o nome do inquilino executando o seguinte comando:
```
aws sesv2 list-tenants
```

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Tenant-levellistas de supressão

Gerenciando entradas de supressão de inquilinos