GetLoadBalancers

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.

Request Syntax


{
   "pageToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

pageToken

A token used for paginating the results from your GetLoadBalancers request.

Type: String

Required: No

Response Syntax


{
   "loadBalancers": [ 
      { 
         "arn": "string",
         "configurationOptions": { 
            "string" : "string" 
         },
         "createdAt": number,
         "dnsName": "string",
         "healthCheckPath": "string",
         "instanceHealthSummary": [ 
            { 
               "instanceHealth": "string",
               "instanceHealthReason": "string",
               "instanceName": "string"
            }
         ],
         "instancePort": number,
         "location": { 
            "availabilityZone": "string",
            "regionName": "string"
         },
         "name": "string",
         "protocol": "string",
         "publicPorts": [ number ],
         "resourceType": "string",
         "state": "string",
         "supportCode": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "tlsCertificateSummaries": [ 
            { 
               "isAttached": boolean,
               "name": "string"
            }
         ]
      }
   ],
   "nextPageToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

loadBalancers

An array of LoadBalancer objects describing your load balancers.

Type: Array of LoadBalancer objects

nextPageToken

A token used for advancing to the next page of results from your GetLoadBalancers request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

AccountSetupInProgressException

Lightsail throws this exception when an account is still in the setup in progress state.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400

GetLoadBalancers

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also