SES / Client / set_identity_headers_in_notifications_enabled

set_identity_headers_in_notifications_enabled#

SES.Client.set_identity_headers_in_notifications_enabled(**kwargs)#

Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

You can execute this operation no more than once per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.set_identity_headers_in_notifications_enabled(
    Identity='string',
    NotificationType='Bounce'|'Complaint'|'Delivery',
    Enabled=True|False
)
Parameters:

  • Identity (string) –

    [REQUIRED]

    The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

  • NotificationType (string) –

    [REQUIRED]

    The notification type for which to enable or disable headers in notifications.

  • Enabled (boolean) –

    [REQUIRED]

    Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES includes headers in notifications, and a value of false specifies that Amazon SES does not include headers in notifications.

    This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    An empty element returned on a successful request.

Examples

The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications for an identity:

response = client.set_identity_headers_in_notifications_enabled(
    Enabled=True,
    Identity='user@example.com',
    NotificationType='Bounce',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}