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 { GetLoadBalancerMetricDataRequest, GetLoadBalancerMetricDataResult } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetLoadBalancerMetricDataCommand}. */ export interface GetLoadBalancerMetricDataCommandInput extends GetLoadBalancerMetricDataRequest { } /** * @public * * The output of {@link GetLoadBalancerMetricDataCommand}. */ export interface GetLoadBalancerMetricDataCommandOutput extends GetLoadBalancerMetricDataResult, __MetadataBearer { } declare const GetLoadBalancerMetricDataCommand_base: { new (input: GetLoadBalancerMetricDataCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetLoadBalancerMetricDataCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LightsailClient, GetLoadBalancerMetricDataCommand } from "@aws-sdk/client-lightsail"; // ES Modules import * // const { LightsailClient, GetLoadBalancerMetricDataCommand } = 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 = { // GetLoadBalancerMetricDataRequest * loadBalancerName: "STRING_VALUE", // required * metricName: "ClientTLSNegotiationErrorCount" || "HealthyHostCount" || "UnhealthyHostCount" || "HTTPCode_LB_4XX_Count" || "HTTPCode_LB_5XX_Count" || "HTTPCode_Instance_2XX_Count" || "HTTPCode_Instance_3XX_Count" || "HTTPCode_Instance_4XX_Count" || "HTTPCode_Instance_5XX_Count" || "InstanceResponseTime" || "RejectedConnectionCount" || "RequestCount", // required * period: Number("int"), // required * startTime: new Date("TIMESTAMP"), // required * endTime: new Date("TIMESTAMP"), // required * unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", // required * statistics: [ // MetricStatisticList // required * "Minimum" || "Maximum" || "Sum" || "Average" || "SampleCount", * ], * }; * const command = new GetLoadBalancerMetricDataCommand(input); * const response = await client.send(command); * // { // GetLoadBalancerMetricDataResult * // metricName: "ClientTLSNegotiationErrorCount" || "HealthyHostCount" || "UnhealthyHostCount" || "HTTPCode_LB_4XX_Count" || "HTTPCode_LB_5XX_Count" || "HTTPCode_Instance_2XX_Count" || "HTTPCode_Instance_3XX_Count" || "HTTPCode_Instance_4XX_Count" || "HTTPCode_Instance_5XX_Count" || "InstanceResponseTime" || "RejectedConnectionCount" || "RequestCount", * // metricData: [ // MetricDatapointList * // { // MetricDatapoint * // average: Number("double"), * // maximum: Number("double"), * // minimum: Number("double"), * // sampleCount: Number("double"), * // sum: Number("double"), * // timestamp: new Date("TIMESTAMP"), * // unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", * // }, * // ], * // }; * * ``` * * @param GetLoadBalancerMetricDataCommandInput - {@link GetLoadBalancerMetricDataCommandInput} * @returns {@link GetLoadBalancerMetricDataCommandOutput} * @see {@link GetLoadBalancerMetricDataCommandInput} for command's `input` shape. * @see {@link GetLoadBalancerMetricDataCommandOutput} 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 GetLoadBalancerMetricDataCommand extends GetLoadBalancerMetricDataCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetLoadBalancerMetricDataRequest; output: GetLoadBalancerMetricDataResult; }; sdk: { input: GetLoadBalancerMetricDataCommandInput; output: GetLoadBalancerMetricDataCommandOutput; }; }; }