You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Lightsail::Types::GetLoadBalancerMetricDataRequest
 Inherits:

Struct
 Object
 Struct
 Aws::Lightsail::Types::GetLoadBalancerMetricDataRequest
 Defined in:
 (unknown)
Overview
When passing GetLoadBalancerMetricDataRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
load_balancer_name: "ResourceName", # required
metric_name: "ClientTLSNegotiationErrorCount", # required, accepts 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
period: 1, # required
start_time: Time.now, # required
end_time: Time.now, # required
unit: "Seconds", # required, accepts 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
statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
}
Instance Attribute Summary collapse

#end_time ⇒ Time
The end time of the period.

#load_balancer_name ⇒ String
The name of the load balancer.

#metric_name ⇒ String
The metric for which you want to return information.

#period ⇒ Integer
The granularity, in seconds, of the returned data points.

#start_time ⇒ Time
The start time of the period.

#statistics ⇒ Array<String>
The statistic for the metric.

#unit ⇒ String
The unit for the metric data request.
Instance Attribute Details
#end_time ⇒ Time
The end time of the period.
#load_balancer_name ⇒ String
The name of the load balancer.
#metric_name ⇒ String
The metric for which you want to return information.
Valid load balancer metric names are listed below, along with the most
useful statistics
to include in your request, and the published unit
value.
ClientTLSNegotiationErrorCount
 The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
.HealthyHostCount
 The number of target instances that are considered healthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
.Unit
: The published unit isCount
.HTTPCode_Instance_2XX_Count
 The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
.HTTPCode_Instance_3XX_Count
 The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
.HTTPCode_Instance_4XX_Count
 The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
.HTTPCode_Instance_5XX_Count
 The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
.HTTPCode_LB_4XX_Count
 The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
.HTTPCode_LB_5XX_Count
 The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
.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 isAverage
.Unit
: The published unit isSeconds
.RejectedConnectionCount
 The number of connections that were rejected because the load balancer had reached its maximum number of connections.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
.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 isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.Unit
: The published unit isCount
.UnhealthyHostCount
 The number of target instances that are considered unhealthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
.Unit
: The published unit isCount
.Possible values:
 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
#period ⇒ Integer
The granularity, in seconds, of the returned data points.
#start_time ⇒ Time
The start time of the period.
#statistics ⇒ Array<String>
The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.Maximum
 The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.Sum
 All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.Average
 The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.SampleCount
 The count, or number, of data points used for the statistical calculation.
#unit ⇒ String
The unit for the metric data request. Valid units depend on the metric
data being requested. For the valid units with each available metric,
see the metricName
parameter.
Possible values:
 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