Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AWS Tools for Windows PowerShell
Command Reference

Synopsis

Calls the Amazon Lightsail GetLoadBalancerMetricData API operation.

Syntax

Get-LSLoadBalancerMetricData
-LoadBalancerName <String>
-EndTime <DateTime>
-MetricName <LoadBalancerMetricName>
-Period <Int32>
-StartTime <DateTime>
-Statistic <String[]>
-Unit <MetricUnit>
-Select <String>
-PassThru <SwitchParameter>
-ClientConfig <AmazonLightsailConfig>

Description

Returns information about health metrics for your Lightsail load balancer. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

Parameters

-ClientConfig <AmazonLightsailConfig>
Amazon.PowerShell.Cmdlets.LS.AmazonLightsailClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndTime <DateTime>
The end time of the period.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoadBalancerName <String>
The name of the load balancer.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-MetricName <LoadBalancerMetricName>
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 is Sum.Unit: The published unit is Count.
  • HealthyHostCount - The number of target instances that are considered healthy.Statistics: The most useful statistic are Average, Minimum, and Maximum.Unit: The published unit is Count.
  • 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 is Sum. Note that Minimum, Maximum, and Average all return 1.Unit: The published unit is Count.
  • 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 is Sum. Note that Minimum, Maximum, and Average all return 1.Unit: The published unit is Count.
  • 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 is Sum. Note that Minimum, Maximum, and Average all return 1.Unit: The published unit is Count.
  • 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 is Sum. Note that Minimum, Maximum, and Average all return 1.Unit: The published unit is Count.
  • 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 is Sum. Note that Minimum, Maximum, and Average all return 1.Unit: The published unit is Count.
  • 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 is Sum. Note that Minimum, Maximum, and Average all return 1.Unit: The published unit is Count.
  • 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.Unit: The published unit is Seconds.
  • 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.Unit: The published unit is Count.
  • 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.Unit: The published unit is Count.
  • UnhealthyHostCount - The number of target instances that are considered unhealthy.Statistics: The most useful statistic are Average, Minimum, and Maximum.Unit: The published unit is Count.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the LoadBalancerName parameter. The -PassThru parameter is deprecated, use -Select '^LoadBalancerName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Period <Int32>
The granularity, in seconds, of the returned data points.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse). Specifying the name of a property of type Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartTime <DateTime>
The start time of the period.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Statistic <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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStatistics
-Unit <MetricUnit>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse
This cmdlet returns an Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 4.1.795.0