SES / Client / get_identity_notification_attributes

get_identity_notification_attributes

SES.Client.get_identity_notification_attributes(**kwargs)

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

This operation 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.

See also: AWS API Documentation

Request Syntax

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

Parameters:

Identities (list) –

[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) –

Return type:

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 publishes bounce notifications.

        • ComplaintTopic (string) –

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

        • DeliveryTopic (string) –

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

        • ForwardingEnabled (boolean) –

          Describes whether Amazon SES forwards bounce and complaint notifications as email. true indicates that Amazon SES forwards bounce and complaint notifications as email, while false indicates that bounce and complaint notifications are 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 includes headers in bounce notifications, and a value of false specifies that Amazon SES does 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 includes headers in complaint notifications, and a value of false specifies that Amazon SES does 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 includes headers in delivery notifications, and a value of false specifies that Amazon SES does not include headers in delivery notifications.

Examples

The following example returns the notification attributes for an identity:

response = client.get_identity_notification_attributes(
    Identities=[
        'example.com',
    ],
)

print(response)

Expected Output:

{
    'NotificationAttributes': {
        'example.com': {
            'BounceTopic': 'arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic',
            'ComplaintTopic': 'arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic',
            'DeliveryTopic': 'arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic',
            'ForwardingEnabled': True,
            'HeadersInBounceNotificationsEnabled': False,
            'HeadersInComplaintNotificationsEnabled': False,
            'HeadersInDeliveryNotificationsEnabled': False,
        },
    },
    'ResponseMetadata': {
        '...': '...',
    },
}