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 { DescribeDetectorModelRequest, DescribeDetectorModelResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeDetectorModelCommand}. */ export interface DescribeDetectorModelCommandInput extends DescribeDetectorModelRequest { } /** * @public * * The output of {@link DescribeDetectorModelCommand}. */ export interface DescribeDetectorModelCommandOutput extends DescribeDetectorModelResponse, __MetadataBearer { } declare const DescribeDetectorModelCommand_base: { new (input: DescribeDetectorModelCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeDetectorModelCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Describes a detector model. If the version parameter is not specified, * information about the latest version is returned.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTEventsClient, DescribeDetectorModelCommand } from "@aws-sdk/client-iot-events"; // ES Modules import * // const { IoTEventsClient, DescribeDetectorModelCommand } = 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 = { // DescribeDetectorModelRequest * detectorModelName: "STRING_VALUE", // required * detectorModelVersion: "STRING_VALUE", * }; * const command = new DescribeDetectorModelCommand(input); * const response = await client.send(command); * // { // DescribeDetectorModelResponse * // detectorModel: { // DetectorModel * // detectorModelDefinition: { // DetectorModelDefinition * // states: [ // States // required * // { // State * // stateName: "STRING_VALUE", // required * // onInput: { // OnInputLifecycle * // events: [ // Events * // { // Event * // eventName: "STRING_VALUE", // required * // condition: "STRING_VALUE", * // actions: [ // Actions * // { // Action * // setVariable: { // SetVariableAction * // variableName: "STRING_VALUE", // required * // value: "STRING_VALUE", // required * // }, * // sns: { // SNSTopicPublishAction * // targetArn: "STRING_VALUE", // required * // payload: { // Payload * // contentExpression: "STRING_VALUE", // required * // type: "STRING" || "JSON", // required * // }, * // }, * // iotTopicPublish: { // IotTopicPublishAction * // mqttTopic: "STRING_VALUE", // required * // payload: { * // contentExpression: "STRING_VALUE", // required * // type: "STRING" || "JSON", // required * // }, * // }, * // setTimer: { // SetTimerAction * // timerName: "STRING_VALUE", // required * // seconds: Number("int"), * // durationExpression: "STRING_VALUE", * // }, * // clearTimer: { // ClearTimerAction * // timerName: "STRING_VALUE", // required * // }, * // resetTimer: { // ResetTimerAction * // timerName: "STRING_VALUE", // required * // }, * // lambda: { // LambdaAction * // 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: { * // contentExpression: "STRING_VALUE", // required * // type: "STRING" || "JSON", // required * // }, * // }, * // 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", * // }, * // }, * // }, * // ], * // }, * // ], * // transitionEvents: [ // TransitionEvents * // { // TransitionEvent * // eventName: "STRING_VALUE", // required * // condition: "STRING_VALUE", // required * // actions: [ * // { * // setVariable: { * // variableName: "STRING_VALUE", // required * // value: "STRING_VALUE", // required * // }, * // sns: { * // targetArn: "STRING_VALUE", // required * // payload: "", * // }, * // iotTopicPublish: { * // mqttTopic: "STRING_VALUE", // required * // payload: "", * // }, * // setTimer: { * // timerName: "STRING_VALUE", // required * // seconds: Number("int"), * // durationExpression: "STRING_VALUE", * // }, * // clearTimer: { * // timerName: "STRING_VALUE", // required * // }, * // resetTimer: { * // timerName: "STRING_VALUE", // required * // }, * // lambda: { * // functionArn: "STRING_VALUE", // required * // payload: "", * // }, * // iotEvents: { * // inputName: "STRING_VALUE", // required * // payload: "", * // }, * // sqs: { * // queueUrl: "STRING_VALUE", // required * // useBase64: true || false, * // payload: "", * // }, * // firehose: { * // deliveryStreamName: "STRING_VALUE", // required * // separator: "STRING_VALUE", * // payload: "", * // }, * // dynamoDB: { * // 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: { * // tableName: "STRING_VALUE", // required * // payload: "", * // }, * // iotSiteWise: { * // entryId: "STRING_VALUE", * // assetId: "STRING_VALUE", * // propertyId: "STRING_VALUE", * // propertyAlias: "STRING_VALUE", * // propertyValue: { * // value: { * // stringValue: "STRING_VALUE", * // integerValue: "STRING_VALUE", * // doubleValue: "STRING_VALUE", * // booleanValue: "STRING_VALUE", * // }, * // timestamp: { * // timeInSeconds: "STRING_VALUE", // required * // offsetInNanos: "STRING_VALUE", * // }, * // quality: "STRING_VALUE", * // }, * // }, * // }, * // ], * // nextState: "STRING_VALUE", // required * // }, * // ], * // }, * // onEnter: { // OnEnterLifecycle * // events: [ * // { * // eventName: "STRING_VALUE", // required * // condition: "STRING_VALUE", * // actions: [ * // { * // setVariable: { * // variableName: "STRING_VALUE", // required * // value: "STRING_VALUE", // required * // }, * // sns: { * // targetArn: "STRING_VALUE", // required * // payload: "", * // }, * // iotTopicPublish: { * // mqttTopic: "STRING_VALUE", // required * // payload: "", * // }, * // setTimer: { * // timerName: "STRING_VALUE", // required * // seconds: Number("int"), * // durationExpression: "STRING_VALUE", * // }, * // clearTimer: { * // timerName: "STRING_VALUE", // required * // }, * // resetTimer: { * // timerName: "STRING_VALUE", // required * // }, * // lambda: { * // functionArn: "STRING_VALUE", // required * // payload: "", * // }, * // iotEvents: { * // inputName: "STRING_VALUE", // required * // payload: "", * // }, * // sqs: { * // queueUrl: "STRING_VALUE", // required * // useBase64: true || false, * // payload: "", * // }, * // firehose: { * // deliveryStreamName: "STRING_VALUE", // required * // separator: "STRING_VALUE", * // payload: "", * // }, * // dynamoDB: { * // 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: { * // tableName: "STRING_VALUE", // required * // payload: "", * // }, * // iotSiteWise: { * // entryId: "STRING_VALUE", * // assetId: "STRING_VALUE", * // propertyId: "STRING_VALUE", * // propertyAlias: "STRING_VALUE", * // propertyValue: { * // value: { * // stringValue: "STRING_VALUE", * // integerValue: "STRING_VALUE", * // doubleValue: "STRING_VALUE", * // booleanValue: "STRING_VALUE", * // }, * // timestamp: { * // timeInSeconds: "STRING_VALUE", // required * // offsetInNanos: "STRING_VALUE", * // }, * // quality: "STRING_VALUE", * // }, * // }, * // }, * // ], * // }, * // ], * // }, * // onExit: { // OnExitLifecycle * // events: [ * // { * // eventName: "STRING_VALUE", // required * // condition: "STRING_VALUE", * // actions: [ * // { * // setVariable: { * // variableName: "STRING_VALUE", // required * // value: "STRING_VALUE", // required * // }, * // sns: { * // targetArn: "STRING_VALUE", // required * // payload: "", * // }, * // iotTopicPublish: { * // mqttTopic: "STRING_VALUE", // required * // payload: "", * // }, * // setTimer: { * // timerName: "STRING_VALUE", // required * // seconds: Number("int"), * // durationExpression: "STRING_VALUE", * // }, * // clearTimer: { * // timerName: "STRING_VALUE", // required * // }, * // resetTimer: { * // timerName: "STRING_VALUE", // required * // }, * // lambda: { * // functionArn: "STRING_VALUE", // required * // payload: "", * // }, * // iotEvents: { * // inputName: "STRING_VALUE", // required * // payload: "", * // }, * // sqs: { * // queueUrl: "STRING_VALUE", // required * // useBase64: true || false, * // payload: "", * // }, * // firehose: { * // deliveryStreamName: "STRING_VALUE", // required * // separator: "STRING_VALUE", * // payload: "", * // }, * // dynamoDB: { * // 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: { * // tableName: "STRING_VALUE", // required * // payload: "", * // }, * // iotSiteWise: { * // entryId: "STRING_VALUE", * // assetId: "STRING_VALUE", * // propertyId: "STRING_VALUE", * // propertyAlias: "STRING_VALUE", * // propertyValue: { * // value: { * // stringValue: "STRING_VALUE", * // integerValue: "STRING_VALUE", * // doubleValue: "STRING_VALUE", * // booleanValue: "STRING_VALUE", * // }, * // timestamp: { * // timeInSeconds: "STRING_VALUE", // required * // offsetInNanos: "STRING_VALUE", * // }, * // quality: "STRING_VALUE", * // }, * // }, * // }, * // ], * // }, * // ], * // }, * // }, * // ], * // initialStateName: "STRING_VALUE", // required * // }, * // detectorModelConfiguration: { // DetectorModelConfiguration * // detectorModelName: "STRING_VALUE", * // detectorModelVersion: "STRING_VALUE", * // detectorModelDescription: "STRING_VALUE", * // detectorModelArn: "STRING_VALUE", * // roleArn: "STRING_VALUE", * // creationTime: new Date("TIMESTAMP"), * // lastUpdateTime: new Date("TIMESTAMP"), * // status: "ACTIVE" || "ACTIVATING" || "INACTIVE" || "DEPRECATED" || "DRAFT" || "PAUSED" || "FAILED", * // key: "STRING_VALUE", * // evaluationMethod: "BATCH" || "SERIAL", * // }, * // }, * // }; * * ``` * * @param DescribeDetectorModelCommandInput - {@link DescribeDetectorModelCommandInput} * @returns {@link DescribeDetectorModelCommandOutput} * @see {@link DescribeDetectorModelCommandInput} for command's `input` shape. * @see {@link DescribeDetectorModelCommandOutput} 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 DescribeDetectorModelCommand extends DescribeDetectorModelCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDetectorModelRequest; output: DescribeDetectorModelResponse; }; sdk: { input: DescribeDetectorModelCommandInput; output: DescribeDetectorModelCommandOutput; }; }; }