blib/lib/Paws/PerformanceInsights/DescribeDimensionKeys.pm untested

filter: Statementstmt 0.0% 0 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 22 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::PerformanceInsights::DescribeDimensionKeys;
3 use Moose;
4 has EndTime => (is => 'ro', isa => 'Str', required => 1);
5 has Filter => (is => 'ro', isa => 'Paws::PerformanceInsights::MetricQueryFilterMap');
6 has GroupBy => (is => 'ro', isa => 'Paws::PerformanceInsights::DimensionGroup', required => 1);
7 has Identifier => (is => 'ro', isa => 'Str', required => 1);
8 has MaxResults => (is => 'ro', isa => 'Int');
9 has Metric => (is => 'ro', isa => 'Str', required => 1);
10 has NextToken => (is => 'ro', isa => 'Str');
11 has PartitionBy => (is => 'ro', isa => 'Paws::PerformanceInsights::DimensionGroup');
12 has PeriodInSeconds => (is => 'ro', isa => 'Int');
13 has ServiceType => (is => 'ro', isa => 'Str', required => 1);
14 has StartTime => (is => 'ro', isa => 'Str', required => 1);
15  
16 use MooseX::ClassAttribute;
17  
18 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDimensionKeys');
19 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PerformanceInsights::DescribeDimensionKeysResponse');
20 class_has _result_key => (isa => 'Str', is => 'ro');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::PerformanceInsights::DescribeDimensionKeys - Arguments for method DescribeDimensionKeys on L<Paws::PerformanceInsights>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method DescribeDimensionKeys on the
32 L<AWS Performance Insights|Paws::PerformanceInsights> service. Use the attributes of this class
33 as arguments to method DescribeDimensionKeys.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDimensionKeys.
36  
37 =head1 SYNOPSIS
38  
39 my $pi = Paws->service('PerformanceInsights');
40 my $DescribeDimensionKeysResponse = $pi->DescribeDimensionKeys(
41 EndTime => '1970-01-01T01:00:00',
42 GroupBy => {
43 Group => 'MyRequestString', # max: 256
44 Dimensions => [
45 'MyRequestString', ... # max: 256
46 ], # min: 1, max: 10; OPTIONAL
47 Limit => 1, # min: 1, max: 10; OPTIONAL
48 },
49 Identifier => 'MyRequestString',
50 Metric => 'MyRequestString',
51 ServiceType => 'RDS',
52 StartTime => '1970-01-01T01:00:00',
53 Filter => {
54 'MyRequestString' => 'MyRequestString', # key: max: 256, value: max: 256
55 }, # OPTIONAL
56 MaxResults => 1, # OPTIONAL
57 NextToken => 'MyNextToken', # OPTIONAL
58 PartitionBy => {
59 Group => 'MyRequestString', # max: 256
60 Dimensions => [
61 'MyRequestString', ... # max: 256
62 ], # min: 1, max: 10; OPTIONAL
63 Limit => 1, # min: 1, max: 10; OPTIONAL
64 }, # OPTIONAL
65 PeriodInSeconds => 1, # OPTIONAL
66 );
67  
68 # Results:
69 my $AlignedEndTime = $DescribeDimensionKeysResponse->AlignedEndTime;
70 my $AlignedStartTime = $DescribeDimensionKeysResponse->AlignedStartTime;
71 my $Keys = $DescribeDimensionKeysResponse->Keys;
72 my $NextToken = $DescribeDimensionKeysResponse->NextToken;
73 my $PartitionKeys = $DescribeDimensionKeysResponse->PartitionKeys;
74  
75 # Returns a L<Paws::PerformanceInsights::DescribeDimensionKeysResponse> object.
76  
77 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.
78 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pi/DescribeDimensionKeys>
79  
80 =head1 ATTRIBUTES
81  
82  
83 =head2 B<REQUIRED> EndTime => Str
84  
85 The date and time specifying the end of the requested time series data.
86 The value specified is I<exclusive>, which means that data points less
87 than (but not equal to) C<EndTime> are returned.
88  
89 The value for C<EndTime> must be later than the value for C<StartTime>.
90  
91  
92  
93 =head2 Filter => L<Paws::PerformanceInsights::MetricQueryFilterMap>
94  
95 One or more filters to apply in the request. Restrictions:
96  
97 =over
98  
99 =item *
100  
101 Any number of filters by the same dimension, as specified in the
102 C<GroupBy> or C<Partition> parameters.
103  
104 =item *
105  
106 A single filter for any other dimension in this dimension group.
107  
108 =back
109  
110  
111  
112  
113 =head2 B<REQUIRED> GroupBy => L<Paws::PerformanceInsights::DimensionGroup>
114  
115 A specification for how to aggregate the data points from a query
116 result. You must specify a valid dimension group. Performance Insights
117 returns all dimensions within this group, unless you provide the names
118 of specific dimensions within this group. You can also request that
119 Performance Insights return a limited number of values for a dimension.
120  
121  
122  
123 =head2 B<REQUIRED> Identifier => Str
124  
125 An immutable, AWS Region-unique identifier for a data source.
126 Performance Insights gathers metrics from this data source.
127  
128 To use an Amazon RDS instance as a data source, you specify its
129 C<DbiResourceId> value. For example, specify
130 C<db-FAIHNTYBKTGAUSUZQYPDS2GW4A>
131  
132  
133  
134 =head2 MaxResults => Int
135  
136 The maximum number of items to return in the response. If more items
137 exist than the specified C<MaxRecords> value, a pagination token is
138 included in the response so that the remaining results can be
139 retrieved.
140  
141  
142  
143 =head2 B<REQUIRED> Metric => Str
144  
145 The name of a Performance Insights metric to be measured.
146  
147 Valid values for C<Metric> are:
148  
149 =over
150  
151 =item *
152  
153 C<db.load.avg> - a scaled representation of the number of active
154 sessions for the database engine.
155  
156 =item *
157  
158 C<db.sampledload.avg> - the raw number of active sessions for the
159 database engine.
160  
161 =back
162  
163 If the number of active sessions is less than an internal Performance
164 Insights threshold, C<db.load.avg> and C<db.sampledload.avg> are the
165 same value. If the number of active sessions is greater than the
166 internal threshold, Performance Insights samples the active sessions,
167 with C<db.load.avg> showing the scaled values, C<db.sampledload.avg>
168 showing the raw values, and C<db.sampledload.avg> less than
169 C<db.load.avg>. For most use cases, you can query C<db.load.avg> only.
170  
171  
172  
173 =head2 NextToken => Str
174  
175 An optional pagination token provided by a previous request. If this
176 parameter is specified, the response includes only records beyond the
177 token, up to the value specified by C<MaxRecords>.
178  
179  
180  
181 =head2 PartitionBy => L<Paws::PerformanceInsights::DimensionGroup>
182  
183 For each dimension specified in C<GroupBy>, specify a secondary
184 dimension to further subdivide the partition keys in the response.
185  
186  
187  
188 =head2 PeriodInSeconds => Int
189  
190 The granularity, in seconds, of the data points returned from
191 Performance Insights. A period can be as short as one second, or as
192 long as one day (86400 seconds). Valid values are:
193  
194 =over
195  
196 =item *
197  
198 C<1> (one second)
199  
200 =item *
201  
202 C<60> (one minute)
203  
204 =item *
205  
206 C<300> (five minutes)
207  
208 =item *
209  
210 C<3600> (one hour)
211  
212 =item *
213  
214 C<86400> (twenty-four hours)
215  
216 =back
217  
218 If you don't specify C<PeriodInSeconds>, then Performance Insights
219 chooses a value for you, with a goal of returning roughly 100-200 data
220 points in the response.
221  
222  
223  
224 =head2 B<REQUIRED> ServiceType => Str
225  
226 The AWS service for which Performance Insights will return metrics. The
227 only valid value for I<ServiceType> is C<RDS>.
228  
229 Valid values are: C<"RDS">
230  
231 =head2 B<REQUIRED> StartTime => Str
232  
233 The date and time specifying the beginning of the requested time series
234 data. You must specify a C<StartTime> within the past 7 days. The value
235 specified is I<inclusive>, which means that data points equal to or
236 greater than C<StartTime> are returned.
237  
238 The value for C<StartTime> must be earlier than the value for
239 C<EndTime>.
240  
241  
242  
243  
244 =head1 SEE ALSO
245  
246 This class forms part of L<Paws>, documenting arguments for method DescribeDimensionKeys in L<Paws::PerformanceInsights>
247  
248 =head1 BUGS and CONTRIBUTIONS
249  
250 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
251  
252 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
253  
254 =cut
255