@aws-sdk/client-iot-events 3.295.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.
Files changed (31) hide show
  1. package/dist-types/IoTEvents.d.ts +27 -0
  2. package/dist-types/IoTEventsClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAlarmModelCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateDetectorModelCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateInputCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteAlarmModelCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteDetectorModelCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteInputCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeAlarmModelCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeDetectorModelAnalysisCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeDetectorModelCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeInputCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +16 -0
  14. package/dist-types/commands/GetDetectorModelAnalysisResultsCommand.d.ts +16 -0
  15. package/dist-types/commands/ListAlarmModelVersionsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListAlarmModelsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListDetectorModelVersionsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListDetectorModelsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListInputRoutingsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListInputsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  22. package/dist-types/commands/PutLoggingOptionsCommand.d.ts +16 -0
  23. package/dist-types/commands/StartDetectorModelAnalysisCommand.d.ts +16 -0
  24. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  25. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateAlarmModelCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateDetectorModelCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateInputCommand.d.ts +16 -0
  29. package/dist-types/models/IoTEventsServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +272 -21
  31. package/package.json +29 -29
@@ -27,12 +27,14 @@ import { UpdateDetectorModelCommandInput, UpdateDetectorModelCommandOutput } fro
27
27
  import { UpdateInputCommandInput, UpdateInputCommandOutput } from "./commands/UpdateInputCommand";
28
28
  import { IoTEventsClient } from "./IoTEventsClient";
29
29
  /**
30
+ * @public
30
31
  * <p>AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and
31
32
  * triggers actions when such events occur. You can use AWS IoT Events API operations to create, read,
32
33
  * update, and delete inputs and detector models, and to list their versions.</p>
33
34
  */
34
35
  export declare class IoTEvents extends IoTEventsClient {
35
36
  /**
37
+ * @public
36
38
  * <p>Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get
37
39
  * notified when the value is outside a specified range. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html">Create an
38
40
  * alarm model</a> in the <i>AWS IoT Events Developer Guide</i>.</p>
@@ -41,18 +43,21 @@ export declare class IoTEvents extends IoTEventsClient {
41
43
  createAlarmModel(args: CreateAlarmModelCommandInput, cb: (err: any, data?: CreateAlarmModelCommandOutput) => void): void;
42
44
  createAlarmModel(args: CreateAlarmModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAlarmModelCommandOutput) => void): void;
43
45
  /**
46
+ * @public
44
47
  * <p>Creates a detector model.</p>
45
48
  */
46
49
  createDetectorModel(args: CreateDetectorModelCommandInput, options?: __HttpHandlerOptions): Promise<CreateDetectorModelCommandOutput>;
47
50
  createDetectorModel(args: CreateDetectorModelCommandInput, cb: (err: any, data?: CreateDetectorModelCommandOutput) => void): void;
48
51
  createDetectorModel(args: CreateDetectorModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDetectorModelCommandOutput) => void): void;
49
52
  /**
53
+ * @public
50
54
  * <p>Creates an input.</p>
51
55
  */
52
56
  createInput(args: CreateInputCommandInput, options?: __HttpHandlerOptions): Promise<CreateInputCommandOutput>;
53
57
  createInput(args: CreateInputCommandInput, cb: (err: any, data?: CreateInputCommandOutput) => void): void;
54
58
  createInput(args: CreateInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInputCommandOutput) => void): void;
55
59
  /**
60
+ * @public
56
61
  * <p>Deletes an alarm model. Any alarm instances that were created based on this alarm model
57
62
  * are also deleted. This action can't be undone.</p>
58
63
  */
@@ -60,6 +65,7 @@ export declare class IoTEvents extends IoTEventsClient {
60
65
  deleteAlarmModel(args: DeleteAlarmModelCommandInput, cb: (err: any, data?: DeleteAlarmModelCommandOutput) => void): void;
61
66
  deleteAlarmModel(args: DeleteAlarmModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAlarmModelCommandOutput) => void): void;
62
67
  /**
68
+ * @public
63
69
  * <p>Deletes a detector model. Any active instances of the detector model are also
64
70
  * deleted.</p>
65
71
  */
@@ -67,12 +73,14 @@ export declare class IoTEvents extends IoTEventsClient {
67
73
  deleteDetectorModel(args: DeleteDetectorModelCommandInput, cb: (err: any, data?: DeleteDetectorModelCommandOutput) => void): void;
68
74
  deleteDetectorModel(args: DeleteDetectorModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDetectorModelCommandOutput) => void): void;
69
75
  /**
76
+ * @public
70
77
  * <p>Deletes an input.</p>
71
78
  */
72
79
  deleteInput(args: DeleteInputCommandInput, options?: __HttpHandlerOptions): Promise<DeleteInputCommandOutput>;
73
80
  deleteInput(args: DeleteInputCommandInput, cb: (err: any, data?: DeleteInputCommandOutput) => void): void;
74
81
  deleteInput(args: DeleteInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInputCommandOutput) => void): void;
75
82
  /**
83
+ * @public
76
84
  * <p>Retrieves information about an alarm model. If you don't specify a value for the
77
85
  * <code>alarmModelVersion</code> parameter, the latest version is returned.</p>
78
86
  */
@@ -80,6 +88,7 @@ export declare class IoTEvents extends IoTEventsClient {
80
88
  describeAlarmModel(args: DescribeAlarmModelCommandInput, cb: (err: any, data?: DescribeAlarmModelCommandOutput) => void): void;
81
89
  describeAlarmModel(args: DescribeAlarmModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlarmModelCommandOutput) => void): void;
82
90
  /**
91
+ * @public
83
92
  * <p>Describes a detector model. If the <code>version</code> parameter is not specified,
84
93
  * information about the latest version is returned.</p>
85
94
  */
@@ -87,6 +96,7 @@ export declare class IoTEvents extends IoTEventsClient {
87
96
  describeDetectorModel(args: DescribeDetectorModelCommandInput, cb: (err: any, data?: DescribeDetectorModelCommandOutput) => void): void;
88
97
  describeDetectorModel(args: DescribeDetectorModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDetectorModelCommandOutput) => void): void;
89
98
  /**
99
+ * @public
90
100
  * <p>Retrieves runtime information about a detector model analysis.</p>
91
101
  * <note>
92
102
  * <p>After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.</p>
@@ -96,18 +106,21 @@ export declare class IoTEvents extends IoTEventsClient {
96
106
  describeDetectorModelAnalysis(args: DescribeDetectorModelAnalysisCommandInput, cb: (err: any, data?: DescribeDetectorModelAnalysisCommandOutput) => void): void;
97
107
  describeDetectorModelAnalysis(args: DescribeDetectorModelAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDetectorModelAnalysisCommandOutput) => void): void;
98
108
  /**
109
+ * @public
99
110
  * <p>Describes an input.</p>
100
111
  */
101
112
  describeInput(args: DescribeInputCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInputCommandOutput>;
102
113
  describeInput(args: DescribeInputCommandInput, cb: (err: any, data?: DescribeInputCommandOutput) => void): void;
103
114
  describeInput(args: DescribeInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInputCommandOutput) => void): void;
104
115
  /**
116
+ * @public
105
117
  * <p>Retrieves the current settings of the AWS IoT Events logging options.</p>
106
118
  */
107
119
  describeLoggingOptions(args: DescribeLoggingOptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLoggingOptionsCommandOutput>;
108
120
  describeLoggingOptions(args: DescribeLoggingOptionsCommandInput, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void): void;
109
121
  describeLoggingOptions(args: DescribeLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void): void;
110
122
  /**
123
+ * @public
111
124
  * <p>Retrieves one or more analysis results of the detector model.</p>
112
125
  * <note>
113
126
  * <p>After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.</p>
@@ -117,6 +130,7 @@ export declare class IoTEvents extends IoTEventsClient {
117
130
  getDetectorModelAnalysisResults(args: GetDetectorModelAnalysisResultsCommandInput, cb: (err: any, data?: GetDetectorModelAnalysisResultsCommandOutput) => void): void;
118
131
  getDetectorModelAnalysisResults(args: GetDetectorModelAnalysisResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDetectorModelAnalysisResultsCommandOutput) => void): void;
119
132
  /**
133
+ * @public
120
134
  * <p>Lists the alarm models that you created. The operation returns only the metadata
121
135
  * associated with each alarm model.</p>
122
136
  */
@@ -124,6 +138,7 @@ export declare class IoTEvents extends IoTEventsClient {
124
138
  listAlarmModels(args: ListAlarmModelsCommandInput, cb: (err: any, data?: ListAlarmModelsCommandOutput) => void): void;
125
139
  listAlarmModels(args: ListAlarmModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlarmModelsCommandOutput) => void): void;
126
140
  /**
141
+ * @public
127
142
  * <p>Lists all the versions of an alarm model. The operation returns only the metadata
128
143
  * associated with each alarm model version.</p>
129
144
  */
@@ -131,6 +146,7 @@ export declare class IoTEvents extends IoTEventsClient {
131
146
  listAlarmModelVersions(args: ListAlarmModelVersionsCommandInput, cb: (err: any, data?: ListAlarmModelVersionsCommandOutput) => void): void;
132
147
  listAlarmModelVersions(args: ListAlarmModelVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlarmModelVersionsCommandOutput) => void): void;
133
148
  /**
149
+ * @public
134
150
  * <p>Lists the detector models you have created. Only the metadata associated with each
135
151
  * detector model is returned.</p>
136
152
  */
@@ -138,6 +154,7 @@ export declare class IoTEvents extends IoTEventsClient {
138
154
  listDetectorModels(args: ListDetectorModelsCommandInput, cb: (err: any, data?: ListDetectorModelsCommandOutput) => void): void;
139
155
  listDetectorModels(args: ListDetectorModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDetectorModelsCommandOutput) => void): void;
140
156
  /**
157
+ * @public
141
158
  * <p>Lists all the versions of a detector model. Only the metadata associated with each
142
159
  * detector model version is returned.</p>
143
160
  */
@@ -145,6 +162,7 @@ export declare class IoTEvents extends IoTEventsClient {
145
162
  listDetectorModelVersions(args: ListDetectorModelVersionsCommandInput, cb: (err: any, data?: ListDetectorModelVersionsCommandOutput) => void): void;
146
163
  listDetectorModelVersions(args: ListDetectorModelVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDetectorModelVersionsCommandOutput) => void): void;
147
164
  /**
165
+ * @public
148
166
  * <p>
149
167
  * Lists one or more input routings.
150
168
  * </p>
@@ -153,18 +171,21 @@ export declare class IoTEvents extends IoTEventsClient {
153
171
  listInputRoutings(args: ListInputRoutingsCommandInput, cb: (err: any, data?: ListInputRoutingsCommandOutput) => void): void;
154
172
  listInputRoutings(args: ListInputRoutingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInputRoutingsCommandOutput) => void): void;
155
173
  /**
174
+ * @public
156
175
  * <p>Lists the inputs you have created.</p>
157
176
  */
158
177
  listInputs(args: ListInputsCommandInput, options?: __HttpHandlerOptions): Promise<ListInputsCommandOutput>;
159
178
  listInputs(args: ListInputsCommandInput, cb: (err: any, data?: ListInputsCommandOutput) => void): void;
160
179
  listInputs(args: ListInputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInputsCommandOutput) => void): void;
161
180
  /**
181
+ * @public
162
182
  * <p>Lists the tags (metadata) you have assigned to the resource.</p>
163
183
  */
164
184
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
165
185
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
166
186
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
167
187
  /**
188
+ * @public
168
189
  * <p>Sets or updates the AWS IoT Events logging options.</p>
169
190
  * <p>If you update the value of any <code>loggingOptions</code> field, it takes up to one
170
191
  * minute for the change to take effect. If you change the policy attached to the role you
@@ -175,6 +196,7 @@ export declare class IoTEvents extends IoTEventsClient {
175
196
  putLoggingOptions(args: PutLoggingOptionsCommandInput, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void): void;
176
197
  putLoggingOptions(args: PutLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void): void;
177
198
  /**
199
+ * @public
178
200
  * <p>Performs an analysis of your detector model. For more information,
179
201
  * see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html">Troubleshooting a detector model</a>
180
202
  * in the <i>AWS IoT Events Developer Guide</i>.</p>
@@ -183,6 +205,7 @@ export declare class IoTEvents extends IoTEventsClient {
183
205
  startDetectorModelAnalysis(args: StartDetectorModelAnalysisCommandInput, cb: (err: any, data?: StartDetectorModelAnalysisCommandOutput) => void): void;
184
206
  startDetectorModelAnalysis(args: StartDetectorModelAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDetectorModelAnalysisCommandOutput) => void): void;
185
207
  /**
208
+ * @public
186
209
  * <p>Adds to or modifies the tags of the given resource. Tags are metadata that can be used to
187
210
  * manage a resource.</p>
188
211
  */
@@ -190,12 +213,14 @@ export declare class IoTEvents extends IoTEventsClient {
190
213
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
191
214
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
192
215
  /**
216
+ * @public
193
217
  * <p>Removes the given tags (metadata) from the resource.</p>
194
218
  */
195
219
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
196
220
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
197
221
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
198
222
  /**
223
+ * @public
199
224
  * <p>Updates an alarm model. Any alarms that were created based on the previous version are
200
225
  * deleted and then created again as new data arrives.</p>
201
226
  */
@@ -203,6 +228,7 @@ export declare class IoTEvents extends IoTEventsClient {
203
228
  updateAlarmModel(args: UpdateAlarmModelCommandInput, cb: (err: any, data?: UpdateAlarmModelCommandOutput) => void): void;
204
229
  updateAlarmModel(args: UpdateAlarmModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAlarmModelCommandOutput) => void): void;
205
230
  /**
231
+ * @public
206
232
  * <p>Updates a detector model. Detectors (instances) spawned by the previous version are
207
233
  * deleted and then re-created as new inputs arrive.</p>
208
234
  */
@@ -210,6 +236,7 @@ export declare class IoTEvents extends IoTEventsClient {
210
236
  updateDetectorModel(args: UpdateDetectorModelCommandInput, cb: (err: any, data?: UpdateDetectorModelCommandOutput) => void): void;
211
237
  updateDetectorModel(args: UpdateDetectorModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDetectorModelCommandOutput) => void): void;
212
238
  /**
239
+ * @public
213
240
  * <p>Updates an input.</p>
214
241
  */
215
242
  updateInput(args: UpdateInputCommandInput, options?: __HttpHandlerOptions): Promise<UpdateInputCommandOutput>;
@@ -34,15 +34,24 @@ import { UpdateAlarmModelCommandInput, UpdateAlarmModelCommandOutput } from "./c
34
34
  import { UpdateDetectorModelCommandInput, UpdateDetectorModelCommandOutput } from "./commands/UpdateDetectorModelCommand";
35
35
  import { UpdateInputCommandInput, UpdateInputCommandOutput } from "./commands/UpdateInputCommand";
36
36
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
37
+ /**
38
+ * @public
39
+ */
37
40
  export type ServiceInputTypes = CreateAlarmModelCommandInput | CreateDetectorModelCommandInput | CreateInputCommandInput | DeleteAlarmModelCommandInput | DeleteDetectorModelCommandInput | DeleteInputCommandInput | DescribeAlarmModelCommandInput | DescribeDetectorModelAnalysisCommandInput | DescribeDetectorModelCommandInput | DescribeInputCommandInput | DescribeLoggingOptionsCommandInput | GetDetectorModelAnalysisResultsCommandInput | ListAlarmModelVersionsCommandInput | ListAlarmModelsCommandInput | ListDetectorModelVersionsCommandInput | ListDetectorModelsCommandInput | ListInputRoutingsCommandInput | ListInputsCommandInput | ListTagsForResourceCommandInput | PutLoggingOptionsCommandInput | StartDetectorModelAnalysisCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAlarmModelCommandInput | UpdateDetectorModelCommandInput | UpdateInputCommandInput;
41
+ /**
42
+ * @public
43
+ */
38
44
  export type ServiceOutputTypes = CreateAlarmModelCommandOutput | CreateDetectorModelCommandOutput | CreateInputCommandOutput | DeleteAlarmModelCommandOutput | DeleteDetectorModelCommandOutput | DeleteInputCommandOutput | DescribeAlarmModelCommandOutput | DescribeDetectorModelAnalysisCommandOutput | DescribeDetectorModelCommandOutput | DescribeInputCommandOutput | DescribeLoggingOptionsCommandOutput | GetDetectorModelAnalysisResultsCommandOutput | ListAlarmModelVersionsCommandOutput | ListAlarmModelsCommandOutput | ListDetectorModelVersionsCommandOutput | ListDetectorModelsCommandOutput | ListInputRoutingsCommandOutput | ListInputsCommandOutput | ListTagsForResourceCommandOutput | PutLoggingOptionsCommandOutput | StartDetectorModelAnalysisCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAlarmModelCommandOutput | UpdateDetectorModelCommandOutput | UpdateInputCommandOutput;
45
+ /**
46
+ * @public
47
+ */
39
48
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
40
49
  /**
41
50
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
42
51
  */
43
52
  requestHandler?: __HttpHandler;
44
53
  /**
45
- * A constructor for a class implementing the {@link __Checksum} interface
54
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
46
55
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
47
56
  * @internal
48
57
  */
@@ -132,23 +141,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
132
141
  */
133
142
  logger?: __Logger;
134
143
  /**
135
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
144
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
136
145
  */
137
146
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
138
147
  }
148
+ /**
149
+ * @public
150
+ */
139
151
  type IoTEventsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
140
152
  /**
141
- * The configuration interface of IoTEventsClient class constructor that set the region, credentials and other options.
153
+ * @public
154
+ *
155
+ * The configuration interface of IoTEventsClient class constructor that set the region, credentials and other options.
142
156
  */
143
157
  export interface IoTEventsClientConfig extends IoTEventsClientConfigType {
144
158
  }
159
+ /**
160
+ * @public
161
+ */
145
162
  type IoTEventsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
146
163
  /**
147
- * The resolved configuration interface of IoTEventsClient class. This is resolved and normalized from the {@link IoTEventsClientConfig | constructor configuration interface}.
164
+ * @public
165
+ *
166
+ * The resolved configuration interface of IoTEventsClient class. This is resolved and normalized from the {@link IoTEventsClientConfig | constructor configuration interface}.
148
167
  */
149
168
  export interface IoTEventsClientResolvedConfig extends IoTEventsClientResolvedConfigType {
150
169
  }
151
170
  /**
171
+ * @public
152
172
  * <p>AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and
153
173
  * triggers actions when such events occur. You can use AWS IoT Events API operations to create, read,
154
174
  * update, and delete inputs and detector models, and to list their versions.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
5
5
  import { CreateAlarmModelRequest, CreateAlarmModelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAlarmModelCommand}.
8
10
  */
9
11
  export interface CreateAlarmModelCommandInput extends CreateAlarmModelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAlarmModelCommand}.
13
17
  */
14
18
  export interface CreateAlarmModelCommandOutput extends CreateAlarmModelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get
18
23
  * notified when the value is outside a specified range. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html">Create an
19
24
  * alarm model</a> in the <i>AWS IoT Events Developer Guide</i>.</p>
@@ -27,6 +32,8 @@ export interface CreateAlarmModelCommandOutput extends CreateAlarmModelResponse,
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateAlarmModelCommandInput - {@link CreateAlarmModelCommandInput}
36
+ * @returns {@link CreateAlarmModelCommandOutput}
30
37
  * @see {@link CreateAlarmModelCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateAlarmModelCommandOutput} for command's `response` shape.
32
39
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateAlarmModelCommandOutput extends CreateAlarmModelResponse,
57
64
  export declare class CreateAlarmModelCommand extends $Command<CreateAlarmModelCommandInput, CreateAlarmModelCommandOutput, IoTEventsClientResolvedConfig> {
58
65
  readonly input: CreateAlarmModelCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateAlarmModelCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAlarmModelCommandInput, CreateAlarmModelCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
5
5
  import { CreateDetectorModelRequest, CreateDetectorModelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDetectorModelCommand}.
8
10
  */
9
11
  export interface CreateDetectorModelCommandInput extends CreateDetectorModelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDetectorModelCommand}.
13
17
  */
14
18
  export interface CreateDetectorModelCommandOutput extends CreateDetectorModelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a detector model.</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 CreateDetectorModelCommandOutput extends CreateDetectorModelRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateDetectorModelCommandInput - {@link CreateDetectorModelCommandInput}
34
+ * @returns {@link CreateDetectorModelCommandOutput}
28
35
  * @see {@link CreateDetectorModelCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateDetectorModelCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateDetectorModelCommandOutput extends CreateDetectorModelRes
55
62
  export declare class CreateDetectorModelCommand extends $Command<CreateDetectorModelCommandInput, CreateDetectorModelCommandOutput, IoTEventsClientResolvedConfig> {
56
63
  readonly input: CreateDetectorModelCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateDetectorModelCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDetectorModelCommandInput, CreateDetectorModelCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
5
5
  import { CreateInputRequest, CreateInputResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateInputCommand}.
8
10
  */
9
11
  export interface CreateInputCommandInput extends CreateInputRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateInputCommand}.
13
17
  */
14
18
  export interface CreateInputCommandOutput extends CreateInputResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an input.</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 CreateInputCommandOutput extends CreateInputResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateInputCommandInput - {@link CreateInputCommandInput}
34
+ * @returns {@link CreateInputCommandOutput}
28
35
  * @see {@link CreateInputCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateInputCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateInputCommandOutput extends CreateInputResponse, __Metadat
49
56
  export declare class CreateInputCommand extends $Command<CreateInputCommandInput, CreateInputCommandOutput, IoTEventsClientResolvedConfig> {
50
57
  readonly input: CreateInputCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: CreateInputCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateInputCommandInput, CreateInputCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
5
5
  import { DeleteAlarmModelRequest, DeleteAlarmModelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAlarmModelCommand}.
8
10
  */
9
11
  export interface DeleteAlarmModelCommandInput extends DeleteAlarmModelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAlarmModelCommand}.
13
17
  */
14
18
  export interface DeleteAlarmModelCommandOutput extends DeleteAlarmModelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an alarm model. Any alarm instances that were created based on this alarm model
18
23
  * are also deleted. This action can't be undone.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteAlarmModelCommandOutput extends DeleteAlarmModelResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteAlarmModelCommandInput - {@link DeleteAlarmModelCommandInput}
35
+ * @returns {@link DeleteAlarmModelCommandOutput}
29
36
  * @see {@link DeleteAlarmModelCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteAlarmModelCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DeleteAlarmModelCommandOutput extends DeleteAlarmModelResponse,
53
60
  export declare class DeleteAlarmModelCommand extends $Command<DeleteAlarmModelCommandInput, DeleteAlarmModelCommandOutput, IoTEventsClientResolvedConfig> {
54
61
  readonly input: DeleteAlarmModelCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DeleteAlarmModelCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAlarmModelCommandInput, DeleteAlarmModelCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
5
5
  import { DeleteDetectorModelRequest, DeleteDetectorModelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDetectorModelCommand}.
8
10
  */
9
11
  export interface DeleteDetectorModelCommandInput extends DeleteDetectorModelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDetectorModelCommand}.
13
17
  */
14
18
  export interface DeleteDetectorModelCommandOutput extends DeleteDetectorModelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a detector model. Any active instances of the detector model are also
18
23
  * deleted.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteDetectorModelCommandOutput extends DeleteDetectorModelRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteDetectorModelCommandInput - {@link DeleteDetectorModelCommandInput}
35
+ * @returns {@link DeleteDetectorModelCommandOutput}
29
36
  * @see {@link DeleteDetectorModelCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteDetectorModelCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DeleteDetectorModelCommandOutput extends DeleteDetectorModelRes
53
60
  export declare class DeleteDetectorModelCommand extends $Command<DeleteDetectorModelCommandInput, DeleteDetectorModelCommandOutput, IoTEventsClientResolvedConfig> {
54
61
  readonly input: DeleteDetectorModelCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DeleteDetectorModelCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDetectorModelCommandInput, DeleteDetectorModelCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
5
5
  import { DeleteInputRequest, DeleteInputResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteInputCommand}.
8
10
  */
9
11
  export interface DeleteInputCommandInput extends DeleteInputRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteInputCommand}.
13
17
  */
14
18
  export interface DeleteInputCommandOutput extends DeleteInputResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an input.</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 DeleteInputCommandOutput extends DeleteInputResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteInputCommandInput - {@link DeleteInputCommandInput}
34
+ * @returns {@link DeleteInputCommandOutput}
28
35
  * @see {@link DeleteInputCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteInputCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteInputCommandOutput extends DeleteInputResponse, __Metadat
52
59
  export declare class DeleteInputCommand extends $Command<DeleteInputCommandInput, DeleteInputCommandOutput, IoTEventsClientResolvedConfig> {
53
60
  readonly input: DeleteInputCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteInputCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteInputCommandInput, DeleteInputCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTEventsClient";
5
5
  import { DescribeAlarmModelRequest, DescribeAlarmModelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAlarmModelCommand}.
8
10
  */
9
11
  export interface DescribeAlarmModelCommandInput extends DescribeAlarmModelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAlarmModelCommand}.
13
17
  */
14
18
  export interface DescribeAlarmModelCommandOutput extends DescribeAlarmModelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about an alarm model. If you don't specify a value for the
18
23
  * <code>alarmModelVersion</code> parameter, the latest version is returned.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeAlarmModelCommandOutput extends DescribeAlarmModelRespo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeAlarmModelCommandInput - {@link DescribeAlarmModelCommandInput}
35
+ * @returns {@link DescribeAlarmModelCommandOutput}
29
36
  * @see {@link DescribeAlarmModelCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeAlarmModelCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTEventsClientResolvedConfig | config} for IoTEventsClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeAlarmModelCommandOutput extends DescribeAlarmModelRespo
50
57
  export declare class DescribeAlarmModelCommand extends $Command<DescribeAlarmModelCommandInput, DescribeAlarmModelCommandOutput, IoTEventsClientResolvedConfig> {
51
58
  readonly input: DescribeAlarmModelCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeAlarmModelCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAlarmModelCommandInput, DescribeAlarmModelCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }