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

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CostExplorer::GetSavingsPlansPurchaseRecommendation;
3 use Moose;
4 has AccountScope => (is => 'ro', isa => 'Str');
5 has Filter => (is => 'ro', isa => 'Paws::CostExplorer::Expression');
6 has LookbackPeriodInDays => (is => 'ro', isa => 'Str', required => 1);
7 has NextPageToken => (is => 'ro', isa => 'Str');
8 has PageSize => (is => 'ro', isa => 'Int');
9 has PaymentOption => (is => 'ro', isa => 'Str', required => 1);
10 has SavingsPlansType => (is => 'ro', isa => 'Str', required => 1);
11 has TermInYears => (is => 'ro', isa => 'Str', required => 1);
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSavingsPlansPurchaseRecommendation');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CostExplorer::GetSavingsPlansPurchaseRecommendationResponse');
17 class_has _result_key => (isa => 'Str', is => 'ro');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::CostExplorer::GetSavingsPlansPurchaseRecommendation - Arguments for method GetSavingsPlansPurchaseRecommendation on L<Paws::CostExplorer>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method GetSavingsPlansPurchaseRecommendation on the
29 L<AWS Cost Explorer Service|Paws::CostExplorer> service. Use the attributes of this class
30 as arguments to method GetSavingsPlansPurchaseRecommendation.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSavingsPlansPurchaseRecommendation.
33  
34 =head1 SYNOPSIS
35  
36 my $ce = Paws->service('CostExplorer');
37 my $GetSavingsPlansPurchaseRecommendationResponse =
38 $ce->GetSavingsPlansPurchaseRecommendation(
39 LookbackPeriodInDays => 'SEVEN_DAYS',
40 PaymentOption => 'NO_UPFRONT',
41 SavingsPlansType => 'COMPUTE_SP',
42 TermInYears => 'ONE_YEAR',
43 AccountScope => 'PAYER', # OPTIONAL
44 Filter => {
45 And => [ <Expression>, ... ], # OPTIONAL
46 CostCategories => {
47 Key => 'MyCostCategoryName', # min: 1, max: 50; OPTIONAL
48 MatchOptions => [
49 'EQUALS',
50 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
51 ], # OPTIONAL
52 Values => [
53 'MyValue', ... # max: 1024
54 ], # OPTIONAL
55 }, # OPTIONAL
56 Dimensions => {
57 Key => 'AZ'
58 , # 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
59 MatchOptions => [
60 'EQUALS',
61 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
62 ], # OPTIONAL
63 Values => [
64 'MyValue', ... # max: 1024
65 ], # OPTIONAL
66 }, # OPTIONAL
67 Not => <Expression>,
68 Or => [ <Expression>, ... ], # OPTIONAL
69 Tags => {
70 Key => 'MyTagKey', # max: 1024; OPTIONAL
71 MatchOptions => [
72 'EQUALS',
73 ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
74 ], # OPTIONAL
75 Values => [
76 'MyValue', ... # max: 1024
77 ], # OPTIONAL
78 }, # OPTIONAL
79 }, # OPTIONAL
80 NextPageToken => 'MyNextPageToken', # OPTIONAL
81 PageSize => 1, # OPTIONAL
82 );
83  
84 # Results:
85 my $Metadata = $GetSavingsPlansPurchaseRecommendationResponse->Metadata;
86 my $NextPageToken =
87 $GetSavingsPlansPurchaseRecommendationResponse->NextPageToken;
88 my $SavingsPlansPurchaseRecommendation =
89 $GetSavingsPlansPurchaseRecommendationResponse
90 ->SavingsPlansPurchaseRecommendation;
91  
92 # Returns a L<Paws::CostExplorer::GetSavingsPlansPurchaseRecommendationResponse> object.
93  
94 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.
95 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ce/GetSavingsPlansPurchaseRecommendation>
96  
97 =head1 ATTRIBUTES
98  
99  
100 =head2 AccountScope => Str
101  
102 The account scope that you want your recommendations for. Amazon Web
103 Services calculates recommendations including the management account
104 and member accounts if the value is set to C<PAYER>. If the value is
105 C<LINKED>, recommendations are calculated for individual member
106 accounts only.
107  
108 Valid values are: C<"PAYER">, C<"LINKED">
109  
110 =head2 Filter => L<Paws::CostExplorer::Expression>
111  
112 You can filter your recommendations by Account ID with the
113 C<LINKED_ACCOUNT> dimension. To filter your recommendations by Account
114 ID, specify C<Key> as C<LINKED_ACCOUNT> and C<Value> as the
115 comma-separated Acount ID(s) for which you want to see Savings Plans
116 purchase recommendations.
117  
118 For GetSavingsPlansPurchaseRecommendation, the C<Filter> does not
119 include C<CostCategories> or C<Tags>. It only includes C<Dimensions>.
120 With C<Dimensions>, C<Key> must be C<LINKED_ACCOUNT> and C<Value> can
121 be a single Account ID or multiple comma-separated Account IDs for
122 which you want to see Savings Plans Purchase Recommendations. C<AND>
123 and C<OR> operators are not supported.
124  
125  
126  
127 =head2 B<REQUIRED> LookbackPeriodInDays => Str
128  
129 The lookback period used to generate the recommendation.
130  
131 Valid values are: C<"SEVEN_DAYS">, C<"THIRTY_DAYS">, C<"SIXTY_DAYS">
132  
133 =head2 NextPageToken => Str
134  
135 The token to retrieve the next set of results. Amazon Web Services
136 provides the token when the response from a previous call has more
137 results than the maximum page size.
138  
139  
140  
141 =head2 PageSize => Int
142  
143 The number of recommendations that you want returned in a single
144 response object.
145  
146  
147  
148 =head2 B<REQUIRED> PaymentOption => Str
149  
150 The payment option used to generate these recommendations.
151  
152 Valid values are: C<"NO_UPFRONT">, C<"PARTIAL_UPFRONT">, C<"ALL_UPFRONT">, C<"LIGHT_UTILIZATION">, C<"MEDIUM_UTILIZATION">, C<"HEAVY_UTILIZATION">
153  
154 =head2 B<REQUIRED> SavingsPlansType => Str
155  
156 The Savings Plans recommendation type requested.
157  
158 Valid values are: C<"COMPUTE_SP">, C<"EC2_INSTANCE_SP">, C<"SAGEMAKER_SP">
159  
160 =head2 B<REQUIRED> TermInYears => Str
161  
162 The savings plan recommendation term used to generate these
163 recommendations.
164  
165 Valid values are: C<"ONE_YEAR">, C<"THREE_YEARS">
166  
167  
168 =head1 SEE ALSO
169  
170 This class forms part of L<Paws>, documenting arguments for method GetSavingsPlansPurchaseRecommendation in L<Paws::CostExplorer>
171  
172 =head1 BUGS and CONTRIBUTIONS
173  
174 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
175  
176 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
177  
178 =cut
179