File Coverage

blib/lib/Paws/RedShift/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	sub	time	code
1
2				package Paws::RedShift::DescribeEvents;
3	1	1	356	use Moose;
	1	1	3
	1		9
	1		472
	1		3
	1		16
4				has Duration => (is => 'ro', isa => 'Int');
5				has EndTime => (is => 'ro', isa => 'Str');
6				has Marker => (is => 'ro', isa => 'Str');
7				has MaxRecords => (is => 'ro', isa => 'Int');
8				has SourceIdentifier => (is => 'ro', isa => 'Str');
9				has SourceType => (is => 'ro', isa => 'Str');
10				has StartTime => (is => 'ro', isa => 'Str');
11
12	1	1	6520	use MooseX::ClassAttribute;
	1	1	4
	1		10
	1		6351
	1		2
	1		7
13
14				class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEvents');
15				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::EventsMessage');
16				class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeEventsResult');
17				1;
18
19				### main pod documentation begin ###
20
21				=head1 NAME
22
23				Paws::RedShift::DescribeEvents - Arguments for method DescribeEvents on Paws::RedShift
24
25				=head1 DESCRIPTION
26
27				This class represents the parameters used for calling the method DescribeEvents on the
28				Amazon Redshift service. Use the attributes of this class
29				as arguments to method DescribeEvents.
30
31				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEvents.
32
33				As an example:
34
35				$service_obj->DescribeEvents(Att1 => $value1, Att2 => $value2, ...);
36
37				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.
38
39				=head1 ATTRIBUTES
40
41
42				=head2 Duration => Int
43
44				The number of minutes prior to the time of the request for which to
45				retrieve events. For example, if the request is sent at 18:00 and you
46				specify a duration of 60, then only events which have occurred after
47				17:00 will be returned.
48
49				Default: C<60>
50
51
52
53				=head2 EndTime => Str
54
55				The end of the time interval for which to retrieve events, specified in
56				ISO 8601 format. For more information about ISO 8601, go to the ISO8601
57				Wikipedia page.
58
59				Example: C<2009-07-08T18:00Z>
60
61
62
63				=head2 Marker => Str
64
65				An optional parameter that specifies the starting point to return a set
66				of response records. When the results of a DescribeEvents request
67				exceed the value specified in C<MaxRecords>, AWS returns a value in the
68				C<Marker> field of the response. You can retrieve the next set of
69				response records by providing the returned marker value in the
70				C<Marker> parameter and retrying the request.
71
72
73
74				=head2 MaxRecords => Int
75
76				The maximum number of response records to return in each call. If the
77				number of remaining response records exceeds the specified
78				C<MaxRecords> value, a value is returned in a C<marker> field of the
79				response. You can retrieve the next set of records by retrying the
80				command with the returned marker value.
81
82				Default: C<100>
83
84				Constraints: minimum 20, maximum 100.
85
86
87
88				=head2 SourceIdentifier => Str
89
90				The identifier of the event source for which events will be returned.
91				If this parameter is not specified, then all sources are included in
92				the response.
93
94				Constraints:
95
96				If I<SourceIdentifier> is supplied, I<SourceType> must also be
97				provided.
98
99				=over
100
101				=item *
102
103				Specify a cluster identifier when I<SourceType> is C<cluster>.
104
105				=item *
106
107				Specify a cluster security group name when I<SourceType> is
108				C<cluster-security-group>.
109
110				=item *
111
112				Specify a cluster parameter group name when I<SourceType> is
113				C<cluster-parameter-group>.
114
115				=item *
116
117				Specify a cluster snapshot identifier when I<SourceType> is
118				C<cluster-snapshot>.
119
120				=back
121
122
123
124
125				=head2 SourceType => Str
126
127				The event source to retrieve events for. If no value is specified, all
128				events are returned.
129
130				Constraints:
131
132				If I<SourceType> is supplied, I<SourceIdentifier> must also be
133				provided.
134
135				=over
136
137				=item *
138
139				Specify C<cluster> when I<SourceIdentifier> is a cluster identifier.
140
141				=item *
142
143				Specify C<cluster-security-group> when I<SourceIdentifier> is a cluster
144				security group name.
145
146				=item *
147
148				Specify C<cluster-parameter-group> when I<SourceIdentifier> is a
149				cluster parameter group name.
150
151				=item *
152
153				Specify C<cluster-snapshot> when I<SourceIdentifier> is a cluster
154				snapshot identifier.
155
156				=back
157
158
159				Valid values are: C<"cluster">, C<"cluster-parameter-group">, C<"cluster-security-group">, C<"cluster-snapshot">
160
161				=head2 StartTime => Str
162
163				The beginning of the time interval to retrieve events for, specified in
164				ISO 8601 format. For more information about ISO 8601, go to the ISO8601
165				Wikipedia page.
166
167				Example: C<2009-07-08T18:00Z>
168
169
170
171
172				=head1 SEE ALSO
173
174				This class forms part of L<Paws>, documenting arguments for method DescribeEvents in L<Paws::RedShift>
175
176				=head1 BUGS and CONTRIBUTIONS
177
178				The source code is located here: https://github.com/pplu/aws-sdk-perl
179
180				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
181
182				=cut
183