@aws-sdk/client-iot-events 3.296.0 → 3.297.0

package/dist-types/commands/StartDetectorModelAnalysisCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
 import { StartDetectorModelAnalysisRequest, StartDetectorModelAnalysisResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StartDetectorModelAnalysisCommand}.
  */
 export interface StartDetectorModelAnalysisCommandInput extends StartDetectorModelAnalysisRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartDetectorModelAnalysisCommand}.
  */
 export interface StartDetectorModelAnalysisCommandOutput extends StartDetectorModelAnalysisResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Performs an analysis of your detector model. For more information,
  *       see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html">Troubleshooting a detector model</a>
  *       in the <i>AWS IoT Events Developer Guide</i>.</p>
@@ -27,6 +32,8 @@ export interface StartDetectorModelAnalysisCommandOutput extends StartDetectorMo
  * const response = await client.send(command);
  * ```
  *
+ * @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.
@@ -51,11 +58,20 @@ export interface StartDetectorModelAnalysisCommandOutput extends StartDetectorMo
 export declare class StartDetectorModelAnalysisCommand extends $Command<StartDetectorModelAnalysisCommandInput, StartDetectorModelAnalysisCommandOutput, IoTEventsClientResolvedConfig> {
     readonly input: StartDetectorModelAnalysisCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartDetectorModelAnalysisCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDetectorModelAnalysisCommandInput, StartDetectorModelAnalysisCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds to or modifies the tags of the given resource. Tags are metadata that can be used to
  *       manage a resource.</p>
  * @example
@@ -26,6 +31,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IoTEventsClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes the given tags (metadata) from the resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IoTEventsClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateAlarmModelCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
 import { UpdateAlarmModelRequest, UpdateAlarmModelResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateAlarmModelCommand}.
  */
 export interface UpdateAlarmModelCommandInput extends UpdateAlarmModelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateAlarmModelCommand}.
  */
 export interface UpdateAlarmModelCommandOutput extends UpdateAlarmModelResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an alarm model. Any alarms that were created based on the previous version are
  *       deleted and then created again as new data arrives.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateAlarmModelCommandOutput extends UpdateAlarmModelResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateAlarmModelCommandInput - {@link UpdateAlarmModelCommandInput}
+ * @returns {@link UpdateAlarmModelCommandOutput}
  * @see {@link UpdateAlarmModelCommandInput} for command's `input` shape.
  * @see {@link UpdateAlarmModelCommandOutput} for command's `response` shape.
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateAlarmModelCommandOutput extends UpdateAlarmModelResponse,
 export declare class UpdateAlarmModelCommand extends $Command<UpdateAlarmModelCommandInput, UpdateAlarmModelCommandOutput, IoTEventsClientResolvedConfig> {
     readonly input: UpdateAlarmModelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateAlarmModelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAlarmModelCommandInput, UpdateAlarmModelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateDetectorModelCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
 import { UpdateDetectorModelRequest, UpdateDetectorModelResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateDetectorModelCommand}.
  */
 export interface UpdateDetectorModelCommandInput extends UpdateDetectorModelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDetectorModelCommand}.
  */
 export interface UpdateDetectorModelCommandOutput extends UpdateDetectorModelResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a detector model. Detectors (instances) spawned by the previous version are
  *       deleted and then re-created as new inputs arrive.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateDetectorModelCommandOutput extends UpdateDetectorModelRes
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDetectorModelCommandInput - {@link UpdateDetectorModelCommandInput}
+ * @returns {@link UpdateDetectorModelCommandOutput}
  * @see {@link UpdateDetectorModelCommandInput} for command's `input` shape.
  * @see {@link UpdateDetectorModelCommandOutput} for command's `response` shape.
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateDetectorModelCommandOutput extends UpdateDetectorModelRes
 export declare class UpdateDetectorModelCommand extends $Command<UpdateDetectorModelCommandInput, UpdateDetectorModelCommandOutput, IoTEventsClientResolvedConfig> {
     readonly input: UpdateDetectorModelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDetectorModelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDetectorModelCommandInput, UpdateDetectorModelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateInputCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
 import { UpdateInputRequest, UpdateInputResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateInputCommand}.
  */
 export interface UpdateInputCommandInput extends UpdateInputRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateInputCommand}.
  */
 export interface UpdateInputCommandOutput extends UpdateInputResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an input.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateInputCommandOutput extends UpdateInputResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateInputCommandInput - {@link UpdateInputCommandInput}
+ * @returns {@link UpdateInputCommandOutput}
  * @see {@link UpdateInputCommandInput} for command's `input` shape.
  * @see {@link UpdateInputCommandOutput} for command's `response` shape.
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateInputCommandOutput extends UpdateInputResponse, __Metadat
 export declare class UpdateInputCommand extends $Command<UpdateInputCommandInput, UpdateInputCommandOutput, IoTEventsClientResolvedConfig> {
     readonly input: UpdateInputCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateInputCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateInputCommandInput, UpdateInputCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/IoTEventsServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from IoTEvents service.
  */
 export declare class IoTEventsServiceException extends __ServiceException {