File Coverage

blib/lib/Paws/RDS/DescribeEvents.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RDS::DescribeEvents;
3 1     1   377 use Moose;
  1     1   3  
  1         8  
  1         746  
  1         4  
  1         10  
4             has Duration => (is => 'ro', isa => 'Int');
5             has EndTime => (is => 'ro', isa => 'Str');
6             has EventCategories => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]');
8             has Marker => (is => 'ro', isa => 'Str');
9             has MaxRecords => (is => 'ro', isa => 'Int');
10             has SourceIdentifier => (is => 'ro', isa => 'Str');
11             has SourceType => (is => 'ro', isa => 'Str');
12             has StartTime => (is => 'ro', isa => 'Str');
13              
14 1     1   5870 use MooseX::ClassAttribute;
  1     1   3  
  1         7  
  1         10155  
  1         4  
  1         11  
15              
16             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEvents');
17             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::EventsMessage');
18             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeEventsResult');
19             1;
20              
21             ### main pod documentation begin ###
22              
23             =head1 NAME
24              
25             Paws::RDS::DescribeEvents - Arguments for method DescribeEvents on Paws::RDS
26              
27             =head1 DESCRIPTION
28              
29             This class represents the parameters used for calling the method DescribeEvents on the
30             Amazon Relational Database Service service. Use the attributes of this class
31             as arguments to method DescribeEvents.
32              
33             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEvents.
34              
35             As an example:
36              
37             $service_obj->DescribeEvents(Att1 => $value1, Att2 => $value2, ...);
38              
39             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 Duration => Int
45              
46             The number of minutes to retrieve events for.
47              
48             Default: 60
49              
50              
51              
52             =head2 EndTime => Str
53              
54             The end of the time interval for which to retrieve events, specified in
55             ISO 8601 format. For more information about ISO 8601, go to the ISO8601
56             Wikipedia page.
57              
58             Example: 2009-07-08T18:00Z
59              
60              
61              
62             =head2 EventCategories => ArrayRef[Str|Undef]
63              
64             A list of event categories that trigger notifications for a event
65             notification subscription.
66              
67              
68              
69             =head2 Filters => ArrayRef[L<Paws::RDS::Filter>]
70              
71             This parameter is not currently supported.
72              
73              
74              
75             =head2 Marker => Str
76              
77             An optional pagination token provided by a previous DescribeEvents
78             request. If this parameter is specified, the response includes only
79             records beyond the marker, up to the value specified by C<MaxRecords>.
80              
81              
82              
83             =head2 MaxRecords => Int
84              
85             The maximum number of records to include in the response. If more
86             records exist than the specified C<MaxRecords> value, a pagination
87             token called a marker is included in the response so that the remaining
88             results can be retrieved.
89              
90             Default: 100
91              
92             Constraints: Minimum 20, maximum 100.
93              
94              
95              
96             =head2 SourceIdentifier => Str
97              
98             The identifier of the event source for which events will be returned.
99             If not specified, then all sources are included in the response.
100              
101             Constraints:
102              
103             =over
104              
105             =item *
106              
107             If SourceIdentifier is supplied, SourceType must also be provided.
108              
109             =item *
110              
111             If the source type is C<DBInstance>, then a C<DBInstanceIdentifier>
112             must be supplied.
113              
114             =item *
115              
116             If the source type is C<DBSecurityGroup>, a C<DBSecurityGroupName> must
117             be supplied.
118              
119             =item *
120              
121             If the source type is C<DBParameterGroup>, a C<DBParameterGroupName>
122             must be supplied.
123              
124             =item *
125              
126             If the source type is C<DBSnapshot>, a C<DBSnapshotIdentifier> must be
127             supplied.
128              
129             =item *
130              
131             Cannot end with a hyphen or contain two consecutive hyphens.
132              
133             =back
134              
135              
136              
137              
138             =head2 SourceType => Str
139              
140             The event source to retrieve events for. If no value is specified, all
141             events are returned.
142              
143             Valid values are: C<"db-instance">, C<"db-parameter-group">, C<"db-security-group">, C<"db-snapshot">, C<"db-cluster">, C<"db-cluster-snapshot">
144              
145             =head2 StartTime => Str
146              
147             The beginning of the time interval to retrieve events for, specified in
148             ISO 8601 format. For more information about ISO 8601, go to the ISO8601
149             Wikipedia page.
150              
151             Example: 2009-07-08T18:00Z
152              
153              
154              
155              
156             =head1 SEE ALSO
157              
158             This class forms part of L<Paws>, documenting arguments for method DescribeEvents in L<Paws::RDS>
159              
160             =head1 BUGS and CONTRIBUTIONS
161              
162             The source code is located here: https://github.com/pplu/aws-sdk-perl
163              
164             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
165              
166             =cut
167