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

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 16 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CostExplorer::GetCostForecast;
3 use Moose;
4 has Filter => (is => 'ro', isa => 'Paws::CostExplorer::Expression');
5 has Granularity => (is => 'ro', isa => 'Str', required => 1);
6 has Metric => (is => 'ro', isa => 'Str', required => 1);
7 has PredictionIntervalLevel => (is => 'ro', isa => 'Int');
8 has TimePeriod => (is => 'ro', isa => 'Paws::CostExplorer::DateInterval', required => 1);
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetCostForecast');
13 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CostExplorer::GetCostForecastResponse');
14 class_has _result_key => (isa => 'Str', is => 'ro');
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::CostExplorer::GetCostForecast - Arguments for method GetCostForecast on L<Paws::CostExplorer>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method GetCostForecast on the
26 L<AWS Cost Explorer Service|Paws::CostExplorer> service. Use the attributes of this class
27 as arguments to method GetCostForecast.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCostForecast.
30  
31 =head1 SYNOPSIS
32  
33 my $ce = Paws->service('CostExplorer');
34 my $GetCostForecastResponse = $ce->GetCostForecast(
35 Granularity => 'DAILY',
36 Metric => 'BLENDED_COST',
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 PredictionIntervalLevel => 1, # OPTIONAL
79 );
80  
81 # Results:
82 my $ForecastResultsByTime = $GetCostForecastResponse->ForecastResultsByTime;
83 my $Total = $GetCostForecastResponse->Total;
84  
85 # Returns a L<Paws::CostExplorer::GetCostForecastResponse> object.
86  
87 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.
88 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ce/GetCostForecast>
89  
90 =head1 ATTRIBUTES
91  
92  
93 =head2 Filter => L<Paws::CostExplorer::Expression>
94  
95 The filters that you want to use to filter your forecast. The
96 C<GetCostForecast> API supports filtering by the following dimensions:
97  
98 =over
99  
100 =item *
101  
102 C<AZ>
103  
104 =item *
105  
106 C<INSTANCE_TYPE>
107  
108 =item *
109  
110 C<LINKED_ACCOUNT>
111  
112 =item *
113  
114 C<LINKED_ACCOUNT_NAME>
115  
116 =item *
117  
118 C<OPERATION>
119  
120 =item *
121  
122 C<PURCHASE_TYPE>
123  
124 =item *
125  
126 C<REGION>
127  
128 =item *
129  
130 C<SERVICE>
131  
132 =item *
133  
134 C<USAGE_TYPE>
135  
136 =item *
137  
138 C<USAGE_TYPE_GROUP>
139  
140 =item *
141  
142 C<RECORD_TYPE>
143  
144 =item *
145  
146 C<OPERATING_SYSTEM>
147  
148 =item *
149  
150 C<TENANCY>
151  
152 =item *
153  
154 C<SCOPE>
155  
156 =item *
157  
158 C<PLATFORM>
159  
160 =item *
161  
162 C<SUBSCRIPTION_ID>
163  
164 =item *
165  
166 C<LEGAL_ENTITY_NAME>
167  
168 =item *
169  
170 C<DEPLOYMENT_OPTION>
171  
172 =item *
173  
174 C<DATABASE_ENGINE>
175  
176 =item *
177  
178 C<INSTANCE_TYPE_FAMILY>
179  
180 =item *
181  
182 C<BILLING_ENTITY>
183  
184 =item *
185  
186 C<RESERVATION_ID>
187  
188 =item *
189  
190 C<SAVINGS_PLAN_ARN>
191  
192 =back
193  
194  
195  
196  
197 =head2 B<REQUIRED> Granularity => Str
198  
199 How granular you want the forecast to be. You can get 3 months of
200 C<DAILY> forecasts or 12 months of C<MONTHLY> forecasts.
201  
202 The C<GetCostForecast> operation supports only C<DAILY> and C<MONTHLY>
203 granularities.
204  
205 Valid values are: C<"DAILY">, C<"MONTHLY">, C<"HOURLY">
206  
207 =head2 B<REQUIRED> Metric => Str
208  
209 Which metric Cost Explorer uses to create your forecast. For more
210 information about blended and unblended rates, see Why does the
211 "blended" annotation appear on some line items in my bill?
212 (http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/).
213  
214 Valid values for a C<GetCostForecast> call are the following:
215  
216 =over
217  
218 =item *
219  
220 AMORTIZED_COST
221  
222 =item *
223  
224 BLENDED_COST
225  
226 =item *
227  
228 NET_AMORTIZED_COST
229  
230 =item *
231  
232 NET_UNBLENDED_COST
233  
234 =item *
235  
236 UNBLENDED_COST
237  
238 =back
239  
240  
241 Valid values are: C<"BLENDED_COST">, C<"UNBLENDED_COST">, C<"AMORTIZED_COST">, C<"NET_UNBLENDED_COST">, C<"NET_AMORTIZED_COST">, C<"USAGE_QUANTITY">, C<"NORMALIZED_USAGE_AMOUNT">
242  
243 =head2 PredictionIntervalLevel => Int
244  
245 Cost Explorer always returns the mean forecast as a single point. You
246 can request a prediction interval around the mean by specifying a
247 confidence level. The higher the confidence level, the more confident
248 Cost Explorer is about the actual value falling in the prediction
249 interval. Higher confidence levels result in wider prediction
250 intervals.
251  
252  
253  
254 =head2 B<REQUIRED> TimePeriod => L<Paws::CostExplorer::DateInterval>
255  
256 The period of time that you want the forecast to cover. The start date
257 must be equal to or no later than the current date to avoid a
258 validation error.
259  
260  
261  
262  
263 =head1 SEE ALSO
264  
265 This class forms part of L<Paws>, documenting arguments for method GetCostForecast in L<Paws::CostExplorer>
266  
267 =head1 BUGS and CONTRIBUTIONS
268  
269 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
270  
271 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
272  
273 =cut
274