« blib/lib/Paws/ComputeOptimizer/ExportLambdaFunctionRecommendationsResponse.pm
↑ Summary
blib/lib/Paws/ComputeOptimizer/GetAutoScalingGroupRecommendations.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ComputeOptimizer::Filter; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 5 | has Values => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'values', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::ComputeOptimizer::Filter | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::ComputeOptimizer::Filter object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Name => $value, ..., Values => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::ComputeOptimizer::Filter object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Name | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Describes a filter that returns a more specific list of | ||
| 38 | recommendations. Use this filter with the | ||
| 39 | C<GetAutoScalingGroupRecommendations> and | ||
| 40 | C<GetEC2InstanceRecommendations> actions. | ||
| 41 | |||
| 42 | You can use C<EBSFilter> with the C<GetEBSVolumeRecommendations> | ||
| 43 | action, C<LambdaFunctionRecommendationFilter> with the | ||
| 44 | C<GetLambdaFunctionRecommendations> action, and C<JobFilter> with the | ||
| 45 | C<DescribeRecommendationExportJobs> action. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Name => Str | ||
| 51 | |||
| 52 | The name of the filter. | ||
| 53 | |||
| 54 | Specify C<Finding> to return recommendations with a specific finding | ||
| 55 | classification (e.g., C<Underprovisioned>). | ||
| 56 | |||
| 57 | Specify C<RecommendationSourceType> to return recommendations of a | ||
| 58 | specific resource type (e.g., C<Ec2Instance>). | ||
| 59 | |||
| 60 | Specify C<FindingReasonCodes> to return recommendations with a specific | ||
| 61 | finding reason code (e.g., C<CPUUnderprovisioned>). | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Values => ArrayRef[Str|Undef] | ||
| 65 | |||
| 66 | The value of the filter. | ||
| 67 | |||
| 68 | The valid values for this parameter are as follows, depending on what | ||
| 69 | you specify for the C<name> parameter and the resource type that you | ||
| 70 | wish to filter results for: | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | Specify C<Optimized> or C<NotOptimized> if you specify the C<name> | ||
| 77 | parameter as C<Finding> and you want to filter results for Auto Scaling | ||
| 78 | groups. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | Specify C<Underprovisioned>, C<Overprovisioned>, or C<Optimized> if you | ||
| 83 | specify the C<name> parameter as C<Finding> and you want to filter | ||
| 84 | results for EC2 instances. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | Specify C<Ec2Instance> or C<AutoScalingGroup> if you specify the | ||
| 89 | C<name> parameter as C<RecommendationSourceType>. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | Specify one of the following options if you specify the C<name> | ||
| 94 | parameter as C<FindingReasonCodes>: | ||
| 95 | |||
| 96 | =over | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | B<C<CPUOverprovisioned> > E<mdash> The instanceE<rsquo>s CPU | ||
| 101 | configuration can be sized down while still meeting the performance | ||
| 102 | requirements of your workload. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | B<C<CPUUnderprovisioned> > E<mdash> The instanceE<rsquo>s CPU | ||
| 107 | configuration doesn't meet the performance requirements of your | ||
| 108 | workload and there is an alternative instance type that provides better | ||
| 109 | CPU performance. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | B<C<MemoryOverprovisioned> > E<mdash> The instanceE<rsquo>s memory | ||
| 114 | configuration can be sized down while still meeting the performance | ||
| 115 | requirements of your workload. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | B<C<MemoryUnderprovisioned> > E<mdash> The instanceE<rsquo>s memory | ||
| 120 | configuration doesn't meet the performance requirements of your | ||
| 121 | workload and there is an alternative instance type that provides better | ||
| 122 | memory performance. | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | B<C<EBSThroughputOverprovisioned> > E<mdash> The instanceE<rsquo>s EBS | ||
| 127 | throughput configuration can be sized down while still meeting the | ||
| 128 | performance requirements of your workload. | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | B<C<EBSThroughputUnderprovisioned> > E<mdash> The instanceE<rsquo>s EBS | ||
| 133 | throughput configuration doesn't meet the performance requirements of | ||
| 134 | your workload and there is an alternative instance type that provides | ||
| 135 | better EBS throughput performance. | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | B<C<EBSIOPSOverprovisioned> > E<mdash> The instanceE<rsquo>s EBS IOPS | ||
| 140 | configuration can be sized down while still meeting the performance | ||
| 141 | requirements of your workload. | ||
| 142 | |||
| 143 | =item * | ||
| 144 | |||
| 145 | B<C<EBSIOPSUnderprovisioned> > E<mdash> The instanceE<rsquo>s EBS IOPS | ||
| 146 | configuration doesn't meet the performance requirements of your | ||
| 147 | workload and there is an alternative instance type that provides better | ||
| 148 | EBS IOPS performance. | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | B<C<NetworkBandwidthOverprovisioned> > E<mdash> The instanceE<rsquo>s | ||
| 153 | network bandwidth configuration can be sized down while still meeting | ||
| 154 | the performance requirements of your workload. | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | B<C<NetworkBandwidthUnderprovisioned> > E<mdash> The instanceE<rsquo>s | ||
| 159 | network bandwidth configuration doesn't meet the performance | ||
| 160 | requirements of your workload and there is an alternative instance type | ||
| 161 | that provides better network bandwidth performance. This finding reason | ||
| 162 | happens when the C<NetworkIn> or C<NetworkOut> performance of an | ||
| 163 | instance is impacted. | ||
| 164 | |||
| 165 | =item * | ||
| 166 | |||
| 167 | B<C<NetworkPPSOverprovisioned> > E<mdash> The instanceE<rsquo>s network | ||
| 168 | PPS (packets per second) configuration can be sized down while still | ||
| 169 | meeting the performance requirements of your workload. | ||
| 170 | |||
| 171 | =item * | ||
| 172 | |||
| 173 | B<C<NetworkPPSUnderprovisioned> > E<mdash> The instanceE<rsquo>s | ||
| 174 | network PPS (packets per second) configuration doesn't meet the | ||
| 175 | performance requirements of your workload and there is an alternative | ||
| 176 | instance type that provides better network PPS performance. | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | B<C<DiskIOPSOverprovisioned> > E<mdash> The instanceE<rsquo>s disk IOPS | ||
| 181 | configuration can be sized down while still meeting the performance | ||
| 182 | requirements of your workload. | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | B<C<DiskIOPSUnderprovisioned> > E<mdash> The instanceE<rsquo>s disk | ||
| 187 | IOPS configuration doesn't meet the performance requirements of your | ||
| 188 | workload and there is an alternative instance type that provides better | ||
| 189 | disk IOPS performance. | ||
| 190 | |||
| 191 | =item * | ||
| 192 | |||
| 193 | B<C<DiskThroughputOverprovisioned> > E<mdash> The instanceE<rsquo>s | ||
| 194 | disk throughput configuration can be sized down while still meeting the | ||
| 195 | performance requirements of your workload. | ||
| 196 | |||
| 197 | =item * | ||
| 198 | |||
| 199 | B<C<DiskThroughputUnderprovisioned> > E<mdash> The instanceE<rsquo>s | ||
| 200 | disk throughput configuration doesn't meet the performance requirements | ||
| 201 | of your workload and there is an alternative instance type that | ||
| 202 | provides better disk throughput performance. | ||
| 203 | |||
| 204 | =back | ||
| 205 | |||
| 206 | =back | ||
| 207 | |||
| 208 | |||
| 209 | |||
| 210 | |||
| 211 | =head1 SEE ALSO | ||
| 212 | |||
| 213 | This class forms part of L<Paws>, describing an object used in L<Paws::ComputeOptimizer> | ||
| 214 | |||
| 215 | =head1 BUGS and CONTRIBUTIONS | ||
| 216 | |||
| 217 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 218 | |||
| 219 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 220 | |||
| 221 | =cut | ||
| 222 |