Amazon Simple Email Service

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.

This action is throttled at one request per second.

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

Request Syntax

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

type Identity

string

param Identity

[REQUIRED]

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

type NotificationType

string

param NotificationType

[REQUIRED]

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

type Enabled

boolean

param Enabled

[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 will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

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

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

  An empty element returned on a successful request.

{'NotificationAttributes': {'HeadersInBounceNotificationsEnabled': 'boolean',
                            'HeadersInComplaintNotificationsEnabled': 'boolean',
                            'HeadersInDeliveryNotificationsEnabled': 'boolean'}}

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.

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

Request Syntax

client.get_identity_notification_attributes(
    Identities=[
        'string',
    ]
)

type Identities

list

param Identities

[REQUIRED]

A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com , example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com .

• (string) --

rtype

dict

returns

Response Syntax

{
    'NotificationAttributes': {
        'string': {
            'BounceTopic': 'string',
            'ComplaintTopic': 'string',
            'DeliveryTopic': 'string',
            'ForwardingEnabled': True|False,
            'HeadersInBounceNotificationsEnabled': True|False,
            'HeadersInComplaintNotificationsEnabled': True|False,
            'HeadersInDeliveryNotificationsEnabled': True|False
        }
    }
}

Response Structure

• (dict) --

  Represents the notification attributes for a list of identities.

  • NotificationAttributes (dict) --

    A map of Identity to IdentityNotificationAttributes.

    • (string) --

      • (dict) --

        Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.

        • BounceTopic (string) --

          The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.

        • ComplaintTopic (string) --

          The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.

        • DeliveryTopic (string) --

          The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.

        • ForwardingEnabled (boolean) --

          Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.

        • HeadersInBounceNotificationsEnabled (boolean) --

          Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce . A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications.

        • HeadersInComplaintNotificationsEnabled (boolean) --

          Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint . A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications.

        • HeadersInDeliveryNotificationsEnabled (boolean) --

          Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery . A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications.