blib/lib/Paws/RedShift/DescribeEvents.pm

filter: Statementstmt 100% 17 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 19 / 19 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RedShift/DescribeClusters.pm ↑ Summary blib/lib/Paws/RedShift/DescribeOrderableClusterOptions.pm »
1  
2 package Paws::RedShift::DescribeEvents;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has Duration => (is => 'ro', isa => 'Int');
5 1 has EndTime => (is => 'ro', isa => 'Str');
6 1 has Marker => (is => 'ro', isa => 'Str');
7 1 has MaxRecords => (is => 'ro', isa => 'Int');
8 1 has SourceIdentifier => (is => 'ro', isa => 'Str');
9 1 has SourceType => (is => 'ro', isa => 'Str');
10 1 has StartTime => (is => 'ro', isa => 'Str');
11  
12 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
13  
14 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEvents');
15 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::EventsMessage');
16 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeEventsResult');
17 1 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::RedShift::DescribeEvents - Arguments for method DescribeEvents on L<Paws::RedShift>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method DescribeEvents on the
28 L<Amazon Redshift|Paws::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 =head1 SYNOPSIS
34  
35 my $redshift = Paws->service('RedShift');
36 my $EventsMessage = $redshift->DescribeEvents(
37 Duration => 1, # OPTIONAL
38 EndTime => '1970-01-01T01:00:00', # OPTIONAL
39 Marker => 'MyString', # OPTIONAL
40 MaxRecords => 1, # OPTIONAL
41 SourceIdentifier => 'MyString', # OPTIONAL
42 SourceType => 'cluster', # OPTIONAL
43 StartTime => '1970-01-01T01:00:00', # OPTIONAL
44 );
45  
46 # Results:
47 my $Events = $EventsMessage->Events;
48 my $Marker = $EventsMessage->Marker;
49  
50 # Returns a L<Paws::RedShift::EventsMessage> object.
51  
52 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.
53 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeEvents>
54  
55 =head1 ATTRIBUTES
56  
57  
58 =head2 Duration => Int
59  
60 The number of minutes prior to the time of the request for which to
61 retrieve events. For example, if the request is sent at 18:00 and you
62 specify a duration of 60, then only events which have occurred after
63 17:00 will be returned.
64  
65 Default: C<60>
66  
67  
68  
69 =head2 EndTime => Str
70  
71 The end of the time interval for which to retrieve events, specified in
72 ISO 8601 format. For more information about ISO 8601, go to the ISO8601
73 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601)
74  
75 Example: C<2009-07-08T18:00Z>
76  
77  
78  
79 =head2 Marker => Str
80  
81 An optional parameter that specifies the starting point to return a set
82 of response records. When the results of a DescribeEvents request
83 exceed the value specified in C<MaxRecords>, AWS returns a value in the
84 C<Marker> field of the response. You can retrieve the next set of
85 response records by providing the returned marker value in the
86 C<Marker> parameter and retrying the request.
87  
88  
89  
90 =head2 MaxRecords => Int
91  
92 The maximum number of response records to return in each call. If the
93 number of remaining response records exceeds the specified
94 C<MaxRecords> value, a value is returned in a C<marker> field of the
95 response. You can retrieve the next set of records by retrying the
96 command with the returned marker value.
97  
98 Default: C<100>
99  
100 Constraints: minimum 20, maximum 100.
101  
102  
103  
104 =head2 SourceIdentifier => Str
105  
106 The identifier of the event source for which events will be returned.
107 If this parameter is not specified, then all sources are included in
108 the response.
109  
110 Constraints:
111  
112 If I<SourceIdentifier> is supplied, I<SourceType> must also be
113 provided.
114  
115 =over
116  
117 =item *
118  
119 Specify a cluster identifier when I<SourceType> is C<cluster>.
120  
121 =item *
122  
123 Specify a cluster security group name when I<SourceType> is
124 C<cluster-security-group>.
125  
126 =item *
127  
128 Specify a cluster parameter group name when I<SourceType> is
129 C<cluster-parameter-group>.
130  
131 =item *
132  
133 Specify a cluster snapshot identifier when I<SourceType> is
134 C<cluster-snapshot>.
135  
136 =back
137  
138  
139  
140  
141 =head2 SourceType => Str
142  
143 The event source to retrieve events for. If no value is specified, all
144 events are returned.
145  
146 Constraints:
147  
148 If I<SourceType> is supplied, I<SourceIdentifier> must also be
149 provided.
150  
151 =over
152  
153 =item *
154  
155 Specify C<cluster> when I<SourceIdentifier> is a cluster identifier.
156  
157 =item *
158  
159 Specify C<cluster-security-group> when I<SourceIdentifier> is a cluster
160 security group name.
161  
162 =item *
163  
164 Specify C<cluster-parameter-group> when I<SourceIdentifier> is a
165 cluster parameter group name.
166  
167 =item *
168  
169 Specify C<cluster-snapshot> when I<SourceIdentifier> is a cluster
170 snapshot identifier.
171  
172 =back
173  
174  
175 Valid values are: C<"cluster">, C<"cluster-parameter-group">, C<"cluster-security-group">, C<"cluster-snapshot">, C<"scheduled-action">
176  
177 =head2 StartTime => Str
178  
179 The beginning of the time interval to retrieve events for, specified in
180 ISO 8601 format. For more information about ISO 8601, go to the ISO8601
181 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601)
182  
183 Example: C<2009-07-08T18:00Z>
184  
185  
186  
187  
188 =head1 SEE ALSO
189  
190 This class forms part of L<Paws>, documenting arguments for method DescribeEvents in L<Paws::RedShift>
191  
192 =head1 BUGS and CONTRIBUTIONS
193  
194 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
195  
196 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
197  
198 =cut
199  
« blib/lib/Paws/RedShift/DescribeClusters.pm ↑ Summary blib/lib/Paws/RedShift/DescribeOrderableClusterOptions.pm »