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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass SetIdentityNotificationTopicRequest data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#identityString

The identity for which the Amazon SNS topic will be set. 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.

Returns:

  • (String)


4604
4605
4606
4607
4608
4609
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4604

class SetIdentityNotificationTopicRequest < Struct.new(
  :identity,
  :notification_type,
  :sns_topic)
  include Aws::Structure
end

#notification_typeString

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

Returns:

  • (String)


4604
4605
4606
4607
4608
4609
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4604

class SetIdentityNotificationTopicRequest < Struct.new(
  :identity,
  :notification_type,
  :sns_topic)
  include Aws::Structure
end

#sns_topicString

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)


4604
4605
4606
4607
4608
4609
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4604

class SetIdentityNotificationTopicRequest < Struct.new(
  :identity,
  :notification_type,
  :sns_topic)
  include Aws::Structure
end