Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . lightsail ]

get-load-balancers

Description

Returns information about all load balancers in an account.

If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-load-balancers
[--page-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--page-token (string)

A token used for paginating the results from your get-load-balancers request.

--cli-input-json (string) Performs service operation based on the JSON page-token provided. The JSON page-token follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

loadBalancers -> (list)

An array of LoadBalancer objects describing your load balancers.

(structure)

Describes the Lightsail load balancer.

name -> (string)

The name of the load balancer (e.g., my-load-balancer ).

arn -> (string)

The Amazon Resource Name (ARN) of the load balancer.

supportCode -> (string)

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

createdAt -> (timestamp)

The date when your load balancer was created.

location -> (structure)

The AWS Region and Availability Zone where your load balancer was created (e.g., us-east-2a ).

availabilityZone -> (string)

The Availability Zone. Follows the format us-east-2a (case-sensitive).

regionName -> (string)

The AWS Region name.

resourceType -> (string)

The resource type (e.g., LoadBalancer .

dnsName -> (string)

The DNS name of your Lightsail load balancer.

state -> (string)

The status of your load balancer. Valid values are below.

protocol -> (string)

The protocol you have enabled for your load balancer. Valid values are below.

publicPorts -> (list)

An array of public port settings for your load balancer.

(integer)

healthCheckPath -> (string)

The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

instancePort -> (integer)

The instance port where the load balancer is listening.

instanceHealthSummary -> (list)

An array of InstanceHealthSummary objects describing the health of the load balancer.

(structure)

Describes information about the health of the instance.

instanceName -> (string)

The name of the Lightsail instance for which you are requesting health check data.

instanceHealth -> (string)

Describes the overall instance health. Valid values are below.

instanceHealthReason -> (string)

More information about the instance health. Valid values are below.

tlsCertificateSummaries -> (list)

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.

(structure)

Provides a summary of TLS/SSL certificate metadata.

name -> (string)

The name of the TLS/SSL certificate.

isAttached -> (boolean)

When true , the TLS/SSL certificate is attached to the Lightsail load balancer.

configurationOptions -> (map)

A page-token to page-token map of the configuration options for your load balancer. Valid values are listed below.

key -> (string)

value -> (string)

nextPageToken -> (string)

A token used for advancing to the next page of results from your get-load-balancers request.