1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class IoTEventsData extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: IoTEventsData.Types.ClientConfiguration)
|
13 | config: Config & IoTEventsData.Types.ClientConfiguration;
|
14 | /**
|
15 | * Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.
|
16 | */
|
17 | batchPutMessage(params: IoTEventsData.Types.BatchPutMessageRequest, callback?: (err: AWSError, data: IoTEventsData.Types.BatchPutMessageResponse) => void): Request<IoTEventsData.Types.BatchPutMessageResponse, AWSError>;
|
18 | /**
|
19 | * Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.
|
20 | */
|
21 | batchPutMessage(callback?: (err: AWSError, data: IoTEventsData.Types.BatchPutMessageResponse) => void): Request<IoTEventsData.Types.BatchPutMessageResponse, AWSError>;
|
22 | /**
|
23 | * Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
|
24 | */
|
25 | batchUpdateDetector(params: IoTEventsData.Types.BatchUpdateDetectorRequest, callback?: (err: AWSError, data: IoTEventsData.Types.BatchUpdateDetectorResponse) => void): Request<IoTEventsData.Types.BatchUpdateDetectorResponse, AWSError>;
|
26 | /**
|
27 | * Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
|
28 | */
|
29 | batchUpdateDetector(callback?: (err: AWSError, data: IoTEventsData.Types.BatchUpdateDetectorResponse) => void): Request<IoTEventsData.Types.BatchUpdateDetectorResponse, AWSError>;
|
30 | /**
|
31 | * Returns information about the specified detector (instance).
|
32 | */
|
33 | describeDetector(params: IoTEventsData.Types.DescribeDetectorRequest, callback?: (err: AWSError, data: IoTEventsData.Types.DescribeDetectorResponse) => void): Request<IoTEventsData.Types.DescribeDetectorResponse, AWSError>;
|
34 | /**
|
35 | * Returns information about the specified detector (instance).
|
36 | */
|
37 | describeDetector(callback?: (err: AWSError, data: IoTEventsData.Types.DescribeDetectorResponse) => void): Request<IoTEventsData.Types.DescribeDetectorResponse, AWSError>;
|
38 | /**
|
39 | * Lists detectors (the instances of a detector model).
|
40 | */
|
41 | listDetectors(params: IoTEventsData.Types.ListDetectorsRequest, callback?: (err: AWSError, data: IoTEventsData.Types.ListDetectorsResponse) => void): Request<IoTEventsData.Types.ListDetectorsResponse, AWSError>;
|
42 | /**
|
43 | * Lists detectors (the instances of a detector model).
|
44 | */
|
45 | listDetectors(callback?: (err: AWSError, data: IoTEventsData.Types.ListDetectorsResponse) => void): Request<IoTEventsData.Types.ListDetectorsResponse, AWSError>;
|
46 | }
|
47 | declare namespace IoTEventsData {
|
48 | export type BatchPutMessageErrorEntries = BatchPutMessageErrorEntry[];
|
49 | export interface BatchPutMessageErrorEntry {
|
50 | |
51 |
|
52 |
|
53 | messageId?: MessageId;
|
54 | |
55 |
|
56 |
|
57 | errorCode?: ErrorCode;
|
58 | |
59 |
|
60 |
|
61 | errorMessage?: ErrorMessage;
|
62 | }
|
63 | export interface BatchPutMessageRequest {
|
64 | |
65 |
|
66 |
|
67 | messages: Messages;
|
68 | }
|
69 | export interface BatchPutMessageResponse {
|
70 | |
71 |
|
72 |
|
73 | BatchPutMessageErrorEntries?: BatchPutMessageErrorEntries;
|
74 | }
|
75 | export type BatchUpdateDetectorErrorEntries = BatchUpdateDetectorErrorEntry[];
|
76 | export interface BatchUpdateDetectorErrorEntry {
|
77 | |
78 |
|
79 |
|
80 | messageId?: MessageId;
|
81 | |
82 |
|
83 |
|
84 | errorCode?: ErrorCode;
|
85 | |
86 |
|
87 |
|
88 | errorMessage?: ErrorMessage;
|
89 | }
|
90 | export interface BatchUpdateDetectorRequest {
|
91 | |
92 |
|
93 |
|
94 | detectors: UpdateDetectorRequests;
|
95 | }
|
96 | export interface BatchUpdateDetectorResponse {
|
97 | |
98 |
|
99 |
|
100 | batchUpdateDetectorErrorEntries?: BatchUpdateDetectorErrorEntries;
|
101 | }
|
102 | export interface DescribeDetectorRequest {
|
103 | |
104 |
|
105 |
|
106 | detectorModelName: DetectorModelName;
|
107 | |
108 |
|
109 |
|
110 | keyValue?: KeyValue;
|
111 | }
|
112 | export interface DescribeDetectorResponse {
|
113 | |
114 |
|
115 |
|
116 | detector?: Detector;
|
117 | }
|
118 | export interface Detector {
|
119 | |
120 |
|
121 |
|
122 | detectorModelName?: DetectorModelName;
|
123 | |
124 |
|
125 |
|
126 | keyValue?: KeyValue;
|
127 | |
128 |
|
129 |
|
130 | detectorModelVersion?: DetectorModelVersion;
|
131 | |
132 |
|
133 |
|
134 | state?: DetectorState;
|
135 | |
136 |
|
137 |
|
138 | creationTime?: Timestamp;
|
139 | |
140 |
|
141 |
|
142 | lastUpdateTime?: Timestamp;
|
143 | }
|
144 | export type DetectorModelName = string;
|
145 | export type DetectorModelVersion = string;
|
146 | export interface DetectorState {
|
147 | |
148 |
|
149 |
|
150 | stateName: StateName;
|
151 | |
152 |
|
153 |
|
154 | variables: Variables;
|
155 | |
156 |
|
157 |
|
158 | timers: Timers;
|
159 | }
|
160 | export interface DetectorStateDefinition {
|
161 | |
162 |
|
163 |
|
164 | stateName: StateName;
|
165 | |
166 |
|
167 |
|
168 | variables: VariableDefinitions;
|
169 | |
170 |
|
171 |
|
172 | timers: TimerDefinitions;
|
173 | }
|
174 | export interface DetectorStateSummary {
|
175 | |
176 |
|
177 |
|
178 | stateName?: StateName;
|
179 | }
|
180 | export type DetectorSummaries = DetectorSummary[];
|
181 | export interface DetectorSummary {
|
182 | |
183 |
|
184 |
|
185 | detectorModelName?: DetectorModelName;
|
186 | |
187 |
|
188 |
|
189 | keyValue?: KeyValue;
|
190 | |
191 |
|
192 |
|
193 | detectorModelVersion?: DetectorModelVersion;
|
194 | |
195 |
|
196 |
|
197 | state?: DetectorStateSummary;
|
198 | |
199 |
|
200 |
|
201 | creationTime?: Timestamp;
|
202 | |
203 |
|
204 |
|
205 | lastUpdateTime?: Timestamp;
|
206 | }
|
207 | export type ErrorCode = "ResourceNotFoundException"|"InvalidRequestException"|"InternalFailureException"|"ServiceUnavailableException"|"ThrottlingException"|string;
|
208 | export type ErrorMessage = string;
|
209 | export type InputName = string;
|
210 | export type KeyValue = string;
|
211 | export interface ListDetectorsRequest {
|
212 | |
213 |
|
214 |
|
215 | detectorModelName: DetectorModelName;
|
216 | |
217 |
|
218 |
|
219 | stateName?: StateName;
|
220 | |
221 |
|
222 |
|
223 | nextToken?: NextToken;
|
224 | |
225 |
|
226 |
|
227 | maxResults?: MaxResults;
|
228 | }
|
229 | export interface ListDetectorsResponse {
|
230 | |
231 |
|
232 |
|
233 | detectorSummaries?: DetectorSummaries;
|
234 | |
235 |
|
236 |
|
237 | nextToken?: NextToken;
|
238 | }
|
239 | export type MaxResults = number;
|
240 | export interface Message {
|
241 | |
242 |
|
243 |
|
244 | messageId: MessageId;
|
245 | |
246 |
|
247 |
|
248 | inputName: InputName;
|
249 | |
250 |
|
251 |
|
252 | payload: Payload;
|
253 | }
|
254 | export type MessageId = string;
|
255 | export type Messages = Message[];
|
256 | export type NextToken = string;
|
257 | export type Payload = Buffer|Uint8Array|Blob|string;
|
258 | export type Seconds = number;
|
259 | export type StateName = string;
|
260 | export interface Timer {
|
261 | |
262 |
|
263 |
|
264 | name: TimerName;
|
265 | |
266 |
|
267 |
|
268 | timestamp: Timestamp;
|
269 | }
|
270 | export interface TimerDefinition {
|
271 | |
272 |
|
273 |
|
274 | name: TimerName;
|
275 | |
276 |
|
277 |
|
278 | seconds: Seconds;
|
279 | }
|
280 | export type TimerDefinitions = TimerDefinition[];
|
281 | export type TimerName = string;
|
282 | export type Timers = Timer[];
|
283 | export type Timestamp = Date;
|
284 | export interface UpdateDetectorRequest {
|
285 | |
286 |
|
287 |
|
288 | messageId: MessageId;
|
289 | |
290 |
|
291 |
|
292 | detectorModelName: DetectorModelName;
|
293 | |
294 |
|
295 |
|
296 | keyValue?: KeyValue;
|
297 | |
298 |
|
299 |
|
300 | state: DetectorStateDefinition;
|
301 | }
|
302 | export type UpdateDetectorRequests = UpdateDetectorRequest[];
|
303 | export interface Variable {
|
304 | |
305 |
|
306 |
|
307 | name: VariableName;
|
308 | |
309 |
|
310 |
|
311 | value: VariableValue;
|
312 | }
|
313 | export interface VariableDefinition {
|
314 | |
315 |
|
316 |
|
317 | name: VariableName;
|
318 | |
319 |
|
320 |
|
321 | value: VariableValue;
|
322 | }
|
323 | export type VariableDefinitions = VariableDefinition[];
|
324 | export type VariableName = string;
|
325 | export type VariableValue = string;
|
326 | export type Variables = Variable[];
|
327 | |
328 |
|
329 |
|
330 | export type apiVersion = "2018-10-23"|"latest"|string;
|
331 | export interface ClientApiVersions {
|
332 | |
333 |
|
334 |
|
335 | apiVersion?: apiVersion;
|
336 | }
|
337 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
338 | |
339 |
|
340 |
|
341 | export import Types = IoTEventsData;
|
342 | }
|
343 | export = IoTEventsData;
|