You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SES::Types::SetIdentityNotificationTopicRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SetIdentityNotificationTopicRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  identity: "Identity", # required
  notification_type: "Bounce", # required, accepts Bounce, Complaint, Delivery
  sns_topic: "NotificationTopic",
}

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 Also:

Instance Attribute Summary collapse

Instance Attribute Details

#identity ⇒ String

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.

Returns:

  • (String) —

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

#notification_type ⇒ String

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

Possible values:

  • Bounce
  • Complaint
  • Delivery

Returns:

  • (String) —

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

#sns_topic ⇒ 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.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the Amazon SNS topic.