SESV2 / Client / get_suppressed_destination

get_suppressed_destination

SESV2.Client.get_suppressed_destination(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_suppressed_destination(
    EmailAddress='string',
    TenantName='string'
)
Parameters:

  • EmailAddress (string) –

    [REQUIRED]

    The email address that’s on the suppression list for your account or for the specified tenant.

  • TenantName (string) – The name of the tenant whose suppression list you want to query. If you omit this parameter, the operation targets the account-level suppression list.

Return type:

dict

Returns:

Response Syntax

{
    'SuppressedDestination': {
        'EmailAddress': 'string',
        'Reason': 'BOUNCE'|'COMPLAINT',
        'LastUpdateTime': datetime(2015, 1, 1),
        'Attributes': {
            'MessageId': 'string',
            'FeedbackId': 'string'
        },
        'TenantName': 'string'
    }
}

Response Structure

  • (dict) –

    Information about the suppressed email address.

    • SuppressedDestination (dict) –

      An object containing information about the suppressed email address.

      • EmailAddress (string) –

        The email address that is on the suppression list for your account or for a specific tenant.

      • Reason (string) –

        The reason that the address was added to the suppression list for your account or for a specific tenant.

      • LastUpdateTime (datetime) –

        The date and time when the suppressed destination was last updated, shown in Unix time format.

      • Attributes (dict) –

        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.

        • MessageId (string) –

          The unique identifier of the email message that caused the email address to be added to the suppression list for your account or for a specific tenant.

        • FeedbackId (string) –

          A unique identifier that’s generated when an email address is added to the suppression list for your account or for a specific tenant.

      • TenantName (string) –

        The name of the tenant that the suppressed destination belongs to. This field is present only when the suppressed destination is on a tenant’s suppression list.

Exceptions