blib/lib/Paws/CostExplorer/GetCostCategories.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::GetCostCategories;
3 use Moose;
4 has CostCategoryName => (is => 'ro', isa => 'Str');
5 has Filter => (is => 'ro', isa => 'Paws::CostExplorer::Expression');
6 has MaxResults => (is => 'ro', isa => 'Int');
7 has NextPageToken => (is => 'ro', isa => 'Str');
8 has SearchString => (is => 'ro', isa => 'Str');
9 has SortBy => (is => 'ro', isa => 'ArrayRef[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 => 'GetCostCategories');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CostExplorer::GetCostCategoriesResponse');
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::GetCostCategories - Arguments for method GetCostCategories on L<Paws::CostExplorer>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method GetCostCategories on the
28 L<AWS Cost Explorer Service|Paws::CostExplorer> service. Use the attributes of this class
29 as arguments to method GetCostCategories.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCostCategories.
32  
33 =head1 SYNOPSIS
34  
35 my $ce = Paws->service('CostExplorer');
36 my $GetCostCategoriesResponse = $ce->GetCostCategories(
37 TimePeriod => {
38 End => 'MyYearMonthDay', # max: 40
39 Start => 'MyYearMonthDay', # max: 40
40  
41 },
42 CostCategoryName => 'MyCostCategoryName', # OPTIONAL
43 Filter => {
44 And => [ <Expression>, ... ], # OPTIONAL
45 CostCategories => {
46 Key => 'MyCostCategoryName', # min: 1, max: 50
47 MatchOptions => [
48 'EQUALS',
49 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
50 ], # OPTIONAL
51 Values => [
52 'MyValue', ... # max: 1024
53 ], # OPTIONAL
54 }, # OPTIONAL
55 Dimensions => {
56 Key => 'AZ'
57 , # 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
58 MatchOptions => [
59 'EQUALS',
60 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
61 ], # OPTIONAL
62 Values => [
63 'MyValue', ... # max: 1024
64 ], # OPTIONAL
65 }, # OPTIONAL
66 Not => <Expression>,
67 Or => [ <Expression>, ... ], # OPTIONAL
68 Tags => {
69 Key => 'MyTagKey', # max: 1024; OPTIONAL
70 MatchOptions => [
71 'EQUALS',
72 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
73 ], # OPTIONAL
74 Values => [
75 'MyValue', ... # max: 1024
76 ], # OPTIONAL
77 }, # OPTIONAL
78 }, # OPTIONAL
79 MaxResults => 1, # OPTIONAL
80 NextPageToken => 'MyNextPageToken', # OPTIONAL
81 SearchString => 'MySearchString', # OPTIONAL
82 SortBy => [
83 {
84 Key => 'MySortDefinitionKey', # max: 1024
85 SortOrder => 'ASCENDING', # values: ASCENDING, DESCENDING; OPTIONAL
86 },
87 ...
88 ], # OPTIONAL
89 );
90  
91 # Results:
92 my $CostCategoryNames = $GetCostCategoriesResponse->CostCategoryNames;
93 my $CostCategoryValues = $GetCostCategoriesResponse->CostCategoryValues;
94 my $NextPageToken = $GetCostCategoriesResponse->NextPageToken;
95 my $ReturnSize = $GetCostCategoriesResponse->ReturnSize;
96 my $TotalSize = $GetCostCategoriesResponse->TotalSize;
97  
98 # Returns a L<Paws::CostExplorer::GetCostCategoriesResponse> 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/GetCostCategories>
102  
103 =head1 ATTRIBUTES
104  
105  
106 =head2 CostCategoryName => Str
107  
108  
109  
110  
111  
112 =head2 Filter => L<Paws::CostExplorer::Expression>
113  
114  
115  
116  
117  
118 =head2 MaxResults => Int
119  
120 This field is only used when C<SortBy> is provided in the request.
121  
122 The maximum number of objects that to be returned for this request. If
123 C<MaxResults> is not specified with C<SortBy>, the request will return
124 1000 results as the default value for this parameter.
125  
126 For C<GetCostCategories>, MaxResults has an upper limit of 1000.
127  
128  
129  
130 =head2 NextPageToken => Str
131  
132 If the number of objects that are still available for retrieval exceeds
133 the limit, AWS returns a NextPageToken value in the response. To
134 retrieve the next batch of objects, provide the NextPageToken from the
135 prior call in your next request.
136  
137  
138  
139 =head2 SearchString => Str
140  
141 The value that you want to search the filter values for.
142  
143 If you do not specify a C<CostCategoryName>, C<SearchString> will be
144 used to filter Cost Category names that match the C<SearchString>
145 pattern. If you do specifiy a C<CostCategoryName>, C<SearchString> will
146 be used to filter Cost Category values that match the C<SearchString>
147 pattern.
148  
149  
150  
151 =head2 SortBy => ArrayRef[L<Paws::CostExplorer::SortDefinition>]
152  
153 The value by which you want to sort the data.
154  
155 The key represents cost and usage metrics. The following values are
156 supported:
157  
158 =over
159  
160 =item *
161  
162 C<BlendedCost>
163  
164 =item *
165  
166 C<UnblendedCost>
167  
168 =item *
169  
170 C<AmortizedCost>
171  
172 =item *
173  
174 C<NetAmortizedCost>
175  
176 =item *
177  
178 C<NetUnblendedCost>
179  
180 =item *
181  
182 C<UsageQuantity>
183  
184 =item *
185  
186 C<NormalizedUsageAmount>
187  
188 =back
189  
190 Supported values for C<SortOrder> are C<ASCENDING> or C<DESCENDING>.
191  
192 When using C<SortBy>, C<NextPageToken> and C<SearchString> are not
193 supported.
194  
195  
196  
197 =head2 B<REQUIRED> TimePeriod => L<Paws::CostExplorer::DateInterval>
198  
199  
200  
201  
202  
203  
204 =head1 SEE ALSO
205  
206 This class forms part of L<Paws>, documenting arguments for method GetCostCategories in L<Paws::CostExplorer>
207  
208 =head1 BUGS and CONTRIBUTIONS
209  
210 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
211  
212 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
213  
214 =cut
215