« blib/lib/Paws/Lightsail/GetContainerServiceDeploymentsResult.pm
↑ Summary
blib/lib/Paws/Lightsail/GetContainerServiceMetricDataResult.pm »
| 1 | |||
| 2 | package Paws::Lightsail::GetContainerServiceMetricData; | ||
| 3 | use Moose; | ||
| 4 | has EndTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'endTime' , required => 1); | ||
| 5 | has MetricName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'metricName' , required => 1); | ||
| 6 | has Period => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'period' , required => 1); | ||
| 7 | has ServiceName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'serviceName' , required => 1); | ||
| 8 | has StartTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'startTime' , required => 1); | ||
| 9 | has Statistics => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'statistics' , required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetContainerServiceMetricData'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::GetContainerServiceMetricDataResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Lightsail::GetContainerServiceMetricData - Arguments for method GetContainerServiceMetricData on L<Paws::Lightsail> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetContainerServiceMetricData on the | ||
| 27 | L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class | ||
| 28 | as arguments to method GetContainerServiceMetricData. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetContainerServiceMetricData. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $lightsail = Paws->service('Lightsail'); | ||
| 35 | my $GetContainerServiceMetricDataResult = | ||
| 36 | $lightsail->GetContainerServiceMetricData( | ||
| 37 | EndTime => '1970-01-01T01:00:00', | ||
| 38 | MetricName => 'CPUUtilization', | ||
| 39 | Period => 1, | ||
| 40 | ServiceName => 'MyContainerServiceName', | ||
| 41 | StartTime => '1970-01-01T01:00:00', | ||
| 42 | Statistics => [ | ||
| 43 | 'Minimum', ... # values: Minimum, Maximum, Sum, Average, SampleCount | ||
| 44 | ], | ||
| 45 | |||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $MetricData = $GetContainerServiceMetricDataResult->MetricData; | ||
| 50 | my $MetricName = $GetContainerServiceMetricDataResult->MetricName; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Lightsail::GetContainerServiceMetricDataResult> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/GetContainerServiceMetricData> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> EndTime => Str | ||
| 61 | |||
| 62 | The end time of the time period. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> MetricName => Str | ||
| 67 | |||
| 68 | The metric for which you want to return information. | ||
| 69 | |||
| 70 | Valid container service metric names are listed below, along with the | ||
| 71 | most useful statistics to include in your request, and the published | ||
| 72 | unit value. | ||
| 73 | |||
| 74 | =over | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C<CPUUtilization> - The average percentage of compute units that are | ||
| 79 | currently in use across all nodes of the container service. This metric | ||
| 80 | identifies the processing power required to run containers on each node | ||
| 81 | of the container service. | ||
| 82 | |||
| 83 | Statistics: The most useful statistics are C<Maximum> and C<Average>. | ||
| 84 | |||
| 85 | Unit: The published unit is C<Percent>. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<MemoryUtilization> - The average percentage of available memory that | ||
| 90 | is currently in use across all nodes of the container service. This | ||
| 91 | metric identifies the memory required to run containers on each node of | ||
| 92 | the container service. | ||
| 93 | |||
| 94 | Statistics: The most useful statistics are C<Maximum> and C<Average>. | ||
| 95 | |||
| 96 | Unit: The published unit is C<Percent>. | ||
| 97 | |||
| 98 | =back | ||
| 99 | |||
| 100 | |||
| 101 | Valid values are: C<"CPUUtilization">, C<"MemoryUtilization"> | ||
| 102 | |||
| 103 | =head2 B<REQUIRED> Period => Int | ||
| 104 | |||
| 105 | The granularity, in seconds, of the returned data points. | ||
| 106 | |||
| 107 | All container service metric data is available in 5-minute (300 | ||
| 108 | seconds) granularity. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> ServiceName => Str | ||
| 113 | |||
| 114 | The name of the container service for which to get metric data. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 B<REQUIRED> StartTime => Str | ||
| 119 | |||
| 120 | The start time of the time period. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> Statistics => ArrayRef[Str|Undef] | ||
| 125 | |||
| 126 | The statistic for the metric. | ||
| 127 | |||
| 128 | The following statistics are available: | ||
| 129 | |||
| 130 | =over | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | C<Minimum> - The lowest value observed during the specified period. Use | ||
| 135 | this value to determine low volumes of activity for your application. | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | C<Maximum> - The highest value observed during the specified period. | ||
| 140 | Use this value to determine high volumes of activity for your | ||
| 141 | application. | ||
| 142 | |||
| 143 | =item * | ||
| 144 | |||
| 145 | C<Sum> - All values submitted for the matching metric added together. | ||
| 146 | You can use this statistic to determine the total volume of a metric. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<Average> - The value of C<Sum> / C<SampleCount> during the specified | ||
| 151 | period. By comparing this statistic with the C<Minimum> and C<Maximum> | ||
| 152 | values, you can determine the full scope of a metric and how close the | ||
| 153 | average use is to the C<Minimum> and C<Maximum> values. This comparison | ||
| 154 | helps you to know when to increase or decrease your resources. | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | C<SampleCount> - The count, or number, of data points used for the | ||
| 159 | statistical calculation. | ||
| 160 | |||
| 161 | =back | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head1 SEE ALSO | ||
| 168 | |||
| 169 | This class forms part of L<Paws>, documenting arguments for method GetContainerServiceMetricData in L<Paws::Lightsail> | ||
| 170 | |||
| 171 | =head1 BUGS and CONTRIBUTIONS | ||
| 172 | |||
| 173 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 174 | |||
| 175 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 176 | |||
| 177 | =cut | ||
| 178 |