@aws-sdk/client-iot-events-data 3.533.0 → 3.535.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/dist-types/IoTEventsData.d.ts +1 -1
  2. package/dist-types/IoTEventsDataClient.d.ts +1 -1
  3. package/dist-types/commands/BatchAcknowledgeAlarmCommand.d.ts +2 -1
  4. package/dist-types/commands/BatchDeleteDetectorCommand.d.ts +2 -1
  5. package/dist-types/commands/BatchDisableAlarmCommand.d.ts +2 -1
  6. package/dist-types/commands/BatchEnableAlarmCommand.d.ts +2 -1
  7. package/dist-types/commands/BatchPutMessageCommand.d.ts +2 -1
  8. package/dist-types/commands/BatchResetAlarmCommand.d.ts +2 -1
  9. package/dist-types/commands/BatchSnoozeAlarmCommand.d.ts +2 -1
  10. package/dist-types/commands/BatchUpdateDetectorCommand.d.ts +2 -1
  11. package/dist-types/commands/DescribeAlarmCommand.d.ts +2 -1
  12. package/dist-types/commands/DescribeDetectorCommand.d.ts +2 -1
  13. package/dist-types/commands/ListAlarmsCommand.d.ts +2 -1
  14. package/dist-types/commands/ListDetectorsCommand.d.ts +2 -1
  15. package/dist-types/models/models_0.d.ts +181 -181
  16. package/dist-types/ts3.4/commands/BatchAcknowledgeAlarmCommand.d.ts +9 -0
  17. package/dist-types/ts3.4/commands/BatchDeleteDetectorCommand.d.ts +9 -0
  18. package/dist-types/ts3.4/commands/BatchDisableAlarmCommand.d.ts +9 -0
  19. package/dist-types/ts3.4/commands/BatchEnableAlarmCommand.d.ts +9 -0
  20. package/dist-types/ts3.4/commands/BatchPutMessageCommand.d.ts +9 -0
  21. package/dist-types/ts3.4/commands/BatchResetAlarmCommand.d.ts +9 -0
  22. package/dist-types/ts3.4/commands/BatchSnoozeAlarmCommand.d.ts +9 -0
  23. package/dist-types/ts3.4/commands/BatchUpdateDetectorCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/DescribeAlarmCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/DescribeDetectorCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/ListAlarmsCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/ListDetectorsCommand.d.ts +9 -0
  28. package/package.json +40 -40
@@ -87,12 +87,12 @@ export interface IoTEventsData {
87
87
  listDetectors(args: ListDetectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDetectorsCommandOutput) => void): void;
88
88
  }
89
89
  /**
90
- * @public
91
90
  * <p>IoT Events monitors your equipment or device fleets for failures or changes in operation, and
92
91
  * triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to
93
92
  * detectors, list detectors, and view or update a detector's status.</p>
94
93
  * <p> For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/what-is-iotevents.html">What is IoT Events?</a> in the
95
94
  * <i>IoT Events Developer Guide</i>.</p>
95
+ * @public
96
96
  */
97
97
  export declare class IoTEventsData extends IoTEventsDataClient implements IoTEventsData {
98
98
  }
@@ -163,12 +163,12 @@ export type IoTEventsDataClientResolvedConfigType = __SmithyResolvedConfiguratio
163
163
  export interface IoTEventsDataClientResolvedConfig extends IoTEventsDataClientResolvedConfigType {
164
164
  }
165
165
  /**
166
- * @public
167
166
  * <p>IoT Events monitors your equipment or device fleets for failures or changes in operation, and
168
167
  * triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to
169
168
  * detectors, list detectors, and view or update a detector's status.</p>
170
169
  * <p> For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/what-is-iotevents.html">What is IoT Events?</a> in the
171
170
  * <i>IoT Events Developer Guide</i>.</p>
171
+ * @public
172
172
  */
173
173
  export declare class IoTEventsDataClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IoTEventsDataClientResolvedConfig> {
174
174
  /**
@@ -22,10 +22,10 @@ export interface BatchAcknowledgeAlarmCommandOutput extends BatchAcknowledgeAlar
22
22
  }
23
23
  declare const BatchAcknowledgeAlarmCommand_base: {
24
24
  new (input: BatchAcknowledgeAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchAcknowledgeAlarmCommandInput, BatchAcknowledgeAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: BatchAcknowledgeAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchAcknowledgeAlarmCommandInput, BatchAcknowledgeAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Acknowledges one or more alarms. The alarms change to the <code>ACKNOWLEDGED</code> state
30
30
  * after you acknowledge them.</p>
31
31
  * @example
@@ -79,6 +79,7 @@ declare const BatchAcknowledgeAlarmCommand_base: {
79
79
  * @throws {@link IoTEventsDataServiceException}
80
80
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
81
81
  *
82
+ * @public
82
83
  */
83
84
  export declare class BatchAcknowledgeAlarmCommand extends BatchAcknowledgeAlarmCommand_base {
84
85
  }
@@ -22,10 +22,10 @@ export interface BatchDeleteDetectorCommandOutput extends BatchDeleteDetectorRes
22
22
  }
23
23
  declare const BatchDeleteDetectorCommand_base: {
24
24
  new (input: BatchDeleteDetectorCommandInput): import("@smithy/smithy-client").CommandImpl<BatchDeleteDetectorCommandInput, BatchDeleteDetectorCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: BatchDeleteDetectorCommandInput): import("@smithy/smithy-client").CommandImpl<BatchDeleteDetectorCommandInput, BatchDeleteDetectorCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors.html">ListDetectors</a> API call.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -77,6 +77,7 @@ declare const BatchDeleteDetectorCommand_base: {
77
77
  * @throws {@link IoTEventsDataServiceException}
78
78
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
79
79
  *
80
+ * @public
80
81
  */
81
82
  export declare class BatchDeleteDetectorCommand extends BatchDeleteDetectorCommand_base {
82
83
  }
@@ -22,10 +22,10 @@ export interface BatchDisableAlarmCommandOutput extends BatchDisableAlarmRespons
22
22
  }
23
23
  declare const BatchDisableAlarmCommand_base: {
24
24
  new (input: BatchDisableAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchDisableAlarmCommandInput, BatchDisableAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: BatchDisableAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchDisableAlarmCommandInput, BatchDisableAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Disables one or more alarms. The alarms change to the <code>DISABLED</code> state after
30
30
  * you disable them.</p>
31
31
  * @example
@@ -79,6 +79,7 @@ declare const BatchDisableAlarmCommand_base: {
79
79
  * @throws {@link IoTEventsDataServiceException}
80
80
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
81
81
  *
82
+ * @public
82
83
  */
83
84
  export declare class BatchDisableAlarmCommand extends BatchDisableAlarmCommand_base {
84
85
  }
@@ -22,10 +22,10 @@ export interface BatchEnableAlarmCommandOutput extends BatchEnableAlarmResponse,
22
22
  }
23
23
  declare const BatchEnableAlarmCommand_base: {
24
24
  new (input: BatchEnableAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchEnableAlarmCommandInput, BatchEnableAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: BatchEnableAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchEnableAlarmCommandInput, BatchEnableAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Enables one or more alarms. The alarms change to the <code>NORMAL</code> state after you
30
30
  * enable them.</p>
31
31
  * @example
@@ -79,6 +79,7 @@ declare const BatchEnableAlarmCommand_base: {
79
79
  * @throws {@link IoTEventsDataServiceException}
80
80
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
81
81
  *
82
+ * @public
82
83
  */
83
84
  export declare class BatchEnableAlarmCommand extends BatchEnableAlarmCommand_base {
84
85
  }
@@ -22,10 +22,10 @@ export interface BatchPutMessageCommandOutput extends BatchPutMessageResponse, _
22
22
  }
23
23
  declare const BatchPutMessageCommand_base: {
24
24
  new (input: BatchPutMessageCommandInput): import("@smithy/smithy-client").CommandImpl<BatchPutMessageCommandInput, BatchPutMessageCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: BatchPutMessageCommandInput): import("@smithy/smithy-client").CommandImpl<BatchPutMessageCommandInput, BatchPutMessageCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Sends a set of messages to the IoT Events system. Each message payload is transformed into
30
30
  * the input you specify (<code>"inputName"</code>) and ingested into any detectors that monitor
31
31
  * that input. If multiple messages are sent, the order in which the messages are processed isn't
@@ -84,6 +84,7 @@ declare const BatchPutMessageCommand_base: {
84
84
  * @throws {@link IoTEventsDataServiceException}
85
85
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
86
86
  *
87
+ * @public
87
88
  */
88
89
  export declare class BatchPutMessageCommand extends BatchPutMessageCommand_base {
89
90
  }
@@ -22,10 +22,10 @@ export interface BatchResetAlarmCommandOutput extends BatchResetAlarmResponse, _
22
22
  }
23
23
  declare const BatchResetAlarmCommand_base: {
24
24
  new (input: BatchResetAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchResetAlarmCommandInput, BatchResetAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: BatchResetAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchResetAlarmCommandInput, BatchResetAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Resets one or more alarms. The alarms return to the <code>NORMAL</code> state after you
30
30
  * reset them.</p>
31
31
  * @example
@@ -79,6 +79,7 @@ declare const BatchResetAlarmCommand_base: {
79
79
  * @throws {@link IoTEventsDataServiceException}
80
80
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
81
81
  *
82
+ * @public
82
83
  */
83
84
  export declare class BatchResetAlarmCommand extends BatchResetAlarmCommand_base {
84
85
  }
@@ -22,10 +22,10 @@ export interface BatchSnoozeAlarmCommandOutput extends BatchSnoozeAlarmResponse,
22
22
  }
23
23
  declare const BatchSnoozeAlarmCommand_base: {
24
24
  new (input: BatchSnoozeAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchSnoozeAlarmCommandInput, BatchSnoozeAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: BatchSnoozeAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<BatchSnoozeAlarmCommandInput, BatchSnoozeAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Changes one or more alarms to the snooze mode. The alarms change to the
30
30
  * <code>SNOOZE_DISABLED</code> state after you set them to the snooze mode.</p>
31
31
  * @example
@@ -80,6 +80,7 @@ declare const BatchSnoozeAlarmCommand_base: {
80
80
  * @throws {@link IoTEventsDataServiceException}
81
81
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
82
82
  *
83
+ * @public
83
84
  */
84
85
  export declare class BatchSnoozeAlarmCommand extends BatchSnoozeAlarmCommand_base {
85
86
  }
@@ -22,10 +22,10 @@ export interface BatchUpdateDetectorCommandOutput extends BatchUpdateDetectorRes
22
22
  }
23
23
  declare const BatchUpdateDetectorCommand_base: {
24
24
  new (input: BatchUpdateDetectorCommandInput): import("@smithy/smithy-client").CommandImpl<BatchUpdateDetectorCommandInput, BatchUpdateDetectorCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: BatchUpdateDetectorCommandInput): import("@smithy/smithy-client").CommandImpl<BatchUpdateDetectorCommandInput, BatchUpdateDetectorCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Updates the state, variable values, and timer settings of one or more detectors
30
30
  * (instances) of a specified detector model.</p>
31
31
  * @example
@@ -93,6 +93,7 @@ declare const BatchUpdateDetectorCommand_base: {
93
93
  * @throws {@link IoTEventsDataServiceException}
94
94
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
95
95
  *
96
+ * @public
96
97
  */
97
98
  export declare class BatchUpdateDetectorCommand extends BatchUpdateDetectorCommand_base {
98
99
  }
@@ -22,10 +22,10 @@ export interface DescribeAlarmCommandOutput extends DescribeAlarmResponse, __Met
22
22
  }
23
23
  declare const DescribeAlarmCommand_base: {
24
24
  new (input: DescribeAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeAlarmCommandInput, DescribeAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: DescribeAlarmCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeAlarmCommandInput, DescribeAlarmCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Retrieves information about an alarm.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -111,6 +111,7 @@ declare const DescribeAlarmCommand_base: {
111
111
  * @throws {@link IoTEventsDataServiceException}
112
112
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
113
113
  *
114
+ * @public
114
115
  */
115
116
  export declare class DescribeAlarmCommand extends DescribeAlarmCommand_base {
116
117
  }
@@ -22,10 +22,10 @@ export interface DescribeDetectorCommandOutput extends DescribeDetectorResponse,
22
22
  }
23
23
  declare const DescribeDetectorCommand_base: {
24
24
  new (input: DescribeDetectorCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeDetectorCommandInput, DescribeDetectorCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: DescribeDetectorCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeDetectorCommandInput, DescribeDetectorCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Returns information about the specified detector (instance).</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -90,6 +90,7 @@ declare const DescribeDetectorCommand_base: {
90
90
  * @throws {@link IoTEventsDataServiceException}
91
91
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
92
92
  *
93
+ * @public
93
94
  */
94
95
  export declare class DescribeDetectorCommand extends DescribeDetectorCommand_base {
95
96
  }
@@ -22,10 +22,10 @@ export interface ListAlarmsCommandOutput extends ListAlarmsResponse, __MetadataB
22
22
  }
23
23
  declare const ListAlarmsCommand_base: {
24
24
  new (input: ListAlarmsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAlarmsCommandInput, ListAlarmsCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: ListAlarmsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAlarmsCommandInput, ListAlarmsCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Lists one or more alarms. The operation returns only the metadata associated with each
30
30
  * alarm.</p>
31
31
  * @example
@@ -81,6 +81,7 @@ declare const ListAlarmsCommand_base: {
81
81
  * @throws {@link IoTEventsDataServiceException}
82
82
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
83
83
  *
84
+ * @public
84
85
  */
85
86
  export declare class ListAlarmsCommand extends ListAlarmsCommand_base {
86
87
  }
@@ -22,10 +22,10 @@ export interface ListDetectorsCommandOutput extends ListDetectorsResponse, __Met
22
22
  }
23
23
  declare const ListDetectorsCommand_base: {
24
24
  new (input: ListDetectorsCommandInput): import("@smithy/smithy-client").CommandImpl<ListDetectorsCommandInput, ListDetectorsCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: ListDetectorsCommandInput): import("@smithy/smithy-client").CommandImpl<ListDetectorsCommandInput, ListDetectorsCommandOutput, IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Lists detectors (the instances of a detector model).</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -83,6 +83,7 @@ declare const ListDetectorsCommand_base: {
83
83
  * @throws {@link IoTEventsDataServiceException}
84
84
  * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
85
85
  *
86
+ * @public
86
87
  */
87
88
  export declare class ListDetectorsCommand extends ListDetectorsCommand_base {
88
89
  }