File Coverage

blib/lib/Paws/SES/StopAction.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::StopAction;
2 1     1   1673 use Moose;
  1         4  
  1         14  
3             has Scope => (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::StopAction
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::StopAction object:
23              
24             $service_obj->Method(Att1 => { Scope => $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::StopAction object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->Scope
32              
33             =head1 DESCRIPTION
34              
35             When included in a receipt rule, this action terminates the evaluation
36             of the receipt rule set and, optionally, publishes a notification to
37             Amazon Simple Notification Service (Amazon SNS).
38              
39             For information about setting a stop action in a receipt rule, see the
40             I< Amazon SES Developer Guide.>
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 B<REQUIRED> Scope => Str
46              
47             The name of the RuleSet that is being stopped.
48              
49              
50             =head2 TopicArn => Str
51              
52             The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when
53             the stop action is taken. An example of an Amazon SNS topic ARN is
54             C<arn:aws:sns:us-west-2:123456789012:MyTopic>. For more information
55             about Amazon SNS topics, see the Amazon SNS Developer Guide.
56              
57              
58              
59             =head1 SEE ALSO
60              
61             This class forms part of L<Paws>, describing an object used in L<Paws::SES>
62              
63             =head1 BUGS and CONTRIBUTIONS
64              
65             The source code is located here: https://github.com/pplu/aws-sdk-perl
66              
67             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
68              
69             =cut
70