@aws-sdk/client-iot-events-data 3.296.0 → 3.297.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.
@@ -13,6 +13,7 @@ import { ListAlarmsCommandInput, ListAlarmsCommandOutput } from "./commands/List
13
13
  import { ListDetectorsCommandInput, ListDetectorsCommandOutput } from "./commands/ListDetectorsCommand";
14
14
  import { IoTEventsDataClient } from "./IoTEventsDataClient";
15
15
  /**
16
+ * @public
16
17
  * <p>IoT Events monitors your equipment or device fleets for failures or changes in operation, and
17
18
  * triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to
18
19
  * detectors, list detectors, and view or update a detector's status.</p>
@@ -21,6 +22,7 @@ import { IoTEventsDataClient } from "./IoTEventsDataClient";
21
22
  */
22
23
  export declare class IoTEventsData extends IoTEventsDataClient {
23
24
  /**
25
+ * @public
24
26
  * <p>Acknowledges one or more alarms. The alarms change to the <code>ACKNOWLEDGED</code> state
25
27
  * after you acknowledge them.</p>
26
28
  */
@@ -28,12 +30,14 @@ export declare class IoTEventsData extends IoTEventsDataClient {
28
30
  batchAcknowledgeAlarm(args: BatchAcknowledgeAlarmCommandInput, cb: (err: any, data?: BatchAcknowledgeAlarmCommandOutput) => void): void;
29
31
  batchAcknowledgeAlarm(args: BatchAcknowledgeAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAcknowledgeAlarmCommandOutput) => void): void;
30
32
  /**
33
+ * @public
31
34
  * <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>
32
35
  */
33
36
  batchDeleteDetector(args: BatchDeleteDetectorCommandInput, options?: __HttpHandlerOptions): Promise<BatchDeleteDetectorCommandOutput>;
34
37
  batchDeleteDetector(args: BatchDeleteDetectorCommandInput, cb: (err: any, data?: BatchDeleteDetectorCommandOutput) => void): void;
35
38
  batchDeleteDetector(args: BatchDeleteDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDetectorCommandOutput) => void): void;
36
39
  /**
40
+ * @public
37
41
  * <p>Disables one or more alarms. The alarms change to the <code>DISABLED</code> state after
38
42
  * you disable them.</p>
39
43
  */
@@ -41,6 +45,7 @@ export declare class IoTEventsData extends IoTEventsDataClient {
41
45
  batchDisableAlarm(args: BatchDisableAlarmCommandInput, cb: (err: any, data?: BatchDisableAlarmCommandOutput) => void): void;
42
46
  batchDisableAlarm(args: BatchDisableAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisableAlarmCommandOutput) => void): void;
43
47
  /**
48
+ * @public
44
49
  * <p>Enables one or more alarms. The alarms change to the <code>NORMAL</code> state after you
45
50
  * enable them.</p>
46
51
  */
@@ -48,6 +53,7 @@ export declare class IoTEventsData extends IoTEventsDataClient {
48
53
  batchEnableAlarm(args: BatchEnableAlarmCommandInput, cb: (err: any, data?: BatchEnableAlarmCommandOutput) => void): void;
49
54
  batchEnableAlarm(args: BatchEnableAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchEnableAlarmCommandOutput) => void): void;
50
55
  /**
56
+ * @public
51
57
  * <p>Sends a set of messages to the IoT Events system. Each message payload is transformed into
52
58
  * the input you specify (<code>"inputName"</code>) and ingested into any detectors that monitor
53
59
  * that input. If multiple messages are sent, the order in which the messages are processed isn't
@@ -58,6 +64,7 @@ export declare class IoTEventsData extends IoTEventsDataClient {
58
64
  batchPutMessage(args: BatchPutMessageCommandInput, cb: (err: any, data?: BatchPutMessageCommandOutput) => void): void;
59
65
  batchPutMessage(args: BatchPutMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutMessageCommandOutput) => void): void;
60
66
  /**
67
+ * @public
61
68
  * <p>Resets one or more alarms. The alarms return to the <code>NORMAL</code> state after you
62
69
  * reset them.</p>
63
70
  */
@@ -65,6 +72,7 @@ export declare class IoTEventsData extends IoTEventsDataClient {
65
72
  batchResetAlarm(args: BatchResetAlarmCommandInput, cb: (err: any, data?: BatchResetAlarmCommandOutput) => void): void;
66
73
  batchResetAlarm(args: BatchResetAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchResetAlarmCommandOutput) => void): void;
67
74
  /**
75
+ * @public
68
76
  * <p>Changes one or more alarms to the snooze mode. The alarms change to the
69
77
  * <code>SNOOZE_DISABLED</code> state after you set them to the snooze mode.</p>
70
78
  */
@@ -72,6 +80,7 @@ export declare class IoTEventsData extends IoTEventsDataClient {
72
80
  batchSnoozeAlarm(args: BatchSnoozeAlarmCommandInput, cb: (err: any, data?: BatchSnoozeAlarmCommandOutput) => void): void;
73
81
  batchSnoozeAlarm(args: BatchSnoozeAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchSnoozeAlarmCommandOutput) => void): void;
74
82
  /**
83
+ * @public
75
84
  * <p>Updates the state, variable values, and timer settings of one or more detectors
76
85
  * (instances) of a specified detector model.</p>
77
86
  */
@@ -79,18 +88,21 @@ export declare class IoTEventsData extends IoTEventsDataClient {
79
88
  batchUpdateDetector(args: BatchUpdateDetectorCommandInput, cb: (err: any, data?: BatchUpdateDetectorCommandOutput) => void): void;
80
89
  batchUpdateDetector(args: BatchUpdateDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateDetectorCommandOutput) => void): void;
81
90
  /**
91
+ * @public
82
92
  * <p>Retrieves information about an alarm.</p>
83
93
  */
84
94
  describeAlarm(args: DescribeAlarmCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAlarmCommandOutput>;
85
95
  describeAlarm(args: DescribeAlarmCommandInput, cb: (err: any, data?: DescribeAlarmCommandOutput) => void): void;
86
96
  describeAlarm(args: DescribeAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlarmCommandOutput) => void): void;
87
97
  /**
98
+ * @public
88
99
  * <p>Returns information about the specified detector (instance).</p>
89
100
  */
90
101
  describeDetector(args: DescribeDetectorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDetectorCommandOutput>;
91
102
  describeDetector(args: DescribeDetectorCommandInput, cb: (err: any, data?: DescribeDetectorCommandOutput) => void): void;
92
103
  describeDetector(args: DescribeDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDetectorCommandOutput) => void): void;
93
104
  /**
105
+ * @public
94
106
  * <p>Lists one or more alarms. The operation returns only the metadata associated with each
95
107
  * alarm.</p>
96
108
  */
@@ -98,6 +110,7 @@ export declare class IoTEventsData extends IoTEventsDataClient {
98
110
  listAlarms(args: ListAlarmsCommandInput, cb: (err: any, data?: ListAlarmsCommandOutput) => void): void;
99
111
  listAlarms(args: ListAlarmsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlarmsCommandOutput) => void): void;
100
112
  /**
113
+ * @public
101
114
  * <p>Lists detectors (the instances of a detector model).</p>
102
115
  */
103
116
  listDetectors(args: ListDetectorsCommandInput, options?: __HttpHandlerOptions): Promise<ListDetectorsCommandOutput>;
@@ -20,15 +20,24 @@ import { DescribeDetectorCommandInput, DescribeDetectorCommandOutput } from "./c
20
20
  import { ListAlarmsCommandInput, ListAlarmsCommandOutput } from "./commands/ListAlarmsCommand";
21
21
  import { ListDetectorsCommandInput, ListDetectorsCommandOutput } from "./commands/ListDetectorsCommand";
22
22
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
23
+ /**
24
+ * @public
25
+ */
23
26
  export type ServiceInputTypes = BatchAcknowledgeAlarmCommandInput | BatchDeleteDetectorCommandInput | BatchDisableAlarmCommandInput | BatchEnableAlarmCommandInput | BatchPutMessageCommandInput | BatchResetAlarmCommandInput | BatchSnoozeAlarmCommandInput | BatchUpdateDetectorCommandInput | DescribeAlarmCommandInput | DescribeDetectorCommandInput | ListAlarmsCommandInput | ListDetectorsCommandInput;
27
+ /**
28
+ * @public
29
+ */
24
30
  export type ServiceOutputTypes = BatchAcknowledgeAlarmCommandOutput | BatchDeleteDetectorCommandOutput | BatchDisableAlarmCommandOutput | BatchEnableAlarmCommandOutput | BatchPutMessageCommandOutput | BatchResetAlarmCommandOutput | BatchSnoozeAlarmCommandOutput | BatchUpdateDetectorCommandOutput | DescribeAlarmCommandOutput | DescribeDetectorCommandOutput | ListAlarmsCommandOutput | ListDetectorsCommandOutput;
31
+ /**
32
+ * @public
33
+ */
25
34
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
26
35
  /**
27
36
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
28
37
  */
29
38
  requestHandler?: __HttpHandler;
30
39
  /**
31
- * A constructor for a class implementing the {@link __Checksum} interface
40
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
32
41
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
33
42
  * @internal
34
43
  */
@@ -118,23 +127,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
118
127
  */
119
128
  logger?: __Logger;
120
129
  /**
121
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
130
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
122
131
  */
123
132
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
124
133
  }
134
+ /**
135
+ * @public
136
+ */
125
137
  type IoTEventsDataClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
126
138
  /**
127
- * The configuration interface of IoTEventsDataClient class constructor that set the region, credentials and other options.
139
+ * @public
140
+ *
141
+ * The configuration interface of IoTEventsDataClient class constructor that set the region, credentials and other options.
128
142
  */
129
143
  export interface IoTEventsDataClientConfig extends IoTEventsDataClientConfigType {
130
144
  }
145
+ /**
146
+ * @public
147
+ */
131
148
  type IoTEventsDataClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
132
149
  /**
133
- * The resolved configuration interface of IoTEventsDataClient class. This is resolved and normalized from the {@link IoTEventsDataClientConfig | constructor configuration interface}.
150
+ * @public
151
+ *
152
+ * The resolved configuration interface of IoTEventsDataClient class. This is resolved and normalized from the {@link IoTEventsDataClientConfig | constructor configuration interface}.
134
153
  */
135
154
  export interface IoTEventsDataClientResolvedConfig extends IoTEventsDataClientResolvedConfigType {
136
155
  }
137
156
  /**
157
+ * @public
138
158
  * <p>IoT Events monitors your equipment or device fleets for failures or changes in operation, and
139
159
  * triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to
140
160
  * detectors, list detectors, and view or update a detector's status.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient";
5
5
  import { BatchAcknowledgeAlarmRequest, BatchAcknowledgeAlarmResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchAcknowledgeAlarmCommand}.
8
10
  */
9
11
  export interface BatchAcknowledgeAlarmCommandInput extends BatchAcknowledgeAlarmRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchAcknowledgeAlarmCommand}.
13
17
  */
14
18
  export interface BatchAcknowledgeAlarmCommandOutput extends BatchAcknowledgeAlarmResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Acknowledges one or more alarms. The alarms change to the <code>ACKNOWLEDGED</code> state
18
23
  * after you acknowledge them.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface BatchAcknowledgeAlarmCommandOutput extends BatchAcknowledgeAlar
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param BatchAcknowledgeAlarmCommandInput - {@link BatchAcknowledgeAlarmCommandInput}
35
+ * @returns {@link BatchAcknowledgeAlarmCommandOutput}
29
36
  * @see {@link BatchAcknowledgeAlarmCommandInput} for command's `input` shape.
30
37
  * @see {@link BatchAcknowledgeAlarmCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape.
@@ -47,11 +54,20 @@ export interface BatchAcknowledgeAlarmCommandOutput extends BatchAcknowledgeAlar
47
54
  export declare class BatchAcknowledgeAlarmCommand extends $Command<BatchAcknowledgeAlarmCommandInput, BatchAcknowledgeAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
48
55
  readonly input: BatchAcknowledgeAlarmCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: BatchAcknowledgeAlarmCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchAcknowledgeAlarmCommandInput, BatchAcknowledgeAlarmCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient";
5
5
  import { BatchDeleteDetectorRequest, BatchDeleteDetectorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchDeleteDetectorCommand}.
8
10
  */
9
11
  export interface BatchDeleteDetectorCommandInput extends BatchDeleteDetectorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchDeleteDetectorCommand}.
13
17
  */
14
18
  export interface BatchDeleteDetectorCommandOutput extends BatchDeleteDetectorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BatchDeleteDetectorCommandOutput extends BatchDeleteDetectorRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param BatchDeleteDetectorCommandInput - {@link BatchDeleteDetectorCommandInput}
34
+ * @returns {@link BatchDeleteDetectorCommandOutput}
28
35
  * @see {@link BatchDeleteDetectorCommandInput} for command's `input` shape.
29
36
  * @see {@link BatchDeleteDetectorCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape.
@@ -46,11 +53,20 @@ export interface BatchDeleteDetectorCommandOutput extends BatchDeleteDetectorRes
46
53
  export declare class BatchDeleteDetectorCommand extends $Command<BatchDeleteDetectorCommandInput, BatchDeleteDetectorCommandOutput, IoTEventsDataClientResolvedConfig> {
47
54
  readonly input: BatchDeleteDetectorCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: BatchDeleteDetectorCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteDetectorCommandInput, BatchDeleteDetectorCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient";
5
5
  import { BatchDisableAlarmRequest, BatchDisableAlarmResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchDisableAlarmCommand}.
8
10
  */
9
11
  export interface BatchDisableAlarmCommandInput extends BatchDisableAlarmRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchDisableAlarmCommand}.
13
17
  */
14
18
  export interface BatchDisableAlarmCommandOutput extends BatchDisableAlarmResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disables one or more alarms. The alarms change to the <code>DISABLED</code> state after
18
23
  * you disable them.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface BatchDisableAlarmCommandOutput extends BatchDisableAlarmRespons
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param BatchDisableAlarmCommandInput - {@link BatchDisableAlarmCommandInput}
35
+ * @returns {@link BatchDisableAlarmCommandOutput}
29
36
  * @see {@link BatchDisableAlarmCommandInput} for command's `input` shape.
30
37
  * @see {@link BatchDisableAlarmCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape.
@@ -47,11 +54,20 @@ export interface BatchDisableAlarmCommandOutput extends BatchDisableAlarmRespons
47
54
  export declare class BatchDisableAlarmCommand extends $Command<BatchDisableAlarmCommandInput, BatchDisableAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
48
55
  readonly input: BatchDisableAlarmCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: BatchDisableAlarmCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDisableAlarmCommandInput, BatchDisableAlarmCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient";
5
5
  import { BatchEnableAlarmRequest, BatchEnableAlarmResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchEnableAlarmCommand}.
8
10
  */
9
11
  export interface BatchEnableAlarmCommandInput extends BatchEnableAlarmRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchEnableAlarmCommand}.
13
17
  */
14
18
  export interface BatchEnableAlarmCommandOutput extends BatchEnableAlarmResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enables one or more alarms. The alarms change to the <code>NORMAL</code> state after you
18
23
  * enable them.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface BatchEnableAlarmCommandOutput extends BatchEnableAlarmResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param BatchEnableAlarmCommandInput - {@link BatchEnableAlarmCommandInput}
35
+ * @returns {@link BatchEnableAlarmCommandOutput}
29
36
  * @see {@link BatchEnableAlarmCommandInput} for command's `input` shape.
30
37
  * @see {@link BatchEnableAlarmCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape.
@@ -47,11 +54,20 @@ export interface BatchEnableAlarmCommandOutput extends BatchEnableAlarmResponse,
47
54
  export declare class BatchEnableAlarmCommand extends $Command<BatchEnableAlarmCommandInput, BatchEnableAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
48
55
  readonly input: BatchEnableAlarmCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: BatchEnableAlarmCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchEnableAlarmCommandInput, BatchEnableAlarmCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient";
5
5
  import { BatchPutMessageRequest, BatchPutMessageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchPutMessageCommand}.
8
10
  */
9
11
  export interface BatchPutMessageCommandInput extends BatchPutMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchPutMessageCommand}.
13
17
  */
14
18
  export interface BatchPutMessageCommandOutput extends BatchPutMessageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sends a set of messages to the IoT Events system. Each message payload is transformed into
18
23
  * the input you specify (<code>"inputName"</code>) and ingested into any detectors that monitor
19
24
  * that input. If multiple messages are sent, the order in which the messages are processed isn't
@@ -29,6 +34,8 @@ export interface BatchPutMessageCommandOutput extends BatchPutMessageResponse, _
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param BatchPutMessageCommandInput - {@link BatchPutMessageCommandInput}
38
+ * @returns {@link BatchPutMessageCommandOutput}
32
39
  * @see {@link BatchPutMessageCommandInput} for command's `input` shape.
33
40
  * @see {@link BatchPutMessageCommandOutput} for command's `response` shape.
34
41
  * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape.
@@ -50,11 +57,20 @@ export interface BatchPutMessageCommandOutput extends BatchPutMessageResponse, _
50
57
  export declare class BatchPutMessageCommand extends $Command<BatchPutMessageCommandInput, BatchPutMessageCommandOutput, IoTEventsDataClientResolvedConfig> {
51
58
  readonly input: BatchPutMessageCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: BatchPutMessageCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchPutMessageCommandInput, BatchPutMessageCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient";
5
5
  import { BatchResetAlarmRequest, BatchResetAlarmResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchResetAlarmCommand}.
8
10
  */
9
11
  export interface BatchResetAlarmCommandInput extends BatchResetAlarmRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchResetAlarmCommand}.
13
17
  */
14
18
  export interface BatchResetAlarmCommandOutput extends BatchResetAlarmResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Resets one or more alarms. The alarms return to the <code>NORMAL</code> state after you
18
23
  * reset them.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface BatchResetAlarmCommandOutput extends BatchResetAlarmResponse, _
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param BatchResetAlarmCommandInput - {@link BatchResetAlarmCommandInput}
35
+ * @returns {@link BatchResetAlarmCommandOutput}
29
36
  * @see {@link BatchResetAlarmCommandInput} for command's `input` shape.
30
37
  * @see {@link BatchResetAlarmCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape.
@@ -47,11 +54,20 @@ export interface BatchResetAlarmCommandOutput extends BatchResetAlarmResponse, _
47
54
  export declare class BatchResetAlarmCommand extends $Command<BatchResetAlarmCommandInput, BatchResetAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
48
55
  readonly input: BatchResetAlarmCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: BatchResetAlarmCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchResetAlarmCommandInput, BatchResetAlarmCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient";
5
5
  import { BatchSnoozeAlarmRequest, BatchSnoozeAlarmResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchSnoozeAlarmCommand}.
8
10
  */
9
11
  export interface BatchSnoozeAlarmCommandInput extends BatchSnoozeAlarmRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchSnoozeAlarmCommand}.
13
17
  */
14
18
  export interface BatchSnoozeAlarmCommandOutput extends BatchSnoozeAlarmResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes one or more alarms to the snooze mode. The alarms change to the
18
23
  * <code>SNOOZE_DISABLED</code> state after you set them to the snooze mode.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface BatchSnoozeAlarmCommandOutput extends BatchSnoozeAlarmResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param BatchSnoozeAlarmCommandInput - {@link BatchSnoozeAlarmCommandInput}
35
+ * @returns {@link BatchSnoozeAlarmCommandOutput}
29
36
  * @see {@link BatchSnoozeAlarmCommandInput} for command's `input` shape.
30
37
  * @see {@link BatchSnoozeAlarmCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape.
@@ -47,11 +54,20 @@ export interface BatchSnoozeAlarmCommandOutput extends BatchSnoozeAlarmResponse,
47
54
  export declare class BatchSnoozeAlarmCommand extends $Command<BatchSnoozeAlarmCommandInput, BatchSnoozeAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
48
55
  readonly input: BatchSnoozeAlarmCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: BatchSnoozeAlarmCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchSnoozeAlarmCommandInput, BatchSnoozeAlarmCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient";
5
5
  import { BatchUpdateDetectorRequest, BatchUpdateDetectorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchUpdateDetectorCommand}.
8
10
  */
9
11
  export interface BatchUpdateDetectorCommandInput extends BatchUpdateDetectorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchUpdateDetectorCommand}.
13
17
  */
14
18
  export interface BatchUpdateDetectorCommandOutput extends BatchUpdateDetectorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the state, variable values, and timer settings of one or more detectors
18
23
  * (instances) of a specified detector model.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface BatchUpdateDetectorCommandOutput extends BatchUpdateDetectorRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param BatchUpdateDetectorCommandInput - {@link BatchUpdateDetectorCommandInput}
35
+ * @returns {@link BatchUpdateDetectorCommandOutput}
29
36
  * @see {@link BatchUpdateDetectorCommandInput} for command's `input` shape.
30
37
  * @see {@link BatchUpdateDetectorCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape.
@@ -47,11 +54,20 @@ export interface BatchUpdateDetectorCommandOutput extends BatchUpdateDetectorRes
47
54
  export declare class BatchUpdateDetectorCommand extends $Command<BatchUpdateDetectorCommandInput, BatchUpdateDetectorCommandOutput, IoTEventsDataClientResolvedConfig> {
48
55
  readonly input: BatchUpdateDetectorCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: BatchUpdateDetectorCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchUpdateDetectorCommandInput, BatchUpdateDetectorCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsDataClient";
5
5
  import { DescribeAlarmRequest, DescribeAlarmResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAlarmCommand}.
8
10
  */
9
11
  export interface DescribeAlarmCommandInput extends DescribeAlarmRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAlarmCommand}.
13
17
  */
14
18
  export interface DescribeAlarmCommandOutput extends DescribeAlarmResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about an alarm.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAlarmCommandOutput extends DescribeAlarmResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAlarmCommandInput - {@link DescribeAlarmCommandInput}
34
+ * @returns {@link DescribeAlarmCommandOutput}
28
35
  * @see {@link DescribeAlarmCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAlarmCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTEventsDataClientResolvedConfig | config} for IoTEventsDataClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DescribeAlarmCommandOutput extends DescribeAlarmResponse, __Met
49
56
  export declare class DescribeAlarmCommand extends $Command<DescribeAlarmCommandInput, DescribeAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
50
57
  readonly input: DescribeAlarmCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DescribeAlarmCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAlarmCommandInput, DescribeAlarmCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }