| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SES.SetIdentityNotificationTopic
Description
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.
Synopsis
- data SetIdentityNotificationTopic = SetIdentityNotificationTopic' {}
- newSetIdentityNotificationTopic :: Text -> NotificationType -> SetIdentityNotificationTopic
- setIdentityNotificationTopic_snsTopic :: Lens' SetIdentityNotificationTopic (Maybe Text)
- setIdentityNotificationTopic_identity :: Lens' SetIdentityNotificationTopic Text
- setIdentityNotificationTopic_notificationType :: Lens' SetIdentityNotificationTopic NotificationType
- data SetIdentityNotificationTopicResponse = SetIdentityNotificationTopicResponse' {
- httpStatus :: Int
- newSetIdentityNotificationTopicResponse :: Int -> SetIdentityNotificationTopicResponse
- setIdentityNotificationTopicResponse_httpStatus :: Lens' SetIdentityNotificationTopicResponse Int
Creating a Request
data SetIdentityNotificationTopic Source #
Represents a request to specify the Amazon SNS topic to which Amazon SES will publish bounce, complaint, or delivery notifications for emails sent with that identity as the Source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
See: newSetIdentityNotificationTopic smart constructor.
Constructors
| SetIdentityNotificationTopic' | |
Fields
| |
Instances
newSetIdentityNotificationTopic Source #
Arguments
| :: Text | |
| -> NotificationType | |
| -> SetIdentityNotificationTopic |
Create a value of SetIdentityNotificationTopic with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snsTopic:SetIdentityNotificationTopic', setIdentityNotificationTopic_snsTopic - 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.
$sel:identity:SetIdentityNotificationTopic', setIdentityNotificationTopic_identity - The identity (email address or domain) that you want to set the Amazon
SNS topic for.
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.
$sel:notificationType:SetIdentityNotificationTopic', setIdentityNotificationTopic_notificationType - The type of notifications that will be published to the specified Amazon
SNS topic.
Request Lenses
setIdentityNotificationTopic_snsTopic :: Lens' SetIdentityNotificationTopic (Maybe Text) Source #
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.
setIdentityNotificationTopic_identity :: Lens' SetIdentityNotificationTopic Text Source #
The identity (email address or domain) that you want to set the Amazon SNS topic for.
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.
setIdentityNotificationTopic_notificationType :: Lens' SetIdentityNotificationTopic NotificationType Source #
The type of notifications that will be published to the specified Amazon SNS topic.
Destructuring the Response
data SetIdentityNotificationTopicResponse Source #
An empty element returned on a successful request.
See: newSetIdentityNotificationTopicResponse smart constructor.
Constructors
| SetIdentityNotificationTopicResponse' | |
Fields
| |
Instances
newSetIdentityNotificationTopicResponse Source #
Arguments
| :: Int | |
| -> SetIdentityNotificationTopicResponse |
Create a value of SetIdentityNotificationTopicResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SetIdentityNotificationTopicResponse', setIdentityNotificationTopicResponse_httpStatus - The response's http status code.
Response Lenses
setIdentityNotificationTopicResponse_httpStatus :: Lens' SetIdentityNotificationTopicResponse Int Source #
The response's http status code.