« blib/lib/Paws/ComputeOptimizer/LambdaFunctionMemoryRecommendationOption.pm
↑ Summary
blib/lib/Paws/ComputeOptimizer/LambdaFunctionRecommendationFilter.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ComputeOptimizer::LambdaFunctionRecommendation; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', request_name => 'accountId', traits => ['NameInRequest']); | ||
| 5 | has CurrentMemorySize => (is => 'ro', isa => 'Int', request_name => 'currentMemorySize', traits => ['NameInRequest']); | ||
| 6 | has Finding => (is => 'ro', isa => 'Str', request_name => 'finding', traits => ['NameInRequest']); | ||
| 7 | has FindingReasonCodes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'findingReasonCodes', traits => ['NameInRequest']); | ||
| 8 | has FunctionArn => (is => 'ro', isa => 'Str', request_name => 'functionArn', traits => ['NameInRequest']); | ||
| 9 | has FunctionVersion => (is => 'ro', isa => 'Str', request_name => 'functionVersion', traits => ['NameInRequest']); | ||
| 10 | has LastRefreshTimestamp => (is => 'ro', isa => 'Str', request_name => 'lastRefreshTimestamp', traits => ['NameInRequest']); | ||
| 11 | has LookbackPeriodInDays => (is => 'ro', isa => 'Num', request_name => 'lookbackPeriodInDays', traits => ['NameInRequest']); | ||
| 12 | has MemorySizeRecommendationOptions => (is => 'ro', isa => 'ArrayRef[Paws::ComputeOptimizer::LambdaFunctionMemoryRecommendationOption]', request_name => 'memorySizeRecommendationOptions', traits => ['NameInRequest']); | ||
| 13 | has NumberOfInvocations => (is => 'ro', isa => 'Int', request_name => 'numberOfInvocations', traits => ['NameInRequest']); | ||
| 14 | has UtilizationMetrics => (is => 'ro', isa => 'ArrayRef[Paws::ComputeOptimizer::LambdaFunctionUtilizationMetric]', request_name => 'utilizationMetrics', traits => ['NameInRequest']); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ComputeOptimizer::LambdaFunctionRecommendation | ||
| 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::ComputeOptimizer::LambdaFunctionRecommendation object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { AccountId => $value, ..., UtilizationMetrics => $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::ComputeOptimizer::LambdaFunctionRecommendation object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->AccountId | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Describes an AWS Lambda function recommendation. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AccountId => Str | ||
| 52 | |||
| 53 | The AWS account ID of the function. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 CurrentMemorySize => Int | ||
| 57 | |||
| 58 | The amount of memory, in MB, that's allocated to the current function. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Finding => Str | ||
| 62 | |||
| 63 | The finding classification of the function. | ||
| 64 | |||
| 65 | Findings for functions include: | ||
| 66 | |||
| 67 | =over | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | B<C<Optimized> > E<mdash> The function is correctly provisioned to run | ||
| 72 | your workload based on its current configuration and its utilization | ||
| 73 | history. This finding classification does not include finding reason | ||
| 74 | codes. | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | B<C<NotOptimized> > E<mdash> The function is performing at a higher | ||
| 79 | level (over-provisioned) or at a lower level (under-provisioned) than | ||
| 80 | required for your workload because its current configuration is not | ||
| 81 | optimal. Over-provisioned resources might lead to unnecessary | ||
| 82 | infrastructure cost, and under-provisioned resources might lead to poor | ||
| 83 | application performance. This finding classification can include the | ||
| 84 | C<MemoryUnderprovisioned> and C<MemoryUnderprovisioned> finding reason | ||
| 85 | codes. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | B<C<Unavailable> > E<mdash> Compute Optimizer was unable to generate a | ||
| 90 | recommendation for the function. This could be because the function has | ||
| 91 | not accumulated sufficient metric data, or the function does not | ||
| 92 | qualify for a recommendation. This finding classification can include | ||
| 93 | the C<InsufficientData> and C<Inconclusive> finding reason codes. | ||
| 94 | |||
| 95 | Functions with a finding of unavailable are not returned unless you | ||
| 96 | specify the C<filter> parameter with a value of C<Unavailable> in your | ||
| 97 | C<GetLambdaFunctionRecommendations> request. | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 FindingReasonCodes => ArrayRef[Str|Undef] | ||
| 104 | |||
| 105 | The reason for the finding classification of the function. | ||
| 106 | |||
| 107 | Functions that have a finding classification of C<Optimized> don't have | ||
| 108 | a finding reason code. | ||
| 109 | |||
| 110 | Finding reason codes for functions include: | ||
| 111 | |||
| 112 | =over | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | B<C<MemoryOverprovisioned> > E<mdash> The function is over-provisioned | ||
| 117 | when its memory configuration can be sized down while still meeting the | ||
| 118 | performance requirements of your workload. An over-provisioned function | ||
| 119 | might lead to unnecessary infrastructure cost. This finding reason code | ||
| 120 | is part of the C<NotOptimized> finding classification. | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | B<C<MemoryUnderprovisioned> > E<mdash> The function is | ||
| 125 | under-provisioned when its memory configuration doesn't meet the | ||
| 126 | performance requirements of the workload. An under-provisioned function | ||
| 127 | might lead to poor application performance. This finding reason code is | ||
| 128 | part of the C<NotOptimized> finding classification. | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | B<C<InsufficientData> > E<mdash> The function does not have sufficient | ||
| 133 | metric data for Compute Optimizer to generate a recommendation. For | ||
| 134 | more information, see the Supported resources and requirements | ||
| 135 | (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) | ||
| 136 | in the I<AWS Compute Optimizer User Guide>. This finding reason code is | ||
| 137 | part of the C<Unavailable> finding classification. | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | B<C<Inconclusive> > E<mdash> The function does not qualify for a | ||
| 142 | recommendation because Compute Optimizer cannot generate a | ||
| 143 | recommendation with a high degree of confidence. This finding reason | ||
| 144 | code is part of the C<Unavailable> finding classification. | ||
| 145 | |||
| 146 | =back | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 FunctionArn => Str | ||
| 151 | |||
| 152 | The Amazon Resource Name (ARN) of the current function. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 FunctionVersion => Str | ||
| 156 | |||
| 157 | The version number of the current function. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 LastRefreshTimestamp => Str | ||
| 161 | |||
| 162 | The time stamp of when the function recommendation was last refreshed. | ||
| 163 | |||
| 164 | |||
| 165 | =head2 LookbackPeriodInDays => Num | ||
| 166 | |||
| 167 | The number of days for which utilization metrics were analyzed for the | ||
| 168 | function. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 MemorySizeRecommendationOptions => ArrayRef[L<Paws::ComputeOptimizer::LambdaFunctionMemoryRecommendationOption>] | ||
| 172 | |||
| 173 | An array of objects that describe the memory configuration | ||
| 174 | recommendation options for the function. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 NumberOfInvocations => Int | ||
| 178 | |||
| 179 | The number of times your function code was executed during the | ||
| 180 | look-back period. | ||
| 181 | |||
| 182 | |||
| 183 | =head2 UtilizationMetrics => ArrayRef[L<Paws::ComputeOptimizer::LambdaFunctionUtilizationMetric>] | ||
| 184 | |||
| 185 | An array of objects that describe the utilization metrics of the | ||
| 186 | function. | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head1 SEE ALSO | ||
| 191 | |||
| 192 | This class forms part of L<Paws>, describing an object used in L<Paws::ComputeOptimizer> | ||
| 193 | |||
| 194 | =head1 BUGS and CONTRIBUTIONS | ||
| 195 | |||
| 196 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 197 | |||
| 198 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 199 | |||
| 200 | =cut | ||
| 201 |