File Coverage

blib/lib/Paws/SES/WorkmailAction.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::WorkmailAction;
2 1     1   427 use Moose;
  1         3  
  1         7  
3             has OrganizationArn => (is => 'ro', isa => 'Str', required => 1);
4             has TopicArn => (is => 'ro', isa => 'Str');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::SES::WorkmailAction
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::WorkmailAction object:
23              
24             $service_obj->Method(Att1 => { OrganizationArn => $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::WorkmailAction object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->OrganizationArn
32              
33             =head1 DESCRIPTION
34              
35             When included in a receipt rule, this action calls Amazon WorkMail and,
36             optionally, publishes a notification to Amazon Simple Notification
37             Service (Amazon SNS). You will typically not use this action directly
38             because Amazon WorkMail adds the rule automatically during its setup
39             procedure.
40              
41             For information using a receipt rule to call Amazon WorkMail, see the
42             Amazon SES Developer Guide.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 B<REQUIRED> OrganizationArn => Str
48              
49             The ARN of the Amazon WorkMail organization. An example of an Amazon
50             WorkMail organization ARN is
51             C<arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7>.
52             For information about Amazon WorkMail organizations, see the Amazon
53             WorkMail Administrator Guide.
54              
55              
56             =head2 TopicArn => Str
57              
58             The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when
59             the WorkMail action is called. An example of an Amazon SNS topic ARN is
60             C<arn:aws:sns:us-west-2:123456789012:MyTopic>. For more information
61             about Amazon SNS topics, see the Amazon SNS Developer Guide.
62              
63              
64              
65             =head1 SEE ALSO
66              
67             This class forms part of L<Paws>, describing an object used in L<Paws::SES>
68              
69             =head1 BUGS and CONTRIBUTIONS
70              
71             The source code is located here: https://github.com/pplu/aws-sdk-perl
72              
73             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
74              
75             =cut
76