« blib/lib/Paws/CostExplorer/SavingsPlansPurchaseRecommendationMetadata.pm
↑ Summary
blib/lib/Paws/CostExplorer/SavingsPlansSavings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CostExplorer::SavingsPlansPurchaseRecommendationSummary; | ||
| 3 | use Moose; | ||
| 4 | has CurrencyCode => (is => 'ro', isa => 'Str'); | ||
| 5 | has CurrentOnDemandSpend => (is => 'ro', isa => 'Str'); | ||
| 6 | has DailyCommitmentToPurchase => (is => 'ro', isa => 'Str'); | ||
| 7 | has EstimatedMonthlySavingsAmount => (is => 'ro', isa => 'Str'); | ||
| 8 | has EstimatedOnDemandCostWithCurrentCommitment => (is => 'ro', isa => 'Str'); | ||
| 9 | has EstimatedROI => (is => 'ro', isa => 'Str'); | ||
| 10 | has EstimatedSavingsAmount => (is => 'ro', isa => 'Str'); | ||
| 11 | has EstimatedSavingsPercentage => (is => 'ro', isa => 'Str'); | ||
| 12 | has EstimatedTotalCost => (is => 'ro', isa => 'Str'); | ||
| 13 | has HourlyCommitmentToPurchase => (is => 'ro', isa => 'Str'); | ||
| 14 | has TotalRecommendationCount => (is => 'ro', isa => 'Str'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CostExplorer::SavingsPlansPurchaseRecommendationSummary | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::CostExplorer::SavingsPlansPurchaseRecommendationSummary object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { CurrencyCode => $value, ..., TotalRecommendationCount => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::CostExplorer::SavingsPlansPurchaseRecommendationSummary object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->CurrencyCode | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Summary metrics for your Savings Plans Purchase Recommendations. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 CurrencyCode => Str | ||
| 52 | |||
| 53 | The currency code AWS used to generate the recommendations and present | ||
| 54 | potential savings. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 CurrentOnDemandSpend => Str | ||
| 58 | |||
| 59 | The current total on demand spend of the applicable usage types over | ||
| 60 | the lookback period. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 DailyCommitmentToPurchase => Str | ||
| 64 | |||
| 65 | The recommended Savings Plans cost on a daily (24 hourly) basis. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 EstimatedMonthlySavingsAmount => Str | ||
| 69 | |||
| 70 | The estimated monthly savings amount, based on the recommended Savings | ||
| 71 | Plans purchase. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 EstimatedOnDemandCostWithCurrentCommitment => Str | ||
| 75 | |||
| 76 | The estimated On-Demand costs you would expect with no additional | ||
| 77 | commitment, based on your usage of the selected time period and the | ||
| 78 | Savings Plans you own. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 EstimatedROI => Str | ||
| 82 | |||
| 83 | The estimated return on investment based on the recommended Savings | ||
| 84 | Plans and estimated savings. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 EstimatedSavingsAmount => Str | ||
| 88 | |||
| 89 | The estimated total savings over the lookback period, based on the | ||
| 90 | purchase of the recommended Savings Plans. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 EstimatedSavingsPercentage => Str | ||
| 94 | |||
| 95 | The estimated savings relative to the total cost of On-Demand usage, | ||
| 96 | over the lookback period. This is calculated as | ||
| 97 | C<estimatedSavingsAmount>/ C<CurrentOnDemandSpend>*100. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 EstimatedTotalCost => Str | ||
| 101 | |||
| 102 | The estimated total cost of the usage after purchasing the recommended | ||
| 103 | Savings Plans. This is a sum of the cost of Savings Plans during this | ||
| 104 | term, and the remaining On-Demand usage. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 HourlyCommitmentToPurchase => Str | ||
| 108 | |||
| 109 | The recommended hourly commitment based on the recommendation | ||
| 110 | parameters. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 TotalRecommendationCount => Str | ||
| 114 | |||
| 115 | The aggregate number of Savings Plans recommendations that exist for | ||
| 116 | your account. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, describing an object used in L<Paws::CostExplorer> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |