import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient"; import type { DescribeAlarmRequest, DescribeAlarmResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeAlarmCommand}. */ export interface DescribeAlarmCommandInput extends DescribeAlarmRequest { } /** * @public * * The output of {@link DescribeAlarmCommand}. */ export interface DescribeAlarmCommandOutput extends DescribeAlarmResponse, __MetadataBearer { } declare const DescribeAlarmCommand_base: { new (input: DescribeAlarmCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeAlarmCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Retrieves information about an alarm.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTEventsDataClient, DescribeAlarmCommand } from "@aws-sdk/client-iot-events-data"; // ES Modules import * // const { IoTEventsDataClient, DescribeAlarmCommand } = require("@aws-sdk/client-iot-events-data"); // CommonJS import * // import type { IoTEventsDataClientConfig } from "@aws-sdk/client-iot-events-data"; * const config = {}; // type is IoTEventsDataClientConfig * const client = new IoTEventsDataClient(config); * const input = { // DescribeAlarmRequest * alarmModelName: "STRING_VALUE", // required * keyValue: "STRING_VALUE", * }; * const command = new DescribeAlarmCommand(input); * const response = await client.send(command); * // { // DescribeAlarmResponse * // alarm: { // Alarm * // alarmModelName: "STRING_VALUE", * // alarmModelVersion: "STRING_VALUE", * // keyValue: "STRING_VALUE", * // alarmState: { // AlarmState * // stateName: "DISABLED" || "NORMAL" || "ACTIVE" || "ACKNOWLEDGED" || "SNOOZE_DISABLED" || "LATCHED", * // ruleEvaluation: { // RuleEvaluation * // simpleRuleEvaluation: { // SimpleRuleEvaluation * // inputPropertyValue: "STRING_VALUE", * // operator: "GREATER" || "GREATER_OR_EQUAL" || "LESS" || "LESS_OR_EQUAL" || "EQUAL" || "NOT_EQUAL", * // thresholdValue: "STRING_VALUE", * // }, * // }, * // customerAction: { // CustomerAction * // actionName: "SNOOZE" || "ENABLE" || "DISABLE" || "ACKNOWLEDGE" || "RESET", * // snoozeActionConfiguration: { // SnoozeActionConfiguration * // snoozeDuration: Number("int"), * // note: "STRING_VALUE", * // }, * // enableActionConfiguration: { // EnableActionConfiguration * // note: "STRING_VALUE", * // }, * // disableActionConfiguration: { // DisableActionConfiguration * // note: "STRING_VALUE", * // }, * // acknowledgeActionConfiguration: { // AcknowledgeActionConfiguration * // note: "STRING_VALUE", * // }, * // resetActionConfiguration: { // ResetActionConfiguration * // note: "STRING_VALUE", * // }, * // }, * // systemEvent: { // SystemEvent * // eventType: "STATE_CHANGE", * // stateChangeConfiguration: { // StateChangeConfiguration * // triggerType: "SNOOZE_TIMEOUT", * // }, * // }, * // }, * // severity: Number("int"), * // creationTime: new Date("TIMESTAMP"), * // lastUpdateTime: new Date("TIMESTAMP"), * // }, * // }; * * ``` * * @param DescribeAlarmCommandInput - {@link DescribeAlarmCommandInput} * @returns {@link DescribeAlarmCommandOutput} * @see {@link DescribeAlarmCommandInput} for command's `input` shape. * @see {@link DescribeAlarmCommandOutput} for command's `response` shape. * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape. * * @throws {@link InternalFailureException} (server fault) *

An internal failure occurred.

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

The request was invalid.

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

The resource was not found.

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

The service is currently unavailable.

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

The request could not be completed due to throttling.

* * @throws {@link IoTEventsDataServiceException} *

Base exception class for all service exceptions from IoTEventsData service.

* * * @public */ export declare class DescribeAlarmCommand extends DescribeAlarmCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeAlarmRequest; output: DescribeAlarmResponse; }; sdk: { input: DescribeAlarmCommandInput; output: DescribeAlarmCommandOutput; }; }; }