suppressed_destinations

Creates, updates, deletes, gets or lists a suppressed_destinations resource.

Overview

Name	suppressed_destinations
Type	Resource
Id	aws.sesv2.suppressed_destinations

Fields

The following fields are returned by SELECT queries:

get_suppressed_destination

Name	Datatype	Description
attributes	object	An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account or for a specific tenant.
email_address	string	The email address that is on the suppression list for your account or for a specific tenant.
last_update_time	string (date-time)	The date and time when the suppressed destination was last updated, shown in Unix time format.
reason	string	The reason that the address was added to the suppression list for your account or for a specific tenant. The value can be one of the following: COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant because a message sent to that address results in a complaint. BOUNCE – Amazon SES added an email address to the suppression list for your account or for a specific tenant because a message sent to that address results in a hard bounce. (BOUNCE, COMPLAINT)
tenant_name	string	The name of a tenant. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

list_suppressed_destinations

Name	Datatype	Description
next_token	string	A token that indicates that there are additional email addresses on the suppression list for your account or for the specified tenant. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter.
suppressed_destination_summaries	array	A list of summaries, each containing a summary for a suppressed email destination.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_suppressed_destination	select	email_address, region	TenantName	Retrieves information about a specific email address that's on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list.
list_suppressed_destinations	select	region	TenantName, Reason, StartDate, EndDate, NextToken, PageSize	Retrieves a list of email addresses that are on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list.
put_suppressed_destination	replace	region, EmailAddress, Reason		Adds an email address to the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the address is added to the account-level suppression list.
delete_suppressed_destination	delete	email_address, region	TenantName	Removes an email address from the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the address is removed from the account-level suppression list.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
email_address	string	The suppressed email destination to remove from the suppression list for your account or for the specified tenant.
region	string	AWS region (default: us-east-1)
EndDate	string (date-time)	Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.
NextToken	string	A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.
PageSize	integer	The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
Reason	array	The factors that caused the email address to be added to the suppression list for your account or for a specific tenant.
StartDate	string (date-time)	Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.
TenantName	string	The name of the tenant whose suppression list you want to remove the address from. If you omit this parameter, the address is removed from the account-level suppression list.

SELECT examples

get_suppressed_destination

Retrieves information about a specific email address that's on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list.

SELECT
attributes,
email_address,
last_update_time,
reason,
tenant_name
FROM aws.sesv2.suppressed_destinations
WHERE email_address = '{{ email_address }}' -- required
AND region = '{{ region }}' -- required
AND TenantName = '{{ TenantName }}'
;

list_suppressed_destinations

Retrieves a list of email addresses that are on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list.

SELECT
next_token,
suppressed_destination_summaries
FROM aws.sesv2.suppressed_destinations
WHERE region = '{{ region }}' -- required
AND TenantName = '{{ TenantName }}'
AND Reason = '{{ Reason }}'
AND StartDate = '{{ StartDate }}'
AND EndDate = '{{ EndDate }}'
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

REPLACE examples

put_suppressed_destination

Adds an email address to the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the address is added to the account-level suppression list.

REPLACE aws.sesv2.suppressed_destinations
SET 
EmailAddress = '{{ EmailAddress }}',
Reason = '{{ Reason }}',
TenantName = '{{ TenantName }}'
WHERE 
region = '{{ region }}' --required
AND EmailAddress = '{{ EmailAddress }}' --required
AND Reason = '{{ Reason }}' --required;

DELETE examples

delete_suppressed_destination

Removes an email address from the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the address is removed from the account-level suppression list.

DELETE FROM aws.sesv2.suppressed_destinations
WHERE email_address = '{{ email_address }}' --required
AND region = '{{ region }}' --required
AND TenantName = '{{ TenantName }}'
;