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

Class: Aws::SES::Types::SNSAction

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 SNSAction data as a hash:

{
  topic_arn: "AmazonResourceName", # required
  encoding: "UTF-8", # accepts UTF-8, Base64
}

When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.

If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.

You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.

For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#encodingString

The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

Returns:

  • (String)


3716
3717
3718
3719
3720
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 3716

class SNSAction < Struct.new(
  :topic_arn,
  :encoding)
  include Aws::Structure
end

#topic_arnString

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Returns:

  • (String)


3716
3717
3718
3719
3720
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 3716

class SNSAction < Struct.new(
  :topic_arn,
  :encoding)
  include Aws::Structure
end