import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient"; import type { DescribeAlarmModelRequest, DescribeAlarmModelResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeAlarmModelCommand}. */ export interface DescribeAlarmModelCommandInput extends DescribeAlarmModelRequest { } /** * @public * * The output of {@link DescribeAlarmModelCommand}. */ export interface DescribeAlarmModelCommandOutput extends DescribeAlarmModelResponse, __MetadataBearer { } declare const DescribeAlarmModelCommand_base: { new (input: DescribeAlarmModelCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeAlarmModelCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Retrieves information about an alarm model. If you don't specify a value for the * alarmModelVersion parameter, the latest version is returned.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTEventsClient, DescribeAlarmModelCommand } from "@aws-sdk/client-iot-events"; // ES Modules import * // const { IoTEventsClient, DescribeAlarmModelCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import * // import type { IoTEventsClientConfig } from "@aws-sdk/client-iot-events"; * const config = {}; // type is IoTEventsClientConfig * const client = new IoTEventsClient(config); * const input = { // DescribeAlarmModelRequest * alarmModelName: "STRING_VALUE", // required * alarmModelVersion: "STRING_VALUE", * }; * const command = new DescribeAlarmModelCommand(input); * const response = await client.send(command); * // { // DescribeAlarmModelResponse * // creationTime: new Date("TIMESTAMP"), * // alarmModelArn: "STRING_VALUE", * // alarmModelVersion: "STRING_VALUE", * // lastUpdateTime: new Date("TIMESTAMP"), * // status: "ACTIVE" || "ACTIVATING" || "INACTIVE" || "FAILED", * // statusMessage: "STRING_VALUE", * // alarmModelName: "STRING_VALUE", * // alarmModelDescription: "STRING_VALUE", * // roleArn: "STRING_VALUE", * // key: "STRING_VALUE", * // severity: Number("int"), * // alarmRule: { // AlarmRule * // simpleRule: { // SimpleRule * // inputProperty: "STRING_VALUE", // required * // comparisonOperator: "GREATER" || "GREATER_OR_EQUAL" || "LESS" || "LESS_OR_EQUAL" || "EQUAL" || "NOT_EQUAL", // required * // threshold: "STRING_VALUE", // required * // }, * // }, * // alarmNotification: { // AlarmNotification * // notificationActions: [ // NotificationActions * // { // NotificationAction * // action: { // NotificationTargetActions * // lambdaAction: { // LambdaAction * // functionArn: "STRING_VALUE", // required * // payload: { // Payload * // contentExpression: "STRING_VALUE", // required * // type: "STRING" || "JSON", // required * // }, * // }, * // }, * // smsConfigurations: [ // SMSConfigurations * // { // SMSConfiguration * // senderId: "STRING_VALUE", * // additionalMessage: "STRING_VALUE", * // recipients: [ // RecipientDetails // required * // { // RecipientDetail * // ssoIdentity: { // SSOIdentity * // identityStoreId: "STRING_VALUE", // required * // userId: "STRING_VALUE", * // }, * // }, * // ], * // }, * // ], * // emailConfigurations: [ // EmailConfigurations * // { // EmailConfiguration * // from: "STRING_VALUE", // required * // content: { // EmailContent * // subject: "STRING_VALUE", * // additionalMessage: "STRING_VALUE", * // }, * // recipients: { // EmailRecipients * // to: [ * // { * // ssoIdentity: { * // identityStoreId: "STRING_VALUE", // required * // userId: "STRING_VALUE", * // }, * // }, * // ], * // }, * // }, * // ], * // }, * // ], * // }, * // alarmEventActions: { // AlarmEventActions * // alarmActions: [ // AlarmActions * // { // AlarmAction * // sns: { // SNSTopicPublishAction * // targetArn: "STRING_VALUE", // required * // payload: { * // contentExpression: "STRING_VALUE", // required * // type: "STRING" || "JSON", // required * // }, * // }, * // iotTopicPublish: { // IotTopicPublishAction * // mqttTopic: "STRING_VALUE", // required * // payload: { * // contentExpression: "STRING_VALUE", // required * // type: "STRING" || "JSON", // required * // }, * // }, * // lambda: { * // functionArn: "STRING_VALUE", // required * // payload: { * // contentExpression: "STRING_VALUE", // required * // type: "STRING" || "JSON", // required * // }, * // }, * // iotEvents: { // IotEventsAction * // inputName: "STRING_VALUE", // required * // payload: { * // contentExpression: "STRING_VALUE", // required * // type: "STRING" || "JSON", // required * // }, * // }, * // sqs: { // SqsAction * // queueUrl: "STRING_VALUE", // required * // useBase64: true || false, * // payload: "", * // }, * // firehose: { // FirehoseAction * // deliveryStreamName: "STRING_VALUE", // required * // separator: "STRING_VALUE", * // payload: "", * // }, * // dynamoDB: { // DynamoDBAction * // hashKeyType: "STRING_VALUE", * // hashKeyField: "STRING_VALUE", // required * // hashKeyValue: "STRING_VALUE", // required * // rangeKeyType: "STRING_VALUE", * // rangeKeyField: "STRING_VALUE", * // rangeKeyValue: "STRING_VALUE", * // operation: "STRING_VALUE", * // payloadField: "STRING_VALUE", * // tableName: "STRING_VALUE", // required * // payload: "", * // }, * // dynamoDBv2: { // DynamoDBv2Action * // tableName: "STRING_VALUE", // required * // payload: "", * // }, * // iotSiteWise: { // IotSiteWiseAction * // entryId: "STRING_VALUE", * // assetId: "STRING_VALUE", * // propertyId: "STRING_VALUE", * // propertyAlias: "STRING_VALUE", * // propertyValue: { // AssetPropertyValue * // value: { // AssetPropertyVariant * // stringValue: "STRING_VALUE", * // integerValue: "STRING_VALUE", * // doubleValue: "STRING_VALUE", * // booleanValue: "STRING_VALUE", * // }, * // timestamp: { // AssetPropertyTimestamp * // timeInSeconds: "STRING_VALUE", // required * // offsetInNanos: "STRING_VALUE", * // }, * // quality: "STRING_VALUE", * // }, * // }, * // }, * // ], * // }, * // alarmCapabilities: { // AlarmCapabilities * // initializationConfiguration: { // InitializationConfiguration * // disabledOnInitialization: true || false, // required * // }, * // acknowledgeFlow: { // AcknowledgeFlow * // enabled: true || false, // required * // }, * // }, * // }; * * ``` * * @param DescribeAlarmModelCommandInput - {@link DescribeAlarmModelCommandInput} * @returns {@link DescribeAlarmModelCommandOutput} * @see {@link DescribeAlarmModelCommandInput} for command's `input` shape. * @see {@link DescribeAlarmModelCommandOutput} for command's `response` shape. * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient'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 IoTEventsServiceException} *

Base exception class for all service exceptions from IoTEvents service.

* * * @public */ export declare class DescribeAlarmModelCommand extends DescribeAlarmModelCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeAlarmModelRequest; output: DescribeAlarmModelResponse; }; sdk: { input: DescribeAlarmModelCommandInput; output: DescribeAlarmModelCommandOutput; }; }; }