AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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>

Description

Returns information about health metrics for your Lightsail load balancer.

Parameters

-EndTime <DateTime>
The end time of the period.
Required?False
Position?Named
Accept pipeline input?False
-LoadBalancerName <String>
The name of the load balancer.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
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.
Required?False
Position?Named
Accept pipeline input?False
-Period <Int32>
The time period duration for your health data request.
Required?False
Position?Named
Accept pipeline input?False
-StartTime <DateTime>
The start time of the period.
Required?False
Position?Named
Accept pipeline input?False
-Statistic <String[]>
An array of statistics that you want to request metrics for. Valid values are listed below.
Required?False
Position?Named
Accept pipeline input?False
-Unit <MetricUnit>
The unit for the time period request. Valid values are listed below.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the LoadBalancerName parameter.

Outputs

This cmdlet returns a Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z