File Coverage

blib/lib/Paws/Snowball/Notification.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::Snowball::Notification;
2 1     1   562 use Moose;
  1         3  
  1         8  
3             has JobStatesToNotify => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
4             has NotifyAll => (is => 'ro', isa => 'Bool');
5             has SnsTopicARN => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::Snowball::Notification
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::Snowball::Notification object:
24              
25             $service_obj->Method(Att1 => { JobStatesToNotify => $value, ..., SnsTopicARN => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::Snowball::Notification object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->JobStatesToNotify
33              
34             =head1 DESCRIPTION
35              
36             The Amazon Simple Notification Service (Amazon SNS) notification
37             settings associated with a specific job. The C<Notification> object is
38             returned as a part of the response syntax of the C<DescribeJob> action
39             in the C<JobMetadata> data type.
40              
41             When the notification settings are defined during job creation, you can
42             choose to notify based on a specific set of job states using the
43             C<JobStatesToNotify> array of strings, or you can specify that you want
44             to have Amazon SNS notifications sent out for all job states with
45             C<NotifyAll> set to true.
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 JobStatesToNotify => ArrayRef[Str|Undef]
51              
52             The list of job states that will trigger a notification for this job.
53              
54              
55             =head2 NotifyAll => Bool
56              
57             Any change in job state will trigger a notification for this job.
58              
59              
60             =head2 SnsTopicARN => Str
61              
62             The new SNS C<TopicArn> that you want to associate with this job. You
63             can create Amazon Resource Names (ARNs) for topics by using the
64             CreateTopic Amazon SNS API action.
65              
66             You can subscribe email addresses to an Amazon SNS topic through the
67             AWS Management Console, or by using the Subscribe AWS Simple
68             Notification Service (SNS) API action.
69              
70              
71              
72             =head1 SEE ALSO
73              
74             This class forms part of L<Paws>, describing an object used in L<Paws::Snowball>
75              
76             =head1 BUGS and CONTRIBUTIONS
77              
78             The source code is located here: https://github.com/pplu/aws-sdk-perl
79              
80             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
81              
82             =cut
83