| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SES::SNSAction; | ||
| 3 | use Moose; | ||
| 4 | has Encoding => (is => 'ro', isa => 'Str'); | ||
| 5 | has TopicArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::SES::SNSAction | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::SES::SNSAction object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Encoding => $value, ..., TopicArn => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::SES::SNSAction object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Encoding | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | When included in a receipt rule, this action publishes a notification | ||
| 38 | to Amazon Simple Notification Service (Amazon SNS). This action | ||
| 39 | includes a complete copy of the email content in the Amazon SNS | ||
| 40 | notifications. Amazon SNS notifications for all other actions simply | ||
| 41 | provide information about the email. They do not include the email | ||
| 42 | content itself. | ||
| 43 | |||
| 44 | If you own the Amazon SNS topic, you don't need to do anything to give | ||
| 45 | Amazon SES permission to publish emails to it. However, if you don't | ||
| 46 | own the Amazon SNS topic, you need to attach a policy to the topic to | ||
| 47 | give Amazon SES permissions to access it. For information about giving | ||
| 48 | permissions, see the Amazon SES Developer Guide | ||
| 49 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). | ||
| 50 | |||
| 51 | You can only publish emails that are 150 KB or less (including the | ||
| 52 | header) to Amazon SNS. Larger emails will bounce. If you anticipate | ||
| 53 | emails larger than 150 KB, use the S3 action instead. | ||
| 54 | |||
| 55 | For information about using a receipt rule to publish an Amazon SNS | ||
| 56 | notification, see the Amazon SES Developer Guide | ||
| 57 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-sns.html). | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Encoding => Str | ||
| 63 | |||
| 64 | The encoding to use for the email within the Amazon SNS notification. | ||
| 65 | UTF-8 is easier to use, but may not preserve all special characters | ||
| 66 | when a message was encoded with a different encoding format. Base64 | ||
| 67 | preserves all special characters. The default value is UTF-8. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> TopicArn => Str | ||
| 71 | |||
| 72 | The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An | ||
| 73 | example of an Amazon SNS topic ARN is | ||
| 74 | C<arn:aws:sns:us-west-2:123456789012:MyTopic>. For more information | ||
| 75 | about Amazon SNS topics, see the Amazon SNS Developer Guide | ||
| 76 | (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, describing an object used in L<Paws::SES> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |