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

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