blib/lib/Paws/SES/S3Action.pm untested

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 8 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::SES::S3Action;
3 use Moose;
4 has BucketName => (is => 'ro', isa => 'Str', required => 1);
5 has KmsKeyArn => (is => 'ro', isa => 'Str');
6 has ObjectKeyPrefix => (is => 'ro', isa => 'Str');
7 has TopicArn => (is => 'ro', isa => 'Str');
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::SES::S3Action
16  
17 =head1 USAGE
18  
19 This class represents one of two things:
20  
21 =head3 Arguments in a call to a service
22  
23 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24 Each attribute should be used as a named argument in the calls that expect this type of object.
25  
26 As an example, if Att1 is expected to be a Paws::SES::S3Action object:
27  
28 $service_obj->Method(Att1 => { BucketName => $value, ..., TopicArn => $value });
29  
30 =head3 Results returned from an API call
31  
32 Use accessors for each attribute. If Att1 is expected to be an Paws::SES::S3Action object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->BucketName
36  
37 =head1 DESCRIPTION
38  
39 When included in a receipt rule, this action saves the received message
40 to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally,
41 publishes a notification to Amazon Simple Notification Service (Amazon
42 SNS).
43  
44 To enable Amazon SES to write emails to your Amazon S3 bucket, use an
45 AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic
46 of another account, Amazon SES must have permission to access those
47 resources. For information about giving permissions, see the Amazon SES
48 Developer Guide
49 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html).
50  
51 When you save your emails to an Amazon S3 bucket, the maximum email
52 size (including headers) is 30 MB. Emails larger than that will bounce.
53  
54 For information about specifying Amazon S3 actions in receipt rules,
55 see the Amazon SES Developer Guide
56 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-s3.html).
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 B<REQUIRED> BucketName => Str
62  
63 The name of the Amazon S3 bucket that incoming email will be saved to.
64  
65  
66 =head2 KmsKeyArn => Str
67  
68 The customer master key that Amazon SES should use to encrypt your
69 emails before saving them to the Amazon S3 bucket. You can use the
70 default master key or a custom master key you created in AWS KMS as
71 follows:
72  
73 =over
74  
75 =item *
76  
77 To use the default master key, provide an ARN in the form of
78 C<arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses>. For
79 example, if your AWS account ID is 123456789012 and you want to use the
80 default master key in the US West (Oregon) region, the ARN of the
81 default master key would be
82 C<arn:aws:kms:us-west-2:123456789012:alias/aws/ses>. If you use the
83 default master key, you don't need to perform any extra steps to give
84 Amazon SES permission to use the key.
85  
86 =item *
87  
88 To use a custom master key you created in AWS KMS, provide the ARN of
89 the master key and ensure that you add a statement to your key's policy
90 to give Amazon SES permission to use it. For more information about
91 giving permissions, see the Amazon SES Developer Guide
92 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html).
93  
94 =back
95  
96 For more information about key policies, see the AWS KMS Developer
97 Guide
98 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html).
99 If you do not specify a master key, Amazon SES will not encrypt your
100 emails.
101  
102 Your mail is encrypted by Amazon SES using the Amazon S3 encryption
103 client before the mail is submitted to Amazon S3 for storage. It is not
104 encrypted using Amazon S3 server-side encryption. This means that you
105 must use the Amazon S3 encryption client to decrypt the email after
106 retrieving it from Amazon S3, as the service has no access to use your
107 AWS KMS keys for decryption. This encryption client is currently
108 available with the AWS SDK for Java
109 (http://aws.amazon.com/sdk-for-java/) and AWS SDK for Ruby
110 (http://aws.amazon.com/sdk-for-ruby/) only. For more information about
111 client-side encryption using AWS KMS master keys, see the Amazon S3
112 Developer Guide
113 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html).
114  
115  
116 =head2 ObjectKeyPrefix => Str
117  
118 The key prefix of the Amazon S3 bucket. The key prefix is similar to a
119 directory name that enables you to store similar data under the same
120 directory in a bucket.
121  
122  
123 =head2 TopicArn => Str
124  
125 The ARN of the Amazon SNS topic to notify when the message is saved to
126 the Amazon S3 bucket. An example of an Amazon SNS topic ARN is
127 C<arn:aws:sns:us-west-2:123456789012:MyTopic>. For more information
128 about Amazon SNS topics, see the Amazon SNS Developer Guide
129 (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html).
130  
131  
132  
133 =head1 SEE ALSO
134  
135 This class forms part of L<Paws>, describing an object used in L<Paws::SES>
136  
137 =head1 BUGS and CONTRIBUTIONS
138  
139 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
140  
141 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
142  
143 =cut
144