File Coverage

blib/lib/Paws/SES/SNSAction.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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