com.amazonaws.services.simpleemail.model

Class SNSAction

java.lang.Object

com.amazonaws.services.simpleemail.model.SNSAction

All Implemented Interfaces:

java.io.Serializable

public class SNSAction
extends java.lang.Object
implements java.io.Serializable

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SNSAction()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEncoding() The encoding to use for the email within the Amazon SNS notification.
java.lang.String	getTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
int	hashCode()
void	setEncoding(SNSActionEncoding encoding) The encoding to use for the email within the Amazon SNS notification.
void	setEncoding(java.lang.String encoding) The encoding to use for the email within the Amazon SNS notification.
void	setTopicArn(java.lang.String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SNSAction	withEncoding(SNSActionEncoding encoding) The encoding to use for the email within the Amazon SNS notification.
SNSAction	withEncoding(java.lang.String encoding) The encoding to use for the email within the Amazon SNS notification.
SNSAction	withTopicArn(java.lang.String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SNSAction

public SNSAction()

Method Detail

getTopicArn

public java.lang.String getTopicArn()

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:

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.

setTopicArn

public void setTopicArn(java.lang.String topicArn)

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.

Parameters:

topicArn -

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.

withTopicArn

public SNSAction withTopicArn(java.lang.String topicArn)

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 a reference to this object so that method calls can be chained together.

Parameters:

topicArn -

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:

A reference to this updated object so that method calls can be chained together.

getEncoding

public java.lang.String getEncoding()

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.

Constraints:
Allowed Values: UTF-8, Base64

Returns:

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.

See Also:

SNSActionEncoding

setEncoding

public void setEncoding(java.lang.String encoding)

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.

Constraints:
Allowed Values: UTF-8, Base64

Parameters:

encoding -

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.

See Also:

SNSActionEncoding

withEncoding

public SNSAction withEncoding(java.lang.String encoding)

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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: UTF-8, Base64

Parameters:

encoding -

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:

A reference to this updated object so that method calls can be chained together.

See Also:

SNSActionEncoding

setEncoding

public void setEncoding(SNSActionEncoding encoding)

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.

Constraints:
Allowed Values: UTF-8, Base64

Parameters:

encoding -

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.

See Also:

SNSActionEncoding

withEncoding

public SNSAction withEncoding(SNSActionEncoding encoding)

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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: UTF-8, Base64

Parameters:

encoding -

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:

A reference to this updated object so that method calls can be chained together.

See Also:

SNSActionEncoding

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object