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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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].

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html

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: ‘[email protected]`, `example.com`, `arn:aws:ses:us-east-1:123456789012:identity/example.com`.

Returns:

  • (String) 


5026
5027
5028
5029
5030
5031
 
# File 'lib/aws-sdk-ses/types.rb', line 5026

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

#notification_type ⇒ String

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

Returns:

  • (String) 


5026
5027
5028
5029
5030
5031
 
# File 'lib/aws-sdk-ses/types.rb', line 5026

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

#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) 


5026
5027
5028
5029
5030
5031
 
# File 'lib/aws-sdk-ses/types.rb', line 5026

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