blib/lib/Paws/CostExplorer/GetReservationUtilization.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CostExplorer::GetReservationUtilization;
3 use Moose;
4 has Filter => (is => 'ro', isa => 'Paws::CostExplorer::Expression');
5 has Granularity => (is => 'ro', isa => 'Str');
6 has GroupBy => (is => 'ro', isa => 'ArrayRef[Paws::CostExplorer::GroupDefinition]');
7 has MaxResults => (is => 'ro', isa => 'Int');
8 has NextPageToken => (is => 'ro', isa => 'Str');
9 has SortBy => (is => 'ro', isa => 'Paws::CostExplorer::SortDefinition');
10 has TimePeriod => (is => 'ro', isa => 'Paws::CostExplorer::DateInterval', required => 1);
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetReservationUtilization');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CostExplorer::GetReservationUtilizationResponse');
16 class_has _result_key => (isa => 'Str', is => 'ro');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::CostExplorer::GetReservationUtilization - Arguments for method GetReservationUtilization on L<Paws::CostExplorer>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method GetReservationUtilization on the
28 L<AWS Cost Explorer Service|Paws::CostExplorer> service. Use the attributes of this class
29 as arguments to method GetReservationUtilization.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetReservationUtilization.
32  
33 =head1 SYNOPSIS
34  
35 my $ce = Paws->service('CostExplorer');
36 my $GetReservationUtilizationResponse = $ce->GetReservationUtilization(
37 TimePeriod => {
38 End => 'MyYearMonthDay', # max: 40
39 Start => 'MyYearMonthDay', # max: 40
40  
41 },
42 Filter => {
43 And => [ <Expression>, ... ], # OPTIONAL
44 CostCategories => {
45 Key => 'MyCostCategoryName', # min: 1, max: 50; OPTIONAL
46 MatchOptions => [
47 'EQUALS',
48 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
49 ], # OPTIONAL
50 Values => [
51 'MyValue', ... # max: 1024
52 ], # OPTIONAL
53 }, # OPTIONAL
54 Dimensions => {
55 Key => 'AZ'
56 , # values: AZ, INSTANCE_TYPE, LINKED_ACCOUNT, LINKED_ACCOUNT_NAME, OPERATION, PURCHASE_TYPE, REGION, SERVICE, SERVICE_CODE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID, LEGAL_ENTITY_NAME, DEPLOYMENT_OPTION, DATABASE_ENGINE, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID, RESOURCE_ID, RIGHTSIZING_TYPE, SAVINGS_PLANS_TYPE, SAVINGS_PLAN_ARN, PAYMENT_OPTION, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE; OPTIONAL
57 MatchOptions => [
58 'EQUALS',
59 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
60 ], # OPTIONAL
61 Values => [
62 'MyValue', ... # max: 1024
63 ], # OPTIONAL
64 }, # OPTIONAL
65 Not => <Expression>,
66 Or => [ <Expression>, ... ], # OPTIONAL
67 Tags => {
68 Key => 'MyTagKey', # max: 1024; OPTIONAL
69 MatchOptions => [
70 'EQUALS',
71 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
72 ], # OPTIONAL
73 Values => [
74 'MyValue', ... # max: 1024
75 ], # OPTIONAL
76 }, # OPTIONAL
77 }, # OPTIONAL
78 Granularity => 'DAILY', # OPTIONAL
79 GroupBy => [
80 {
81 Key => 'MyGroupDefinitionKey', # max: 1024; OPTIONAL
82 Type => 'DIMENSION', # values: DIMENSION, TAG, COST_CATEGORY; OPTIONAL
83 },
84 ...
85 ], # OPTIONAL
86 MaxResults => 1, # OPTIONAL
87 NextPageToken => 'MyNextPageToken', # OPTIONAL
88 SortBy => {
89 Key => 'MySortDefinitionKey', # max: 1024
90 SortOrder => 'ASCENDING', # values: ASCENDING, DESCENDING; OPTIONAL
91 }, # OPTIONAL
92 );
93  
94 # Results:
95 my $NextPageToken = $GetReservationUtilizationResponse->NextPageToken;
96 my $Total = $GetReservationUtilizationResponse->Total;
97 my $UtilizationsByTime =
98 $GetReservationUtilizationResponse->UtilizationsByTime;
99  
100 # Returns a L<Paws::CostExplorer::GetReservationUtilizationResponse> object.
101  
102 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.
103 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ce/GetReservationUtilization>
104  
105 =head1 ATTRIBUTES
106  
107  
108 =head2 Filter => L<Paws::CostExplorer::Expression>
109  
110 Filters utilization data by dimensions. You can filter by the following
111 dimensions:
112  
113 =over
114  
115 =item *
116  
117 AZ
118  
119 =item *
120  
121 CACHE_ENGINE
122  
123 =item *
124  
125 DEPLOYMENT_OPTION
126  
127 =item *
128  
129 INSTANCE_TYPE
130  
131 =item *
132  
133 LINKED_ACCOUNT
134  
135 =item *
136  
137 OPERATING_SYSTEM
138  
139 =item *
140  
141 PLATFORM
142  
143 =item *
144  
145 REGION
146  
147 =item *
148  
149 SERVICE
150  
151 =item *
152  
153 SCOPE
154  
155 =item *
156  
157 TENANCY
158  
159 =back
160  
161 C<GetReservationUtilization> uses the same Expression
162 (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html)
163 object as the other operations, but only C<AND> is supported among each
164 dimension, and nesting is supported up to only one level deep. If there
165 are multiple values for a dimension, they are OR'd together.
166  
167  
168  
169 =head2 Granularity => Str
170  
171 If C<GroupBy> is set, C<Granularity> can't be set. If C<Granularity>
172 isn't set, the response object doesn't include C<Granularity>, either
173 C<MONTHLY> or C<DAILY>. If both C<GroupBy> and C<Granularity> aren't
174 set, C<GetReservationUtilization> defaults to C<DAILY>.
175  
176 The C<GetReservationUtilization> operation supports only C<DAILY> and
177 C<MONTHLY> granularities.
178  
179 Valid values are: C<"DAILY">, C<"MONTHLY">, C<"HOURLY">
180  
181 =head2 GroupBy => ArrayRef[L<Paws::CostExplorer::GroupDefinition>]
182  
183 Groups only by C<SUBSCRIPTION_ID>. Metadata is included.
184  
185  
186  
187 =head2 MaxResults => Int
188  
189 The maximum number of objects that you returned for this request. If
190 more objects are available, in the response, AWS provides a
191 NextPageToken value that you can use in a subsequent call to get the
192 next batch of objects.
193  
194  
195  
196 =head2 NextPageToken => Str
197  
198 The token to retrieve the next set of results. AWS provides the token
199 when the response from a previous call has more results than the
200 maximum page size.
201  
202  
203  
204 =head2 SortBy => L<Paws::CostExplorer::SortDefinition>
205  
206 The value by which you want to sort the data.
207  
208 The following values are supported for C<Key>:
209  
210 =over
211  
212 =item *
213  
214 C<UtilizationPercentage>
215  
216 =item *
217  
218 C<UtilizationPercentageInUnits>
219  
220 =item *
221  
222 C<PurchasedHours>
223  
224 =item *
225  
226 C<PurchasedUnits>
227  
228 =item *
229  
230 C<TotalActualHours>
231  
232 =item *
233  
234 C<TotalActualUnits>
235  
236 =item *
237  
238 C<UnusedHours>
239  
240 =item *
241  
242 C<UnusedUnits>
243  
244 =item *
245  
246 C<OnDemandCostOfRIHoursUsed>
247  
248 =item *
249  
250 C<NetRISavings>
251  
252 =item *
253  
254 C<TotalPotentialRISavings>
255  
256 =item *
257  
258 C<AmortizedUpfrontFee>
259  
260 =item *
261  
262 C<AmortizedRecurringFee>
263  
264 =item *
265  
266 C<TotalAmortizedFee>
267  
268 =item *
269  
270 C<RICostForUnusedHours>
271  
272 =item *
273  
274 C<RealizedSavings>
275  
276 =item *
277  
278 C<UnrealizedSavings>
279  
280 =back
281  
282 Supported values for C<SortOrder> are C<ASCENDING> or C<DESCENDING>.
283  
284  
285  
286 =head2 B<REQUIRED> TimePeriod => L<Paws::CostExplorer::DateInterval>
287  
288 Sets the start and end dates for retrieving RI utilization. The start
289 date is inclusive, but the end date is exclusive. For example, if
290 C<start> is C<2017-01-01> and C<end> is C<2017-05-01>, then the cost
291 and usage data is retrieved from C<2017-01-01> up to and including
292 C<2017-04-30> but not including C<2017-05-01>.
293  
294  
295  
296  
297 =head1 SEE ALSO
298  
299 This class forms part of L<Paws>, documenting arguments for method GetReservationUtilization in L<Paws::CostExplorer>
300  
301 =head1 BUGS and CONTRIBUTIONS
302  
303 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
304  
305 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
306  
307 =cut
308