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

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CostExplorer::GetSavingsPlansUtilization;
3 use Moose;
4 has Filter => (is => 'ro', isa => 'Paws::CostExplorer::Expression');
5 has Granularity => (is => 'ro', isa => 'Str');
6 has SortBy => (is => 'ro', isa => 'Paws::CostExplorer::SortDefinition');
7 has TimePeriod => (is => 'ro', isa => 'Paws::CostExplorer::DateInterval', required => 1);
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSavingsPlansUtilization');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CostExplorer::GetSavingsPlansUtilizationResponse');
13 class_has _result_key => (isa => 'Str', is => 'ro');
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::CostExplorer::GetSavingsPlansUtilization - Arguments for method GetSavingsPlansUtilization on L<Paws::CostExplorer>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method GetSavingsPlansUtilization on the
25 L<AWS Cost Explorer Service|Paws::CostExplorer> service. Use the attributes of this class
26 as arguments to method GetSavingsPlansUtilization.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSavingsPlansUtilization.
29  
30 =head1 SYNOPSIS
31  
32 my $ce = Paws->service('CostExplorer');
33 my $GetSavingsPlansUtilizationResponse = $ce->GetSavingsPlansUtilization(
34 TimePeriod => {
35 End => 'MyYearMonthDay', # max: 40
36 Start => 'MyYearMonthDay', # max: 40
37  
38 },
39 Filter => {
40 And => [ <Expression>, ... ], # OPTIONAL
41 CostCategories => {
42 Key => 'MyCostCategoryName', # min: 1, max: 50; OPTIONAL
43 MatchOptions => [
44 'EQUALS',
45 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
46 ], # OPTIONAL
47 Values => [
48 'MyValue', ... # max: 1024
49 ], # OPTIONAL
50 }, # OPTIONAL
51 Dimensions => {
52 Key => 'AZ'
53 , # 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
54 MatchOptions => [
55 'EQUALS',
56 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
57 ], # OPTIONAL
58 Values => [
59 'MyValue', ... # max: 1024
60 ], # OPTIONAL
61 }, # OPTIONAL
62 Not => <Expression>,
63 Or => [ <Expression>, ... ], # OPTIONAL
64 Tags => {
65 Key => 'MyTagKey', # max: 1024; OPTIONAL
66 MatchOptions => [
67 'EQUALS',
68 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
69 ], # OPTIONAL
70 Values => [
71 'MyValue', ... # max: 1024
72 ], # OPTIONAL
73 }, # OPTIONAL
74 }, # OPTIONAL
75 Granularity => 'DAILY', # OPTIONAL
76 SortBy => {
77 Key => 'MySortDefinitionKey', # max: 1024
78 SortOrder => 'ASCENDING', # values: ASCENDING, DESCENDING; OPTIONAL
79 }, # OPTIONAL
80 );
81  
82 # Results:
83 my $SavingsPlansUtilizationsByTime =
84 $GetSavingsPlansUtilizationResponse->SavingsPlansUtilizationsByTime;
85 my $Total = $GetSavingsPlansUtilizationResponse->Total;
86  
87 # Returns a L<Paws::CostExplorer::GetSavingsPlansUtilizationResponse> object.
88  
89 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.
90 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ce/GetSavingsPlansUtilization>
91  
92 =head1 ATTRIBUTES
93  
94  
95 =head2 Filter => L<Paws::CostExplorer::Expression>
96  
97 Filters Savings Plans utilization coverage data for active Savings
98 Plans dimensions. You can filter data with the following dimensions:
99  
100 =over
101  
102 =item *
103  
104 C<LINKED_ACCOUNT>
105  
106 =item *
107  
108 C<SAVINGS_PLAN_ARN>
109  
110 =item *
111  
112 C<SAVINGS_PLANS_TYPE>
113  
114 =item *
115  
116 C<REGION>
117  
118 =item *
119  
120 C<PAYMENT_OPTION>
121  
122 =item *
123  
124 C<INSTANCE_TYPE_FAMILY>
125  
126 =back
127  
128 C<GetSavingsPlansUtilization> uses the same Expression
129 (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html)
130 object as the other operations, but only C<AND> is supported among each
131 dimension.
132  
133  
134  
135 =head2 Granularity => Str
136  
137 The granularity of the Amazon Web Services utillization data for your
138 Savings Plans.
139  
140 The C<GetSavingsPlansUtilization> operation supports only C<DAILY> and
141 C<MONTHLY> granularities.
142  
143 Valid values are: C<"DAILY">, C<"MONTHLY">, C<"HOURLY">
144  
145 =head2 SortBy => L<Paws::CostExplorer::SortDefinition>
146  
147 The value by which you want to sort the data.
148  
149 The following values are supported for C<Key>:
150  
151 =over
152  
153 =item *
154  
155 C<UtilizationPercentage>
156  
157 =item *
158  
159 C<TotalCommitment>
160  
161 =item *
162  
163 C<UsedCommitment>
164  
165 =item *
166  
167 C<UnusedCommitment>
168  
169 =item *
170  
171 C<NetSavings>
172  
173 =back
174  
175 Supported values for C<SortOrder> are C<ASCENDING> or C<DESCENDING>.
176  
177  
178  
179 =head2 B<REQUIRED> TimePeriod => L<Paws::CostExplorer::DateInterval>
180  
181 The time period that you want the usage and costs for. The C<Start>
182 date must be within 13 months. The C<End> date must be after the
183 C<Start> date, and before the current date. Future dates can't be used
184 as an C<End> date.
185  
186  
187  
188  
189 =head1 SEE ALSO
190  
191 This class forms part of L<Paws>, documenting arguments for method GetSavingsPlansUtilization in L<Paws::CostExplorer>
192  
193 =head1 BUGS and CONTRIBUTIONS
194  
195 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
196  
197 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
198  
199 =cut
200