Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_suppressed_destination

get_suppressed_destination(**kwargs)

Retrieves information about a specific email address that's on the suppression list for your account.

See also: AWS API Documentation

Request Syntax

response = client.get_suppressed_destination(
    EmailAddress='string'
)
Parameters
EmailAddress (string) --

[REQUIRED]

The email address that's on the account suppression list.

Return type
dict
Returns
Response Syntax
{
    'SuppressedDestination': {
        'EmailAddress': 'string',
        'Reason': 'BOUNCE'|'COMPLAINT',
        'LastUpdateTime': datetime(2015, 1, 1),
        'Attributes': {
            'MessageId': 'string',
            'FeedbackId': '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.

      • Reason (string) --

        The reason that the address was added to the suppression list for your account.

      • 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.

        • MessageId (string) --

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

        • FeedbackId (string) --

          A unique identifier that's generated when an email address is added to the suppression list for your account.

Exceptions

  • SESV2.Client.exceptions.BadRequestException
  • SESV2.Client.exceptions.TooManyRequestsException
  • SESV2.Client.exceptions.NotFoundException