NAME

Paws::Lightsail::GetLoadBalancerMetricData - Arguments for method GetLoadBalancerMetricData on Paws::Lightsail

DESCRIPTION

This class represents the parameters used for calling the method GetLoadBalancerMetricData on the Amazon Lightsail service. Use the attributes of this class as arguments to method GetLoadBalancerMetricData.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetLoadBalancerMetricData.

SYNOPSIS

my $lightsail = Paws->service('Lightsail');
my $GetLoadBalancerMetricDataResult = $lightsail->GetLoadBalancerMetricData(
  EndTime          => '1970-01-01T01:00:00',
  LoadBalancerName => 'MyResourceName',
  MetricName       => 'ClientTLSNegotiationErrorCount',
  Period           => 1,
  StartTime        => '1970-01-01T01:00:00',
  Statistics       => [
    'Minimum', ...    # values: Minimum, Maximum, Sum, Average, SampleCount
  ],
  Unit => 'Seconds',

);

# Results:
my $MetricData = $GetLoadBalancerMetricDataResult->MetricData;
my $MetricName = $GetLoadBalancerMetricDataResult->MetricName;

# Returns a L<Paws::Lightsail::GetLoadBalancerMetricDataResult> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/lightsail/GetLoadBalancerMetricData

ATTRIBUTES

REQUIRED EndTime => Str

The end time of the period.

REQUIRED LoadBalancerName => Str

The name of the load balancer.

REQUIRED MetricName => Str

The metric about which you want to return information. Valid values are listed below, along with the most useful statistics to include in your request.

• ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.

  Statistics: The most useful statistic is Sum.

• HealthyHostCount - The number of target instances that are considered healthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• UnhealthyHostCount - The number of target instances that are considered unhealthy.

  Statistics: The most useful statistic are Average, Minimum, and Maximum.

• HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

• HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

• InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

  Statistics: The most useful statistic is Average.

• RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

  Statistics: The most useful statistic is Sum.

• RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

  Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

Valid values are: "ClientTLSNegotiationErrorCount", "HealthyHostCount", "UnhealthyHostCount", "HTTPCode_LB_4XX_Count", "HTTPCode_LB_5XX_Count", "HTTPCode_Instance_2XX_Count", "HTTPCode_Instance_3XX_Count", "HTTPCode_Instance_4XX_Count", "HTTPCode_Instance_5XX_Count", "InstanceResponseTime", "RejectedConnectionCount", "RequestCount"

REQUIRED Period => Int

The granularity, in seconds, of the returned data points.

REQUIRED StartTime => Str

The start time of the period.

REQUIRED Statistics => ArrayRef[Str|Undef]

An array of statistics that you want to request metrics for. Valid values are listed below.

• SampleCount - The count (number) of data points used for the statistical calculation.

• Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.

• Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.

• Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.

• Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.

REQUIRED Unit => Str

The unit for the time period request. Valid values are listed below.

Valid values are: "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"

SEE ALSO

This class forms part of Paws, documenting arguments for method GetLoadBalancerMetricData in Paws::Lightsail

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config