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 { GetAlarmsRequest, GetAlarmsResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetAlarmsCommand}. */ export interface GetAlarmsCommandInput extends GetAlarmsRequest { } /** * @public * * The output of {@link GetAlarmsCommand}. */ export interface GetAlarmsCommandOutput extends GetAlarmsResult, __MetadataBearer { } declare const GetAlarmsCommand_base: { new (input: GetAlarmsCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [GetAlarmsCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Returns information about the configured alarms. Specify an alarm name in your request to * return information about a specific alarm, or specify a monitored resource name to return * information about all alarms for a specific resource.

*

An alarm is used to monitor a single metric for one of your resources. When a metric * condition is met, the alarm can notify you by email, SMS text message, and a banner displayed * on the Amazon Lightsail console. For more information, see Alarms * in Amazon Lightsail.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LightsailClient, GetAlarmsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import * // const { LightsailClient, GetAlarmsCommand } = 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 = { // GetAlarmsRequest * alarmName: "STRING_VALUE", * pageToken: "STRING_VALUE", * monitoredResourceName: "STRING_VALUE", * }; * const command = new GetAlarmsCommand(input); * const response = await client.send(command); * // { // GetAlarmsResult * // alarms: [ // AlarmsList * // { // Alarm * // name: "STRING_VALUE", * // arn: "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", * // supportCode: "STRING_VALUE", * // monitoredResourceInfo: { // MonitoredResourceInfo * // arn: "STRING_VALUE", * // name: "STRING_VALUE", * // resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket", * // }, * // comparisonOperator: "GreaterThanOrEqualToThreshold" || "GreaterThanThreshold" || "LessThanThreshold" || "LessThanOrEqualToThreshold", * // evaluationPeriods: Number("int"), * // period: Number("int"), * // threshold: Number("double"), * // datapointsToAlarm: Number("int"), * // treatMissingData: "breaching" || "notBreaching" || "ignore" || "missing", * // statistic: "Minimum" || "Maximum" || "Sum" || "Average" || "SampleCount", * // metricName: "CPUUtilization" || "NetworkIn" || "NetworkOut" || "StatusCheckFailed" || "StatusCheckFailed_Instance" || "StatusCheckFailed_System" || "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" || "DatabaseConnections" || "DiskQueueDepth" || "FreeStorageSpace" || "NetworkReceiveThroughput" || "NetworkTransmitThroughput" || "BurstCapacityTime" || "BurstCapacityPercentage", * // state: "OK" || "ALARM" || "INSUFFICIENT_DATA", * // 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", * // contactProtocols: [ // ContactProtocolsList * // "Email" || "SMS", * // ], * // notificationTriggers: [ // NotificationTriggerList * // "OK" || "ALARM" || "INSUFFICIENT_DATA", * // ], * // notificationEnabled: true || false, * // tags: [ // TagList * // { // Tag * // key: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // }, * // ], * // nextPageToken: "STRING_VALUE", * // }; * * ``` * * @param GetAlarmsCommandInput - {@link GetAlarmsCommandInput} * @returns {@link GetAlarmsCommandOutput} * @see {@link GetAlarmsCommandInput} for command's `input` shape. * @see {@link GetAlarmsCommandOutput} 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 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 GetAlarmsCommand extends GetAlarmsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetAlarmsRequest; output: GetAlarmsResult; }; sdk: { input: GetAlarmsCommandInput; output: GetAlarmsCommandOutput; }; }; }