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

Performs an analysis of your detector model. For more information, * see Troubleshooting a detector model * in the AWS IoT Events Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTEventsClient, StartDetectorModelAnalysisCommand } from "@aws-sdk/client-iot-events"; // ES Modules import * // const { IoTEventsClient, StartDetectorModelAnalysisCommand } = 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 = { // StartDetectorModelAnalysisRequest * 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 * }, * }; * const command = new StartDetectorModelAnalysisCommand(input); * const response = await client.send(command); * // { // StartDetectorModelAnalysisResponse * // analysisId: "STRING_VALUE", * // }; * * ``` * * @param StartDetectorModelAnalysisCommandInput - {@link StartDetectorModelAnalysisCommandInput} * @returns {@link StartDetectorModelAnalysisCommandOutput} * @see {@link StartDetectorModelAnalysisCommandInput} for command's `input` shape. * @see {@link StartDetectorModelAnalysisCommandOutput} 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 LimitExceededException} (client fault) *

A limit was exceeded.

* * @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 StartDetectorModelAnalysisCommand extends StartDetectorModelAnalysisCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartDetectorModelAnalysisRequest; output: StartDetectorModelAnalysisResponse; }; sdk: { input: StartDetectorModelAnalysisCommandInput; output: StartDetectorModelAnalysisCommandOutput; }; }; }