SES / Client / set_identity_notification_topic

set_identity_notification_topic#

SES.Client.set_identity_notification_topic(**kwargs)#

Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.

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

For more information about feedback notification, see the Amazon SES Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.set_identity_notification_topic(
    Identity='string',
    NotificationType='Bounce'|'Complaint'|'Delivery',
    SnsTopic='string'
)
Parameters:

  • Identity (string) –

    [REQUIRED]

    The identity (email address or domain) that you want to set the Amazon SNS topic for.

    Warning

    You can only specify a verified identity for this parameter.

    You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

  • NotificationType (string) –

    [REQUIRED]

    The type of notifications that will be published to the specified Amazon SNS topic.

  • SnsTopic (string) – The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    An empty element returned on a successful request.

Examples

The following example sets the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with the specified identity as the Source:

response = client.set_identity_notification_topic(
    Identity='user@example.com',
    NotificationType='Bounce',
    SnsTopic='arn:aws:sns:us-west-2:111122223333:MyTopic',
)

print(response)

Expected Output:

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