« blib/lib/Paws/ComputeOptimizer/EBSFilter.pm
↑ Summary
blib/lib/Paws/ComputeOptimizer/ExportAutoScalingGroupRecommendations.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ComputeOptimizer::EBSUtilizationMetric; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 5 | has Statistic => (is => 'ro', isa => 'Str', request_name => 'statistic', traits => ['NameInRequest']); | ||
| 6 | has Value => (is => 'ro', isa => 'Num', request_name => 'value', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::ComputeOptimizer::EBSUtilizationMetric | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::ComputeOptimizer::EBSUtilizationMetric object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Name => $value, ..., Value => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::ComputeOptimizer::EBSUtilizationMetric object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Name | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Describes a utilization metric of an Amazon Elastic Block Store (Amazon | ||
| 39 | EBS) volume. | ||
| 40 | |||
| 41 | Compare the utilization metric data of your resource against its | ||
| 42 | projected utilization metric data to determine the performance | ||
| 43 | difference between your current resource and the recommended option. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Name => Str | ||
| 49 | |||
| 50 | The name of the utilization metric. | ||
| 51 | |||
| 52 | The following utilization metrics are available: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | C<VolumeReadOpsPerSecond> - The completed read operations per second | ||
| 59 | from the volume in a specified period of time. | ||
| 60 | |||
| 61 | Unit: Count | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | C<VolumeWriteOpsPerSecond> - The completed write operations per second | ||
| 66 | to the volume in a specified period of time. | ||
| 67 | |||
| 68 | Unit: Count | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<VolumeReadBytesPerSecond> - The bytes read per second from the volume | ||
| 73 | in a specified period of time. | ||
| 74 | |||
| 75 | Unit: Bytes | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<VolumeWriteBytesPerSecond> - The bytes written to the volume in a | ||
| 80 | specified period of time. | ||
| 81 | |||
| 82 | Unit: Bytes | ||
| 83 | |||
| 84 | =back | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Statistic => Str | ||
| 89 | |||
| 90 | The statistic of the utilization metric. | ||
| 91 | |||
| 92 | The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and | ||
| 93 | SDKs return utilization metrics using only the C<Maximum> statistic, | ||
| 94 | which is the highest value observed during the specified period. | ||
| 95 | |||
| 96 | The Compute Optimizer console displays graphs for some utilization | ||
| 97 | metrics using the C<Average> statistic, which is the value of C<Sum> / | ||
| 98 | C<SampleCount> during the specified period. For more information, see | ||
| 99 | Viewing resource recommendations | ||
| 100 | (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) | ||
| 101 | in the I<AWS Compute Optimizer User Guide>. You can also get averaged | ||
| 102 | utilization metric data for your resources using Amazon CloudWatch. For | ||
| 103 | more information, see the Amazon CloudWatch User Guide | ||
| 104 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). | ||
| 105 | |||
| 106 | |||
| 107 | =head2 Value => Num | ||
| 108 | |||
| 109 | The value of the utilization metric. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, describing an object used in L<Paws::ComputeOptimizer> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |