import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient"; import type { GetLoadBalancerRequest } from "../models/models_0"; import type { GetLoadBalancerResult } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetLoadBalancerCommand}. */ export interface GetLoadBalancerCommandInput extends GetLoadBalancerRequest { } /** * @public * * The output of {@link GetLoadBalancerCommand}. */ export interface GetLoadBalancerCommandOutput extends GetLoadBalancerResult, __MetadataBearer { } declare const GetLoadBalancerCommand_base: { new (input: GetLoadBalancerCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetLoadBalancerCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Returns information about the specified Lightsail load balancer.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LightsailClient, GetLoadBalancerCommand } from "@aws-sdk/client-lightsail"; // ES Modules import * // const { LightsailClient, GetLoadBalancerCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import * // import type { LightsailClientConfig } from "@aws-sdk/client-lightsail"; * const config = {}; // type is LightsailClientConfig * const client = new LightsailClient(config); * const input = { // GetLoadBalancerRequest * loadBalancerName: "STRING_VALUE", // required * }; * const command = new GetLoadBalancerCommand(input); * const response = await client.send(command); * // { // GetLoadBalancerResult * // loadBalancer: { // LoadBalancer * // name: "STRING_VALUE", * // arn: "STRING_VALUE", * // supportCode: "STRING_VALUE", * // createdAt: new Date("TIMESTAMP"), * // location: { // ResourceLocation * // availabilityZone: "STRING_VALUE", * // regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "eu-north-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "ap-southeast-3" || "ap-southeast-5", * // }, * // resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket", * // tags: [ // TagList * // { // Tag * // key: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // dnsName: "STRING_VALUE", * // state: "active" || "provisioning" || "active_impaired" || "failed" || "unknown", * // protocol: "HTTP_HTTPS" || "HTTP", * // publicPorts: [ // PortList * // Number("int"), * // ], * // healthCheckPath: "STRING_VALUE", * // instancePort: Number("int"), * // instanceHealthSummary: [ // InstanceHealthSummaryList * // { // InstanceHealthSummary * // instanceName: "STRING_VALUE", * // instanceHealth: "initial" || "healthy" || "unhealthy" || "unused" || "draining" || "unavailable", * // instanceHealthReason: "Lb.RegistrationInProgress" || "Lb.InitialHealthChecking" || "Lb.InternalError" || "Instance.ResponseCodeMismatch" || "Instance.Timeout" || "Instance.FailedHealthChecks" || "Instance.NotRegistered" || "Instance.NotInUse" || "Instance.DeregistrationInProgress" || "Instance.InvalidState" || "Instance.IpUnusable", * // }, * // ], * // tlsCertificateSummaries: [ // LoadBalancerTlsCertificateSummaryList * // { // LoadBalancerTlsCertificateSummary * // name: "STRING_VALUE", * // isAttached: true || false, * // }, * // ], * // configurationOptions: { // LoadBalancerConfigurationOptions * // "": "STRING_VALUE", * // }, * // ipAddressType: "dualstack" || "ipv4" || "ipv6", * // httpsRedirectionEnabled: true || false, * // tlsPolicyName: "STRING_VALUE", * // }, * // }; * * ``` * * @param GetLoadBalancerCommandInput - {@link GetLoadBalancerCommandInput} * @returns {@link GetLoadBalancerCommandOutput} * @see {@link GetLoadBalancerCommandInput} for command's `input` shape. * @see {@link GetLoadBalancerCommandOutput} for command's `response` shape. * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

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

* * @throws {@link AccountSetupInProgressException} (client fault) *

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

* * @throws {@link InvalidInputException} (client fault) *

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

* *

Domain and distribution APIs are only available in the N. Virginia * (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services * Region configuration to us-east-1 to create, view, or edit these * resources.

*
* * @throws {@link NotFoundException} (client fault) *

Lightsail throws this exception when it cannot find a resource.

* * @throws {@link OperationFailureException} (client fault) *

Lightsail throws this exception when an operation fails to execute.

* * @throws {@link RegionSetupInProgressException} (client fault) *

Lightsail throws this exception when an operation is performed on resources in an opt-in * Region that is currently being set up.

* * @throws {@link ServiceException} (server fault) *

A general service exception.

* * @throws {@link UnauthenticatedException} (client fault) *

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

* * @throws {@link LightsailServiceException} *

Base exception class for all service exceptions from Lightsail service.

* * * @public */ export declare class GetLoadBalancerCommand extends GetLoadBalancerCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetLoadBalancerRequest; output: GetLoadBalancerResult; }; sdk: { input: GetLoadBalancerCommandInput; output: GetLoadBalancerCommandOutput; }; }; }